Class Instance

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 > Instance

Package

@google-cloud/spanner!

Constructors

(constructor)(spanner, name)

constructor(spanner: Spanner, name: string);

Constructs a new instance of the Instance class

Parameters

Type	Name	Description
Spanner	spanner
string	name

Properties

databases_

databases_: Map<string, Database>;

Property Value

Type	Description
Map<string, Database>

formattedName_

formattedName_: string;

Property Value

Type	Description
string

metadata

metadata?: IInstance;

Property Value

Type	Description
IInstance

request

request: InstanceRequest;

Property Value

Type	Description
InstanceRequest

requestStream

requestStream: (config: RequestConfig) => Duplex;

Property Value

Type	Description
(config: RequestConfig) => internal.Duplex

resourceHeader_

resourceHeader_: {
        [k: string]: string;
    };

Property Value

Type	Description
{ [k: string]: string; }

Methods

backup(backupId)

backup(backupId: string): Backup;

Get a reference to a Backup object.

Parameter

Type	Name	Description
string	backupId	The name of the backup. {Backup} A Backup object.

Returns

Type	Description
Backup

createDatabase(name, options)

createDatabase(name: string, options?: CreateDatabaseOptions): Promise<CreateDatabaseResponse>;

Parameters

Type	Name	Description
string	name
CreateDatabaseOptions	options

Returns

Type	Description
Promise<CreateDatabaseResponse>

createDatabase(name, callback)

createDatabase(name: string, callback: CreateDatabaseCallback): void;

Parameters

Type	Name	Description
string	name
CreateDatabaseCallback	callback

Returns

Type	Description
void

createDatabase(name, options, callback)

createDatabase(name: string, options: CreateDatabaseOptions, callback: CreateDatabaseCallback): void;

Parameters

Type	Name	Description
string	name
CreateDatabaseOptions	options
CreateDatabaseCallback	callback

Returns

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.

Parameters

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.

Returns

Type	Description
Database

delete(gaxOptions)

delete(gaxOptions?: CallOptions): Promise<DeleteInstanceResponse>;

Parameter

Type	Name	Description
CallOptions	gaxOptions

Returns

Type	Description
Promise<DeleteInstanceResponse>

delete(callback)

delete(callback: DeleteInstanceCallback): void;

Parameter

Type	Name	Description
DeleteInstanceCallback	callback

Returns

Type	Description
void

delete(gaxOptions, callback)

delete(gaxOptions: CallOptions, callback: DeleteInstanceCallback): void;

Parameters

Type	Name	Description
CallOptions	gaxOptions
DeleteInstanceCallback	callback

Returns

Type	Description
void

exists(gaxOptions)

exists(gaxOptions?: CallOptions): Promise<ExistsInstanceResponse>;

Parameter

Type	Name	Description
CallOptions	gaxOptions

Returns

Type	Description
Promise<ExistsInstanceResponse>

exists(callback)

exists(callback: ExistsInstanceCallback): void;

Parameter

Type	Name	Description
ExistsInstanceCallback	callback

Returns

Type	Description
void

exists(gaxOptions, callback)

exists(gaxOptions: CallOptions, callback: ExistsInstanceCallback): void;

Parameters

Type	Name	Description
CallOptions	gaxOptions
ExistsInstanceCallback	callback

Returns

Type	Description
void

formatName_(projectId, name)

static formatName_(projectId: string, name: string): string;

Format the instance name to include the project ID.

Parameters

Type	Name	Description
string	projectId	The project ID.
string	name	The instance name.

Returns

Type	Description
string	{string}

get(options)

get(options?: GetInstanceConfig): Promise<GetInstanceResponse>;

Parameter

Type	Name	Description
GetInstanceConfig	options

Returns

Type	Description
Promise<GetInstanceResponse>

get(callback)

get(callback: GetInstanceCallback): void;

Parameter

Type	Name	Description
GetInstanceCallback	callback

Returns

Type	Description
void

get(options, callback)

get(options: GetInstanceConfig, callback: GetInstanceCallback): void;

Parameters

Type	Name	Description
GetInstanceConfig	options
GetInstanceCallback	callback

Returns

Type	Description
void

getBackupOperations(options)

getBackupOperations(options?: GetBackupOperationsOptions): Promise<GetBackupOperationsResponse>;

Parameter

Type	Name	Description
GetBackupOperationsOptions	options

Returns

Type	Description
Promise<GetBackupOperationsResponse>

getBackupOperations(callback)

getBackupOperations(callback: GetBackupOperationsCallback): void;

Parameter

Type	Name	Description
GetBackupOperationsCallback	callback

Returns

Type	Description
void

getBackupOperations(options, callback)

getBackupOperations(options: GetBackupOperationsOptions, callback: GetBackupOperationsCallback): void;

Parameters

Type	Name	Description
GetBackupOperationsOptions	options
GetBackupOperationsCallback	callback

Returns

Type	Description
void

getBackups(options)

getBackups(options?: GetBackupsOptions): Promise<GetBackupsResponse>;

Parameter

Type	Name	Description
GetBackupsOptions	options

Returns

Type	Description
Promise<GetBackupsResponse>

getBackups(callback)

getBackups(callback: GetBackupsCallback): void;

Parameter

Type	Name	Description
GetBackupsCallback	callback

Returns

Type	Description
void

getBackups(options, callback)

getBackups(options: GetBackupsOptions, callback: GetBackupsCallback): void;

Parameters

Type	Name	Description
GetBackupsOptions	options
GetBackupsCallback	callback

Returns

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

Parameter

Type	Name	Description
GetBackupsOptions	options	Query object for listing backups.

Returns

Type	Description
NodeJS.ReadableStream	{ReadableStream} A readable stream that emits Backup instances.

getDatabaseOperations(options)

getDatabaseOperations(options?: GetDatabaseOperationsOptions): Promise<GetDatabaseOperationsResponse>;

Parameter

Type	Name	Description
GetDatabaseOperationsOptions	options

Returns

Type	Description
Promise<GetDatabaseOperationsResponse>

getDatabaseOperations(callback)

getDatabaseOperations(callback: GetDatabaseOperationsCallback): void;

Parameter

Type	Name	Description
GetDatabaseOperationsCallback	callback

Returns

Type	Description
void

getDatabaseOperations(options, callback)

getDatabaseOperations(options: GetDatabaseOperationsOptions, callback: GetDatabaseOperationsCallback): void;

Parameters

Type	Name	Description
GetDatabaseOperationsOptions	options
GetDatabaseOperationsCallback	callback

Returns

Type	Description
void

getDatabases(options)

getDatabases(options?: GetDatabasesOptions): Promise<GetDatabasesResponse>;

Parameter

Type	Name	Description
GetDatabasesOptions	options

Returns

Type	Description
Promise<GetDatabasesResponse>

getDatabases(callback)

getDatabases(callback: GetDatabasesCallback): void;

Parameter

Type	Name	Description
GetDatabasesCallback	callback

Returns

Type	Description
void

getDatabases(options, callback)

getDatabases(options: GetDatabasesOptions, callback: GetDatabasesCallback): void;

Parameters

Type	Name	Description
GetDatabasesOptions	options
GetDatabasesCallback	callback

Returns

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

Parameter

Type	Name	Description
GetDatabasesOptions	options	Query object for listing databases.

Returns

Type	Description
NodeJS.ReadableStream	{ReadableStream} A readable stream that emits Database instances.

getMetadata(options)

getMetadata(options?: GetInstanceMetadataOptions): Promise<GetInstanceMetadataResponse>;

Parameter

Type	Name	Description
GetInstanceMetadataOptions	options

Returns

Type	Description
Promise<GetInstanceMetadataResponse>

getMetadata(callback)

getMetadata(callback: GetInstanceMetadataCallback): void;

Parameter

Type	Name	Description
GetInstanceMetadataCallback	callback

Returns

Type	Description
void

getMetadata(options, callback)

getMetadata(options: GetInstanceMetadataOptions, callback: GetInstanceMetadataCallback): void;

Parameters

Type	Name	Description
GetInstanceMetadataOptions	options
GetInstanceMetadataCallback	callback

Returns

Type	Description
void

setMetadata(metadata, gaxOptions)

setMetadata(metadata: IInstance, gaxOptions?: CallOptions): Promise<SetInstanceMetadataResponse>;

Parameters

Type	Name	Description
IInstance	metadata
CallOptions	gaxOptions

Returns

Type	Description
Promise<SetInstanceMetadataResponse>

setMetadata(metadata, callback)

setMetadata(metadata: IInstance, callback: SetInstanceMetadataCallback): void;

Parameters

Type	Name	Description
IInstance	metadata
SetInstanceMetadataCallback	callback

Returns

Type	Description
void

setMetadata(metadata, gaxOptions, callback)

setMetadata(metadata: IInstance, gaxOptions: CallOptions, callback: SetInstanceMetadataCallback): void;

Parameters

Type	Name	Description
IInstance	metadata
CallOptions	gaxOptions
SetInstanceMetadataCallback	callback

Returns

Type	Description
void