Send feedback
Class Database Stay organized with collections
Save and categorize content based on your preferences.
Version 5.13.1 keyboard_arrow_down
Create a Database object to interact with a Cloud Spanner database.
Inheritance
common
.GrpcServiceObject
>
Database
Package
@google-cloud/spanner!
Constructors
(constructor)(instance, name, poolOptions, queryOptions)
constructor
(
instance
:
Instance
,
name
:
string
,
poolOptions
?:
SessionPoolConstructor
|
SessionPoolOptions
,
queryOptions
?:
spannerClient
.
spanner
.
v1
.
ExecuteSqlRequest
.
IQueryOptions
);
Constructs a new instance of the Database
class
Parameters
Properties
formattedName_
:
string
;
Property Value
pool_
pool_
:
SessionPoolInterface
;
Property Value
queryOptions_
queryOptions_
?:
spannerClient
.
spanner
.
v1
.
ExecuteSqlRequest
.
IQueryOptions
;
Property Value
request
request
:
DatabaseRequest
;
Property Value
resourceHeader_
:
{
[
k
:
string
]
:
string
;
};
Property Value
Methods
_runPartitionedUpdate(session, query, callback)
_runPartitionedUpdate
(
session
:
Session
,
query
:
string
|
ExecuteSqlRequest
,
callback
?:
RunUpdateCallback
)
:
void
|
Promise<number>
;
Parameters
Returns
batchCreateSessions(options)
batchCreateSessions
(
options
:
number
|
BatchCreateSessionsOptions
)
:
Promise<BatchCreateSessionsResponse>
;
Parameter
Returns
batchCreateSessions(options, callback)
batchCreateSessions
(
options
:
number
|
BatchCreateSessionsOptions
,
callback
:
BatchCreateSessionsCallback
)
:
void
;
Parameters
Returns
batchTransaction(identifier, options)
batchTransaction
(
identifier
:
TransactionIdentifier
,
options
?:
TimestampBounds
)
:
BatchTransaction
;
Get a reference to a object.
to generate an identifier.
Parameters
Returns
close(callback)
close
(
callback
:
SessionPoolCloseCallback
)
:
void
;
Parameter
Returns
close()
close
()
:
Promise<DatabaseCloseResponse>
;
Returns
createBatchTransaction(options)
createBatchTransaction
(
options
?:
TimestampBounds
)
:
Promise<CreateBatchTransactionResponse>
;
Parameter
Returns
createBatchTransaction(callback)
createBatchTransaction
(
callback
:
CreateBatchTransactionCallback
)
:
void
;
Parameter
Returns
createBatchTransaction(options, callback)
createBatchTransaction
(
options
:
TimestampBounds
,
callback
:
CreateBatchTransactionCallback
)
:
void
;
Parameters
Returns
createSession(options)
createSession
(
options
:
CreateSessionOptions
)
:
Promise<CreateSessionResponse>
;
Parameter
Returns
createSession(callback)
createSession
(
callback
:
CreateSessionCallback
)
:
void
;
Parameter
Returns
createSession(options, callback)
createSession
(
options
:
CreateSessionOptions
,
callback
:
CreateSessionCallback
)
:
void
;
Parameters
Returns
createTable(schema, gaxOptions)
createTable
(
schema
:
Schema
,
gaxOptions
?:
CallOptions
)
:
Promise<CreateTableResponse>
;
Parameters
Returns
createTable(schema, callback)
createTable
(
schema
:
Schema
,
callback
:
CreateTableCallback
)
:
void
;
Parameters
Returns
createTable(schema, gaxOptions, callback)
createTable
(
schema
:
Schema
,
gaxOptions
:
CallOptions
,
callback
:
CreateTableCallback
)
:
void
;
Parameters
Returns
delete(gaxOptions)
delete
(
gaxOptions
?:
CallOptions
)
:
Promise<DatabaseDeleteResponse>
;
Parameter
Returns
delete(callback)
delete
(
callback
:
DatabaseDeleteCallback
)
:
void
;
Parameter
Returns
delete(gaxOptions, callback)
delete
(
gaxOptions
:
CallOptions
,
callback
:
DatabaseDeleteCallback
)
:
void
;
Parameters
Returns
exists(gaxOptions)
exists
(
gaxOptions
?:
CallOptions
)
:
Promise
< [
boolean
]>;
Parameter
Returns
exists(callback)
exists
(
callback
:
ExistsCallback
)
:
void
;
Parameter
Returns
exists(gaxOptions, callback)
exists
(
gaxOptions
:
CallOptions
,
callback
:
ExistsCallback
)
:
void
;
Parameters
Returns
static
formatName_
(
instanceName
:
string
,
name
:
string
)
:
string
;
Format the database name to include the instance name.
Parameters
Returns
get(options)
get
(
options
?:
GetDatabaseConfig
)
:
Promise<DatabaseResponse>
;
Parameter
Returns
get(callback)
get
(
callback
:
DatabaseCallback
)
:
void
;
Parameter
Returns
get(options, callback)
get
(
options
:
GetDatabaseConfig
,
callback
:
DatabaseCallback
)
:
void
;
Parameters
Returns
getEnvironmentQueryOptions()
static
getEnvironmentQueryOptions
()
:
databaseAdmin
.
spanner
.
v1
.
ExecuteSqlRequest
.
IQueryOptions
;
Returns
getMetadata
(
gaxOptions
?:
CallOptions
)
:
Promise<GetDatabaseMetadataResponse>
;
Parameter
Returns
getMetadata
(
callback
:
GetDatabaseMetadataCallback
)
:
void
;
Parameter
Returns
getMetadata
(
gaxOptions
:
CallOptions
,
callback
:
GetDatabaseMetadataCallback
)
:
void
;
Parameters
Returns
getOperations(options)
getOperations
(
options
?:
GetDatabaseOperationsOptions
)
:
Promise<GetDatabaseOperationsResponse>
;
Parameter
Returns
getOperations(callback)
getOperations
(
callback
:
GetDatabaseOperationsCallback
)
:
void
;
Parameter
Returns
getOperations(options, callback)
getOperations
(
options
:
GetDatabaseOperationsOptions
,
callback
:
GetDatabaseOperationsCallback
)
:
void
;
Parameters
Returns
getRestoreInfo(options)
getRestoreInfo
(
options
?:
CallOptions
)
:
Promise<IRestoreInfoTranslatedEnum
|
undefined
> ;
Parameter
Returns
getRestoreInfo(callback)
getRestoreInfo
(
callback
:
GetRestoreInfoCallback
)
:
void
;
Parameter
Returns
getRestoreInfo(options, callback)
getRestoreInfo
(
options
:
CallOptions
,
callback
:
GetRestoreInfoCallback
)
:
void
;
Parameters
Returns
getSchema(options)
getSchema
(
options
?:
CallOptions
)
:
Promise<GetSchemaResponse>
;
Parameter
Returns
getSchema(callback)
getSchema
(
callback
:
GetSchemaCallback
)
:
void
;
Parameter
Returns
getSchema(options, callback)
getSchema
(
options
:
CallOptions
,
callback
:
GetSchemaCallback
)
:
void
;
Parameters
Returns
getSessions(options)
getSessions
(
options
?:
GetSessionsOptions
)
:
Promise<GetSessionsResponse>
;
Parameter
Returns
getSessions(callback)
getSessions
(
callback
:
GetSessionsCallback
)
:
void
;
Parameter
Returns
getSessions(options, callback)
getSessions
(
options
:
GetSessionsOptions
,
callback
:
GetSessionsCallback
)
:
void
;
Parameters
Returns
getSessionsStream(options)
getSessionsStream
(
options
?:
GetSessionsOptions
)
:
NodeJS
.
ReadableStream
;
Get a list of sessions as a readable object stream.
Wrapper around
[ListSessions API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.Spanner.ListSessions)
Spanner#getSessionsStream
Parameter
Returns
getSnapshot(options)
getSnapshot
(
options
?:
TimestampBounds
)
:
Promise
< [
Snapshot
]>;
Parameter
Returns
getSnapshot(callback)
getSnapshot
(
callback
:
GetSnapshotCallback
)
:
void
;
Parameter
Returns
getSnapshot(options, callback)
getSnapshot
(
options
:
TimestampBounds
,
callback
:
GetSnapshotCallback
)
:
void
;
Parameters
Returns
getState(options)
getState
(
options
?:
CallOptions
)
:
Promise<EnumKey<typeof
databaseAdmin
.
spanner
.
admin
.
database
.
v1
.
Database
.
State
> |
undefined
> ;
Parameter
Returns
getState(callback)
getState
(
callback
:
GetStateCallback
)
:
void
;
Parameter
Returns
getState(options, callback)
getState
(
options
:
CallOptions
,
callback
:
GetStateCallback
)
:
void
;
Parameters
Returns
getTransaction()
getTransaction
()
:
Promise
< [
Transaction
]>;
Returns
getTransaction(callback)
getTransaction
(
callback
:
GetTransactionCallback
)
:
void
;
Parameter
Returns
makePooledRequest_(config)
makePooledRequest_
(
config
:
RequestConfig
)
:
Promise<Session>
;
Parameter
Returns
makePooledRequest_(config, callback)
makePooledRequest_
(
config
:
RequestConfig
,
callback
:
PoolRequestCallback
)
:
void
;
Parameters
Returns
makePooledStreamingRequest_(config)
makePooledStreamingRequest_
(
config
:
RequestConfig
)
:
Readable
;
Make an API request as a stream, first assuring an active session is used.
Parameter
Returns
restore(backupPath)
restore
(
backupPath
:
string
)
:
Promise<RestoreDatabaseResponse>
;
Parameter
Returns
restore(backupPath, options)
restore
(
backupPath
:
string
,
options
?:
RestoreOptions
|
CallOptions
)
:
Promise<RestoreDatabaseResponse>
;
Parameters
Returns
restore(backupPath, callback)
restore
(
backupPath
:
string
,
callback
:
RestoreDatabaseCallback
)
:
void
;
Parameters
Returns
restore(backupPath, options, callback)
restore
(
backupPath
:
string
,
options
:
RestoreOptions
|
CallOptions
,
callback
:
RestoreDatabaseCallback
)
:
void
;
Parameters
Returns
run(query)
run
(
query
:
string
|
ExecuteSqlRequest
)
:
Promise<RunResponse>
;
Parameter
Returns
run(query, options)
run
(
query
:
string
|
ExecuteSqlRequest
,
options
?:
TimestampBounds
)
:
Promise<RunResponse>
;
Parameters
Returns
run(query, callback)
run
(
query
:
string
|
ExecuteSqlRequest
,
callback
:
RunCallback
)
:
void
;
Parameters
Returns
run(query, options, callback)
run
(
query
:
string
|
ExecuteSqlRequest
,
options
:
TimestampBounds
,
callback
:
RunCallback
)
:
void
;
Parameters
Returns
runPartitionedUpdate(query)
runPartitionedUpdate
(
query
:
string
|
ExecuteSqlRequest
)
:
Promise
< [
number
]>;
Parameter
Returns
runPartitionedUpdate(query, callback)
runPartitionedUpdate
(
query
:
string
|
ExecuteSqlRequest
,
callback
?:
RunUpdateCallback
)
:
void
;
Parameters
Returns
runStream(query, options)
runStream
(
query
:
string
|
ExecuteSqlRequest
,
options
?:
TimestampBounds
)
:
PartialResultStream
;
Create a readable object stream to receive resulting rows from a SQL statement.
Wrapper around .
[Query Syntax]( https://cloud.google.com/spanner/docs/query-syntax
) [ExecuteSql API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.Spanner.ExecuteSql)
PartialResultStream#response
Parameters
Returns
runTransaction(runFn)
runTransaction
(
runFn
:
RunTransactionCallback
)
:
void
;
Parameter
Returns
runTransaction(options, runFn)
runTransaction
(
options
:
RunTransactionOptions
,
runFn
:
RunTransactionCallback
)
:
void
;
Parameters
Returns
runTransactionAsync(runFn)
runTransactionAsync<T
=
{}>(
runFn
:
AsyncRunTransactionCallback<T>
)
:
Promise<T>
;
Parameter
Returns
Type Parameter
runTransactionAsync(options, runFn)
runTransactionAsync<T
=
{}>(
options
:
RunTransactionOptions
,
runFn
:
AsyncRunTransactionCallback<T>
)
:
Promise<T>
;
Parameters
Returns
Type Parameter
session(name)
session
(
name
?:
string
)
:
Session
;
Create a Session object.
It is unlikely you will need to interact with sessions directly. By default, sessions are created and utilized for maximum performance automatically.
Parameter
Returns
table(name)
table
(
name
:
string
)
:
Table
;
Get a reference to a Table object.
Parameter
Returns
updateSchema(statements, gaxOptions)
updateSchema
(
statements
:
Schema
,
gaxOptions
?:
CallOptions
)
:
Promise<UpdateSchemaResponse>
;
Parameters
Returns
updateSchema(statements, callback)
updateSchema
(
statements
:
Schema
,
callback
:
UpdateSchemaCallback
)
:
void
;
Parameters
Returns
updateSchema(statements, gaxOptions, callback)
updateSchema
(
statements
:
Schema
,
gaxOptions
:
CallOptions
,
callback
:
UpdateSchemaCallback
)
:
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,[]]
