Send feedback
Class Instance (3.10.0) Stay organized with collections
Save and categorize content based on your preferences.
Version 3.10.0 keyboard_arrow_down
Create an Instance object to interact with a Cloud Bigtable instance.
Package
@google-cloud/bigtable
Example
const
{
Bigtable
}
=
require
(
' @google-cloud/bigtable
'
);
const
bigtable
=
new
Bigtable
();
const
instance
=
bigtable
.
instance
(
'my-instance'
);
Constructors
(constructor)(bigtable, id)
constructor
(
bigtable
:
Bigtable
,
id
:
string
);
Constructs a new instance of the Instance
class
Parameters
Properties
bigtable
id
metadata
?:
google
.
bigtable
.
admin
.
v2
.
IInstance
;
name
Methods
appProfile(name)
appProfile
(
name
:
string
)
:
AppProfile
;
Get a reference to a Bigtable App Profile.
Parameter Name
Description
name
string
The name of the app profile.
Returns
cluster(id)
cluster
(
id
:
string
)
:
Cluster
;
Get a reference to a Bigtable Cluster.
Parameter Name
Description
id
string
The id of the cluster.
Returns
create(options)
create
(
options
:
InstanceOptions
)
:
Promise<CreateInstanceResponse>
;
Parameter
Returns
create(options, callback)
create
(
options
:
InstanceOptions
,
callback
:
CreateInstanceCallback
)
:
void
;
Parameters
Returns
createAppProfile(id, options)
createAppProfile
(
id
:
string
,
options
?:
AppProfileOptions
)
:
Promise<CreateAppProfileResponse>
;
Parameters
Returns
createAppProfile(id, options, callback)
createAppProfile
(
id
:
string
,
options
:
AppProfileOptions
,
callback
:
CreateAppProfileCallback
)
:
void
;
Parameters
Returns
createAppProfile(id, callback)
createAppProfile
(
id
:
string
,
callback
:
CreateAppProfileCallback
)
:
void
;
Parameters
Returns
createCluster(id, options)
createCluster
(
id
:
string
,
options
?:
CreateClusterOptions
)
:
Promise<CreateClusterResponse>
;
Parameters
Returns
createCluster(id, options, callback)
createCluster
(
id
:
string
,
options
:
CreateClusterOptions
,
callback
:
CreateClusterCallback
)
:
void
;
Parameters
Returns
createCluster(id, callback)
createCluster
(
id
:
string
,
callback
:
CreateClusterCallback
)
:
void
;
Parameters
Returns
createTable(id, options)
createTable
(
id
:
string
,
options
?:
CreateTableOptions
)
:
Promise<CreateTableResponse>
;
Parameters
Returns
createTable(id, options, callback)
createTable
(
id
:
string
,
options
:
CreateTableOptions
,
callback
:
CreateTableCallback
)
:
void
;
Parameters
Returns
createTable(id, callback)
createTable
(
id
:
string
,
callback
:
CreateTableCallback
)
:
void
;
Parameters
Returns
createTableFromBackup(config)
createTableFromBackup
(
config
:
CreateTableFromBackupConfig
)
:
Promise<RestoreTableResponse>
;
Parameter Name
Description
config
CreateTableFromBackupConfig
Returns
createTableFromBackup(config, callback)
createTableFromBackup
(
config
:
CreateTableFromBackupConfig
,
callback
:
RestoreTableCallback
)
:
void
;
Parameters
Returns
delete(gaxOptions)
delete
(
gaxOptions
?:
CallOptions
)
:
Promise<DeleteInstanceResponse>
;
Parameter
Returns
delete(gaxOptions, callback)
delete
(
gaxOptions
:
CallOptions
,
callback
:
DeleteInstanceCallback
)
:
void
;
Parameters
Returns
delete(callback)
delete
(
callback
:
DeleteInstanceCallback
)
:
void
;
Parameter
Returns
exists(options)
exists
(
options
?:
CallOptions
)
:
Promise<InstanceExistsResponse>
;
Parameter
Returns
exists(options, callback)
exists
(
options
:
CallOptions
,
callback
:
InstanceExistsCallback
)
:
void
;
Parameters
Returns
exists(callback)
exists
(
callback
:
InstanceExistsCallback
)
:
void
;
Parameter
Returns
get(gaxOptions)
get
(
gaxOptions
?:
CallOptions
)
:
Promise<GetInstanceResponse>
;
Parameter
Returns
get(gaxOptions, callback)
get
(
gaxOptions
:
CallOptions
,
callback
:
GetInstanceCallback
)
:
void
;
Parameters
Returns
get(callback)
get
(
callback
:
GetInstanceCallback
)
:
void
;
Parameter
Returns
getAppProfiles(options)
getAppProfiles
(
options
?:
CallOptions
)
:
Promise<GetAppProfilesResponse>
;
Parameter
Returns
getAppProfiles(options, callback)
getAppProfiles
(
options
:
CallOptions
,
callback
:
GetAppProfilesCallback
)
:
void
;
Parameters
Returns
getAppProfiles(callback)
getAppProfiles
(
callback
:
GetAppProfilesCallback
)
:
void
;
Parameter
Returns
getAppProfilesStream(gaxOptions)
getAppProfilesStream
(
gaxOptions
?:
CallOptions
)
:
NodeJS
.
ReadableStream
;
Get AppProfile
objects for all the App Profiles in your Cloud Bigtable instance as a readable object stream.
Parameter
Returns
Example const
{
Bigtable
}
=
require
(
' @google-cloud/bigtable
'
);
const
bigtable
=
new
Bigtable
();
const
instance
=
bigtable
.
instance
(
'my-instance'
);
instance
.
getAppProfilesStream
()
.
on
(
'error'
,
console
.
error
)
.
on
(
'data'
,
function
(
appProfile
)
{
// appProfile is a AppProfile object.
})
.
on
(
'end'
,
()
=
>
{
// All appProfiles retrieved.
});
//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
instance
.
getAppProfilesStream
()
.
on
(
'data'
,
function
(
appProfile
)
{
this
.
end
();
});
getBackups(options)
getBackups
(
options
?:
GetBackupsOptions
)
:
Promise<GetBackupsResponse>
;
Parameter
Returns
getBackups(options, callback)
getBackups
(
options
:
GetBackupsOptions
,
callback
:
GetBackupsCallback
)
:
void
;
Parameters
Returns
getBackups(callback)
getBackups
(
callback
:
GetBackupsCallback
)
:
void
;
Parameter
Returns
getBackupsStream(options)
getBackupsStream
(
options
?:
GetBackupsOptions
)
:
NodeJS
.
ReadableStream
;
Get Cloud Bigtable Backup instances within this instance. This returns both completed and pending backups as a readable stream.
Parameter Name
Description
options
GetBackupsOptions
Configuration object. See for a complete list of options.
Returns
Example const
{
Bigtable
}
=
require
(
' @google-cloud/bigtable
'
);
const
bigtable
=
new
Bigtable
();
const
instance
=
bigtable
.
instance
(
'my-instance'
);
instance
.
getBackupsStream
()
.
on
(
'error'
,
console
.
error
)
.
on
(
'data'
,
function
(
backup
)
{
// backup is a Backup object.
})
.
on
(
'end'
,
()
=
>
{
// All backups retrieved.
});
//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
instance
.
getBackupsStream
()
.
on
(
'data'
,
function
(
backup
)
{
this
.
end
();
});
getClusters(options)
getClusters
(
options
?:
CallOptions
)
:
Promise<GetClustersResponse>
;
Parameter
Returns
getClusters(options, callback)
getClusters
(
options
:
CallOptions
,
callback
:
GetClustersCallback
)
:
void
;
Parameters
Returns
getClusters(callback)
getClusters
(
callback
:
GetClustersCallback
)
:
void
;
Parameter
Returns
getIamPolicy(options)
getIamPolicy
(
options
?:
GetIamPolicyOptions
)
:
Promise
< [
Policy
]>;
Parameter
Returns
getIamPolicy(options, callback)
getIamPolicy
(
options
:
GetIamPolicyOptions
,
callback
:
GetIamPolicyCallback
)
:
void
;
Parameters
Returns
getMetadata
(
options
?:
CallOptions
)
:
Promise<GetInstanceMetadataResponse>
;
Parameter
Returns
getMetadata
(
options
:
CallOptions
,
callback
:
GetInstanceMetadataCallback
)
:
void
;
Parameters
Returns
getMetadata
(
callback
:
GetInstanceMetadataCallback
)
:
void
;
Parameter
Returns
getTables(options)
getTables
(
options
?:
GetTablesOptions
)
:
Promise<GetTablesResponse>
;
Parameter
Returns
getTables(options, callback)
getTables
(
options
:
GetTablesOptions
,
callback
:
GetTablesCallback
)
:
void
;
Parameters
Returns
getTables(callback)
getTables
(
callback
:
GetTablesCallback
)
:
void
;
Parameter
Returns
getTablesStream(options)
getTablesStream
(
options
?:
GetTablesOptions
)
:
NodeJS
.
ReadableStream
;
Get Table
objects for all the tables in your Cloud Bigtable instance as a readable object stream.
Parameter Name
Description
options
GetTablesOptions
Query object. See for a complete list of options.
Returns
Example const
{
Bigtable
}
=
require
(
' @google-cloud/bigtable
'
);
const
bigtable
=
new
Bigtable
();
const
instance
=
bigtable
.
instance
(
'my-instance'
);
instance
.
getTablesStream
()
.
on
(
'error'
,
console
.
error
)
.
on
(
'data'
,
function
(
table
)
{
// table is a Table object.
})
.
on
(
'end'
,
()
=
>
{
// All tables retrieved.
});
//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
instance
.
getTablesStream
()
.
on
(
'data'
,
function
(
table
)
{
this
.
end
();
});
getTypeType_(type)
static
getTypeType_
(
type
?:
string
)
:
number
;
Maps the instance type to the proper integer.
Parameter Name
Description
type
string
The instance type (production, development).
Returns
Example Instance
.
getTypeType_
(
'production'
);
// 1
setIamPolicy(policy, gaxOptions)
setIamPolicy
(
policy
:
Policy
,
gaxOptions
?:
CallOptions
)
:
Promise<SetIamPolicyResponse>
;
Parameters
Returns
setIamPolicy(policy, gaxOptions, callback)
setIamPolicy
(
policy
:
Policy
,
gaxOptions
:
CallOptions
,
callback
:
SetIamPolicyCallback
)
:
void
;
Parameters
Returns
setIamPolicy(policy, callback)
setIamPolicy
(
policy
:
Policy
,
callback
:
SetIamPolicyCallback
)
:
void
;
Parameters
Returns
setMetadata
(
metadata
:
IInstance
,
options
?:
CallOptions
)
:
Promise<SetInstanceMetadataResponse>
;
Parameters
Returns
setMetadata
(
metadata
:
IInstance
,
options
:
CallOptions
,
callback
:
SetInstanceMetadataCallback
)
:
void
;
Parameters
Returns
setMetadata
(
metadata
:
IInstance
,
callback
:
SetInstanceMetadataCallback
)
:
void
;
Parameters
Returns
table(id)
table
(
id
:
string
)
:
Table
;
Get a reference to a Bigtable table.
Parameter Name
Description
id
string
Unique identifier of the table.
Returns
Example const
{
Bigtable
}
=
require
(
' @google-cloud/bigtable
'
);
const
bigtable
=
new
Bigtable
();
const
instance
=
bigtable
.
instance
(
'my-instance'
);
const
table
=
instance
.
table
(
'presidents'
);
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
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-09-04 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-09-04 UTC."],[],[],null,[]]