SpannerClient

v1~ SpannerClient

Cloud Spanner API

The Cloud Spanner API can be used to manage sessions and execute transactions on data stored in Cloud Spanner databases.

Constructor

new SpannerClient(optionsopt)

Construct an instance of SpannerClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

promise function <optional>

Custom promise module to use instead of native Promises.

apiEndpoint string <optional>

The domain name of the API remote host.

Source:

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Source:

(static) port

The port for this API service.

Source:

(static) scopes

The scopes needed to make gRPC calls for every method defined in this service.

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

batchCreateSessions(request, optionsopt, callbackopt) → {Promise}

Creates multiple new sessions.

This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
database string

Required. The database in which the new sessions are created.

sessionCount number

Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary).

sessionTemplate Object <optional>

Parameters to be applied to each created session.

This object should have the same structure as Session

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing BatchCreateSessionsResponse.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedDatabase = client.databasePath('[PROJECT]', '[INSTANCE]', '[DATABASE]');
const sessionCount = 0;
const request = {
  database: formattedDatabase,
  sessionCount: sessionCount,
};
client.batchCreateSessions(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

beginTransaction(request, optionsopt, callbackopt) → {Promise}

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
session string

Required. The session in which the transaction runs.

options Object

Required. Options for the new transaction.

This object should have the same structure as TransactionOptions

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Transaction.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedSession = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
const options = {};
const request = {
  session: formattedSession,
  options: options,
};
client.beginTransaction(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

commit(request, optionsopt, callbackopt) → {Promise}

Commits a transaction. The request includes the mutations to be applied to rows in the database.

Commit might return an ABORTED error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If Commit returns ABORTED, the caller should re-attempt the transaction from the beginning, re-using the same session.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
session string

Required. The session in which the transaction to be committed is running.

transactionId Buffer <optional>

Commit a previously-started transaction.

singleUseTransaction Object <optional>

Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

This object should have the same structure as TransactionOptions

mutations Array.<Object> <optional>

The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

This object should have the same structure as Mutation

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing CommitResponse.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedSession = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
client.commit({session: formattedSession})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

createSession(request, optionsopt, callbackopt) → {Promise}

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions.

Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit.

Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return NOT_FOUND.

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1".

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
database string

Required. The database in which the new session is created.

session Object <optional>

The session to create.

This object should have the same structure as Session

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Session.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedDatabase = client.databasePath('[PROJECT]', '[INSTANCE]', '[DATABASE]');
client.createSession({database: formattedDatabase})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

databasePath(project, instance, database) → {String}

Return a fully-qualified database resource name string.

Parameters:
Name Type Description
project String
instance String
database String
Source:

deleteSession(request, optionsopt, callbackopt) → {Promise}

Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the session to delete.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedName = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
client.deleteSession({name: formattedName}).catch(err => {
  console.error(err);
});

executeBatchDml(request, optionsopt, callbackopt) → {Promise}

Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql.

Statements are executed in sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred.

Execution stops after the first failed statement; the remaining statements are not executed.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
session string

Required. The session in which the DML statements should be performed.

transaction Object

Required. The transaction to use. Must be a read-write transaction.

To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

This object should have the same structure as TransactionSelector

statements Array.<Object>

Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed.

Callers must provide at least one statement.

This object should have the same structure as Statement

seqno number

Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed.

The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing ExecuteBatchDmlResponse.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedSession = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
const transaction = {};
const statements = [];
const seqno = 0;
const request = {
  session: formattedSession,
  transaction: transaction,
  statements: statements,
  seqno: seqno,
};
client.executeBatchDml(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

executeSql(request, optionsopt, callbackopt) → {Promise}

Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a FAILED_PRECONDITION error.

Operations inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
session string

Required. The session in which the SQL query should be performed.

sql string

Required. The SQL string.

transaction Object <optional>

The transaction to use.

For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency.

Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

Partitioned DML requires an existing Partitioned DML transaction ID.

This object should have the same structure as TransactionSelector

params Object <optional>

Parameter names and values that bind to placeholders in the SQL string.

A parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName). Parameter names can contain letters, numbers, and underscores.

Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example:

"WHERE id > @msg_id AND id < @msg_id + 100"

It is an error to execute a SQL statement with unbound parameters.

This object should have the same structure as Struct

paramTypes Object.<string, Object> <optional>

It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type BYTES and values of type STRING both appear in params as JSON strings.

In these cases, param_types can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.

resumeToken Buffer <optional>

If this request is resuming a previously interrupted SQL statement execution, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.

queryMode number <optional>

Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL.

The number should be among the values of QueryMode

partitionToken Buffer <optional>

If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token.

seqno number <optional>

A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed.

The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution.

Required for DML statements. Ignored for queries.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing ResultSet.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedSession = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
const sql = '';
const request = {
  session: formattedSession,
  sql: sql,
};
client.executeSql(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

executeStreamingSql(request, optionsopt) → {Stream}

Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
session string

Required. The session in which the SQL query should be performed.

sql string

Required. The SQL string.

transaction Object <optional>

The transaction to use.

For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency.

Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

Partitioned DML requires an existing Partitioned DML transaction ID.

This object should have the same structure as TransactionSelector

params Object <optional>

Parameter names and values that bind to placeholders in the SQL string.

A parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName). Parameter names can contain letters, numbers, and underscores.

Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example:

"WHERE id > @msg_id AND id < @msg_id + 100"

It is an error to execute a SQL statement with unbound parameters.

This object should have the same structure as Struct

paramTypes Object.<string, Object> <optional>

It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type BYTES and values of type STRING both appear in params as JSON strings.

In these cases, param_types can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.

resumeToken Buffer <optional>

If this request is resuming a previously interrupted SQL statement execution, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.

queryMode number <optional>

Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL.

The number should be among the values of QueryMode

partitionToken Buffer <optional>

If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token.

seqno number <optional>

A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed.

The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution.

Required for DML statements. Ignored for queries.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedSession = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
const sql = '';
const request = {
  session: formattedSession,
  sql: sql,
};
client.executeStreamingSql(request).on('data', response => {
  // doThingsWith(response)
});

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.

Source:

getSession(request, optionsopt, callbackopt) → {Promise}

Gets a session. Returns NOT_FOUND if the session does not exist. This is mainly useful for determining whether a session is still alive.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the session to retrieve.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Session.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedName = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
client.getSession({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

listSessions(request, optionsopt, callbackopt) → {Promise}

Lists all sessions in a given database.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
database string

Required. The database in which to list sessions.

pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

filter string <optional>

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

* `labels.key` where key is the name of a label

Some examples of using filters are:

* `labels.env:*` --> The session has the label "env".
* `labels.env:dev` --> The session has the label "env" and the value of
                     the label contains the string "dev".
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is Array of Session.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListSessionsResponse.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedDatabase = client.databasePath('[PROJECT]', '[INSTANCE]', '[DATABASE]');

client.listSessions({database: formattedDatabase})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedDatabase = client.databasePath('[PROJECT]', '[INSTANCE]', '[DATABASE]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listSessions(nextRequest, options).then(callback);
  }
}
client.listSessions({database: formattedDatabase}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listSessionsStream(request, optionsopt) → {Stream}

Equivalent to listSessions, but returns a NodeJS Stream object.

This fetches the paged responses for listSessions continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
database string

Required. The database in which to list sessions.

pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

filter string <optional>

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

* `labels.key` where key is the name of a label

Some examples of using filters are:

* `labels.env:*` --> The session has the label "env".
* `labels.env:dev` --> The session has the label "env" and the value of
                     the label contains the string "dev".
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Source:
See:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedDatabase = client.databasePath('[PROJECT]', '[INSTANCE]', '[DATABASE]');
client.listSessionsStream({database: formattedDatabase})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

matchDatabaseFromDatabaseName(databaseName) → {String}

Parse the databaseName from a database resource.

Parameters:
Name Type Description
databaseName String

A fully-qualified path representing a database resources.

Source:

matchDatabaseFromSessionName(sessionName) → {String}

Parse the sessionName from a session resource.

Parameters:
Name Type Description
sessionName String

A fully-qualified path representing a session resources.

Source:

matchInstanceFromDatabaseName(databaseName) → {String}

Parse the databaseName from a database resource.

Parameters:
Name Type Description
databaseName String

A fully-qualified path representing a database resources.

Source:

matchInstanceFromSessionName(sessionName) → {String}

Parse the sessionName from a session resource.

Parameters:
Name Type Description
sessionName String

A fully-qualified path representing a session resources.

Source:

matchProjectFromDatabaseName(databaseName) → {String}

Parse the databaseName from a database resource.

Parameters:
Name Type Description
databaseName String

A fully-qualified path representing a database resources.

Source:

matchProjectFromSessionName(sessionName) → {String}

Parse the sessionName from a session resource.

Parameters:
Name Type Description
sessionName String

A fully-qualified path representing a session resources.

Source:

matchSessionFromSessionName(sessionName) → {String}

Parse the sessionName from a session resource.

Parameters:
Name Type Description
sessionName String

A fully-qualified path representing a session resources.

Source:

partitionQuery(request, optionsopt, callbackopt) → {Promise}

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
session string

Required. The session used to create the partitions.

sql string

Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results.

This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.

transaction Object <optional>

Read only snapshot transactions are supported, read/write and single use transactions are not.

This object should have the same structure as TransactionSelector

params Object <optional>

Parameter names and values that bind to placeholders in the SQL string.

A parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName). Parameter names can contain letters, numbers, and underscores.

Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example:

"WHERE id > @msg_id AND id < @msg_id + 100"

It is an error to execute a SQL statement with unbound parameters.

This object should have the same structure as Struct

paramTypes Object.<string, Object> <optional>

It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type BYTES and values of type STRING both appear in params as JSON strings.

In these cases, param_types can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types.

partitionOptions Object <optional>

Additional options that affect how many partitions are created.

This object should have the same structure as PartitionOptions

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing PartitionResponse.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedSession = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
const sql = '';
const request = {
  session: formattedSession,
  sql: sql,
};
client.partitionQuery(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

partitionRead(request, optionsopt, callbackopt) → {Promise}

Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
session string

Required. The session used to create the partitions.

table string

Required. The name of the table in the database to be read.

keySet Object

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

This object should have the same structure as KeySet

transaction Object <optional>

Read only snapshot transactions are supported, read/write and single use transactions are not.

This object should have the same structure as TransactionSelector

index string <optional>

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

columns Array.<string> <optional>

The columns of table to be returned for each row matching this request.

partitionOptions Object <optional>

Additional options that affect how many partitions are created.

This object should have the same structure as PartitionOptions

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing PartitionResponse.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedSession = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
const table = '';
const keySet = {};
const request = {
  session: formattedSession,
  table: table,
  keySet: keySet,
};
client.partitionRead(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

read(request, optionsopt, callbackopt) → {Promise}

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a FAILED_PRECONDITION error.

Reads inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
session string

Required. The session in which the read should be performed.

table string

Required. The name of the table in the database to be read.

columns Array.<string>

Required. The columns of table to be returned for each row matching this request.

keySet Object

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

This object should have the same structure as KeySet

transaction Object <optional>

The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.

This object should have the same structure as TransactionSelector

index string <optional>

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

limit number <optional>

If greater than zero, only the first limit rows are yielded. If limit is zero, the default is no limit. A limit cannot be specified if partition_token is set.

resumeToken Buffer <optional>

If this request is resuming a previously interrupted read, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token.

partitionToken Buffer <optional>

If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing ResultSet.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedSession = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
const table = '';
const columns = [];
const keySet = {};
const request = {
  session: formattedSession,
  table: table,
  columns: columns,
  keySet: keySet,
};
client.read(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

rollback(request, optionsopt, callbackopt) → {Promise}

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit.

Rollback returns OK if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. Rollback never returns ABORTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
session string

Required. The session in which the transaction to roll back is running.

transactionId Buffer

Required. The transaction to roll back.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedSession = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
const transactionId = Buffer.from('');
const request = {
  session: formattedSession,
  transactionId: transactionId,
};
client.rollback(request).catch(err => {
  console.error(err);
});

sessionPath(project, instance, database, session) → {String}

Return a fully-qualified session resource name string.

Parameters:
Name Type Description
project String
instance String
database String
session String
Source:

streamingRead(request, optionsopt) → {Stream}

Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
session string

Required. The session in which the read should be performed.

table string

Required. The name of the table in the database to be read.

columns Array.<string>

Required. The columns of table to be returned for each row matching this request.

keySet Object

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

This object should have the same structure as KeySet

transaction Object <optional>

The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.

This object should have the same structure as TransactionSelector

index string <optional>

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

limit number <optional>

If greater than zero, only the first limit rows are yielded. If limit is zero, the default is no limit. A limit cannot be specified if partition_token is set.

resumeToken Buffer <optional>

If this request is resuming a previously interrupted read, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token.

partitionToken Buffer <optional>

If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Source:
Example
const spanner = require('@google-cloud/spanner');

const client = new spanner.v1.SpannerClient({
  // optional auth parameters.
});

const formattedSession = client.sessionPath('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
const table = '';
const columns = [];
const keySet = {};
const request = {
  session: formattedSession,
  table: table,
  columns: columns,
  keySet: keySet,
};
client.streamingRead(request).on('data', response => {
  // doThingsWith(response)
});