Send feedback
Class Table (6.0.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
Create a Table object to interact with a Cloud Bigtable table.
Inheritance
TabularApiSurface
>
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
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
checkConsistency(token, callback)
checkConsistency ( token : string , callback : CheckConsistencyCallback ) : void ;
Returns
Type
Description
void
create(options)
create ( options ?: CreateTableOptions ) : Promise<CreateTableResponse> ;
create(options, callback)
create ( options : CreateTableOptions , callback : CreateTableCallback ) : void ;
Returns
Type
Description
void
create(callback)
create ( callback : CreateTableCallback ) : void ;
Returns
Type
Description
void
createBackup(id, config)
createBackup ( id : string , config : CreateBackupConfig ) : Promise<CreateBackupResponse> ;
Parameters
Name
Description
id
string
config
CreateBackupConfig
createBackup(id, config, callback)
createBackup ( id : string , config : CreateBackupConfig , callback : CreateBackupCallback ) : void ;
Returns
Type
Description
void
createBackup(id, config, callback)
createBackup ( id : string , config : CreateBackupConfig , callback : CreateBackupCallback ) : void ;
Returns
Type
Description
void
createFamily(id, options)
createFamily ( id : string , options ?: CreateFamilyOptions ) : Promise<CreateFamilyResponse> ;
createFamily(id, options, callback)
createFamily ( id : string , options : CreateFamilyOptions , callback : CreateFamilyCallback ) : void ;
Returns
Type
Description
void
createFamily(id, callback)
createFamily ( id : string , callback : CreateFamilyCallback ) : void ;
Returns
Type
Description
void
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.
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
// }
// }
decodePolicyEtag(policy)
static decodePolicyEtag ( policy : Policy ) : Policy ;
Formats the decodes policy etag value to string.
Parameter
Name
Description
policy
Policy
Returns
Type
Description
Policy
delete(gaxOptions)
delete ( gaxOptions ?: CallOptions ) : Promise<DeleteTableResponse> ;
Parameter
Name
Description
gaxOptions
CallOptions
delete(gaxOptions, callback)
delete ( gaxOptions : CallOptions , callback : DeleteTableCallback ) : void ;
Returns
Type
Description
void
delete(callback)
delete ( callback : DeleteTableCallback ) : void ;
Returns
Type
Description
void
deleteRows(prefix, gaxOptions)
deleteRows ( prefix : string , gaxOptions ?: CallOptions ) : Promise<DeleteRowsResponse> ;
Parameters
Name
Description
prefix
string
gaxOptions
CallOptions
deleteRows(prefix, gaxOptions, callback)
deleteRows ( prefix : string , gaxOptions : CallOptions , callback : DeleteRowsCallback ) : void ;
Parameters
Name
Description
prefix
string
gaxOptions
CallOptions
callback
DeleteRowsCallback
Returns
Type
Description
void
deleteRows(prefix, callback)
deleteRows ( prefix : string , callback : DeleteRowsCallback ) : void ;
Returns
Type
Description
void
exists(gaxOptions)
exists ( gaxOptions ?: CallOptions ) : Promise<TableExistsResponse> ;
Parameter
Name
Description
gaxOptions
CallOptions
exists(gaxOptions, callback)
exists ( gaxOptions : CallOptions , callback : TableExistsCallback ) : void ;
Returns
Type
Description
void
exists(callback)
exists ( callback : TableExistsCallback ) : void ;
Returns
Type
Description
void
family(id)
family ( id : string ) : Family ;
Get a reference to a Table Family.
Parameter
Name
Description
id
string
The family unique identifier.
Returns
Type
Description
Family
{Family}
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
Type
Description
string
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> ;
generateConsistencyToken(callback)
generateConsistencyToken ( callback : GenerateConsistencyTokenCallback ) : void ;
Returns
Type
Description
void
get(options)
get ( options ?: GetTableOptions ) : Promise<GetTableResponse> ;
get(options, callback)
get ( options : GetTableOptions , callback : GetTableCallback ) : void ;
Returns
Type
Description
void
get(callback)
get ( callback : GetTableCallback ) : void ;
Returns
Type
Description
void
getFamilies(gaxOptions)
getFamilies ( gaxOptions ?: CallOptions ) : Promise<GetFamiliesResponse> ;
Parameter
Name
Description
gaxOptions
CallOptions
getFamilies(gaxOptions, callback)
getFamilies ( gaxOptions : CallOptions , callback : GetFamiliesCallback ) : void ;
Returns
Type
Description
void
getFamilies(callback)
getFamilies ( callback : GetFamiliesCallback ) : void ;
Returns
Type
Description
void
getIamPolicy(options)
getIamPolicy ( options ?: GetIamPolicyOptions ) : Promise <[ Policy ]>;
Returns
Type
Description
Promise <[Policy ]>
getIamPolicy(options, callback)
getIamPolicy ( options : GetIamPolicyOptions , callback : GetIamPolicyCallback ) : void ;
Returns
Type
Description
void
getMetadata ( options ?: GetMetadataOptions ) : Promise<GetMetadataResponse> ;
getMetadata ( options : GetMetadataOptions , callback : GetMetadataCallback ) : void ;
Returns
Type
Description
void
getMetadata ( callback : GetMetadataCallback ) : void ;
Returns
Type
Description
void
getReplicationStates(gaxOptions)
getReplicationStates ( gaxOptions ?: CallOptions ) : Promise<GetReplicationStatesResponse> ;
Parameter
Name
Description
gaxOptions
CallOptions
getReplicationStates(gaxOptions, callback)
getReplicationStates ( gaxOptions : CallOptions , callback : GetReplicationStatesCallback ) : void ;
Returns
Type
Description
void
getReplicationStates(callback)
getReplicationStates ( callback : GetReplicationStatesCallback ) : void ;
Returns
Type
Description
void
setIamPolicy(policy, gaxOptions)
setIamPolicy ( policy : Policy , gaxOptions ?: CallOptions ) : Promise<SetIamPolicyResponse> ;
Parameters
Name
Description
policy
Policy
gaxOptions
CallOptions
setIamPolicy(policy, callback)
setIamPolicy ( policy : Policy , callback : SetIamPolicyCallback ) : void ;
Returns
Type
Description
void
setIamPolicy(policy, gaxOptions, callback)
setIamPolicy ( policy : Policy , gaxOptions : CallOptions , callback : SetIamPolicyCallback ) : void ;
Returns
Type
Description
void
testIamPermissions(permissions, gaxOptions)
testIamPermissions ( permissions : string | string [], gaxOptions ?: CallOptions ) : Promise<TestIamPermissionsResponse> ;
Parameters
Name
Description
permissions
string | string[]
gaxOptions
CallOptions
testIamPermissions(permissions, callback)
testIamPermissions ( permissions : string | string [], callback : TestIamPermissionsCallback ) : void ;
Returns
Type
Description
void
testIamPermissions(permissions, gaxOptions, callback)
testIamPermissions ( permissions : string | string [], gaxOptions : CallOptions , callback : TestIamPermissionsCallback ) : void ;
Returns
Type
Description
void
truncate(gaxOptions)
truncate ( gaxOptions ?: CallOptions ) : Promise<TruncateResponse> ;
Parameter
Name
Description
gaxOptions
CallOptions
truncate(gaxOptions, callback)
truncate ( gaxOptions : CallOptions , callback : TruncateCallback ) : void ;
Returns
Type
Description
void
truncate(callback)
truncate ( callback : TruncateCallback ) : void ;
Returns
Type
Description
void
waitForReplication()
waitForReplication () : Promise<WaitForReplicationResponse> ;
waitForReplication(callback)
waitForReplication ( callback : WaitForReplicationCallback ) : void ;
Returns
Type
Description
void
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-09 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-09 UTC."],[],[]]