Class Session (7.5.0)

Package

Example

const {Spanner} = require('@google-cloud/spanner');
const spanner = new Spanner();

const instance = spanner.instance('my-instance');
const database = instance.database('my-database');

//-
// To create a session manually, don't provide a name.
//-
const session = database.session();

session.create(function(err) {
  if (err) {
    // Error handling omitted.
  }

  // Session created successfully.
  // `session.id` = The name of the session.
});

//-
// To access a previously-created session, provide a name.
//-
const session = database.session('session-name');

Constructors

(constructor)(database, name)

constructor(database: Database, name?: string);

Properties

formattedName_

formattedName_?: string;

id

id: string;

lastError

lastError?: grpc.ServiceError;

lastUsed

lastUsed?: number;

resourceHeader_

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

txn

txn?: Transaction;

Methods

delete(gaxOptions)

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

session.delete(function(err, apiResponse) {
  if (err) {
    // Error handling omitted.
  }

  // Session deleted successfully.
});

//-
//Returns a Promise if the callback is omitted.
//-
session.delete().then(function(data) {
  const apiResponse = data[0];
});

delete(callback)

delete(callback: DeleteSessionCallback): void;

delete(gaxOptions, callback)

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

formatName_(databaseName, name)

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

Session.formatName_('my-database', 'my-session');
// 'projects/grape-spaceship-123/instances/my-instance/' +
// 'databases/my-database/sessions/my-session'

getMetadata(gaxOptions)

getMetadata(gaxOptions?: CallOptions): Promise<GetSessionMetadataResponse>;

session.getMetadata(function(err, metadata, apiResponse) {});

//-
//Returns a Promise if the callback is omitted.
//-
session.getMetadata().then(function(data) {
  const metadata = data[0];
  const apiResponse = data[1];
});

getMetadata(callback)

getMetadata(callback: GetSessionMetadataCallback): void;

getMetadata(gaxOptions, callback)

getMetadata(gaxOptions: CallOptions, callback: GetSessionMetadataCallback): void;

keepAlive(gaxOptions)

keepAlive(gaxOptions?: CallOptions): Promise<KeepAliveResponse>;

session.keepAlive(function(err) {
  if (err) {
    // An error occurred while trying to keep this session alive.
  }
});

keepAlive(callback)

keepAlive(callback: KeepAliveCallback): void;

keepAlive(gaxOptions, callback)

keepAlive(gaxOptions: CallOptions, callback: KeepAliveCallback): void;

partitionedDml()

partitionedDml(): PartitionedDml;

const transaction = session.partitionedDml();

snapshot(options, queryOptions)

snapshot(options?: TimestampBounds, queryOptions?: google.spanner.v1.ExecuteSqlRequest.IQueryOptions): Snapshot;

const snapshot = session.snapshot({strong: false});

transaction(queryOptions, requestOptions)

transaction(queryOptions?: google.spanner.v1.ExecuteSqlRequest.IQueryOptions, requestOptions?: Pick<IRequestOptions, 'transactionTag'>): Transaction;

const transaction = session.transaction();