Compare `fe003c0 ... +116 ... 8ae1f6e`

 * @module spanner/session
 */

import {GrpcServiceObject} from './common-grpc/service-object';
// eslint-disable-next-line @typescript-eslint/no-var-requires
const common = require('./common-grpc/service-object');
import {promisifyAll} from '@google-cloud/promisify';
import * as extend from 'extend';
import * as r from 'teeny-request';

@@ -34,9 +35,9 @@

  CreateSessionCallback,
  CreateSessionOptions,
} from './database';
import {ServiceObjectConfig, DeleteCallback} from '@google-cloud/common';
import {NormalCallback} from './common';
import {ServiceError} from 'grpc';
import {ServiceObjectConfig} from '@google-cloud/common';
import {NormalCallback, CLOUD_RESOURCE_HEADER} from './common';
import {grpc, CallOptions} from 'google-gax';

export type GetSessionResponse = [Session, r.Response];


@@ -55,7 +56,9 @@


export type KeepAliveCallback = NormalCallback<google.spanner.v1.IResultSet>;
export type KeepAliveResponse = [google.spanner.v1.IResultSet];
export type DeleteResponse = [r.Response];
export type DeleteSessionResponse = [google.protobuf.IEmpty];
export type DeleteSessionCallback = NormalCallback<google.protobuf.IEmpty>;

/**
 * Create a Session object to interact with a Cloud Spanner session.
 *

@@ -94,13 +97,14 @@

 * //-
 * const session = database.session('session-name');
 */
export class Session extends GrpcServiceObject {
export class Session extends common.GrpcServiceObject {
  id!: string;
  formattedName_?: string;
  type?: types;
  txn?: Transaction;
  lastUsed?: number;
  lastError?: ServiceError;
  lastError?: grpc.ServiceError;
  resourceHeader_: {[k: string]: string};
  constructor(database: Database, name?: string) {
    const methods = {
      /**

@@ -231,15 +235,19 @@

      },
    } as {}) as ServiceObjectConfig);

    this.resourceHeader_ = {
      [CLOUD_RESOURCE_HEADER]: (this.parent as Database).formattedName_,
    };
    this.request = database.request;
    this.requestStream = database.requestStream;

    if (name) {
      this.formattedName_ = Session.formatName_(database.formattedName_, name);
    }
  }
  delete(): Promise<DeleteResponse>;
  delete(callback: DeleteCallback): void;
  delete(gaxOptions?: CallOptions): Promise<DeleteSessionResponse>;
  delete(callback: DeleteSessionCallback): void;
  delete(gaxOptions: CallOptions, callback: DeleteSessionCallback): void;
  /**
   * Delete a session.
   *

@@ -248,8 +256,10 @@

   * @see {@link v1.SpannerClient#deleteSession}
   * @see [DeleteSession API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.Spanner.DeleteSession)
   *
   * @param {BasicCallback} [callback] Callback function.
   * @returns {Promise<BasicResponse>}
   * @param {object} [gaxOptions] Request configuration options, outlined here:
   *     https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
   * @param {DeleteSessionCallback} [callback] Callback function.
   * @returns {Promise<DeleteSessionResponse>}
   *
   * @example
   * session.delete(function(err, apiResponse) {

@@ -267,7 +277,15 @@

   *   const apiResponse = data[0];
   * });
   */
  delete(callback?: DeleteCallback): void | Promise<DeleteResponse> {
  delete(
    optionsOrCallback?: CallOptions | DeleteSessionCallback,
    cb?: DeleteSessionCallback
  ): void | Promise<DeleteSessionResponse> {
    const gaxOpts =
      typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
    const callback =
      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;

    const reqOpts = {
      name: this.formattedName_,
    };

@@ -276,12 +294,18 @@

        client: 'SpannerClient',
        method: 'deleteSession',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      callback!
    );
  }
  getMetadata(): Promise<GetSessionMetadataResponse>;
  getMetadata(gaxOptions?: CallOptions): Promise<GetSessionMetadataResponse>;
  getMetadata(callback: GetSessionMetadataCallback): void;
  getMetadata(
    gaxOptions: CallOptions,
    callback: GetSessionMetadataCallback
  ): void;
  /**
   * @typedef {array} GetSessionMetadataResponse
   * @property {object} 0 The session's metadata.

@@ -301,6 +325,8 @@

   * @see {@link v1.SpannerClient#getSession}
   * @see [GetSession API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.Spanner.GetSession)
   *
   * @param {object} [gaxOptions] Request configuration options, outlined here:
   *     https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
   * @param {GetSessionMetadataCallback} [callback] Callback function.
   * @returns {Promise<GetSessionMetadataResponse>}
   *

@@ -316,8 +342,14 @@

   * });
   */
  getMetadata(
    callback?: GetSessionMetadataCallback
    optionsOrCallback?: CallOptions | GetSessionMetadataCallback,
    cb?: GetSessionMetadataCallback
  ): void | Promise<GetSessionMetadataResponse> {
    const gaxOpts =
      typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
    const callback =
      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;

    const reqOpts = {
      name: this.formattedName_,
    };

@@ -326,15 +358,25 @@

        client: 'SpannerClient',
        method: 'getSession',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      callback!
      (err, resp) => {
        if (resp) {
          this.metadata = resp;
        }
        callback!(err, resp);
      }
    );
  }
  keepAlive(): Promise<KeepAliveResponse>;
  keepAlive(gaxOptions?: CallOptions): Promise<KeepAliveResponse>;
  keepAlive(callback: KeepAliveCallback): void;
  keepAlive(gaxOptions: CallOptions, callback: KeepAliveCallback): void;
  /**
   * Ping the session with `SELECT 1` to prevent it from expiring.
   *
   * @param {object} [gaxOptions] Request configuration options, outlined here:
   *     https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
   * @param {BasicCallback} [callback] Callback function.
   * @returns {Promise<BasicResponse>}
   *

@@ -345,7 +387,15 @@

   *   }
   * });
   */
  keepAlive(callback?: KeepAliveCallback): void | Promise<KeepAliveResponse> {
  keepAlive(
    optionsOrCallback?: CallOptions | KeepAliveCallback,
    cb?: KeepAliveCallback
  ): void | Promise<KeepAliveResponse> {
    const gaxOpts =
      typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
    const callback =
      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;

    const reqOpts = {
      session: this.formattedName_,
      sql: 'SELECT 1',

@@ -355,6 +405,8 @@

        client: 'SpannerClient',
        method: 'executeSql',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      callback!
    );

@@ -15,51 +15,49 @@

 */

import {GrpcService, GrpcServiceConfig} from './common-grpc/service';
import {paginator} from '@google-cloud/paginator';
import {PreciseDate} from '@google-cloud/precise-date';
import {replaceProjectIdToken} from '@google-cloud/projectify';
import {promisifyAll} from '@google-cloud/promisify';
import * as extend from 'extend';
import {GoogleAuth, GoogleAuthOptions} from 'google-auth-library';
import * as is from 'is';
import * as path from 'path';
import {common as p} from 'protobufjs';
import * as streamEvents from 'stream-events';
import * as through from 'through2';
import {codec, Float, Int, SpannerDate, Struct} from './codec';
import {codec, Float, Int, Numeric, SpannerDate, Struct} from './codec';
import {Backup} from './backup';
import {Database} from './database';
import {
  Instance,
  CreateInstanceCallback,
  CreateInstanceResponse,
} from './instance';
import {grpc, GrpcClientOptions, CallOptions} from 'google-gax';
import {google as instanceAdmin} from '../protos/protos';
import {PagedRequest, PagedResponse, PagedCallback} from './common';
import {
  PagedOptions,
  PagedResponse,
  PagedCallback,
  PagedOptionsWithFilter,
  CLOUD_RESOURCE_HEADER,
} from './common';
import {Session} from './session';
import {SessionPool} from './session-pool';
import {Table} from './table';
import {PartitionedDml, Snapshot, Transaction} from './transaction';
import {GrpcClientOptions} from 'google-gax';
import {ChannelCredentials} from 'grpc';
import {
  createGcpApiConfig,
  gcpCallInvocationTransformer,
  gcpChannelFactoryOverride,
} from 'grpc-gcp';
import grpcGcpModule = require('grpc-gcp');
const grpcGcp = grpcGcpModule(grpc);
import * as v1 from './v1';
import * as grpc from 'grpc';
import * as pumpify from 'pumpify';
import {Transform} from 'stream';

// eslint-disable-next-line @typescript-eslint/no-var-requires
const gcpApiConfig = require('./spanner_grpc_config.json');

export type IOperation = instanceAdmin.longrunning.IOperation;

export type GetInstancesRequest = PagedRequest<
  instanceAdmin.spanner.admin.instance.v1.IListInstancesRequest & {
    maxResults?: number;
  }
>;
export type GetInstancesOptions = PagedOptionsWithFilter;

export type GetInstancesResponse = PagedResponse<
  Instance,
  instanceAdmin.spanner.admin.instance.v1.IListInstancesResponse

@@ -69,37 +67,36 @@

  instanceAdmin.spanner.admin.instance.v1.IListInstancesResponse
>;

export type GetInstanceConfigsRequest = PagedRequest<
  instanceAdmin.spanner.admin.instance.v1.IListInstanceConfigsRequest & {
    maxResults?: number;
  }
>;
export type GetInstanceConfigsOptions = PagedOptions;
export type GetInstanceConfigsResponse = PagedResponse<
  instanceAdmin.spanner.admin.instance.v1.InstanceConfig,
  instanceAdmin.spanner.admin.instance.v1.IInstanceConfig,
  instanceAdmin.spanner.admin.instance.v1.IListInstanceConfigsResponse
>;
export type GetInstanceConfigsCallback = PagedCallback<
  instanceAdmin.spanner.admin.instance.v1.InstanceConfig,
  instanceAdmin.spanner.admin.instance.v1.IInstanceConfig,
  instanceAdmin.spanner.admin.instance.v1.IListInstanceConfigsResponse
>;

export interface SpannerOptions extends GrpcClientOptions {
  apiEndpoint?: string;
  servicePath?: string;
  port?: number;
  sslCreds?: ChannelCredentials;
  sslCreds?: grpc.ChannelCredentials;
}
export interface RequestConfig {
  client: string;
  method: string;
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  reqOpts: any;
  gaxOpts?: {};
  gaxOpts?: CallOptions;
  headers: {[k: string]: string};
}
export interface CreateInstanceRequest {
  config: string;
  config?: string;
  nodes?: number;
  displayName?: string;
  labels?: {[k: string]: string} | null;
  gaxOptions?: CallOptions;
}
/**
 * Translates enum values to string keys.

@@ -161,7 +158,8 @@

  auth: GoogleAuth;
  clients_: Map<string, {}>;
  instances_: Map<string, Instance>;
  getInstancesStream: Function;
  projectFormattedName_: string;
  resourceHeader_: {[k: string]: string};

  /**
   * Placeholder used to auto populate a column with the commit timestamp.

@@ -225,9 +223,9 @@

        libVersion: require('../../package.json').version,
        scopes,
        // Enable grpc-gcp support
        'grpc.callInvocationTransformer': gcpCallInvocationTransformer,
        'grpc.channelFactoryOverride': gcpChannelFactoryOverride,
        'grpc.gcpApiConfig': createGcpApiConfig(gcpApiConfig),
        'grpc.callInvocationTransformer': grpcGcp.gcpCallInvocationTransformer,
        'grpc.channelFactoryOverride': grpcGcp.gcpChannelFactoryOverride,
        'grpc.gcpApiConfig': grpcGcp.createGcpApiConfig(gcpApiConfig),
        grpc,
      },
      options || {}

@@ -262,43 +260,10 @@

    this.auth = new GoogleAuth(this.options);
    this.clients_ = new Map();
    this.instances_ = new Map();

    /**
     * Get a list of {@link Instance} objects as a readable object stream.
     *
     * Wrapper around {@link v1.InstanceAdminClient#listInstances}.
     *
     * @see {@link v1.InstanceAdminClient#listInstances}
     * @see [ListInstances API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.ListInstances)
     *
     * @method Spanner#getInstancesStream
     * @param {GetInstancesRequest} [query] Query object for listing instances.
     * @returns {ReadableStream} A readable stream that emits {@link Instance}
     *     instances.
     *
     * @example
     * const {Spanner} = require('@google-cloud/spanner');
     * const spanner = new Spanner();
     *
     * spanner.getInstancesStream()
     *   .on('error', console.error)
     *   .on('data', function(instance) {
     *     // `instance` is an `Instance` object.
     *   })
     *   .on('end', function() {
     *     // All instances retrieved.
     *   });
     *
     * //-
     * // If you anticipate many results, you can end a stream early to prevent
     * // unnecessary processing and API requests.
     * //-
     * spanner.getInstancesStream()
     *   .on('data', function(instance) {
     *     this.end();
     *   });
     */
    this.getInstancesStream = paginator.streamify('getInstances');
    this.projectFormattedName_ = 'projects/' + this.projectId;
    this.resourceHeader_ = {
      [CLOUD_RESOURCE_HEADER]: this.projectFormattedName_,
    };
  }

  createInstance(

@@ -324,6 +289,11 @@

   *     be used to control how resource metrics are aggregated. And they can
   *     be used as arguments to policy management rules (e.g. route,
   *     firewall, load balancing, etc.).
   * @property {string} [displayName] The descriptive name for this instance
   *     as it appears in UIs. Must be unique per project and between 4 and 30
   *     characters in length.
   *     Defaults to the instance unique identifier '<instance>' of the full
   *     instance name of the form 'projects/<project>/instances/<instance>'.
   */
  /**
   * @typedef {array} CreateInstanceResponse

@@ -406,30 +376,33 @@

      );
    }
    const formattedName = Instance.formatName_(this.projectId, name);
    const shortName = formattedName.split('/').pop();
    const displayName = config.displayName || formattedName.split('/').pop();
    const reqOpts = {
      parent: 'projects/' + this.projectId,
      instanceId: shortName,
      parent: this.projectFormattedName_,
      instanceId: formattedName.split('/').pop(),
      instance: extend(
        {
          name: formattedName,
          displayName: shortName,
          displayName,
          nodeCount: config.nodes || 1,
        },
        config
      ),
    };

    delete reqOpts.instance.nodes;
    delete reqOpts.instance.gaxOptions;

    if (config.config.indexOf('/') === -1) {
    if (config.config!.indexOf('/') === -1) {
      reqOpts.instance.config = `projects/${this.projectId}/instanceConfigs/${config.config}`;
    }
    this.request(
      {
        client: 'InstanceAdminClient',
        method: 'createInstance',
        reqOpts,
        gaxOpts: config.gaxOptions,
        headers: this.resourceHeader_,
      },
      (err, operation, resp) => {
        if (err) {

@@ -442,18 +415,18 @@

    );
  }

  getInstances(query?: GetInstancesRequest): Promise<GetInstancesResponse>;
  getInstances(options?: GetInstancesOptions): Promise<GetInstancesResponse>;
  getInstances(callback: GetInstancesCallback): void;
  getInstances(
    query: GetInstancesRequest,
    query: GetInstancesOptions,
    callback: GetInstancesCallback
  ): void;
  /**
   * Query object for listing instances.
   *
   * @typedef {object} GetInstancesRequest
   * @property {boolean} [autoPaginate=true] Have pagination handled
   *     automatically.
   * @typedef {object} GetInstancesOptions
   * @property {object} [gaxOptions] Request configuration options, outlined
   *     here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
   * @property {string} [filter] An expression for filtering the results of the
   *     request. Filter rules are case insensitive. The fields eligible for
   *     filtering are:

@@ -468,21 +441,21 @@

   *     - **`labels.env:dev`** The instance's label env has the value dev.
   *     - **`name:howl labels.env:dev`** The instance's name is howl and it has
   *       the label env with value dev.
   * @property {number} [maxApiCalls] Maximum number of API calls to make.
   * @property {number} [maxResults] Maximum number of items to return.
   * @property {number} [pageSize] Maximum number of results per page.
   * @property {string} [pageToken] A previously-returned page token
   *     representing part of the larger set of results to view.
   */
  /**
   * @typedef {array} GetInstancesResponse
   * @property {Instance[]} 0 Array of {@link Instance} instances.
   * @property {object} 1 The full API response.
   * @property {object} 1 A query object to receive more results.
   * @property {object} 2 The full API response.
   */
  /**
   * @callback GetInstancesCallback
   * @param {?Error} err Request error, if any.
   * @param {Instance[]} instances Array of {@link Instance} instances.
   * @param {string} nextQuery A query object to receive more results.
   * @param {object} apiResponse The full API response.
   */
  /**

@@ -493,7 +466,7 @@

   * @see {@link v1.InstanceAdminClient#listInstances}
   * @see [ListInstances API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.ListInstances)
   *
   * @param {GetInstancesRequest} [query] Query object for listing instances.
   * @param {GetInstancesOptions} [options] Query object for listing instances.
   * @param {GetInstancesCallback} [callback] Callback function.
   * @returns {Promise<GetInstancesResponse>}
   *

@@ -517,7 +490,9 @@

   * }
   *
   * spanner.getInstances({
   *   autoPaginate: false
   *   gaxOptions: {
   *     autoPaginate: false,
   *   }
   * }, callback);
   *
   * //-

@@ -528,26 +503,50 @@

   * });
   */
  getInstances(
    query?: GetInstancesRequest | GetInstancesCallback,
    callback?: GetInstancesCallback
    optionsOrCallback?: GetInstancesOptions | GetInstancesCallback,
    cb?: GetInstancesCallback
  ): Promise<GetInstancesResponse> | void {
    // eslint-disable-next-line @typescript-eslint/no-this-alias
    const self = this;
    if (is.fn(query)) {
      callback = query as GetInstancesCallback;
      query = {};
    }
    const reqOpts = extend({}, query, {
    const options =
      typeof optionsOrCallback === 'object'
        ? optionsOrCallback
        : ({} as GetInstancesOptions);
    const callback =
      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;

    const gaxOpts = extend(true, {}, options.gaxOptions);

    let reqOpts = extend({}, options, {
      parent: 'projects/' + this.projectId,
    });

    delete reqOpts.gaxOptions;

    // Copy over pageSize and pageToken values from gaxOptions.
    // However values set on options take precedence.
    if (gaxOpts) {
      reqOpts = extend(
        {},
        {
          pageSize: gaxOpts.pageSize,
          pageToken: gaxOpts.pageToken,
        },
        reqOpts
      );
      delete gaxOpts.pageToken;
      delete gaxOpts.pageSize;
    }

    this.request(
      {
        client: 'InstanceAdminClient',
        method: 'listInstances',
        reqOpts,
        gaxOpts: query,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      (err, instances, ...args) => {
      (err, instances, nextPageRequest, ...args) => {
        let instanceInstances: Instance[] | null = null;
        if (instances) {
          instanceInstances = instances.map(instance => {

@@ -556,38 +555,122 @@

            return instanceInstance;
          });
        }
        callback!(err, instanceInstances, ...args);
        const nextQuery = nextPageRequest!
          ? extend({}, options, nextPageRequest!)
          : null;
        callback!(err, instanceInstances, nextQuery, ...args);
      }
    );
  }

  /**
   * Get a list of {@link Instance} objects as a readable object stream.
   *
   * Wrapper around {@link v1.InstanceAdminClient#listInstances}.
   *
   * @see {@link v1.InstanceAdminClient#listInstances}
   * @see [ListInstances API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.ListInstances)
   *
   * @method Spanner#getInstancesStream
   * @param {GetInstancesOptions} [options] Query object for listing instances.
   * @returns {ReadableStream} A readable stream that emits {@link Instance}
   *     instances.
   *
   * @example
   * const {Spanner} = require('@google-cloud/spanner');
   * const spanner = new Spanner();
   *
   * spanner.getInstancesStream()
   *   .on('error', console.error)
   *   .on('data', function(instance) {
   *     // `instance` is an `Instance` object.
   *   })
   *   .on('end', function() {
   *     // All instances retrieved.
   *   });
   *
   * //-
   * // If you anticipate many results, you can end a stream early to prevent
   * // unnecessary processing and API requests.
   * //-
   * spanner.getInstancesStream()
   *   .on('data', function(instance) {
   *     this.end();
   *   });
   */
  getInstancesStream(options: GetInstancesOptions = {}): NodeJS.ReadableStream {
    const gaxOpts = extend(true, {}, options.gaxOptions);

    let reqOpts = extend({}, options, {
      parent: 'projects/' + this.projectId,
    });
    delete reqOpts.gaxOptions;

    // Copy over pageSize and pageToken values from gaxOptions.
    // However values set on options take precedence.
    if (gaxOpts) {
      reqOpts = extend(
        {},
        {
          pageSize: gaxOpts.pageSize,
          pageToken: gaxOpts.pageToken,
        },
        reqOpts
      );
      delete gaxOpts.pageSize;
      delete gaxOpts.pageToken;
    }

    return new pumpify.obj([
      this.requestStream({
        client: 'InstanceAdminClient',
        method: 'listInstancesStream',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      }),
      new Transform({
        objectMode: true,
        transform: (
          chunk: instanceAdmin.spanner.admin.instance.v1.IInstance,
          enc: string,
          cb: Function
        ) => {
          const instance = this.instance(chunk.name!);
          instance.metadata = chunk;
          cb(null, instance);
        },
      }),
    ]);
  }

  getInstanceConfigs(
    query?: GetInstanceConfigsRequest
    query?: GetInstanceConfigsOptions
  ): Promise<GetInstanceConfigsResponse>;
  getInstanceConfigs(callback: GetInstanceConfigsCallback): void;
  getInstanceConfigs(
    query: GetInstanceConfigsRequest,
    query: GetInstanceConfigsOptions,
    callback: GetInstanceConfigsCallback
  ): void;
  /**
   * Query object for listing instance configs.
   * Lists the supported instance configurations for a given project.
   *
   * @typedef {object} GetInstanceConfigsRequest
   * @property {boolean} [autoPaginate=true] Have pagination handled
   *     automatically.
   * @property {number} [maxApiCalls] Maximum number of API calls to make.
   * @property {number} [maxResults] Maximum number of items to return.
   * @typedef {object} GetInstanceConfigsOptions
   * @property {number} [pageSize] Maximum number of results per page.
   * @property {string} [pageToken] A previously-returned page token
   *     representing part of the larger set of results to view.
   * @property {object} [gaxOptions] Request configuration options, outlined
   *     here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.

   */
  /**
   * @typedef {array} GetInstanceConfigsResponse
   * @property {object[]} 0 List of all available instance configs.
   * @property {string} 0.name The unique identifier for the instance config.
   * @property {string} 0.displayName The name of the instance config as it
   *     appears in UIs.
   * @property {object} 1 The full API response.
   * @property {object} 1 A query object to receive more results.
   * @property {object} 2 The full API response.
   */
  /**
   * @callback GetInstanceConfigsCallback

@@ -597,6 +680,7 @@

   *     config.
   * @param {string} instanceConfigs.displayName The name of the instance config
   *     as it appears in UIs.
   * @param {object} nextQuery A query object to receive more results.
   * @param {object} apiResponse The full API response.
   */
  /**

@@ -607,7 +691,7 @@

   * @see {@link v1.InstanceAdminClient#listInstanceConfigs}
   * @see [ListInstanceConfigs API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs)
   *
   * @param {GetInstanceConfigsRequest} [query] Query object for listing instance
   * @param {GetInstanceConfigsOptions} [options] Query object for listing instance
   *     configs.
   * @param {GetInstanceConfigsCallback} [callback] Callback function.
   * @returns {Promise<GetInstanceConfigsResponse>}

@@ -632,7 +716,9 @@

   * }
   *
   * spanner.getInstanceConfigs({
   *   autoPaginate: false
   *   gaxOptions: {
   *     autoPaginate: false,
   *   }
   * }, callback);
   *
   * //-

@@ -643,28 +729,51 @@

   * });
   */
  getInstanceConfigs(
    queryOrCallback?: GetInstanceConfigsRequest | GetInstanceConfigsCallback,
    optionsOrCallback?: GetInstanceConfigsOptions | GetInstanceConfigsCallback,
    cb?: GetInstanceConfigsCallback
  ): Promise<GetInstanceConfigsResponse> | void {
    const callback =
      typeof queryOrCallback === 'function'
        ? (queryOrCallback as GetInstanceConfigsCallback)
        : cb;
    const query =
      typeof queryOrCallback === 'object'
        ? (queryOrCallback as GetInstanceConfigsRequest)
        : {};
    const reqOpts = extend({}, query, {
      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb;
    const options =
      typeof optionsOrCallback === 'object'
        ? optionsOrCallback
        : ({} as GetInstanceConfigsOptions);

    const gaxOpts = extend(true, {}, options.gaxOptions);
    let reqOpts = extend({}, options, {
      parent: 'projects/' + this.projectId,
    });
    delete reqOpts.gaxOptions;

    // Copy over pageSize and pageToken values from gaxOptions.
    // However values set on options take precedence.
    if (gaxOpts) {
      reqOpts = extend(
        {},
        {
          pageSize: gaxOpts.pageSize,
          pageToken: gaxOpts.pageToken,
        },
        reqOpts
      );
      delete gaxOpts.pageSize;
      delete gaxOpts.pageToken;
    }

    return this.request(
      {
        client: 'InstanceAdminClient',
        method: 'listInstanceConfigs',
        reqOpts,
        gaxOpts: query,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      callback
      (err, instanceConfigs, nextPageRequest, ...args) => {
        const nextQuery = nextPageRequest!
          ? extend({}, options, nextPageRequest!)
          : null;
        callback!(err, instanceConfigs, nextQuery, ...args);
      }
    );
  }


@@ -677,7 +786,7 @@

   * @see [ListInstanceConfigs API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs)
   *
   * @method Spanner#getInstanceConfigsStream
   * @param {GetInstanceConfigsRequest} [query] Query object for listing instance
   * @param {GetInstanceConfigsOptions} [options] Query object for listing instance
   *     configs.
   * @returns {ReadableStream} A readable stream that emits instance configs.
   *

@@ -702,16 +811,36 @@

   *   });
   */
  getInstanceConfigsStream(
    query?: GetInstanceConfigsRequest
    options: GetInstanceConfigsOptions = {}
  ): NodeJS.ReadableStream {
    const reqOpts = extend({}, query, {
    const gaxOpts = extend(true, {}, options.gaxOptions);

    let reqOpts = extend({}, options, {
      parent: 'projects/' + this.projectId,
    });

    // Copy over pageSize and pageToken values from gaxOptions.
    // However values set on options take precedence.
    if (gaxOpts) {
      reqOpts = extend(
        {},
        {
          pageSize: gaxOpts.pageSize,
          pageToken: gaxOpts.pageToken,
        },
        reqOpts
      );
      delete gaxOpts.pageSize;
      delete gaxOpts.pageToken;
    }

    delete reqOpts.gaxOptions;
    return this.requestStream({
      client: 'InstanceAdminClient',
      method: 'listInstanceConfigsStream',
      reqOpts,
      gaxOpts: query,
      gaxOpts,
      headers: this.resourceHeader_,
    });
  }


@@ -764,7 +893,12 @@

      const requestFn = gaxClient[config.method].bind(
        gaxClient,
        reqOpts,
        config.gaxOpts
        // Add headers to `gaxOpts`
        extend(true, {}, config.gaxOpts, {
          otherArgs: {
            headers: config.headers,
          },
        })
      );
      callback(null, requestFn);
    });

@@ -783,7 +917,7 @@

   */
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  request(config: any, callback?: any): any {
    if (is.fn(callback)) {
    if (typeof callback === 'function') {
      this.prepareGapicRequest_(config, (err, requestFn) => {
        if (err) {
          callback(err);

@@ -939,6 +1073,20 @@

    return new codec.Int(value);
  }

  /**
   * Helper function to get a Cloud Spanner Numeric object.
   *
   * @param {string} value The numeric value as a string.
   * @returns {Numeric}
   *
   * @example
   * const {Spanner} = require('@google-cloud/spanner');
   * const numeric = Spanner.numeric("3.141592653");
   */
  static numeric(value): Numeric {
    return new codec.Numeric(value);
  }

  /**
   * Helper function to get a Cloud Spanner Struct object.
   *

@@ -969,9 +1117,9 @@

  exclude: [
    'date',
    'float',
    'getInstanceConfigs',
    'instance',
    'int',
    'numeric',
    'operation',
    'timestamp',
  ],

@@ -32,7 +32,7 @@

import {RequestType} from 'google-gax/build/src/apitypes';
import * as protos from '../../protos/protos';
import * as gapicConfig from './instance_admin_client_config.json';

import {operationsProtos} from 'google-gax';
const version = require('../../../package.json').version;

/**

@@ -82,8 +82,10 @@

  /**
   * Construct an instance of InstanceAdminClient.
   *
   * @param {object} [options] - The configuration object. See the subsequent
   *   parameters for more details.
   * @param {object} [options] - The configuration object.
   * The options accepted by the constructor are described in detail
   * in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
   * The common options are:
   * @param {object} [options.credentials] - Credentials object.
   * @param {string} [options.credentials.client_email]
   * @param {string} [options.credentials.private_key]

@@ -103,38 +105,33 @@

   *     your project ID will be detected automatically.
   * @param {string} [options.apiEndpoint] - The domain name of the
   *     API remote host.
   * @param {gax.ClientConfig} [options.clientConfig] - client configuration override.
   *     TODO(@alexander-fenster): link to gax documentation.
   * @param {boolean} fallback - Use HTTP fallback mode.
   *     In fallback mode, a special browser-compatible transport implementation is used
   *     instead of gRPC transport. In browser context (if the `window` object is defined)
   *     the fallback mode is enabled automatically; set `options.fallback` to `false`
   *     if you need to override this behavior.
   */

  constructor(opts?: ClientOptions) {
    // Ensure that options include the service address and port.
    // Ensure that options include all the required fields.
    const staticMembers = this.constructor as typeof InstanceAdminClient;
    const servicePath =
      opts && opts.servicePath
        ? opts.servicePath
        : opts && opts.apiEndpoint
        ? opts.apiEndpoint
        : staticMembers.servicePath;
    const port = opts && opts.port ? opts.port : staticMembers.port;
      opts?.servicePath || opts?.apiEndpoint || staticMembers.servicePath;
    const port = opts?.port || staticMembers.port;
    const clientConfig = opts?.clientConfig ?? {};
    const fallback = opts?.fallback ?? typeof window !== 'undefined';
    opts = Object.assign({servicePath, port, clientConfig, fallback}, opts);

    if (!opts) {
      opts = {servicePath, port};
    // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
    if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
      opts['scopes'] = staticMembers.scopes;
    }
    opts.servicePath = opts.servicePath || servicePath;
    opts.port = opts.port || port;
    opts.clientConfig = opts.clientConfig || {};

    const isBrowser = typeof window !== 'undefined';
    if (isBrowser) {
      opts.fallback = true;
    }
    // If we are in browser, we are already using fallback because of the
    // "browser" field in package.json.
    // But if we were explicitly requested to use fallback, let's do it now.
    this._gaxModule = !isBrowser && opts.fallback ? gax.fallback : gax;
    // Choose either gRPC or proto-over-HTTP implementation of google-gax.
    this._gaxModule = opts.fallback ? gax.fallback : gax;

    // Create a `gaxGrpc` object, with any grpc-specific options
    // sent to the client.
    opts.scopes = (this.constructor as typeof InstanceAdminClient).scopes;
    // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
    this._gaxGrpc = new this._gaxModule.GrpcClient(opts);

    // Save options to use in initialize() method.

@@ -143,6 +140,11 @@

    // Save the auth object to the client, for use by other methods.
    this.auth = this._gaxGrpc.auth as gax.GoogleAuth;

    // Set the default scopes in auth client if needed.
    if (servicePath === staticMembers.servicePath) {
      this.auth.defaultScopes = staticMembers.scopes;
    }

    // Determine the client header string.
    const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
    if (typeof process !== 'undefined' && 'versions' in process) {

@@ -184,6 +186,9 @@

      instanceConfigPathTemplate: new this._gaxModule.PathTemplate(
        'projects/{project}/instanceConfigs/{instance_config}'
      ),
      projectPathTemplate: new this._gaxModule.PathTemplate(
        'projects/{project}'
      ),
    };

    // Some of the methods on this service return "paged" results,

@@ -315,12 +320,14 @@

        }
      );

      const descriptor =
        this.descriptors.page[methodName] ||
        this.descriptors.longrunning[methodName] ||
        undefined;
      const apiCall = this._gaxModule.createApiCall(
        callPromise,
        this._defaults[methodName],
        this.descriptors.page[methodName] ||
          this.descriptors.stream[methodName] ||
          this.descriptors.longrunning[methodName]
        descriptor
      );

      this.innerApiCalls[methodName] = apiCall;

@@ -331,6 +338,7 @@


  /**
   * The DNS address for this API service.
   * @returns {string} The DNS address for this service.
   */
  static get servicePath() {
    return 'spanner.googleapis.com';

@@ -339,13 +347,15 @@

  /**
   * The DNS address for this API service - same as servicePath(),
   * exists for compatibility reasons.
   * @returns {string} The DNS address for this service.
   */
  static get apiEndpoint() {
    return 'spanner.googleapis.com';
  }

  /**
   * The port for this API service.
   * @returns {number} The default port for this service.
   */
  static get port() {
    return 443;

@@ -354,6 +364,7 @@

  /**
   * The scopes needed to make gRPC calls for every method defined
   * in this service.
   * @returns {string[]} List of default scopes.
   */
  static get scopes() {
    return [

@@ -366,8 +377,7 @@

  getProjectId(callback: Callback<string, undefined, undefined>): void;
  /**
   * Return the project ID used by this class.
   * @param {function(Error, string)} callback - the callback to
   *   be called with the current project Id.
   * @returns {Promise} A promise that resolves to string containing the project ID.
   */
  getProjectId(
    callback?: Callback<string, undefined, undefined>

@@ -428,7 +438,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [InstanceConfig]{@link google.spanner.admin.instance.v1.InstanceConfig}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.getInstanceConfig(request);
   */
  getInstanceConfig(
    request: protos.google.spanner.admin.instance.v1.IGetInstanceConfigRequest,

@@ -524,7 +538,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Instance]{@link google.spanner.admin.instance.v1.Instance}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.getInstance(request);
   */
  getInstance(
    request: protos.google.spanner.admin.instance.v1.IGetInstanceRequest,

@@ -626,7 +644,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.deleteInstance(request);
   */
  deleteInstance(
    request: protos.google.spanner.admin.instance.v1.IDeleteInstanceRequest,

@@ -723,7 +745,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Policy]{@link google.iam.v1.Policy}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.setIamPolicy(request);
   */
  setIamPolicy(
    request: protos.google.iam.v1.ISetIamPolicyRequest,

@@ -811,7 +837,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Policy]{@link google.iam.v1.Policy}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.getIamPolicy(request);
   */
  getIamPolicy(
    request: protos.google.iam.v1.IGetIamPolicyRequest,

@@ -902,7 +932,11 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [TestIamPermissionsResponse]{@link google.iam.v1.TestIamPermissionsResponse}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
   *   for more details and examples.
   * @example
   * const [response] = await client.testIamPermissions(request);
   */
  testIamPermissions(
    request: protos.google.iam.v1.ITestIamPermissionsRequest,

@@ -1032,8 +1066,15 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   The first element of the array is an object representing
   *   a long running operation. Its `promise()` method returns a promise
   *   you can `await` for.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const [operation] = await client.createInstance(request);
   * const [response] = await operation.promise();
   */
  createInstance(
    request: protos.google.spanner.admin.instance.v1.ICreateInstanceRequest,

@@ -1084,6 +1125,43 @@

1084	1125		this.initialize();
1085	1126		return this.innerApiCalls.createInstance(request, options, callback);
1086	1127		}
	1128	+	/**
	1129	+	* Check the status of the long running operation returned by `createInstance()`.
	1130	+	* @param {String} name
	1131	+	* The operation name that will be passed.
	1132	+	* @returns {Promise} - The promise which resolves to an object.
	1133	+	* The decoded operation object has result and metadata field to get information from.
	1134	+	* Please see the
	1135	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
	1136	+	* for more details and examples.
	1137	+	* @example
	1138	+	* const decodedOperation = await checkCreateInstanceProgress(name);
	1139	+	* console.log(decodedOperation.result);
	1140	+	* console.log(decodedOperation.done);
	1141	+	* console.log(decodedOperation.metadata);
	1142	+	*/
	1143	+	async checkCreateInstanceProgress(
	1144	+	name: string
	1145	+	): Promise<
	1146	+	LROperation<
	1147	+	protos.google.spanner.admin.instance.v1.Instance,
	1148	+	protos.google.spanner.admin.instance.v1.CreateInstanceMetadata
	1149	+	>
	1150	+	> {
	1151	+	const request = new operationsProtos.google.longrunning.GetOperationRequest(
	1152	+	{name}
	1153	+	);
	1154	+	const [operation] = await this.operationsClient.getOperation(request);
	1155	+	const decodeOperation = new gax.Operation(
	1156	+	operation,
	1157	+	this.descriptors.longrunning.createInstance,
	1158	+	gax.createDefaultBackoffSettings()
	1159	+	);
	1160	+	return decodeOperation as LROperation<
	1161	+	protos.google.spanner.admin.instance.v1.Instance,
	1162	+	protos.google.spanner.admin.instance.v1.CreateInstanceMetadata
	1163	+	>;
	1164	+	}
1087	1165		updateInstance(
1088	1166		request: protos.google.spanner.admin.instance.v1.IUpdateInstanceRequest,
1089	1167		options?: gax.CallOptions

@@ -1175,8 +1253,15 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is an object representing [Operation]{@link google.longrunning.Operation}.
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   The first element of the array is an object representing
   *   a long running operation. Its `promise()` method returns a promise
   *   you can `await` for.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
   *   for more details and examples.
   * @example
   * const [operation] = await client.updateInstance(request);
   * const [response] = await operation.promise();
   */
  updateInstance(
    request: protos.google.spanner.admin.instance.v1.IUpdateInstanceRequest,

@@ -1227,6 +1312,43 @@

1227	1312		this.initialize();
1228	1313		return this.innerApiCalls.updateInstance(request, options, callback);
1229	1314		}
	1315	+	/**
	1316	+	* Check the status of the long running operation returned by `updateInstance()`.
	1317	+	* @param {String} name
	1318	+	* The operation name that will be passed.
	1319	+	* @returns {Promise} - The promise which resolves to an object.
	1320	+	* The decoded operation object has result and metadata field to get information from.
	1321	+	* Please see the
	1322	+	* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
	1323	+	* for more details and examples.
	1324	+	* @example
	1325	+	* const decodedOperation = await checkUpdateInstanceProgress(name);
	1326	+	* console.log(decodedOperation.result);
	1327	+	* console.log(decodedOperation.done);
	1328	+	* console.log(decodedOperation.metadata);
	1329	+	*/
	1330	+	async checkUpdateInstanceProgress(
	1331	+	name: string
	1332	+	): Promise<
	1333	+	LROperation<
	1334	+	protos.google.spanner.admin.instance.v1.Instance,
	1335	+	protos.google.spanner.admin.instance.v1.UpdateInstanceMetadata
	1336	+	>
	1337	+	> {
	1338	+	const request = new operationsProtos.google.longrunning.GetOperationRequest(
	1339	+	{name}
	1340	+	);
	1341	+	const [operation] = await this.operationsClient.getOperation(request);
	1342	+	const decodeOperation = new gax.Operation(
	1343	+	operation,
	1344	+	this.descriptors.longrunning.updateInstance,
	1345	+	gax.createDefaultBackoffSettings()
	1346	+	);
	1347	+	return decodeOperation as LROperation<
	1348	+	protos.google.spanner.admin.instance.v1.Instance,
	1349	+	protos.google.spanner.admin.instance.v1.UpdateInstanceMetadata
	1350	+	>;
	1351	+	}
1230	1352		listInstanceConfigs(
1231	1353		request: protos.google.spanner.admin.instance.v1.IListInstanceConfigsRequest,
1232	1354		options?: gax.CallOptions

@@ -1278,19 +1400,14 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is Array of [InstanceConfig]{@link google.spanner.admin.instance.v1.InstanceConfig}.
   *   The client library support auto-pagination by default: it will call the API as many
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed and will merge results from all the pages into this array.
   *
   *   When autoPaginate: false is specified through options, the array has three elements.
   *   The first element is Array of [InstanceConfig]{@link google.spanner.admin.instance.v1.InstanceConfig} that corresponds to
   *   the one page received from the API server.
   *   If the second element is not null it contains the request object of type [ListInstanceConfigsRequest]{@link google.spanner.admin.instance.v1.ListInstanceConfigsRequest}
   *   that can be used to obtain the next page of the results.
   *   If it is null, the next page does not exist.
   *   The third element contains the raw response received from the API server. Its type is
   *   [ListInstanceConfigsResponse]{@link google.spanner.admin.instance.v1.ListInstanceConfigsResponse}.
   *
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Note that it can affect your quota.
   *   We recommend using `listInstanceConfigsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listInstanceConfigs(
    request: protos.google.spanner.admin.instance.v1.IListInstanceConfigsRequest,

@@ -1338,18 +1455,7 @@

  }

  /**
   * Equivalent to {@link listInstanceConfigs}, but returns a NodeJS Stream object.
   *
   * This fetches the paged responses for {@link listInstanceConfigs} 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.
   *
   * @see {@link https://nodejs.org/api/stream.html}
   *
   * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -1367,6 +1473,13 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Stream}
   *   An object stream which emits an object representing [InstanceConfig]{@link google.spanner.admin.instance.v1.InstanceConfig} on 'data' event.
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed. Note that it can affect your quota.
   *   We recommend using `listInstanceConfigsAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listInstanceConfigsStream(
    request?: protos.google.spanner.admin.instance.v1.IListInstanceConfigsRequest,

@@ -1391,10 +1504,9 @@

  }

  /**
   * Equivalent to {@link listInstanceConfigs}, but returns an iterable object.
   *
   * for-await-of syntax is used with the iterable to recursively get response element on-demand.
   * Equivalent to `listInstanceConfigs`, but returns an iterable object.
   *
   * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -1411,7 +1523,18 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Object}
   *   An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
   *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
   *   When you iterate the returned iterable, each element will be an object representing
   *   [InstanceConfig]{@link google.spanner.admin.instance.v1.InstanceConfig}. The API will be called under the hood as needed, once per the page,
   *   so you can stop the iteration when you don't need more results.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   * @example
   * const iterable = client.listInstanceConfigsAsync(request);
   * for await (const response of iterable) {
   *   // process response
   * }
   */
  listInstanceConfigsAsync(
    request?: protos.google.spanner.admin.instance.v1.IListInstanceConfigsRequest,

@@ -1505,19 +1628,14 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Promise} - The promise which resolves to an array.
   *   The first element of the array is Array of [Instance]{@link google.spanner.admin.instance.v1.Instance}.
   *   The client library support auto-pagination by default: it will call the API as many
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed and will merge results from all the pages into this array.
   *
   *   When autoPaginate: false is specified through options, the array has three elements.
   *   The first element is Array of [Instance]{@link google.spanner.admin.instance.v1.Instance} that corresponds to
   *   the one page received from the API server.
   *   If the second element is not null it contains the request object of type [ListInstancesRequest]{@link google.spanner.admin.instance.v1.ListInstancesRequest}
   *   that can be used to obtain the next page of the results.
   *   If it is null, the next page does not exist.
   *   The third element contains the raw response received from the API server. Its type is
   *   [ListInstancesResponse]{@link google.spanner.admin.instance.v1.ListInstancesResponse}.
   *
   *   The promise has a method named "cancel" which cancels the ongoing API call.
   *   Note that it can affect your quota.
   *   We recommend using `listInstancesAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listInstances(
    request: protos.google.spanner.admin.instance.v1.IListInstancesRequest,

@@ -1565,18 +1683,7 @@

  }

  /**
   * Equivalent to {@link listInstances}, but returns a NodeJS Stream object.
   *
   * This fetches the paged responses for {@link listInstances} 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.
   *
   * @see {@link https://nodejs.org/api/stream.html}
   *
   * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -1613,6 +1720,13 @@

   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Stream}
   *   An object stream which emits an object representing [Instance]{@link google.spanner.admin.instance.v1.Instance} on 'data' event.
   *   The client library will perform auto-pagination by default: it will call the API as many
   *   times as needed. Note that it can affect your quota.
   *   We recommend using `listInstancesAsync()`
   *   method described below for async iteration which you can stop as needed.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   */
  listInstancesStream(
    request?: protos.google.spanner.admin.instance.v1.IListInstancesRequest,

@@ -1637,10 +1751,9 @@

  }

  /**
   * Equivalent to {@link listInstances}, but returns an iterable object.
   *
   * for-await-of syntax is used with the iterable to recursively get response element on-demand.
   * Equivalent to `listInstances`, but returns an iterable object.
   *
   * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
   * @param {Object} request
   *   The request object that will be sent.
   * @param {string} request.parent

@@ -1676,7 +1789,18 @@

   * @param {object} [options]
   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
   * @returns {Object}
   *   An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
   *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
   *   When you iterate the returned iterable, each element will be an object representing
   *   [Instance]{@link google.spanner.admin.instance.v1.Instance}. The API will be called under the hood as needed, once per the page,
   *   so you can stop the iteration when you don't need more results.
   *   Please see the
   *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
   *   for more details and examples.
   * @example
   * const iterable = client.listInstancesAsync(request);
   * for await (const response of iterable) {
   *   // process response
   * }
   */
  listInstancesAsync(
    request?: protos.google.spanner.admin.instance.v1.IListInstancesRequest,

@@ -1781,9 +1905,33 @@

  }

  /**
   * Terminate the GRPC channel and close the client.
   * Return a fully-qualified project resource name string.
   *
   * @param {string} project
   * @returns {string} Resource name string.
   */
  projectPath(project: string) {
    return this.pathTemplates.projectPathTemplate.render({
      project: project,
    });
  }

  /**
   * Parse the project from Project resource.
   *
   * @param {string} projectName
   *   A fully-qualified path representing Project resource.
   * @returns {string} A string representing the project.
   */
  matchProjectFromProjectName(projectName: string) {
    return this.pathTemplates.projectPathTemplate.match(projectName).project;
  }

  /**
   * Terminate the gRPC channel and close the client.
   *
   * The client will no longer be usable and all future behavior is undefined.
   * @returns {Promise} A promise that resolves when the client is closed.
   */
  close(): Promise<void> {
    this.initialize();

@@ -17,46 +17,52 @@

import {
  ApiError,
  ExistsCallback,
  GetConfig,
  Metadata,
  ServiceObjectConfig,
  GetConfig,
} from '@google-cloud/common';
import {GrpcServiceObject} from './common-grpc/service-object';
import {promisify, promisifyAll} from '@google-cloud/promisify';
import arrify = require('arrify');
// eslint-disable-next-line @typescript-eslint/no-var-requires
const common = require('./common-grpc/service-object');
import {promisify, promisifyAll, callbackifyAll} from '@google-cloud/promisify';
import * as extend from 'extend';
import * as r from 'teeny-request';
import * as streamEvents from 'stream-events';
import * as through from 'through2';
import {Operation as GaxOperation} from 'google-gax';
import {CallOptions, grpc, Operation as GaxOperation} from 'google-gax';
import {Backup} from './backup';
import {BatchTransaction, TransactionIdentifier} from './batch-transaction';
import {google as databaseAdmin} from '../protos/protos';
import * as pumpify from 'pumpify';
import {
  google as databaseAdmin,
  google,
  google as spannerClient,
} from '../protos/protos';
import {
  Instance,
  CreateDatabaseOptions,
  CreateDatabaseCallback,
  CreateDatabaseOptions,
  GetDatabaseOperationsOptions,
  GetDatabaseOperationsResponse,
  Instance,
  GetDatabaseOperationsCallback,
} from './instance';
import {PartialResultStream, Row} from './partial-result-stream';
import {Session} from './session';
import {
  isSessionNotFoundError,
  SessionPool,
  SessionPoolOptions,
  SessionPoolCloseCallback,
  SessionPoolInterface,
  isSessionNotFoundError,
  SessionPoolOptions,
} from './session-pool';
import {Table, CreateTableCallback, CreateTableResponse} from './table';
import {CreateTableCallback, CreateTableResponse, Table} from './table';
import {
  ExecuteSqlRequest,
  RunCallback,
  RunResponse,
  RunUpdateCallback,
  Snapshot,
  TimestampBounds,
  Transaction,
  ExecuteSqlRequest,
  RunUpdateCallback,
  RunResponse,
  RunCallback,
} from './transaction';
import {
  AsyncRunTransactionCallback,

@@ -65,23 +71,21 @@

  RunTransactionOptions,
  TransactionRunner,
} from './transaction-runner';

import {google} from '../protos/protos';
import {
  IOperation,
  Schema,
  LongRunningCallback,
  NormalCallback,
  PagedOptionsWithFilter,
  CLOUD_RESOURCE_HEADER,
  PagedResponse,
  RequestCallback,
  PagedRequest,
  ResourceCallback,
  PagedResponse,
  NormalCallback,
  LongRunningCallback,
  Schema,
} from './common';
import {ServiceError, CallOptions} from 'grpc';
import {Readable, Transform, Duplex} from 'stream';
import {Duplex, Readable, Transform} from 'stream';
import {PreciseDate} from '@google-cloud/precise-date';
import {google as spannerClient} from '../protos/protos';
import {EnumKey, RequestConfig, TranslateEnumKeys} from '.';
import arrify = require('arrify');

type CreateBatchTransactionCallback = ResourceCallback<
  BatchTransaction,

@@ -120,7 +124,7 @@


type ResultSetStats = spannerClient.spanner.v1.ResultSetStats;

type GetSessionsOptions = PagedRequest<google.spanner.v1.IListSessionsRequest>;
export type GetSessionsOptions = PagedOptionsWithFilter;

/**
 * IDatabase structure with database state enum translated to string form.

@@ -166,7 +170,9 @@

>;

export type GetDatabaseConfig = GetConfig &
  databaseAdmin.spanner.admin.database.v1.GetDatabaseRequest;
  databaseAdmin.spanner.admin.database.v1.GetDatabaseRequest & {
    gaxOptions?: CallOptions;
  };
type DatabaseCloseResponse = [google.protobuf.IEmpty];

export type CreateSessionResponse = [

@@ -175,8 +181,8 @@

];

export interface CreateSessionOptions {
  name?: string | null;
  labels?: {[k: string]: string} | null;
  gaxOptions?: CallOptions;
}

export type CreateSessionCallback = ResourceCallback<

@@ -198,7 +204,10 @@

  spannerClient.spanner.v1.IBatchCreateSessionsResponse
>;

export type DatabaseDeleteCallback = NormalCallback<r.Response>;
export type DatabaseDeleteResponse = [databaseAdmin.protobuf.IEmpty];
export type DatabaseDeleteCallback = NormalCallback<
  databaseAdmin.protobuf.IEmpty
>;

export interface CancelableDuplex extends Duplex {
  cancel(): void;

@@ -212,6 +221,11 @@

  databaseAdmin.longrunning.IOperation
];

export type GetRestoreInfoCallback = NormalCallback<IRestoreInfoTranslatedEnum>;
export type GetStateCallback = NormalCallback<
  EnumKey<typeof databaseAdmin.spanner.admin.database.v1.Database.State>
>;

interface DatabaseRequest {
  (
    config: RequestConfig,

@@ -237,11 +251,12 @@

 * const instance = spanner.instance('my-instance');
 * const database = instance.database('my-database');
 */
class Database extends GrpcServiceObject {
class Database extends common.GrpcServiceObject {
  private instance: Instance;
  formattedName_: string;
  pool_: SessionPoolInterface;
  queryOptions_?: spannerClient.spanner.v1.ExecuteSqlRequest.IQueryOptions;
  resourceHeader_: {[k: string]: string};
  request: DatabaseRequest;
  constructor(
    instance: Instance,

@@ -304,7 +319,41 @@

304	319		options: CreateDatabaseOptions,
305	320		callback: CreateDatabaseCallback
306	321		) => {
307		-	return instance.createDatabase(formattedName_, options, callback);
	322	+	const pool = this.pool_ as SessionPool;
	323	+	if (pool._pending > 0) {
	324	+	// If there are BatchCreateSessions requests pending, then we should
	325	+	// wait until these have finished before we try to create the database.
	326	+	// Otherwise the results of these requests might be propagated to
	327	+	// client requests that are submitted after the database has been
	328	+	// created. If the pending requests have not finished within 10 seconds,
	329	+	// they will be ignored and the database creation will proceed.
	330	+	let timeout;
	331	+	const promises = [
	332	+	new Promise<void>(
	333	+	resolve => (timeout = setTimeout(resolve, 10000))
	334	+	),
	335	+	new Promise<void>(resolve => {
	336	+	pool
	337	+	.on('available', () => {
	338	+	if (pool._pending === 0) {
	339	+	clearTimeout(timeout);
	340	+	resolve();
	341	+	}
	342	+	})
	343	+	.on('createError', () => {
	344	+	if (pool._pending === 0) {
	345	+	clearTimeout(timeout);
	346	+	resolve();
	347	+	}
	348	+	});
	349	+	}),
	350	+	];
	351	+	Promise.race(promises).then(() =>
	352	+	instance.createDatabase(formattedName_, options, callback)
	353	+	);
	354	+	} else {
	355	+	return instance.createDatabase(formattedName_, options, callback);
	356	+	}
308	357		},
309	358		} as {}) as ServiceObjectConfig);
310	359

@@ -314,9 +363,11 @@

        : new SessionPool(this, poolOptions);
    this.formattedName_ = formattedName_;
    this.instance = instance;
    this.resourceHeader_ = {
      [CLOUD_RESOURCE_HEADER]: this.formattedName_,
    };
    this.request = instance.request;
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    this.requestStream = instance.requestStream as any;
    this.requestStream = instance.requestStream;
    this.pool_.on('error', this.emit.bind(this, 'error'));
    this.pool_.open();
    this.queryOptions_ = Object.assign(

@@ -417,6 +468,8 @@

        client: 'SpannerClient',
        method: 'batchCreateSessions',
        reqOpts,
        gaxOpts: options.gaxOptions,
        headers: this.resourceHeader_,
      },
      (err, resp) => {
        if (err) {

@@ -555,12 +608,13 @@

        ? (optionsOrCallback as TimestampBounds)
        : {};

    this.createSession((err, session, resp) => {
    this.pool_.getReadSession((err, session) => {
      if (err) {
        callback!(err, null, resp);
        callback!(err, null, undefined);
        return;
      }
      const transaction = this.batchTransaction({session: session!}, options);
      this._releaseOnEnd(session!, transaction);
      transaction.begin((err, resp) => {
        if (err) {
          callback!(err, null, resp!);

@@ -576,6 +630,20 @@

    options: CreateSessionOptions,
    callback: CreateSessionCallback
  ): void;
  /**
   * Create a new session.
   *
   * @typedef {object} CreateSessionOptions
   * @property {Object.<string, string>} [labels] The labels for the session.
   *
   *   * Label keys must be between 1 and 63 characters long and must conform to
   *     the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
   *   * Label values must be between 0 and 63 characters long and must conform
   *     to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
   *   * No more than 64 labels can be associated with a given session.
   * @property {object} [gaxOptions] Request configuration options, outlined
   *     here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
   */
  /**
   * @typedef {array} CreateSessionResponse
   * @property {Session} 0 The newly created session.

@@ -637,10 +705,8 @@

    cb?: CreateSessionCallback
  ): void | Promise<CreateSessionResponse> {
    const callback =
      typeof optionsOrCallback === 'function'
        ? (optionsOrCallback as CreateSessionCallback)
        : cb!;
    const gaxOpts =
      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;
    const options =
      typeof optionsOrCallback === 'object' && optionsOrCallback
        ? extend({}, optionsOrCallback)
        : ({} as CreateSessionOptions);

@@ -649,17 +715,17 @@

      database: this.formattedName_,
    };

    if (gaxOpts.labels) {
      reqOpts.session = {labels: gaxOpts.labels};
      delete gaxOpts.labels;
    if (options.labels) {
      reqOpts.session = {labels: options.labels};
    }

    this.request<google.spanner.v1.ISession>(
      {
        client: 'SpannerClient',
        method: 'createSession',
        reqOpts,
        gaxOpts,
        gaxOpts: options.gaxOptions,
        headers: this.resourceHeader_,
      },
      (err, resp) => {
        if (err) {

@@ -672,8 +738,16 @@

      }
    );
  }
  createTable(schema: Schema): Promise<CreateTableResponse>;
  createTable(schema: Schema, callback?: CreateTableCallback): void;
  createTable(
    schema: Schema,
    gaxOptions?: CallOptions
  ): Promise<CreateTableResponse>;
  createTable(schema: Schema, callback: CreateTableCallback): void;
  createTable(
    schema: Schema,
    gaxOptions: CallOptions,
    callback: CreateTableCallback
  ): void;
  /**
   * @typedef {array} CreateTableResponse
   * @property {Table} 0 The new {@link Table}.

@@ -697,6 +771,8 @@

   * @see {@link Database#updateSchema}
   *
   * @param {string} schema A DDL CREATE statement describing the table.
   * @param {object} [gaxOptions] Request configuration options, outlined here:
   *     https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
   * @param {CreateTableCallback} [callback] Callback function.
   * @returns {Promise<CreateTableResponse>}
   *

@@ -743,9 +819,15 @@

   */
  createTable(
    schema: Schema,
    callback?: CreateTableCallback
    gaxOptionsOrCallback?: CallOptions | CreateTableCallback,
    cb?: CreateTableCallback
  ): void | Promise<CreateTableResponse> {
    this.updateSchema(schema, (err, operation, resp) => {
    const gaxOptions =
      typeof gaxOptionsOrCallback === 'object' ? gaxOptionsOrCallback : {};
    const callback =
      typeof gaxOptionsOrCallback === 'function' ? gaxOptionsOrCallback : cb!;

    this.updateSchema(schema, gaxOptions, (err, operation, resp) => {
      if (err) {
        callback!(err, null, null, resp!);
        return;

@@ -776,17 +858,21 @@

      }
    });
  }
  delete(): Promise<[r.Response]>;
  delete(gaxOptions?: CallOptions): Promise<DatabaseDeleteResponse>;
  delete(callback: DatabaseDeleteCallback): void;
  delete(gaxOptions: CallOptions, callback: DatabaseDeleteCallback): void;
  /**
   * Delete the database.
   *
   * Wrapper around {@link v1.DatabaseAdminClient#dropDatabase}.
   *
   * @see {@link v1.DatabaseAdminClient#dropDatabase}
   * @see [DropDatabase API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase)
   * @param {BasicCallback} [callback] Callback function.
   * @returns {Promise<BasicResponse>}
   *
   * @param {object} [gaxOptions] Request configuration options, outlined here:
   *     https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
   * @param {DatabaseDeleteCallback} [callback] Callback function.
   * @returns {Promise<DatabaseDeleteResponse>}
   *
   * @example
   * const {Spanner} = require('@google-cloud/spanner');

@@ -810,7 +896,15 @@

   *   const apiResponse = data[0];
   * });
   */
  delete(callback?: DatabaseDeleteCallback): void | Promise<[r.Response]> {
  delete(
    optionsOrCallback?: CallOptions | DatabaseDeleteCallback,
    cb?: DatabaseDeleteCallback
  ): void | Promise<DatabaseDeleteResponse> {
    const gaxOpts =
      typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
    const callback =
      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;

    const reqOpts: databaseAdmin.spanner.admin.database.v1.IDropDatabaseRequest = {
      database: this.formattedName_,
    };

@@ -820,13 +914,16 @@

          client: 'DatabaseAdminClient',
          method: 'dropDatabase',
          reqOpts,
          gaxOpts,
          headers: this.resourceHeader_,
        },
        callback!
      );
    });
  }
  exists(): Promise<[boolean]>;
  exists(gaxOptions?: CallOptions): Promise<[boolean]>;
  exists(callback: ExistsCallback): void;
  exists(gaxOptions: CallOptions, callback: ExistsCallback): void;
  /**
   * @typedef {array} DatabaseExistsResponse
   * @property {boolean} 0 Whether the {@link Database} exists.

@@ -840,6 +937,8 @@

   * Check if a database exists.
   *
   * @method Database#exists
   * @param {object} [gaxOptions] Request configuration options, outlined here:
   *     https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
   * @param {DatabaseExistsCallback} [callback] Callback function.
   * @returns {Promise<DatabaseExistsResponse>}
   *

@@ -859,10 +958,18 @@

   *   const exists = data[0];
   * });
   */
  exists(callback?: ExistsCallback): void | Promise<[boolean]> {
  exists(
    gaxOptionsOrCallback?: CallOptions | ExistsCallback,
    cb?: ExistsCallback
  ): void | Promise<[boolean]> {
    const gaxOptions =
      typeof gaxOptionsOrCallback === 'object' ? gaxOptionsOrCallback : {};
    const callback =
      typeof gaxOptionsOrCallback === 'function' ? gaxOptionsOrCallback : cb!;

    const NOT_FOUND = 5;

    this.getMetadata(err => {
    this.getMetadata(gaxOptions, err => {
      if (err && (err as ApiError).code !== NOT_FOUND) {
        callback!(err);
        return;

@@ -928,14 +1035,14 @@

        : ({} as GetDatabaseConfig);
    const callback =
      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb;
    this.getMetadata((err, metadata) => {
    this.getMetadata(options.gaxOptions!, (err, metadata) => {
      if (err) {
        if (options.autoCreate && (err as ApiError).code === 5) {
          this.create(
            options,
            (err, database: Database, operation: GaxOperation) => {
              if (err) {
                callback!(err);
                callback!(err as grpc.ServiceError);
                return;
              }
              operation

@@ -954,8 +1061,9 @@

      callback!(null, this, metadata as r.Response);
    });
  }
  getMetadata(): Promise<GetMetadataResponse>;
  getMetadata(gaxOptions?: CallOptions): Promise<GetMetadataResponse>;
  getMetadata(callback: GetMetadataCallback): void;
  getMetadata(gaxOptions: CallOptions, callback: GetMetadataCallback): void;
  /**
   * @typedef {array} GetDatabaseMetadataResponse
   * @property {object} 0 The {@link Database} metadata.

@@ -974,7 +1082,8 @@

   *
   * @see {@link v1.DatabaseAdminClient#getDatabase}
   * @see [GetDatabase API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase)
   *
   * @param {object} [gaxOptions] Request configuration options, outlined here:
   *     https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
   * @param {GetMetadataCallback} [callback] Callback function.
   * @returns {Promise<GetMetadataResponse>}
   *

@@ -1002,8 +1111,18 @@

   * });
   */
  getMetadata(
    callback?: GetMetadataCallback
    gaxOptionsOrCallback?: CallOptions | GetMetadataCallback,
    cb?: GetMetadataCallback
  ): void | Promise<GetMetadataResponse> {
    const callback =
      typeof gaxOptionsOrCallback === 'function'
        ? (gaxOptionsOrCallback as GetMetadataCallback)
        : cb;
    const gaxOpts =
      typeof gaxOptionsOrCallback === 'object'
        ? (gaxOptionsOrCallback as CallOptions)
        : {};

    const reqOpts: databaseAdmin.spanner.admin.database.v1.IGetDatabaseRequest = {
      name: this.formattedName_,
    };

@@ -1012,11 +1131,23 @@

        client: 'DatabaseAdminClient',
        method: 'getDatabase',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      callback!
      (err, resp) => {
        if (resp) {
          this.metadata = resp;
        }
        callback!(err, resp);
      }
    );
  }

  getRestoreInfo(
    options?: CallOptions
  ): Promise<IRestoreInfoTranslatedEnum | undefined>;
  getRestoreInfo(callback: GetRestoreInfoCallback): void;
  getRestoreInfo(options: CallOptions, callback: GetRestoreInfoCallback): void;
  /**
   * {@link google.spanner.admin.database.v1#RestoreInfo} structure with restore
   * source type enum translated to string form.

@@ -1029,6 +1160,9 @@

   * @see {@link #getMetadata}
   *
   * @method Database#getRestoreInfo
   * @param {object} [gaxOptions] Request configuration options, outlined here:
   *     https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
   * @param {GetRestoreInfoCallback} [callback] Callback function.
   * @returns {Promise<IRestoreInfoTranslatedEnum | undefined>} When resolved,
   *     contains the restore information for the database if it was restored
   *     from a backup.

@@ -1041,11 +1175,24 @@

   * const restoreInfo = await database.getRestoreInfo();
   * console.log(`Database restored from ${restoreInfo.backupInfo.backup}`);
   */
  async getRestoreInfo(): Promise<IRestoreInfoTranslatedEnum | undefined> {
    const [metadata] = await this.getMetadata();
  async getRestoreInfo(
    optionsOrCallback?: CallOptions | GetRestoreInfoCallback
  ): Promise<IRestoreInfoTranslatedEnum | undefined> {
    const gaxOptions =
      typeof optionsOrCallback === 'object' ? optionsOrCallback : {};

    const [metadata] = await this.getMetadata(gaxOptions);
    return metadata.restoreInfo ? metadata.restoreInfo : undefined;
  }

  getState(
    options?: CallOptions
  ): Promise<
    | EnumKey<typeof databaseAdmin.spanner.admin.database.v1.Database.State>
    | undefined
  >;
  getState(callback: GetStateCallback): void;
  getState(options: CallOptions, callback: GetStateCallback): void;
  /**
   * Retrieves the state of the database.
   *

@@ -1055,6 +1202,9 @@

   * @see {@link #getMetadata}
   *
   * @method Database#getState
   * @param {object} [gaxOptions] Request configuration options, outlined here:
   *     https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
   * @param {GetStateCallback} [callback] Callback function.
   * @returns {Promise<EnumKey<typeof, databaseAdmin.spanner.admin.database.v1.Database.State> | undefined>}
   *     When resolved, contains the current state of the database if the state
   *     is defined.

@@ -1067,16 +1217,22 @@

   * const state = await database.getState();
   * const isReady = (state === 'READY');
   */
  async getState(): Promise<
  async getState(
    optionsOrCallback?: CallOptions | GetStateCallback
  ): Promise<
    | EnumKey<typeof databaseAdmin.spanner.admin.database.v1.Database.State>
    | undefined
  > {
    const [metadata] = await this.getMetadata();
    const gaxOptions =
      typeof optionsOrCallback === 'object' ? optionsOrCallback : {};

    const [metadata] = await this.getMetadata(gaxOptions);
    return metadata.state || undefined;
  }

  getSchema(): Promise<GetSchemaResponse>;
  getSchema(options?: CallOptions): Promise<GetSchemaResponse>;
  getSchema(callback: GetSchemaCallback): void;
  getSchema(options: CallOptions, callback: GetSchemaCallback): void;
  /**
   * @typedef {array} GetSchemaResponse
   * @property {string[]} 0 An array of database DDL statements.

@@ -1097,6 +1253,8 @@

   * @see [Data Definition Language (DDL)](https://cloud.google.com/spanner/docs/data-definition-language)
   * @see [GetDatabaseDdl API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl)
   *
   * @param {object} [gaxOptions] Request configuration options, outlined here:
   *     https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
   * @param {GetSchemaCallback} [callback] Callback function.
   * @returns {Promise<GetSchemaResponse>}
   *

@@ -1117,7 +1275,15 @@

   *   const apiResponse = data[1];
   * });
   */
  getSchema(callback?: GetSchemaCallback): void | Promise<GetSchemaResponse> {
  getSchema(
    optionsOrCallback?: CallOptions | GetSchemaCallback,
    cb?: GetSchemaCallback
  ): void | Promise<GetSchemaResponse> {
    const gaxOpts =
      typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
    const callback =
      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;

    const reqOpts: databaseAdmin.spanner.admin.database.v1.IGetDatabaseDdlRequest = {
      database: this.formattedName_,
    };

@@ -1128,6 +1294,8 @@

        client: 'DatabaseAdminClient',
        method: 'getDatabaseDdl',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      // eslint-disable-next-line @typescript-eslint/no-explicit-any
      (err, statements, ...args: any[]) => {

@@ -1141,9 +1309,7 @@

  /**
   * Options object for listing sessions.
   *
   * @typedef {object} GetSessionsRequest
   * @property {boolean} [autoPaginate=true] Have pagination handled
   *     automatically.
   * @typedef {object} GetSessionsOptions
   * @property {string} [filter] An expression for filtering the results of the
   *     request. Filter rules are case insensitive. The fields eligible for
   *     filtering are:

@@ -1158,21 +1324,23 @@

   *     - **`labels.env:dev`** The instance's label env has the value dev.
   *     - **`name:howl labels.env:dev`** The instance's name is howl and it has
   *       the label env with value dev.
   * @property {number} [maxApiCalls] Maximum number of API calls to make.
   * @property {number} [maxResults] Maximum number of items to return.
   * @property {number} [pageSize] Maximum number of results per page.
   * @property {string} [pageToken] A previously-returned page token
   *     representing part of the larger set of results to view.
   * @property {object} [gaxOptions] Request configuration options, outlined
   *     here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
   */
  /**
   * @typedef {array} GetSessionsResponse
   * @property {Session[]} 0 Array of {@link Session} instances.
   * @property {object} 1 The full API response.
   * @property {object} 1 A query object to receive more results.
   * @property {object} 2 The full API response.
   */
  /**
   * @callback GetSessionsCallback
   * @param {?Error} err Request error, if any.
   * @param {Session[]} instances Array of {@link Session} instances.
   * @param {object} nextQuery A query object to receive more results.
   * @param {object} apiResponse The full API response.
   */
  /**

@@ -1210,7 +1378,7 @@

   * }
   *
   * database.getInstances({
   *   autoPaginate: false
   *   gaxOptions: {autoPaginate: false}
   * }, callback);
   *
   * //-

@@ -1227,19 +1395,32 @@

    // eslint-disable-next-line @typescript-eslint/no-this-alias
    const self = this;
    const callback =
      typeof optionsOrCallback === 'function'
        ? (optionsOrCallback as GetSessionsCallback)
        : cb;
      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb;
    const options =
      typeof optionsOrCallback === 'object'
        ? (optionsOrCallback as GetSessionsOptions)
        : {gaxOptions: {}};
    const gaxOpts: CallOptions = options.gaxOptions as CallOptions;
    const reqOpts = extend({}, options, {
        ? optionsOrCallback
        : ({} as GetSessionsOptions);
    const gaxOpts = extend(true, {}, options.gaxOptions);
    let reqOpts = extend({}, options, {
      database: this.formattedName_,
    });

    delete reqOpts.gaxOptions;

    // Copy over pageSize and pageToken values from gaxOptions.
    // However values set on options take precedence.
    if (gaxOpts) {
      reqOpts = extend(
        {},
        {
          pageSize: gaxOpts.pageSize,
          pageToken: gaxOpts.pageToken,
        },
        reqOpts
      );
      delete gaxOpts.pageSize;
      delete gaxOpts.pageToken;
    }

    this.request<
      google.spanner.v1.ISession,
      google.spanner.v1.IListSessionsResponse

@@ -1249,8 +1430,9 @@

        method: 'listSessions',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      (err, sessions, ...args) => {
      (err, sessions, nextPageRequest, ...args) => {
        let sessionInstances: Session[] | null = null;
        if (sessions) {
          sessionInstances = sessions.map(metadata => {

@@ -1259,10 +1441,98 @@

            return session;
          });
        }
        callback!(err, sessionInstances!, ...args);
        const nextQuery = nextPageRequest!
          ? extend({}, options, nextPageRequest!)
          : null;
        callback!(err, sessionInstances!, nextQuery, ...args);
      }
    );
  }

  /**
   * Get a list of sessions as a readable object stream.
   *
   * Wrapper around {@link v1.SpannerClient#listSessions}
   *
   * @see {@link v1.SpannerClient#listSessions}
   * @see [ListSessions API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.Spanner.ListSessions)
   *
   * @method Spanner#getSessionsStream
   * @param {GetSessionsOptions} [options] Options object for listing sessions.
   * @returns {ReadableStream} A readable stream that emits {@link Session}
   *     instances.
   *
   * @example
   * const {Spanner} = require('@google-cloud/spanner');
   * const spanner = new Spanner();
   *
   * const instance = spanner.instance('my-instance');
   * const database = instance.database('my-database');
   *
   * database.getSessionsStream()
   *   .on('error', console.error)
   *   .on('data', function(database) {
   *     // `sessions` is a `Session` object.
   *   })
   *   .on('end', function() {
   *     // All sessions retrieved.
   *   });
   *
   * //-
   * // If you anticipate many results, you can end a stream early to prevent
   * // unnecessary processing and API requests.
   * //-
   * database.getSessionsStream()
   *   .on('data', function(session) {
   *     this.end();
   *   });
   */
  getSessionsStream(options: GetSessionsOptions = {}): NodeJS.ReadableStream {
    const gaxOpts = extend(true, {}, options.gaxOptions);

    let reqOpts = extend({}, options, {
      database: this.formattedName_,
    });
    delete reqOpts.gaxOptions;

    // Copy over pageSize and pageToken values from gaxOptions.
    // However values set on options take precedence.
    if (gaxOpts) {
      reqOpts = extend(
        {},
        {
          pageSize: gaxOpts.pageSize,
          pageToken: gaxOpts.pageToken,
        },
        reqOpts
      );
      delete gaxOpts.pageSize;
      delete gaxOpts.pageToken;
    }

    return new pumpify.obj([
      this.requestStream({
        client: 'SpannerClient',
        method: 'listSessionsStream',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      }),
      new Transform({
        objectMode: true,
        transform: (
          chunk: databaseAdmin.spanner.v1.ISession,
          enc: string,
          cb: Function
        ) => {
          const session = this.session(chunk.name!);
          session.metadata = chunk;
          cb(null, session);
        },
      }),
    ]);
  }

  getSnapshot(options?: TimestampBounds): Promise<[Snapshot]>;
  getSnapshot(callback: GetSnapshotCallback): void;
  getSnapshot(options: TimestampBounds, callback: GetSnapshotCallback): void;

@@ -1284,6 +1554,12 @@

   * called to release the underlying {@link Session}. **Failure to do could
   * result in a Session leak.**
   *
   * **NOTE:** Since the returned {@link Snapshot} transaction is not a
   * single-use transaction, it is invalid to set the `minReadTimestamp` and
   * `maxStaleness` parameters in {@link TimestampBounds} as those parameters
   * can only be set for single-use transactions.
   * https://cloud.google.com/spanner/docs/reference/rest/v1/TransactionOptions#bounded-staleness
   *
   * @see {@link v1.SpannerClient#beginTransaction}
   *
   * @param {TimestampBounds} [options] Timestamp bounds.

@@ -1404,10 +1680,18 @@

      if (!err) {
        this._releaseOnEnd(session!, transaction!);
      }
      callback!(err, transaction);
      callback!(err as grpc.ServiceError | null, transaction);
    });
  }

  getOperations(
    options?: GetDatabaseOperationsOptions
  ): Promise<GetDatabaseOperationsResponse>;
  getOperations(callback: GetDatabaseOperationsCallback): void;
  getOperations(
    options: GetDatabaseOperationsOptions,
    callback: GetDatabaseOperationsCallback
  ): void;
  /**
   * Query object for listing database operations.
   *

@@ -1418,6 +1702,9 @@

   * @property {number} [pageSize] Maximum number of results per page.
   * @property {string} [pageToken] A previously-returned page token
   *     representing part of the larger set of results to view.
   * @property {object} [gaxOptions] Request configuration options, outlined
   *     here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
   * @param {GetDatabaseOperationsCallback} [callback] Callback function.
   */
  /**
   * @typedef {array} GetDatabaseOperationsResponse

@@ -1459,8 +1746,12 @@

   * } while (pageToken);
   */
  async getOperations(
    options?: GetDatabaseOperationsOptions
    optionsOrCallback?:
      | GetDatabaseOperationsOptions
      | GetDatabaseOperationsCallback
  ): Promise<GetDatabaseOperationsResponse> {
    const options =
      typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
    // Create a query that lists database operations only on this database from
    // the instance. Operation name will be prefixed with the database path for
    // all operations on this database

@@ -1529,7 +1820,7 @@

        requestStream.cancel();
      }
    };
    function destroyStream(err: ServiceError) {
    function destroyStream(err: grpc.ServiceError) {
      waitForSessionStream.destroy(err);
    }
    function releaseSession() {

@@ -1628,6 +1919,7 @@

        method: 'restoreDatabase',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      (err, operation, resp) => {
        if (err) {

@@ -1859,20 +2151,41 @@

        return;
      }

      const transaction = session!.partitionedDml();
      this._runPartitionedUpdate(session!, query, callback);
    });
  }

  _runPartitionedUpdate(
    session: Session,
    query: string | ExecuteSqlRequest,
    callback?: RunUpdateCallback
  ): void | Promise<number> {
    const transaction = session.partitionedDml();

      transaction.begin(err => {
    transaction.begin(err => {
      if (err) {
        this.pool_.release(session!);
        callback!(err, 0);
        return;
      }

      transaction.runUpdate(query, (err, updateCount) => {
        if (err) {
          if (err.code !== grpc.status.ABORTED) {
            this.pool_.release(session!);
            callback!(err, 0);
            return;
          }
          this._runPartitionedUpdate(session, query, callback);
        } else {
          this.pool_.release(session!);
          callback!(err, 0);
          callback!(null, updateCount);
          return;
        }

        this._releaseOnEnd(session!, transaction);
        transaction.runUpdate(query, callback!);
      });
    });
  }

  /**
   * Create a readable object stream to receive resulting rows from a SQL
   * statement.

@@ -2018,12 +2331,15 @@

      dataStream
        .once('data', () => (dataReceived = true))
        .once('error', err => {
          if (!dataReceived && isSessionNotFoundError(err)) {
          if (
            !dataReceived &&
            isSessionNotFoundError(err as grpc.ServiceError)
          ) {
            // If it is a 'Session not found' error and we have not yet received
            // any data, we can safely retry the query on a new session.
            // Register the error on the session so the pool can discard it.
            if (session) {
              session.lastError = err;
              session.lastError = err as grpc.ServiceError;
            }
            // Remove the current data stream from the end user stream.
            dataStream.unpipe(proxyStream);

@@ -2141,12 +2457,12 @@

        : {};

    this.pool_.getWriteSession((err, session?, transaction?) => {
      if (err && isSessionNotFoundError(err)) {
      if (err && isSessionNotFoundError(err as grpc.ServiceError)) {
        this.runTransaction(options, runFn!);
        return;
      }
      if (err) {
        runFn!(err);
        runFn!(err as grpc.ServiceError);
        return;
      }


@@ -2307,8 +2623,16 @@

    }
    return new Table(this, name);
  }
  updateSchema(statements: Schema): Promise<UpdateSchemaResponse>;
  updateSchema(
    statements: Schema,
    gaxOptions?: CallOptions
  ): Promise<UpdateSchemaResponse>;
  updateSchema(statements: Schema, callback: UpdateSchemaCallback): void;
  updateSchema(
    statements: Schema,
    gaxOptions: CallOptions,
    callback: UpdateSchemaCallback
  ): void;
  /**
   * Update the schema of the database by creating/altering/dropping tables,
   * columns, indexes, etc.

@@ -2327,6 +2651,8 @@

   * @param {string|string[]|object} statements An array of database DDL
   *     statements, or an
   *     [`UpdateDatabaseDdlRequest` object](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.UpdateDatabaseDdlRequest).
   * @param {object} [gaxOptions] Request configuration options, outlined here:
   *     https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
   * @param {LongRunningOperationCallback} [callback] Callback function.
   * @returns {Promise<LongRunningOperationResponse>}
   *

@@ -2384,8 +2710,14 @@

   */
  updateSchema(
    statements: Schema,
    callback?: UpdateSchemaCallback
    optionsOrCallback?: CallOptions | UpdateSchemaCallback,
    cb?: UpdateSchemaCallback
  ): Promise<UpdateSchemaResponse> | void {
    const gaxOpts =
      typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
    const callback =
      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;

    if (typeof statements === 'string' || Array.isArray(statements)) {
      statements = {
        statements: arrify(statements) as string[],

@@ -2402,6 +2734,8 @@

        client: 'DatabaseAdminClient',
        method: 'updateDatabaseDdl',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      callback!
    );

@@ -2439,17 +2773,49 @@

promisifyAll(Database, {
  exclude: [
    'batchTransaction',
    'getMetadata',
    'getRestoreInfo',
    'getState',
    'getOperations',
    'runTransaction',
    'runTransactionAsync',
    'table',
    'updateSchema',
    'session',
  ],
});

/*! Developer Documentation
 *
 * All async methods (except for streams) will return a Promise in the event
 * that a callback is omitted.
 */
callbackifyAll(Database, {
  exclude: [
    'create',
    'batchCreateSessions',
    'batchTransaction',
    'close',
    'createBatchTransaction',
    'createSession',
    'createTable',
    'delete',
    'exists',
    'get',
    'getMetadata',
    'getSchema',
    'getSessions',
    'getSnapshot',
    'getTransaction',
    'restore',
    'run',
    'runPartitionedUpdate',
    'runTransaction',
    'runTransactionAsync',
    'session',
    'table',
    'updateSchema',
  ],
});

/**
 * Reference to the {@link Database} class.
 * @name module:@google-cloud/spanner.Database

@@ -13,18 +13,24 @@

 * limitations under the License.
 */

import {promisifyAll} from '@google-cloud/promisify';
import {promisifyAll, callbackifyAll} from '@google-cloud/promisify';
import {Instance} from './instance';
import {
  IOperation,
  LongRunningCallback,
  RequestCallback,
  ResourceCallback,
  NormalCallback,
  CLOUD_RESOURCE_HEADER,
} from './common';
import {EnumKey, Spanner, RequestConfig, TranslateEnumKeys} from '.';
import {Metadata, Operation as GaxOperation} from 'google-gax';
import {
  grpc,
  CallOptions,
  Metadata,
  Operation as GaxOperation,
} from 'google-gax';
import {DateStruct, PreciseDate} from '@google-cloud/precise-date';
import {CallOptions, status} from 'grpc';
import {google as databaseAdmin} from '../protos/protos';
import {common as p} from 'protobufjs';


@@ -64,7 +70,7 @@

  databaseAdmin.spanner.admin.database.v1.IBackup
>;

type DeleteCallback = RequestCallback<void>;
type DeleteCallback = RequestCallback<databaseAdmin.protobuf.IEmpty>;

interface BackupRequest {
  (

@@ -73,6 +79,11 @@

  ): void;
  <T>(config: RequestConfig, callback: RequestCallback<T>): void;
}
export type GetStateCallback = NormalCallback<
  EnumKey<typeof databaseAdmin.spanner.admin.database.v1.Backup.State>
>;
export type GetExpireTimeCallback = NormalCallback<PreciseDate>;
export type ExistsCallback = NormalCallback<boolean>;
/**
 * The {@link Backup} class represents a Cloud Spanner backup.
 *

@@ -90,12 +101,17 @@

  id: string;
  formattedName_: string;
  instanceFormattedName_: string;
  resourceHeader_: {[k: string]: string};
  request: BackupRequest;
  metadata?: databaseAdmin.spanner.admin.database.v1.IBackup;
  constructor(instance: Instance, name: string) {
    this.request = instance.request;
    this.instanceFormattedName_ = instance.formattedName_;
    this.formattedName_ = Backup.formatName_(instance.formattedName_, name);
    this.id = this.formattedName_.split('/').pop() || '';
    this.resourceHeader_ = {
      [CLOUD_RESOURCE_HEADER]: this.instanceFormattedName_,
    };
  }

  create(options: CreateBackupOptions): Promise<CreateBackupResponse>;

@@ -154,7 +170,7 @@

    options: CreateBackupOptions,
    callback?: CreateBackupCallback
  ): Promise<CreateBackupResponse> | void {
    const gaxOpts: CallOptions = options.gaxOptions as CallOptions;
    const gaxOpts = options.gaxOptions;
    const reqOpts: databaseAdmin.spanner.admin.database.v1.ICreateBackupRequest = {
      parent: this.instanceFormattedName_,
      backupId: this.id,

@@ -164,12 +180,13 @@

        name: this.formattedName_,
      },
    };
    return this.request(
    this.request(
      {
        client: 'DatabaseAdminClient',
        method: 'createBackup',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      (err, operation, resp) => {
        if (err) {

@@ -181,7 +198,6 @@

    );
  }

  getMetadata(): Promise<GetMetadataResponse>;
  getMetadata(gaxOptions?: CallOptions): Promise<GetMetadataResponse>;
  getMetadata(callback: GetMetadataCallback): void;
  getMetadata(gaxOptions: CallOptions, callback: GetMetadataCallback): void;

@@ -231,19 +247,29 @@

    const reqOpts: databaseAdmin.spanner.admin.database.v1.IGetBackupRequest = {
      name: this.formattedName_,
    };
    return this.request<IBackupTranslatedEnum>(
    this.request<IBackupTranslatedEnum>(
      {
        client: 'DatabaseAdminClient',
        method: 'getBackup',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      (err, response) => {
        if (response) {
          this.metadata = response;
        }
        callback!(err, response);
      }
    );
  }

  getState(): Promise<
    | EnumKey<typeof databaseAdmin.spanner.admin.database.v1.Backup.State>
    | undefined
    | null
  >;
  getState(callback: GetStateCallback): void;
  /**
   * Retrieves the state of the backup.
   *

@@ -252,6 +278,7 @@

   * @see {@link #getMetadata}
   *
   * @method Backup#getState
   * @param {GetStateCallback} [callback] Callback function.
   * @returns {Promise<EnumKey<typeof, databaseAdmin.spanner.admin.database.v1.Backup.State> | undefined>}
   *     When resolved, contains the current state of the backup if it exists.
   *

@@ -266,11 +293,14 @@

  async getState(): Promise<
    | EnumKey<typeof databaseAdmin.spanner.admin.database.v1.Backup.State>
    | undefined
    | null
  > {
    const [backupInfo] = await this.getMetadata();
    return backupInfo.state || undefined;
    return backupInfo.state;
  }

  getExpireTime(): Promise<PreciseDate | undefined>;
  getExpireTime(callback: GetExpireTimeCallback): void;
  /**
   * Retrieves the expiry time of the backup.
   *

@@ -294,6 +324,8 @@

    return new PreciseDate(backupInfo.expireTime as DateStruct);
  }

  exists(): Promise<boolean>;
  exists(callback: ExistsCallback): void;
  /**
   * Checks whether the backup exists.
   *

@@ -318,7 +350,7 @@

      // Found therefore it exists
      return true;
    } catch (err) {
      if (err.code === status.NOT_FOUND) {
      if (err.code === grpc.status.NOT_FOUND) {
        return false;
      }
      // Some other error occurred, rethrow

@@ -393,21 +425,21 @@

        paths: ['expire_time'],
      },
    };
    return this.request<databaseAdmin.spanner.admin.database.v1.IBackup>(
    this.request<databaseAdmin.spanner.admin.database.v1.IBackup>(
      {
        client: 'DatabaseAdminClient',
        method: 'updateBackup',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      (err, response) => {
        callback!(err, response);
      }
    );
  }

  delete(): Promise<void>;
  delete(gaxOptions?: CallOptions): Promise<void>;
  delete(gaxOptions?: CallOptions): Promise<databaseAdmin.protobuf.IEmpty>;
  delete(callback: DeleteCallback): void;
  delete(gaxOptions: CallOptions, callback: DeleteCallback): void;
  /**

@@ -429,7 +461,7 @@

  delete(
    gaxOptionsOrCallback?: CallOptions | DeleteCallback,
    cb?: DeleteCallback
  ): void | Promise<void> {
  ): void | Promise<databaseAdmin.protobuf.IEmpty> {
    const callback =
      typeof gaxOptionsOrCallback === 'function'
        ? (gaxOptionsOrCallback as DeleteCallback)

@@ -441,12 +473,13 @@

    const reqOpts: databaseAdmin.spanner.admin.database.v1.IDeleteBackupRequest = {
      name: this.formattedName_,
    };
    return this.request<databaseAdmin.spanner.admin.database.v1.IBackup>(
    this.request<databaseAdmin.spanner.admin.database.v1.IBackup>(
      {
        client: 'DatabaseAdminClient',
        method: 'deleteBackup',
        reqOpts,
        gaxOpts,
        headers: this.resourceHeader_,
      },
      err => {
        callback!(err);

@@ -488,6 +521,15 @@

  exclude: ['getState', 'getExpireTime', 'exists'],
});

/*! Developer Documentation
 *
 * All async methods (except for streams) will return a Promise in the event
 * that a callback is omitted.
 */
callbackifyAll(Backup, {
  exclude: ['create', 'getMetadata', 'updateExpireTime', 'delete'],
});

/**
 * Reference to the {@link Backup} class.
 * @name module:@google-cloud/spanner.Backup

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Click to load this diff.

Loading diff...

Learn more Showing 9 files with coverage changes found.

Changes in src/transaction-runner.ts

New

Loading file...

New file .prettierrc.js

New

Loading file...

New file .mocharc.js

New

Loading file...

Changes in src/v1/database_admin_client.ts

-1

→

Loading file...

Changes in src/database.ts

-1

→

Loading file...

Changes in src/v1/spanner_client.ts

-1

→

Loading file...

Changes in src/v1/instance_admin_client.ts

-1

→

Loading file...

Changes in src/backup.ts

-1

→

Loading file...

Changes in src/common.ts

-21

→

+21

Loading file...

98.60% 98.40% +<.01%

Merge branch 'master' into improve_streams

AVaksman

#967 8ae1f6e

CI Passed

+51

98.60% 98.40% -0.03%

fix: do not modify options object, use defaultScopes (#1264)

alexander-fenster

6628c6a

CI Passed

+183

+174

98.63% ø ø

test: fix NUMERIC toJSON test expectation (#1262)

skuruppu

3c17b44

CI Passed

Hiding 2 contexual commits

-6

98.60% ø ø

chore: clean up Node.js TOC for cloud-rad (#1256)

yoshi-automation

d8d8f2b

CI Passed

98.60% ø +0.25%

build: only check --engine-strict for production deps (#1255)

yoshi-automation

ee7b10e

CI Passed

-20 Files

-20143

-19755

-10

-378

98.34% ø ø

chore(deps): update dependency @types/big.js to v6 (#1252)

renovate-bot

f7c2db3

CI Passed

98.34% ø -0.25%

fix(deps): update dependency big.js to v6 (#1244)

renovate-bot

259a51e

CI Passed

Hiding 1 contexual commits

+20 Files

+20143

+19755

+10

+378

98.60% 100.00% ø

fix: do not create sessions after getDatabases call (#1228)

olavloite

53d5f37

CI Passed

98.60% ø ø

test: unskip "should list database operations" (#1248)

skuruppu

63b03cd

CI Passed

98.60% ø ø

chore: update bucket for cloud-rad (#1247)

yoshi-automation

29749b9

CI Passed

98.60% ø ø

test: skip tests that filter on get operations (#1246)

skuruppu

7b65691

CI Passed

Hiding 1 contexual commits

98.60% ø ø

docs: update list of available samples (#1239)

yoshi-automation

9d6012c

CI Passed

98.60% ø ø

docs(samples): updated NUMERIC samples (#1238)

skuruppu

cefa3a1

CI Passed

Hiding 2 contexual commits

-50

98.60% 100.00% +<.01%

Merge branch 'master' into improve_streams

#967 bc4c591

#967 ddd3343

Hiding 1 contexual commits

+75

98.60% 100.00% +<.01%

refactor, do not create sessions after getDatabasesStream call

AVaksman

#967 79d0b6f

CI Passed

493	466		* @see {@link v1.InstanceAdminClient#listInstances}
494	467		* @see [ListInstances API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.ListInstances)
495	468		*
496		-	* @param {GetInstancesRequest} [query] Query object for listing instances.
	469	+	* @param {GetInstancesOptions} [options] Query object for listing instances.
497	470		* @param {GetInstancesCallback} [callback] Callback function.
498	471		* @returns {Promise<GetInstancesResponse>}
499	472		*

Compare `fe003c0 ... +116 ... 8ae1f6e`

No flags found

Show failed CI and contexual commits `c`

118 Commits

18	18		* @module spanner/session
19	19		*/
20	20
21		-	import {GrpcServiceObject} from './common-grpc/service-object';
	21	+	// eslint-disable-next-line @typescript-eslint/no-var-requires
	22	+	const common = require('./common-grpc/service-object');
22	23		import {promisifyAll} from '@google-cloud/promisify';
23	24		import * as extend from 'extend';
24	25		import * as r from 'teeny-request';

34	35		CreateSessionCallback,
35	36		CreateSessionOptions,
36	37		} from './database';
37		-	import {ServiceObjectConfig, DeleteCallback} from '@google-cloud/common';
38		-	import {NormalCallback} from './common';
39		-	import {ServiceError} from 'grpc';
	38	+	import {ServiceObjectConfig} from '@google-cloud/common';
	39	+	import {NormalCallback, CLOUD_RESOURCE_HEADER} from './common';
	40	+	import {grpc, CallOptions} from 'google-gax';
40	41
41	42		export type GetSessionResponse = [Session, r.Response];
42	43

55	56
56	57		export type KeepAliveCallback = NormalCallback<google.spanner.v1.IResultSet>;
57	58		export type KeepAliveResponse = [google.spanner.v1.IResultSet];
58		-	export type DeleteResponse = [r.Response];
	59	+	export type DeleteSessionResponse = [google.protobuf.IEmpty];
	60	+	export type DeleteSessionCallback = NormalCallback<google.protobuf.IEmpty>;
	61	+
59	62		/**
60	63		* Create a Session object to interact with a Cloud Spanner session.
61	64		*

94	97		* //-
95	98		* const session = database.session('session-name');
96	99		*/
97		-	export class Session extends GrpcServiceObject {
	100	+	export class Session extends common.GrpcServiceObject {
98	101		id!: string;
99	102		formattedName_?: string;
100	103		type?: types;
101	104		txn?: Transaction;
102	105		lastUsed?: number;
103		-	lastError?: ServiceError;
	106	+	lastError?: grpc.ServiceError;
	107	+	resourceHeader_: {[k: string]: string};
104	108		constructor(database: Database, name?: string) {
105	109		const methods = {
106	110		/**

231	235		},
232	236		} as {}) as ServiceObjectConfig);
233	237
	238	+	this.resourceHeader_ = {
	239	+	[CLOUD_RESOURCE_HEADER]: (this.parent as Database).formattedName_,
	240	+	};
234	241		this.request = database.request;
235	242		this.requestStream = database.requestStream;
236	243
237	244		if (name) {
238	245		this.formattedName_ = Session.formatName_(database.formattedName_, name);
239	246		}
240	247		}
241		-	delete(): Promise<DeleteResponse>;
242		-	delete(callback: DeleteCallback): void;
	248	+	delete(gaxOptions?: CallOptions): Promise<DeleteSessionResponse>;
	249	+	delete(callback: DeleteSessionCallback): void;
	250	+	delete(gaxOptions: CallOptions, callback: DeleteSessionCallback): void;
243	251		/**
244	252		* Delete a session.
245	253		*

248	256		* @see {@link v1.SpannerClient#deleteSession}
249	257		* @see [DeleteSession API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.Spanner.DeleteSession)
250	258		*
251		-	* @param {BasicCallback} [callback] Callback function.
252		-	* @returns {Promise<BasicResponse>}
	259	+	* @param {object} [gaxOptions] Request configuration options, outlined here:
	260	+	* https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
	261	+	* @param {DeleteSessionCallback} [callback] Callback function.
	262	+	* @returns {Promise<DeleteSessionResponse>}
253	263		*
254	264		* @example
255	265		* session.delete(function(err, apiResponse) {

267	277		* const apiResponse = data[0];
268	278		* });
269	279		*/
270		-	delete(callback?: DeleteCallback): void \| Promise<DeleteResponse> {
	280	+	delete(
	281	+	optionsOrCallback?: CallOptions \| DeleteSessionCallback,
	282	+	cb?: DeleteSessionCallback
	283	+	): void \| Promise<DeleteSessionResponse> {
	284	+	const gaxOpts =
	285	+	typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
	286	+	const callback =
	287	+	typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;
	288	+
271	289		const reqOpts = {
272	290		name: this.formattedName_,
273	291		};

276	294		client: 'SpannerClient',
277	295		method: 'deleteSession',
278	296		reqOpts,
	297	+	gaxOpts,
	298	+	headers: this.resourceHeader_,
279	299		},
280	300		callback!
281	301		);
282	302		}
283		-	getMetadata(): Promise<GetSessionMetadataResponse>;
	303	+	getMetadata(gaxOptions?: CallOptions): Promise<GetSessionMetadataResponse>;
284	304		getMetadata(callback: GetSessionMetadataCallback): void;
	305	+	getMetadata(
	306	+	gaxOptions: CallOptions,
	307	+	callback: GetSessionMetadataCallback
	308	+	): void;
285	309		/**
286	310		* @typedef {array} GetSessionMetadataResponse
287	311		* @property {object} 0 The session's metadata.

301	325		* @see {@link v1.SpannerClient#getSession}
302	326		* @see [GetSession API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.Spanner.GetSession)
303	327		*
	328	+	* @param {object} [gaxOptions] Request configuration options, outlined here:
	329	+	* https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
304	330		* @param {GetSessionMetadataCallback} [callback] Callback function.
305	331		* @returns {Promise<GetSessionMetadataResponse>}
306	332		*

316	342		* });
317	343		*/
318	344		getMetadata(
319		-	callback?: GetSessionMetadataCallback
	345	+	optionsOrCallback?: CallOptions \| GetSessionMetadataCallback,
	346	+	cb?: GetSessionMetadataCallback
320	347		): void \| Promise<GetSessionMetadataResponse> {
	348	+	const gaxOpts =
	349	+	typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
	350	+	const callback =
	351	+	typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;
	352	+
321	353		const reqOpts = {
322	354		name: this.formattedName_,
323	355		};

406	376		);
407	377		}
408	378		const formattedName = Instance.formatName_(this.projectId, name);
409		-	const shortName = formattedName.split('/').pop();
	379	+	const displayName = config.displayName \|\| formattedName.split('/').pop();
410	380		const reqOpts = {
411		-	parent: 'projects/' + this.projectId,
412		-	instanceId: shortName,
	381	+	parent: this.projectFormattedName_,
	382	+	instanceId: formattedName.split('/').pop(),
413	383		instance: extend(
414	384		{
415	385		name: formattedName,
416		-	displayName: shortName,
	386	+	displayName,
417	387		nodeCount: config.nodes \|\| 1,
418	388		},
419	389		config
420	390		),
421	391		};
422	392
423	393		delete reqOpts.instance.nodes;
	394	+	delete reqOpts.instance.gaxOptions;
424	395
425		-	if (config.config.indexOf('/') === -1) {
	396	+	if (config.config!.indexOf('/') === -1) {
426	397		reqOpts.instance.config = `projects/${this.projectId}/instanceConfigs/${config.config}`;
427	398		}
428	399		this.request(
429	400		{
430	401		client: 'InstanceAdminClient',
431	402		method: 'createInstance',
432	403		reqOpts,
	404	+	gaxOpts: config.gaxOptions,
	405	+	headers: this.resourceHeader_,
433	406		},
434	407		(err, operation, resp) => {
435	408		if (err) {

632	716		* }
633	717		*
634	718		* spanner.getInstanceConfigs({
635		-	* autoPaginate: false
	719	+	* gaxOptions: {
	720	+	* autoPaginate: false,
	721	+	* }
636	722		* }, callback);
637	723		*
638	724		* //-

764	893		const requestFn = gaxClient[config.method].bind(
765	894		gaxClient,
766	895		reqOpts,
767		-	config.gaxOpts
	896	+	// Add headers to `gaxOpts`
	897	+	extend(true, {}, config.gaxOpts, {
	898	+	otherArgs: {
	899	+	headers: config.headers,
	900	+	},
	901	+	})
768	902		);
769	903		callback(null, requestFn);
770	904		});

969	1117		exclude: [
970	1118		'date',
971	1119		'float',
972		-	'getInstanceConfigs',
973	1120		'instance',
974	1121		'int',
	1122	+	'numeric',
975	1123		'operation',
976	1124		'timestamp',
977	1125		],

326	358		client: 'SpannerClient',
327	359		method: 'getSession',
328	360		reqOpts,
	361	+	gaxOpts,
	362	+	headers: this.resourceHeader_,
329	363		},
330		-	callback!
	364	+	(err, resp) => {
	365	+	if (resp) {
	366	+	this.metadata = resp;
	367	+	}
	368	+	callback!(err, resp);
	369	+	}
331	370		);
332	371		}
333		-	keepAlive(): Promise<KeepAliveResponse>;
	372	+	keepAlive(gaxOptions?: CallOptions): Promise<KeepAliveResponse>;
334	373		keepAlive(callback: KeepAliveCallback): void;
	374	+	keepAlive(gaxOptions: CallOptions, callback: KeepAliveCallback): void;
335	375		/**
336	376		* Ping the session with `SELECT 1` to prevent it from expiring.
337	377		*
	378	+	* @param {object} [gaxOptions] Request configuration options, outlined here:
	379	+	* https://googleapis.github.io/gax-nodejs/classes/CallSettings.html.
338	380		* @param {BasicCallback} [callback] Callback function.
339	381		* @returns {Promise<BasicResponse>}
340	382		*

345	387		* }
346	388		* });
347	389		*/
348		-	keepAlive(callback?: KeepAliveCallback): void \| Promise<KeepAliveResponse> {
	390	+	keepAlive(
	391	+	optionsOrCallback?: CallOptions \| KeepAliveCallback,
	392	+	cb?: KeepAliveCallback
	393	+	): void \| Promise<KeepAliveResponse> {
	394	+	const gaxOpts =
	395	+	typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
	396	+	const callback =
	397	+	typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;
	398	+
349	399		const reqOpts = {
350	400		session: this.formattedName_,
351	401		sql: 'SELECT 1',

355	405		client: 'SpannerClient',
356	406		method: 'executeSql',
357	407		reqOpts,
	408	+	gaxOpts,
	409	+	headers: this.resourceHeader_,
358	410		},
359	411		callback!
360	412		);

15	15		*/
16	16
17	17		import {GrpcService, GrpcServiceConfig} from './common-grpc/service';
18		-	import {paginator} from '@google-cloud/paginator';
19	18		import {PreciseDate} from '@google-cloud/precise-date';
20	19		import {replaceProjectIdToken} from '@google-cloud/projectify';
21	20		import {promisifyAll} from '@google-cloud/promisify';
22	21		import * as extend from 'extend';
23	22		import {GoogleAuth, GoogleAuthOptions} from 'google-auth-library';
24		-	import * as is from 'is';
25	23		import * as path from 'path';
26	24		import {common as p} from 'protobufjs';
27	25		import * as streamEvents from 'stream-events';
28	26		import * as through from 'through2';
29		-	import {codec, Float, Int, SpannerDate, Struct} from './codec';
	27	+	import {codec, Float, Int, Numeric, SpannerDate, Struct} from './codec';
30	28		import {Backup} from './backup';
31	29		import {Database} from './database';
32	30		import {
33	31		Instance,
34	32		CreateInstanceCallback,
35	33		CreateInstanceResponse,
36	34		} from './instance';
	35	+	import {grpc, GrpcClientOptions, CallOptions} from 'google-gax';
37	36		import {google as instanceAdmin} from '../protos/protos';
38		-	import {PagedRequest, PagedResponse, PagedCallback} from './common';
	37	+	import {
	38	+	PagedOptions,
	39	+	PagedResponse,
	40	+	PagedCallback,
	41	+	PagedOptionsWithFilter,
	42	+	CLOUD_RESOURCE_HEADER,
	43	+	} from './common';
39	44		import {Session} from './session';
40	45		import {SessionPool} from './session-pool';
41	46		import {Table} from './table';
42	47		import {PartitionedDml, Snapshot, Transaction} from './transaction';
43		-	import {GrpcClientOptions} from 'google-gax';
44		-	import {ChannelCredentials} from 'grpc';
45		-	import {
46		-	createGcpApiConfig,
47		-	gcpCallInvocationTransformer,
48		-	gcpChannelFactoryOverride,
49		-	} from 'grpc-gcp';
	48	+	import grpcGcpModule = require('grpc-gcp');
	49	+	const grpcGcp = grpcGcpModule(grpc);
50	50		import * as v1 from './v1';
51		-	import * as grpc from 'grpc';
	51	+	import * as pumpify from 'pumpify';
	52	+	import {Transform} from 'stream';
52	53
53	54		// eslint-disable-next-line @typescript-eslint/no-var-requires
54	55		const gcpApiConfig = require('./spanner_grpc_config.json');
55	56
56	57		export type IOperation = instanceAdmin.longrunning.IOperation;
57	58
58		-	export type GetInstancesRequest = PagedRequest<
59		-	instanceAdmin.spanner.admin.instance.v1.IListInstancesRequest & {
60		-	maxResults?: number;
61		-	}
62		-	>;
	59	+	export type GetInstancesOptions = PagedOptionsWithFilter;
	60	+
63	61		export type GetInstancesResponse = PagedResponse<
64	62		Instance,
65	63		instanceAdmin.spanner.admin.instance.v1.IListInstancesResponse

69	67		instanceAdmin.spanner.admin.instance.v1.IListInstancesResponse
70	68		>;
71	69
72		-	export type GetInstanceConfigsRequest = PagedRequest<
73		-	instanceAdmin.spanner.admin.instance.v1.IListInstanceConfigsRequest & {
74		-	maxResults?: number;
75		-	}
76		-	>;
	70	+	export type GetInstanceConfigsOptions = PagedOptions;
77	71		export type GetInstanceConfigsResponse = PagedResponse<
78		-	instanceAdmin.spanner.admin.instance.v1.InstanceConfig,
	72	+	instanceAdmin.spanner.admin.instance.v1.IInstanceConfig,
79	73		instanceAdmin.spanner.admin.instance.v1.IListInstanceConfigsResponse
80	74		>;
81	75		export type GetInstanceConfigsCallback = PagedCallback<
82		-	instanceAdmin.spanner.admin.instance.v1.InstanceConfig,
	76	+	instanceAdmin.spanner.admin.instance.v1.IInstanceConfig,
83	77		instanceAdmin.spanner.admin.instance.v1.IListInstanceConfigsResponse
84	78		>;
85	79
86	80		export interface SpannerOptions extends GrpcClientOptions {
87	81		apiEndpoint?: string;
88	82		servicePath?: string;
89	83		port?: number;
90		-	sslCreds?: ChannelCredentials;
	84	+	sslCreds?: grpc.ChannelCredentials;
91	85		}
92	86		export interface RequestConfig {
93	87		client: string;
94	88		method: string;
95	89		// eslint-disable-next-line @typescript-eslint/no-explicit-any
96	90		reqOpts: any;
97		-	gaxOpts?: {};
	91	+	gaxOpts?: CallOptions;
	92	+	headers: {[k: string]: string};
98	93		}
99	94		export interface CreateInstanceRequest {
100		-	config: string;
	95	+	config?: string;
101	96		nodes?: number;
	97	+	displayName?: string;
102	98		labels?: {[k: string]: string} \| null;
	99	+	gaxOptions?: CallOptions;
103	100		}
104	101		/**
105	102		* Translates enum values to string keys.

161	158		auth: GoogleAuth;
162	159		clients_: Map<string, {}>;
163	160		instances_: Map<string, Instance>;
164		-	getInstancesStream: Function;
	161	+	projectFormattedName_: string;
	162	+	resourceHeader_: {[k: string]: string};
165	163
166	164		/**
167	165		* Placeholder used to auto populate a column with the commit timestamp.

225	223		libVersion: require('../../package.json').version,
226	224		scopes,
227	225		// Enable grpc-gcp support
228		-	'grpc.callInvocationTransformer': gcpCallInvocationTransformer,
229		-	'grpc.channelFactoryOverride': gcpChannelFactoryOverride,
230		-	'grpc.gcpApiConfig': createGcpApiConfig(gcpApiConfig),
	226	+	'grpc.callInvocationTransformer': grpcGcp.gcpCallInvocationTransformer,
	227	+	'grpc.channelFactoryOverride': grpcGcp.gcpChannelFactoryOverride,
	228	+	'grpc.gcpApiConfig': grpcGcp.createGcpApiConfig(gcpApiConfig),
231	229		grpc,
232	230		},
233	231		options \|\| {}

262	260		this.auth = new GoogleAuth(this.options);
263	261		this.clients_ = new Map();
264	262		this.instances_ = new Map();
265		-
266		-	/**
267		-	* Get a list of {@link Instance} objects as a readable object stream.
268		-	*
269		-	* Wrapper around {@link v1.InstanceAdminClient#listInstances}.
270		-	*
271		-	* @see {@link v1.InstanceAdminClient#listInstances}
272		-	* @see [ListInstances API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.ListInstances)
273		-	*
274		-	* @method Spanner#getInstancesStream
275		-	* @param {GetInstancesRequest} [query] Query object for listing instances.
276		-	* @returns {ReadableStream} A readable stream that emits {@link Instance}
277		-	* instances.
278		-	*
279		-	* @example
280		-	* const {Spanner} = require('@google-cloud/spanner');
281		-	* const spanner = new Spanner();
282		-	*
283		-	* spanner.getInstancesStream()
284		-	* .on('error', console.error)
285		-	* .on('data', function(instance) {
286		-	* // `instance` is an `Instance` object.
287		-	* })
288		-	* .on('end', function() {
289		-	* // All instances retrieved.
290		-	* });
291		-	*
292		-	* //-
293		-	* // If you anticipate many results, you can end a stream early to prevent
294		-	* // unnecessary processing and API requests.
295		-	* //-
296		-	* spanner.getInstancesStream()
297		-	* .on('data', function(instance) {
298		-	* this.end();
299		-	* });
300		-	*/
301		-	this.getInstancesStream = paginator.streamify('getInstances');
	263	+	this.projectFormattedName_ = 'projects/' + this.projectId;
	264	+	this.resourceHeader_ = {
	265	+	[CLOUD_RESOURCE_HEADER]: this.projectFormattedName_,
	266	+	};
302	267		}
303	268
304	269		createInstance(

324	289		* be used to control how resource metrics are aggregated. And they can
325	290		* be used as arguments to policy management rules (e.g. route,
326	291		* firewall, load balancing, etc.).
	292	+	* @property {string} [displayName] The descriptive name for this instance
	293	+	* as it appears in UIs. Must be unique per project and between 4 and 30
	294	+	* characters in length.
	295	+	* Defaults to the instance unique identifier '<instance>' of the full
	296	+	* instance name of the form 'projects/<project>/instances/<instance>'.
327	297		*/
328	298		/**
329	299		* @typedef {array} CreateInstanceResponse

442	415		);
443	416		}
444	417
445		-	getInstances(query?: GetInstancesRequest): Promise<GetInstancesResponse>;
	418	+	getInstances(options?: GetInstancesOptions): Promise<GetInstancesResponse>;
446	419		getInstances(callback: GetInstancesCallback): void;
447	420		getInstances(
448		-	query: GetInstancesRequest,
	421	+	query: GetInstancesOptions,
449	422		callback: GetInstancesCallback
450	423		): void;
451	424		/**
452	425		* Query object for listing instances.
453	426		*
454		-	* @typedef {object} GetInstancesRequest
455		-	* @property {boolean} [autoPaginate=true] Have pagination handled
456		-	* automatically.
	427	+	* @typedef {object} GetInstancesOptions
	428	+	* @property {object} [gaxOptions] Request configuration options, outlined
	429	+	* here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
457	430		* @property {string} [filter] An expression for filtering the results of the
458	431		* request. Filter rules are case insensitive. The fields eligible for
459	432		* filtering are:

Compare fe003c0 ... +116 ... 8ae1f6e

No flags found

Show failed CI and contexual commits c 118 Commits

Compare `fe003c0 ... +116 ... 8ae1f6e`

Show failed CI and contexual commits `c`

118 Commits

468	441		* - `labels.env:dev` The instance's label env has the value dev.
469	442		* - `name:howl labels.env:dev` The instance's name is howl and it has
470	443		* the label env with value dev.
471		-	* @property {number} [maxApiCalls] Maximum number of API calls to make.
472		-	* @property {number} [maxResults] Maximum number of items to return.
473	444		* @property {number} [pageSize] Maximum number of results per page.
474	445		* @property {string} [pageToken] A previously-returned page token
475	446		* representing part of the larger set of results to view.
476	447		*/
477	448		/**
478	449		* @typedef {array} GetInstancesResponse
479	450		* @property {Instance[]} 0 Array of {@link Instance} instances.
480		-	* @property {object} 1 The full API response.
	451	+	* @property {object} 1 A query object to receive more results.
	452	+	* @property {object} 2 The full API response.
481	453		*/
482	454		/**
483	455		* @callback GetInstancesCallback
484	456		* @param {?Error} err Request error, if any.
485	457		* @param {Instance[]} instances Array of {@link Instance} instances.
	458	+	* @param {string} nextQuery A query object to receive more results.
486	459		* @param {object} apiResponse The full API response.
487	460		*/
488	461		/**

517	490		* }
518	491		*
519	492		* spanner.getInstances({
520		-	* autoPaginate: false
	493	+	* gaxOptions: {
	494	+	* autoPaginate: false,
	495	+	* }
521	496		* }, callback);
522	497		*
523	498		* //-

528	503		* });
529	504		*/
530	505		getInstances(
531		-	query?: GetInstancesRequest \| GetInstancesCallback,
532		-	callback?: GetInstancesCallback
	506	+	optionsOrCallback?: GetInstancesOptions \| GetInstancesCallback,
	507	+	cb?: GetInstancesCallback
533	508		): Promise<GetInstancesResponse> \| void {
534	509		// eslint-disable-next-line @typescript-eslint/no-this-alias
535	510		const self = this;
536		-	if (is.fn(query)) {
537		-	callback = query as GetInstancesCallback;
538		-	query = {};
539		-	}
540		-	const reqOpts = extend({}, query, {
	511	+	const options =
	512	+	typeof optionsOrCallback === 'object'
	513	+	? optionsOrCallback
	514	+	: ({} as GetInstancesOptions);
	515	+	const callback =
	516	+	typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;
	517	+
	518	+	const gaxOpts = extend(true, {}, options.gaxOptions);
	519	+
	520	+	let reqOpts = extend({}, options, {
541	521		parent: 'projects/' + this.projectId,
542	522		});
	523	+
	524	+	delete reqOpts.gaxOptions;
	525	+
	526	+	// Copy over pageSize and pageToken values from gaxOptions.
	527	+	// However values set on options take precedence.
	528	+	if (gaxOpts) {
	529	+	reqOpts = extend(
	530	+	{},
	531	+	{
	532	+	pageSize: gaxOpts.pageSize,
	533	+	pageToken: gaxOpts.pageToken,
	534	+	},
	535	+	reqOpts
	536	+	);
	537	+	delete gaxOpts.pageToken;
	538	+	delete gaxOpts.pageSize;
	539	+	}
	540	+
543	541		this.request(
544	542		{
545	543		client: 'InstanceAdminClient',
546	544		method: 'listInstances',
547	545		reqOpts,
548		-	gaxOpts: query,
	546	+	gaxOpts,
	547	+	headers: this.resourceHeader_,
549	548		},
550		-	(err, instances, ...args) => {
	549	+	(err, instances, nextPageRequest, ...args) => {
551	550		let instanceInstances: Instance[] \| null = null;
552	551		if (instances) {
553	552		instanceInstances = instances.map(instance => {

556	555		return instanceInstance;
557	556		});
558	557		}
559		-	callback!(err, instanceInstances, ...args);
	558	+	const nextQuery = nextPageRequest!
	559	+	? extend({}, options, nextPageRequest!)
	560	+	: null;
	561	+	callback!(err, instanceInstances, nextQuery, ...args);
560	562		}
561	563		);
562	564		}
563	565
	566	+	/**
	567	+	* Get a list of {@link Instance} objects as a readable object stream.
	568	+	*
	569	+	* Wrapper around {@link v1.InstanceAdminClient#listInstances}.
	570	+	*
	571	+	* @see {@link v1.InstanceAdminClient#listInstances}
	572	+	* @see [ListInstances API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.ListInstances)
	573	+	*
	574	+	* @method Spanner#getInstancesStream
	575	+	* @param {GetInstancesOptions} [options] Query object for listing instances.
	576	+	* @returns {ReadableStream} A readable stream that emits {@link Instance}
	577	+	* instances.
	578	+	*
	579	+	* @example
	580	+	* const {Spanner} = require('@google-cloud/spanner');
	581	+	* const spanner = new Spanner();
	582	+	*
	583	+	* spanner.getInstancesStream()
	584	+	* .on('error', console.error)
	585	+	* .on('data', function(instance) {
	586	+	* // `instance` is an `Instance` object.
	587	+	* })
	588	+	* .on('end', function() {
	589	+	* // All instances retrieved.
	590	+	* });
	591	+	*
	592	+	* //-
	593	+	* // If you anticipate many results, you can end a stream early to prevent
	594	+	* // unnecessary processing and API requests.
	595	+	* //-
	596	+	* spanner.getInstancesStream()
	597	+	* .on('data', function(instance) {
	598	+	* this.end();
	599	+	* });
	600	+	*/
	601	+	getInstancesStream(options: GetInstancesOptions = {}): NodeJS.ReadableStream {
	602	+	const gaxOpts = extend(true, {}, options.gaxOptions);
	603	+
	604	+	let reqOpts = extend({}, options, {
	605	+	parent: 'projects/' + this.projectId,
	606	+	});
	607	+	delete reqOpts.gaxOptions;
	608	+
	609	+	// Copy over pageSize and pageToken values from gaxOptions.
	610	+	// However values set on options take precedence.
	611	+	if (gaxOpts) {
	612	+	reqOpts = extend(
	613	+	{},
	614	+	{
	615	+	pageSize: gaxOpts.pageSize,
	616	+	pageToken: gaxOpts.pageToken,
	617	+	},
	618	+	reqOpts
	619	+	);
	620	+	delete gaxOpts.pageSize;
	621	+	delete gaxOpts.pageToken;
	622	+	}
	623	+
	624	+	return new pumpify.obj([
	625	+	this.requestStream({
	626	+	client: 'InstanceAdminClient',
	627	+	method: 'listInstancesStream',
	628	+	reqOpts,
	629	+	gaxOpts,
	630	+	headers: this.resourceHeader_,
	631	+	}),
	632	+	new Transform({
	633	+	objectMode: true,
	634	+	transform: (
	635	+	chunk: instanceAdmin.spanner.admin.instance.v1.IInstance,
	636	+	enc: string,
	637	+	cb: Function
	638	+	) => {
	639	+	const instance = this.instance(chunk.name!);
	640	+	instance.metadata = chunk;
	641	+	cb(null, instance);
	642	+	},
	643	+	}),
	644	+	]);
	645	+	}
	646	+
564	647		getInstanceConfigs(
565		-	query?: GetInstanceConfigsRequest
	648	+	query?: GetInstanceConfigsOptions
566	649		): Promise<GetInstanceConfigsResponse>;
567	650		getInstanceConfigs(callback: GetInstanceConfigsCallback): void;
568	651		getInstanceConfigs(
569		-	query: GetInstanceConfigsRequest,
	652	+	query: GetInstanceConfigsOptions,
570	653		callback: GetInstanceConfigsCallback
571	654		): void;
572	655		/**
573		-	* Query object for listing instance configs.
	656	+	* Lists the supported instance configurations for a given project.
574	657		*
575		-	* @typedef {object} GetInstanceConfigsRequest
576		-	* @property {boolean} [autoPaginate=true] Have pagination handled
577		-	* automatically.
578		-	* @property {number} [maxApiCalls] Maximum number of API calls to make.
579		-	* @property {number} [maxResults] Maximum number of items to return.
	658	+	* @typedef {object} GetInstanceConfigsOptions
580	659		* @property {number} [pageSize] Maximum number of results per page.
581	660		* @property {string} [pageToken] A previously-returned page token
582	661		* representing part of the larger set of results to view.
	662	+	* @property {object} [gaxOptions] Request configuration options, outlined
	663	+	* here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
	664	+
583	665		*/
584	666		/**
585	667		* @typedef {array} GetInstanceConfigsResponse
586	668		* @property {object[]} 0 List of all available instance configs.
587	669		* @property {string} 0.name The unique identifier for the instance config.
588	670		* @property {string} 0.displayName The name of the instance config as it
589	671		* appears in UIs.
590		-	* @property {object} 1 The full API response.
	672	+	* @property {object} 1 A query object to receive more results.
	673	+	* @property {object} 2 The full API response.
591	674		*/
592	675		/**
593	676		* @callback GetInstanceConfigsCallback

597	680		* config.
598	681		* @param {string} instanceConfigs.displayName The name of the instance config
599	682		* as it appears in UIs.
	683	+	* @param {object} nextQuery A query object to receive more results.
600	684		* @param {object} apiResponse The full API response.
601	685		*/
602	686		/**

607	691		* @see {@link v1.InstanceAdminClient#listInstanceConfigs}
608	692		* @see [ListInstanceConfigs API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs)
609	693		*
610		-	* @param {GetInstanceConfigsRequest} [query] Query object for listing instance
	694	+	* @param {GetInstanceConfigsOptions} [options] Query object for listing instance
611	695		* configs.
612	696		* @param {GetInstanceConfigsCallback} [callback] Callback function.
613	697		* @returns {Promise<GetInstanceConfigsResponse>}

643	729		* });
644	730		*/
645	731		getInstanceConfigs(
646		-	queryOrCallback?: GetInstanceConfigsRequest \| GetInstanceConfigsCallback,
	732	+	optionsOrCallback?: GetInstanceConfigsOptions \| GetInstanceConfigsCallback,
647	733		cb?: GetInstanceConfigsCallback
648	734		): Promise<GetInstanceConfigsResponse> \| void {
649	735		const callback =
650		-	typeof queryOrCallback === 'function'
651		-	? (queryOrCallback as GetInstanceConfigsCallback)
652		-	: cb;
653		-	const query =
654		-	typeof queryOrCallback === 'object'
655		-	? (queryOrCallback as GetInstanceConfigsRequest)
656		-	: {};
657		-	const reqOpts = extend({}, query, {
	736	+	typeof optionsOrCallback === 'function' ? optionsOrCallback : cb;
	737	+	const options =
	738	+	typeof optionsOrCallback === 'object'
	739	+	? optionsOrCallback
	740	+	: ({} as GetInstanceConfigsOptions);
	741	+
	742	+	const gaxOpts = extend(true, {}, options.gaxOptions);
	743	+	let reqOpts = extend({}, options, {
658	744		parent: 'projects/' + this.projectId,
659	745		});
	746	+	delete reqOpts.gaxOptions;
	747	+
	748	+	// Copy over pageSize and pageToken values from gaxOptions.
	749	+	// However values set on options take precedence.
	750	+	if (gaxOpts) {
	751	+	reqOpts = extend(
	752	+	{},
	753	+	{
	754	+	pageSize: gaxOpts.pageSize,
	755	+	pageToken: gaxOpts.pageToken,
	756	+	},
	757	+	reqOpts
	758	+	);
	759	+	delete gaxOpts.pageSize;
	760	+	delete gaxOpts.pageToken;
	761	+	}
	762	+
660	763		return this.request(
661	764		{
662	765		client: 'InstanceAdminClient',
663	766		method: 'listInstanceConfigs',
664	767		reqOpts,
665		-	gaxOpts: query,
	768	+	gaxOpts,
	769	+	headers: this.resourceHeader_,
666	770		},
667		-	callback
	771	+	(err, instanceConfigs, nextPageRequest, ...args) => {
	772	+	const nextQuery = nextPageRequest!
	773	+	? extend({}, options, nextPageRequest!)
	774	+	: null;
	775	+	callback!(err, instanceConfigs, nextQuery, ...args);
	776	+	}
668	777		);
669	778		}
670	779

677	786		* @see [ListInstanceConfigs API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs)
678	787		*
679	788		* @method Spanner#getInstanceConfigsStream
680		-	* @param {GetInstanceConfigsRequest} [query] Query object for listing instance
	789	+	* @param {GetInstanceConfigsOptions} [options] Query object for listing instance
681	790		* configs.
682	791		* @returns {ReadableStream} A readable stream that emits instance configs.
683	792		*

702	811		* });
703	812		*/
704	813		getInstanceConfigsStream(
705		-	query?: GetInstanceConfigsRequest
	814	+	options: GetInstanceConfigsOptions = {}
706	815		): NodeJS.ReadableStream {
707		-	const reqOpts = extend({}, query, {
	816	+	const gaxOpts = extend(true, {}, options.gaxOptions);
	817	+
	818	+	let reqOpts = extend({}, options, {
708	819		parent: 'projects/' + this.projectId,
709	820		});
	821	+
	822	+	// Copy over pageSize and pageToken values from gaxOptions.
	823	+	// However values set on options take precedence.
	824	+	if (gaxOpts) {
	825	+	reqOpts = extend(
	826	+	{},
	827	+	{
	828	+	pageSize: gaxOpts.pageSize,
	829	+	pageToken: gaxOpts.pageToken,
	830	+	},
	831	+	reqOpts
	832	+	);
	833	+	delete gaxOpts.pageSize;
	834	+	delete gaxOpts.pageToken;
	835	+	}
	836	+
	837	+	delete reqOpts.gaxOptions;
710	838		return this.requestStream({
711	839		client: 'InstanceAdminClient',
712	840		method: 'listInstanceConfigsStream',
713	841		reqOpts,
714		-	gaxOpts: query,
	842	+	gaxOpts,
	843	+	headers: this.resourceHeader_,
715	844		});
716	845		}
717	846

783	917		*/
784	918		// eslint-disable-next-line @typescript-eslint/no-explicit-any
785	919		request(config: any, callback?: any): any {
786		-	if (is.fn(callback)) {
	920	+	if (typeof callback === 'function') {
787	921		this.prepareGapicRequest_(config, (err, requestFn) => {
788	922		if (err) {
789	923		callback(err);