The Instance class represents a [Cloud Spanner instance]( https://cloud.google.com/spanner/docs/instances ).
Create an Instance
object to interact with a Cloud Spanner instance.
Inheritance
common .GrpcServiceObject > InstancePackage
@google-cloud/spanner!Constructors
(constructor)(spanner, name)
constructor
(
spanner
:
Spanner
,
name
:
string
);
Constructs a new instance of the Instance
class
| Type | Name | Description |
|---|---|---|
|
Spanner
|
spanner | |
|
string
|
name |
Properties
databases_
databases_
:
Map<string
,
Database
> ;
| Type | Description |
|---|---|
| Map <string, Database > |
formattedName_
formattedName_
:
string
;
| Type | Description |
|---|---|
| string |
metadata
metadata
?:
IInstance
;
| Type | Description |
|---|---|
| IInstance |
request
request
:
InstanceRequest
;
| Type | Description |
|---|---|
| InstanceRequest |
requestStream
requestStream
:
(
config
:
RequestConfig
)
=
>
Duplex
;
| Type | Description |
|---|---|
| (config: RequestConfig ) => internal.Duplex |
resourceHeader_
resourceHeader_
:
{
[
k
:
string
]
:
string
;
};
| Type | Description |
|---|---|
| { [k: string]: string; } |
Methods
backup(backupId)
backup
(
backupId
:
string
)
:
Backup
;
Get a reference to a Backup object.
| Type | Name | Description |
|---|---|---|
|
string
|
backupId | The name of the backup. {Backup} A Backup object. |
| Type | Description |
|---|---|
| Backup |
createDatabase(name, options)
createDatabase
(
name
:
string
,
options
?:
CreateDatabaseOptions
)
:
Promise<CreateDatabaseResponse>
;
| Type | Name | Description |
|---|---|---|
|
string
|
name | |
|
CreateDatabaseOptions
|
options |
| Type | Description |
|---|---|
| Promise < CreateDatabaseResponse > |
createDatabase(name, callback)
createDatabase
(
name
:
string
,
callback
:
CreateDatabaseCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
string
|
name | |
|
CreateDatabaseCallback
|
callback |
| Type | Description |
|---|---|
| void |
createDatabase(name, options, callback)
createDatabase
(
name
:
string
,
options
:
CreateDatabaseOptions
,
callback
:
CreateDatabaseCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
string
|
name | |
|
CreateDatabaseOptions
|
options | |
|
CreateDatabaseCallback
|
callback |
| Type | Description |
|---|---|
| void |
database(name, poolOptions, queryOptions)
database
(
name
:
string
,
poolOptions
?:
SessionPoolOptions
|
SessionPoolConstructor
,
queryOptions
?:
spannerClient
.
spanner
.
v1
.
ExecuteSqlRequest
.
IQueryOptions
)
:
Database
;
Get a reference to a Database object.
| Type | Name | Description |
|---|---|---|
|
string
|
name | The name of the instance. |
|
SessionPoolOptions
| SessionPoolConstructor
|
poolOptions | Session pool configuration options. |
|
IQueryOptions
|
queryOptions | Default query options to use with the database. These options will be overridden by any query options set in environment variables or that are specified on a per-query basis. {Database} A Database object. |
| Type | Description |
|---|---|
| Database |
delete(gaxOptions)
delete
(
gaxOptions
?:
CallOptions
)
:
Promise<DeleteInstanceResponse>
;
| Type | Name | Description |
|---|---|---|
|
CallOptions
|
gaxOptions |
| Type | Description |
|---|---|
| Promise < DeleteInstanceResponse > |
delete(callback)
delete
(
callback
:
DeleteInstanceCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
DeleteInstanceCallback
|
callback |
| Type | Description |
|---|---|
| void |
delete(gaxOptions, callback)
delete
(
gaxOptions
:
CallOptions
,
callback
:
DeleteInstanceCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
CallOptions
|
gaxOptions | |
|
DeleteInstanceCallback
|
callback |
| Type | Description |
|---|---|
| void |
exists(gaxOptions)
exists
(
gaxOptions
?:
CallOptions
)
:
Promise<ExistsInstanceResponse>
;
| Type | Name | Description |
|---|---|---|
|
CallOptions
|
gaxOptions |
| Type | Description |
|---|---|
| Promise < ExistsInstanceResponse > |
exists(callback)
exists
(
callback
:
ExistsInstanceCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
ExistsInstanceCallback
|
callback |
| Type | Description |
|---|---|
| void |
exists(gaxOptions, callback)
exists
(
gaxOptions
:
CallOptions
,
callback
:
ExistsInstanceCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
CallOptions
|
gaxOptions | |
|
ExistsInstanceCallback
|
callback |
| Type | Description |
|---|---|
| void |
formatName_(projectId, name)
static
formatName_
(
projectId
:
string
,
name
:
string
)
:
string
;
Format the instance name to include the project ID.
| Type | Name | Description |
|---|---|---|
|
string
|
projectId | The project ID. |
|
string
|
name | The instance name. |
| Type | Description |
|---|---|
| string | {string} |
get(options)
get
(
options
?:
GetInstanceConfig
)
:
Promise<GetInstanceResponse>
;
| Type | Name | Description |
|---|---|---|
|
GetInstanceConfig
|
options |
| Type | Description |
|---|---|
| Promise < GetInstanceResponse > |
get(callback)
get
(
callback
:
GetInstanceCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetInstanceCallback
|
callback |
| Type | Description |
|---|---|
| void |
get(options, callback)
get
(
options
:
GetInstanceConfig
,
callback
:
GetInstanceCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetInstanceConfig
|
options | |
|
GetInstanceCallback
|
callback |
| Type | Description |
|---|---|
| void |
getBackupOperations(options)
getBackupOperations
(
options
?:
GetBackupOperationsOptions
)
:
Promise<GetBackupOperationsResponse>
;
| Type | Name | Description |
|---|---|---|
|
GetBackupOperationsOptions
|
options |
| Type | Description |
|---|---|
| Promise < GetBackupOperationsResponse > |
getBackupOperations(callback)
getBackupOperations
(
callback
:
GetBackupOperationsCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetBackupOperationsCallback
|
callback |
| Type | Description |
|---|---|
| void |
getBackupOperations(options, callback)
getBackupOperations
(
options
:
GetBackupOperationsOptions
,
callback
:
GetBackupOperationsCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetBackupOperationsOptions
|
options | |
|
GetBackupOperationsCallback
|
callback |
| Type | Description |
|---|---|
| void |
getBackups(options)
getBackups
(
options
?:
GetBackupsOptions
)
:
Promise<GetBackupsResponse>
;
| Type | Name | Description |
|---|---|---|
|
GetBackupsOptions
|
options |
| Type | Description |
|---|---|
| Promise < GetBackupsResponse > |
getBackups(callback)
getBackups
(
callback
:
GetBackupsCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetBackupsCallback
|
callback |
| Type | Description |
|---|---|
| void |
getBackups(options, callback)
getBackups
(
options
:
GetBackupsOptions
,
callback
:
GetBackupsCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetBackupsOptions
|
options | |
|
GetBackupsCallback
|
callback |
| Type | Description |
|---|---|
| void |
getBackupsStream(options)
getBackupsStream
(
options
?:
GetBackupsOptions
)
:
NodeJS
.
ReadableStream
;
Get a list of backups as a readable object stream.
Wrapper around .
[ListBackups API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.DatabaseAdmin.ListBackups)
Spanner#getBackupsStream
| Type | Name | Description |
|---|---|---|
|
GetBackupsOptions
|
options | Query object for listing backups. |
| Type | Description |
|---|---|
| NodeJS.ReadableStream | {ReadableStream} A readable stream that emits Backup instances. |
getDatabaseOperations(options)
getDatabaseOperations
(
options
?:
GetDatabaseOperationsOptions
)
:
Promise<GetDatabaseOperationsResponse>
;
| Type | Name | Description |
|---|---|---|
|
GetDatabaseOperationsOptions
|
options |
| Type | Description |
|---|---|
| Promise < GetDatabaseOperationsResponse > |
getDatabaseOperations(callback)
getDatabaseOperations
(
callback
:
GetDatabaseOperationsCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetDatabaseOperationsCallback
|
callback |
| Type | Description |
|---|---|
| void |
getDatabaseOperations(options, callback)
getDatabaseOperations
(
options
:
GetDatabaseOperationsOptions
,
callback
:
GetDatabaseOperationsCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetDatabaseOperationsOptions
|
options | |
|
GetDatabaseOperationsCallback
|
callback |
| Type | Description |
|---|---|
| void |
getDatabases(options)
getDatabases
(
options
?:
GetDatabasesOptions
)
:
Promise<GetDatabasesResponse>
;
| Type | Name | Description |
|---|---|---|
|
GetDatabasesOptions
|
options |
| Type | Description |
|---|---|
| Promise < GetDatabasesResponse > |
getDatabases(callback)
getDatabases
(
callback
:
GetDatabasesCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetDatabasesCallback
|
callback |
| Type | Description |
|---|---|
| void |
getDatabases(options, callback)
getDatabases
(
options
:
GetDatabasesOptions
,
callback
:
GetDatabasesCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetDatabasesOptions
|
options | |
|
GetDatabasesCallback
|
callback |
| Type | Description |
|---|---|
| void |
getDatabasesStream(options)
getDatabasesStream
(
options
?:
GetDatabasesOptions
)
:
NodeJS
.
ReadableStream
;
Get a list of databases as a readable object stream.
Wrapper around .
[ListDatabases API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases)
Spanner#getDatabasesStream
| Type | Name | Description |
|---|---|---|
|
GetDatabasesOptions
|
options | Query object for listing databases. |
| Type | Description |
|---|---|
| NodeJS.ReadableStream | {ReadableStream} A readable stream that emits Database instances. |
getMetadata(options)
getMetadata
(
options
?:
GetInstanceMetadataOptions
)
:
Promise<GetInstanceMetadataResponse>
;
| Type | Name | Description |
|---|---|---|
|
GetInstanceMetadataOptions
|
options |
| Type | Description |
|---|---|
| Promise < GetInstanceMetadataResponse > |
getMetadata(callback)
getMetadata
(
callback
:
GetInstanceMetadataCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetInstanceMetadataCallback
|
callback |
| Type | Description |
|---|---|
| void |
getMetadata(options, callback)
getMetadata
(
options
:
GetInstanceMetadataOptions
,
callback
:
GetInstanceMetadataCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
GetInstanceMetadataOptions
|
options | |
|
GetInstanceMetadataCallback
|
callback |
| Type | Description |
|---|---|
| void |
setMetadata(metadata, gaxOptions)
setMetadata
(
metadata
:
IInstance
,
gaxOptions
?:
CallOptions
)
:
Promise<SetInstanceMetadataResponse>
;
| Type | Name | Description |
|---|---|---|
|
IInstance
|
metadata | |
|
CallOptions
|
gaxOptions |
| Type | Description |
|---|---|
| Promise < SetInstanceMetadataResponse > |
setMetadata(metadata, callback)
setMetadata
(
metadata
:
IInstance
,
callback
:
SetInstanceMetadataCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
IInstance
|
metadata | |
|
SetInstanceMetadataCallback
|
callback |
| Type | Description |
|---|---|
| void |
setMetadata(metadata, gaxOptions, callback)
setMetadata
(
metadata
:
IInstance
,
gaxOptions
:
CallOptions
,
callback
:
SetInstanceMetadataCallback
)
:
void
;
| Type | Name | Description |
|---|---|---|
|
IInstance
|
metadata | |
|
CallOptions
|
gaxOptions | |
|
SetInstanceMetadataCallback
|
callback |
| Type | Description |
|---|---|
| void |
