Create a Table object to interact with a Cloud Bigtable table.
Package
@google-cloud/bigtable
Example
const {Bigtable} = require('@google-cloud/bigtable');
const bigtable = new Bigtable();
const instance = bigtable.instance('my-instance');
const table = instance.table('prezzy');
Constructors
(constructor)(instance, id)
constructor(instance: Instance, id: string);
Constructs a new instance of the Table
class
Parameters
Name | Description |
instance |
Instance
|
id |
string
|
Properties
bigtable
id
instance
maxRetries
metadata?: google.bigtable.admin.v2.ITable;
name
VIEWS
static VIEWS: {
[index: string]: number;
};
The view to be applied to the returned table's fields. Defaults to schema if unspecified.
Methods
checkConsistency(token)
checkConsistency(token: string): Promise<CheckConsistencyResponse>;
Parameter
Name | Description |
token |
string
|
Returns
checkConsistency(token, callback)
checkConsistency(token: string, callback: CheckConsistencyCallback): void;
Parameters
Returns
create(options)
create(options?: CreateTableOptions): Promise<CreateTableResponse>;
Parameter
Returns
create(options, callback)
create(options: CreateTableOptions, callback: CreateTableCallback): void;
Parameters
Returns
create(callback)
create(callback: CreateTableCallback): void;
Parameter
Returns
createBackup(id, config)
createBackup(id: string, config: CreateBackupConfig): Promise<CreateBackupResponse>;
Parameters
Name | Description |
id |
string
|
config |
CreateBackupConfig
|
Returns
createBackup(id, config, callback)
createBackup(id: string, config: CreateBackupConfig, callback: CreateBackupCallback): void;
Parameters
Returns
createBackup(id, config, callback)
createBackup(id: string, config: CreateBackupConfig, callback: CreateBackupCallback): void;
Parameters
Returns
createFamily(id, options)
createFamily(id: string, options?: CreateFamilyOptions): Promise<CreateFamilyResponse>;
Parameters
Returns
createFamily(id, options, callback)
createFamily(id: string, options: CreateFamilyOptions, callback: CreateFamilyCallback): void;
Parameters
Returns
createFamily(id, callback)
createFamily(id: string, callback: CreateFamilyCallback): void;
Parameters
Returns
createPrefixRange(start)
static createPrefixRange(start: string): PrefixRange;
Creates a range based off of a key prefix.
Parameter
Name | Description |
start |
string
The key prefix/starting bound.
|
Returns
Example
const {Bigtable} = require('@google-cloud/bigtable');
const bigtable = new Bigtable();
const instance = bigtable.instance('my-instance');
const table = instance.table('prezzy');
table.createPrefixRange('start');
// => {
// start: 'start',
// end: {
// value: 'staru',
// inclusive: false
// }
// }
createReadStream(opts)
createReadStream(opts?: GetRowsOptions): PassThrough;
Get Row objects for the rows currently in your table as a readable object stream.
Parameter
Returns
Type | Description |
PassThrough | {stream}
|
Example
table
.createReadStream()
.on('error', err => {
// Handle the error.
})
.on('data', row => {
// `row` is a Row object.
})
.on('end', () => {
// All rows retrieved.
});
//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing.
//-
// table
// .createReadStream()
// .on('data', function (row) {
// this.end();
// });
//-
// Specify arbitrary keys for a non-contiguous set of rows.
// The total size of the keys must remain under 1MB, after encoding.
//-
// table.createReadStream({
// keys: [
// 'alincoln',
// 'gwashington'
// ]
// });
//-
// Scan for row keys that contain a specific prefix.
//-
// table.createReadStream({
// prefix: 'gwash'
// });
//-
// Specify a contiguous range of rows to read by supplying `start` and `end`
// keys.
//
// If the `start` key is omitted, it is interpreted as an empty string.
// If the `end` key is omitted, it is interpreted as infinity.
//-
// table.createReadStream({
// start: 'alincoln',
// end: 'gwashington'
// });
//-
// Specify multiple ranges.
//-
// table.createReadStream({
// ranges: [{
// start: 'alincoln',
// end: 'gwashington'
// }, {
// start: 'tjefferson',
// end: 'jadams'
// }]
// });
//-
// Apply a {@link Filter} to the contents of the specified rows.
//-
// table.createReadStream({
// filter: [
// {
// column: 'gwashington'
// }, {
// value: 1
// }
// ]
// });
//
decodePolicyEtag(policy)
static decodePolicyEtag(policy: Policy): Policy;
Formats the decodes policy etag value to string.
Parameter
Returns
delete(gaxOptions)
delete(gaxOptions?: CallOptions): Promise<DeleteTableResponse>;
Parameter
Name | Description |
gaxOptions |
CallOptions
|
Returns
delete(gaxOptions, callback)
delete(gaxOptions: CallOptions, callback: DeleteTableCallback): void;
Parameters
Returns
delete(callback)
delete(callback: DeleteTableCallback): void;
Parameter
Returns
deleteRows(prefix, gaxOptions)
deleteRows(prefix: string, gaxOptions?: CallOptions): Promise<DeleteRowsResponse>;
Parameters
Name | Description |
prefix |
string
|
gaxOptions |
CallOptions
|
Returns
deleteRows(prefix, gaxOptions, callback)
deleteRows(prefix: string, gaxOptions: CallOptions, callback: DeleteRowsCallback): void;
Parameters
Returns
deleteRows(prefix, callback)
deleteRows(prefix: string, callback: DeleteRowsCallback): void;
Parameters
Returns
exists(gaxOptions)
exists(gaxOptions?: CallOptions): Promise<TableExistsResponse>;
Parameter
Name | Description |
gaxOptions |
CallOptions
|
Returns
exists(gaxOptions, callback)
exists(gaxOptions: CallOptions, callback: TableExistsCallback): void;
Parameters
Returns
exists(callback)
exists(callback: TableExistsCallback): void;
Parameter
Returns
family(id)
family(id: string): Family;
Get a reference to a Table Family.
Parameter
Name | Description |
id |
string
The family unique identifier.
|
Returns
Example
const family = table.family('my-family');
static formatName_(instanceName: string, id: string): string;
Formats the table name to include the Bigtable cluster.
Parameters
Name | Description |
instanceName |
string
The formatted instance name.
|
id |
string
|
Returns
Example
Table.formatName_(
'projects/my-project/zones/my-zone/instances/my-instance',
'my-table'
);
//
'projects/my-project/zones/my-zone/instances/my-instance/tables/my-table'
generateConsistencyToken()
generateConsistencyToken(): Promise<GenerateConsistencyTokenResponse>;
Returns
generateConsistencyToken(callback)
generateConsistencyToken(callback: GenerateConsistencyTokenCallback): void;
Parameter
Returns
get(options)
get(options?: GetTableOptions): Promise<GetTableResponse>;
Parameter
Returns
get(options, callback)
get(options: GetTableOptions, callback: GetTableCallback): void;
Parameters
Returns
get(callback)
get(callback: GetTableCallback): void;
Parameter
Returns
getFamilies(gaxOptions)
getFamilies(gaxOptions?: CallOptions): Promise<GetFamiliesResponse>;
Parameter
Name | Description |
gaxOptions |
CallOptions
|
Returns
getFamilies(gaxOptions, callback)
getFamilies(gaxOptions: CallOptions, callback: GetFamiliesCallback): void;
Parameters
Returns
getFamilies(callback)
getFamilies(callback: GetFamiliesCallback): void;
Parameter
Returns
getIamPolicy(options)
getIamPolicy(options?: GetIamPolicyOptions): Promise<[Policy]>;
Parameter
Returns
Type | Description |
Promise<[Policy]> | |
getIamPolicy(options, callback)
getIamPolicy(options: GetIamPolicyOptions, callback: GetIamPolicyCallback): void;
Parameters
Returns
getMetadata(options?: GetMetadataOptions): Promise<GetMetadataResponse>;
Parameter
Returns
getMetadata(options: GetMetadataOptions, callback: GetMetadataCallback): void;
Parameters
Returns
getMetadata(callback: GetMetadataCallback): void;
Parameter
Returns
getReplicationStates(gaxOptions)
getReplicationStates(gaxOptions?: CallOptions): Promise<GetReplicationStatesResponse>;
Parameter
Name | Description |
gaxOptions |
CallOptions
|
Returns
getReplicationStates(gaxOptions, callback)
getReplicationStates(gaxOptions: CallOptions, callback: GetReplicationStatesCallback): void;
Parameters
Returns
getReplicationStates(callback)
getReplicationStates(callback: GetReplicationStatesCallback): void;
Parameter
Returns
getRows(options)
getRows(options?: GetRowsOptions): Promise<GetRowsResponse>;
Parameter
Returns
getRows(options, callback)
getRows(options: GetRowsOptions, callback: GetRowsCallback): void;
Parameters
Returns
getRows(callback)
getRows(callback: GetRowsCallback): void;
Parameter
Returns
insert(entries, gaxOptions)
insert(entries: Entry | Entry[], gaxOptions?: CallOptions): Promise<InsertRowsResponse>;
Parameters
Name | Description |
entries |
Entry | Entry[]
|
gaxOptions |
CallOptions
|
Returns
insert(entries, gaxOptions, callback)
insert(entries: Entry | Entry[], gaxOptions: CallOptions, callback: InsertRowsCallback): void;
Parameters
Returns
insert(entries, callback)
insert(entries: Entry | Entry[], callback: InsertRowsCallback): void;
Parameters
Returns
mutate(entries, options)
mutate(entries: Entry | Entry[], options?: MutateOptions): Promise<MutateResponse>;
Parameters
Returns
mutate(entries, options, callback)
mutate(entries: Entry | Entry[], options: MutateOptions, callback: MutateCallback): void;
Parameters
Returns
mutate(entries, callback)
mutate(entries: Entry | Entry[], callback: MutateCallback): void;
Parameters
Returns
row(key)
Get a reference to a table row.
Parameter
Name | Description |
key |
string
The row key.
|
Returns
Example
const row = table.row('lincoln');
sampleRowKeys(gaxOptions)
sampleRowKeys(gaxOptions?: CallOptions): Promise<SampleRowsKeysResponse>;
Parameter
Name | Description |
gaxOptions |
CallOptions
|
Returns
sampleRowKeys(gaxOptions, callback)
sampleRowKeys(gaxOptions: CallOptions, callback: SampleRowKeysCallback): void;
Parameters
Returns
sampleRowKeys(callback)
sampleRowKeys(callback?: SampleRowKeysCallback): void;
Parameter
Returns
sampleRowKeysStream(gaxOptions)
sampleRowKeysStream(gaxOptions?: CallOptions): any;
Returns a sample of row keys in the table as a readable object stream.
See for more details.
Parameter
Returns
Type | Description |
any | {stream}
|
Example
table.sampleRowKeysStream()
.on('error', console.error)
.on('data', function(key) {
// Do something with the `key` object.
});
//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing.
//-
table.sampleRowKeysStream()
.on('data', function(key) {
this.end();
});
setIamPolicy(policy, gaxOptions)
setIamPolicy(policy: Policy, gaxOptions?: CallOptions): Promise<SetIamPolicyResponse>;
Parameters
Name | Description |
policy |
Policy
|
gaxOptions |
CallOptions
|
Returns
setIamPolicy(policy, callback)
setIamPolicy(policy: Policy, callback: SetIamPolicyCallback): void;
Parameters
Returns
setIamPolicy(policy, gaxOptions, callback)
setIamPolicy(policy: Policy, gaxOptions: CallOptions, callback: SetIamPolicyCallback): void;
Parameters
Returns
testIamPermissions(permissions, gaxOptions)
testIamPermissions(permissions: string | string[], gaxOptions?: CallOptions): Promise<TestIamPermissionsResponse>;
Parameters
Name | Description |
permissions |
string | string[]
|
gaxOptions |
CallOptions
|
Returns
testIamPermissions(permissions, callback)
testIamPermissions(permissions: string | string[], callback: TestIamPermissionsCallback): void;
Parameters
Returns
testIamPermissions(permissions, gaxOptions, callback)
testIamPermissions(permissions: string | string[], gaxOptions: CallOptions, callback: TestIamPermissionsCallback): void;
Parameters
Returns
truncate(gaxOptions)
truncate(gaxOptions?: CallOptions): Promise<TruncateResponse>;
Parameter
Name | Description |
gaxOptions |
CallOptions
|
Returns
truncate(gaxOptions, callback)
truncate(gaxOptions: CallOptions, callback: TruncateCallback): void;
Parameters
Returns
truncate(callback)
truncate(callback: TruncateCallback): void;
Parameter
Returns
waitForReplication()
waitForReplication(): Promise<WaitForReplicationResponse>;
Returns
waitForReplication(callback)
waitForReplication(callback: WaitForReplicationCallback): void;
Parameter
Returns