Send feedback
Class Table (3.6.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.6.0 keyboard_arrow_down
Create a Table object to interact with a Cloud Bigtable table.
Package
@google-cloud/bigtable!
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
Property Value
id
Property Value
instance
Property Value
maxRetries
Property Value
metadata ?: google . bigtable . admin . v2 . ITable ;
Property Value
Type Description google.bigtable.admin.v2.ITable
name
Property Value
VIEWS
static VIEWS : {
[ index : string ] : number ;
};
The view to be applied to the returned table's fields. Defaults to schema if unspecified.
Property Value
Type Description {
[index: string]: number;
}
Methods
checkConsistency(token)
checkConsistency ( token : string ) : Promise<CheckConsistencyResponse> ;
Parameter
Name Description token
string
Returns
Type Description Promise <CheckConsistencyResponse >
checkConsistency(token, callback)
checkConsistency ( token : string , callback : CheckConsistencyCallback ) : void ;
Parameters
Name Description token
string
callback
CheckConsistencyCallback
Returns
create(options)
create ( options ?: CreateTableOptions ) : Promise<CreateTableResponse> ;
Parameter
Returns
Type Description Promise <CreateTableResponse >
create(options, callback)
create ( options : CreateTableOptions , callback : CreateTableCallback ) : void ;
Parameters
Returns
create(callback)
create ( callback : CreateTableCallback ) : void ;
Parameter
Name Description callback
CreateTableCallback
Returns
createBackup(id, config)
createBackup ( id : string , config : CreateBackupConfig ) : Promise<CreateBackupResponse> ;
Parameters
Name Description id
string
config
CreateBackupConfig
Returns
Type Description Promise <CreateBackupResponse >
createBackup(id, config, callback)
createBackup ( id : string , config : CreateBackupConfig , callback : CreateBackupCallback ) : void ;
Parameters
Name Description id
string
config
CreateBackupConfig
callback
CreateBackupCallback
Returns
createBackup(id, config, callback)
createBackup ( id : string , config : CreateBackupConfig , callback : CreateBackupCallback ) : void ;
Parameters
Name Description id
string
config
CreateBackupConfig
callback
CreateBackupCallback
Returns
createFamily(id, options)
createFamily ( id : string , options ?: CreateFamilyOptions ) : Promise<CreateFamilyResponse> ;
Parameters
Returns
Type Description Promise <CreateFamilyResponse >
createFamily(id, options, callback)
createFamily ( id : string , options : CreateFamilyOptions , callback : CreateFamilyCallback ) : void ;
Parameters
Returns
createFamily(id, callback)
createFamily ( id : string , callback : CreateFamilyCallback ) : void ;
Parameters
Name Description id
string
callback
CreateFamilyCallback
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
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}
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
Type Description Promise <DeleteTableResponse >
delete(gaxOptions, callback)
delete ( gaxOptions : CallOptions , callback : DeleteTableCallback ) : void ;
Parameters
Name Description gaxOptions
CallOptions
callback
DeleteTableCallback
Returns
delete(callback)
delete ( callback : DeleteTableCallback ) : void ;
Parameter
Name Description callback
DeleteTableCallback
Returns
deleteRows(prefix, gaxOptions)
deleteRows ( prefix : string , gaxOptions ?: CallOptions ) : Promise<DeleteRowsResponse> ;
Parameters
Name Description prefix
string
gaxOptions
CallOptions
Returns
Type Description Promise <DeleteRowsResponse >
deleteRows(prefix, gaxOptions, callback)
deleteRows ( prefix : string , gaxOptions : CallOptions , callback : DeleteRowsCallback ) : void ;
Parameters
Name Description prefix
string
gaxOptions
CallOptions
callback
DeleteRowsCallback
Returns
deleteRows(prefix, callback)
deleteRows ( prefix : string , callback : DeleteRowsCallback ) : void ;
Parameters
Name Description prefix
string
callback
DeleteRowsCallback
Returns
exists(gaxOptions)
exists ( gaxOptions ?: CallOptions ) : Promise<TableExistsResponse> ;
Parameter
Name Description gaxOptions
CallOptions
Returns
Type Description Promise <TableExistsResponse >
exists(gaxOptions, callback)
exists ( gaxOptions : CallOptions , callback : TableExistsCallback ) : void ;
Parameters
Name Description gaxOptions
CallOptions
callback
TableExistsCallback
Returns
exists(callback)
exists ( callback : TableExistsCallback ) : void ;
Parameter
Name Description callback
TableExistsCallback
Returns
family(id)
family ( id : string ) : Family ;
Get a reference to a Table Family.
Parameter
Name Description id
string
The family unique identifier.
Returns
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
generateConsistencyToken()
generateConsistencyToken () : Promise<GenerateConsistencyTokenResponse> ;
Returns
Type Description Promise <GenerateConsistencyTokenResponse >
generateConsistencyToken(callback)
generateConsistencyToken ( callback : GenerateConsistencyTokenCallback ) : void ;
Parameter
Name Description callback
GenerateConsistencyTokenCallback
Returns
get(options)
get ( options ?: GetTableOptions ) : Promise<GetTableResponse> ;
Parameter
Returns
Type Description Promise <GetTableResponse >
get(options, callback)
get ( options : GetTableOptions , callback : GetTableCallback ) : void ;
Parameters
Returns
get(callback)
get ( callback : GetTableCallback ) : void ;
Parameter
Name Description callback
GetTableCallback
Returns
getFamilies(gaxOptions)
getFamilies ( gaxOptions ?: CallOptions ) : Promise<GetFamiliesResponse> ;
Parameter
Name Description gaxOptions
CallOptions
Returns
Type Description Promise <GetFamiliesResponse >
getFamilies(gaxOptions, callback)
getFamilies ( gaxOptions : CallOptions , callback : GetFamiliesCallback ) : void ;
Parameters
Name Description gaxOptions
CallOptions
callback
GetFamiliesCallback
Returns
getFamilies(callback)
getFamilies ( callback : GetFamiliesCallback ) : void ;
Parameter
Name Description callback
GetFamiliesCallback
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
Type Description Promise <GetMetadataResponse >
getMetadata ( options : GetMetadataOptions , callback : GetMetadataCallback ) : void ;
Parameters
Returns
getMetadata ( callback : GetMetadataCallback ) : void ;
Parameter
Name Description callback
GetMetadataCallback
Returns
getReplicationStates(gaxOptions)
getReplicationStates ( gaxOptions ?: CallOptions ) : Promise<GetReplicationStatesResponse> ;
Parameter
Name Description gaxOptions
CallOptions
Returns
Type Description Promise <GetReplicationStatesResponse >
getReplicationStates(gaxOptions, callback)
getReplicationStates ( gaxOptions : CallOptions , callback : GetReplicationStatesCallback ) : void ;
Parameters
Name Description gaxOptions
CallOptions
callback
GetReplicationStatesCallback
Returns
getReplicationStates(callback)
getReplicationStates ( callback : GetReplicationStatesCallback ) : void ;
Parameter
Name Description callback
GetReplicationStatesCallback
Returns
getRows(options)
getRows ( options ?: GetRowsOptions ) : Promise<GetRowsResponse> ;
Parameter
Returns
Type Description Promise <GetRowsResponse >
getRows(options, callback)
getRows ( options : GetRowsOptions , callback : GetRowsCallback ) : void ;
Parameters
Returns
getRows(callback)
getRows ( callback : GetRowsCallback ) : void ;
Parameter
Name Description callback
GetRowsCallback
Returns
insert(entries, gaxOptions)
insert ( entries : Entry | Entry [], gaxOptions ?: CallOptions ) : Promise<InsertRowsResponse> ;
Parameters
Name Description entries
Entry | Entry []
gaxOptions
CallOptions
Returns
Type Description Promise <InsertRowsResponse >
insert(entries, gaxOptions, callback)
insert ( entries : Entry | Entry [], gaxOptions : CallOptions , callback : InsertRowsCallback ) : void ;
Parameters
Name Description entries
Entry | Entry []
gaxOptions
CallOptions
callback
InsertRowsCallback
Returns
insert(entries, callback)
insert ( entries : Entry | Entry [], callback : InsertRowsCallback ) : void ;
Parameters
Name Description entries
Entry | Entry []
callback
InsertRowsCallback
Returns
mutate(entries, options)
mutate ( entries : Entry | Entry [], options ?: MutateOptions ) : Promise<MutateResponse> ;
Parameters
Returns
Type Description Promise <MutateResponse >
mutate(entries, options, callback)
mutate ( entries : Entry | Entry [], options : MutateOptions , callback : MutateCallback ) : void ;
Parameters
Name Description entries
Entry | Entry []
options
MutateOptions
callback
MutateCallback
Returns
mutate(entries, callback)
mutate ( entries : Entry | Entry [], callback : MutateCallback ) : void ;
Parameters
Name Description entries
Entry | Entry []
callback
MutateCallback
Returns
row(key)
Get a reference to a table row.
Parameter
Name Description key
string
The row key.
Returns
sampleRowKeys(gaxOptions)
sampleRowKeys ( gaxOptions ?: CallOptions ) : Promise<SampleRowsKeysResponse> ;
Parameter
Name Description gaxOptions
CallOptions
Returns
Type Description Promise <SampleRowsKeysResponse >
sampleRowKeys(gaxOptions, callback)
sampleRowKeys ( gaxOptions : CallOptions , callback : SampleRowKeysCallback ) : void ;
Parameters
Name Description gaxOptions
CallOptions
callback
SampleRowKeysCallback
Returns
sampleRowKeys(callback)
sampleRowKeys ( callback ?: SampleRowKeysCallback ) : void ;
Parameter
Name Description callback
SampleRowKeysCallback
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}
setIamPolicy(policy, gaxOptions)
setIamPolicy ( policy : Policy , gaxOptions ?: CallOptions ) : Promise<SetIamPolicyResponse> ;
Parameters
Name Description policy
Policy
gaxOptions
CallOptions
Returns
Type Description Promise <SetIamPolicyResponse >
setIamPolicy(policy, callback)
setIamPolicy ( policy : Policy , callback : SetIamPolicyCallback ) : void ;
Parameters
Name Description policy
Policy
callback
SetIamPolicyCallback
Returns
setIamPolicy(policy, gaxOptions, callback)
setIamPolicy ( policy : Policy , gaxOptions : CallOptions , callback : SetIamPolicyCallback ) : void ;
Parameters
Name Description policy
Policy
gaxOptions
CallOptions
callback
SetIamPolicyCallback
Returns
testIamPermissions(permissions, gaxOptions)
testIamPermissions ( permissions : string | string [], gaxOptions ?: CallOptions ) : Promise<TestIamPermissionsResponse> ;
Parameters
Name Description permissions
string | string[]
gaxOptions
CallOptions
Returns
Type Description Promise <TestIamPermissionsResponse >
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
Type Description Promise <TruncateResponse >
truncate(gaxOptions, callback)
truncate ( gaxOptions : CallOptions , callback : TruncateCallback ) : void ;
Parameters
Name Description gaxOptions
CallOptions
callback
TruncateCallback
Returns
truncate(callback)
truncate ( callback : TruncateCallback ) : void ;
Parameter
Name Description callback
TruncateCallback
Returns
waitForReplication()
waitForReplication () : Promise<WaitForReplicationResponse> ;
Returns
Type Description Promise <WaitForReplicationResponse >
waitForReplication(callback)
waitForReplication ( callback : WaitForReplicationCallback ) : void ;
Parameter
Name Description callback
WaitForReplicationCallback
Returns
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-02-06 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-02-06 UTC."],[],[]]