Class Table

Create a Table object to interact with a table in a Cloud Spanner database.

Package

@google-cloud/spanner!

Constructors

(constructor)(database, name)

  constructor 
 ( 
 database 
 : 
  
 Database 
 , 
  
 name 
 : 
  
 string 
 );

Constructs a new instance of the Table class

Parameters

Type	Name	Description
Database	database
string	name

Properties

database

  database 
 : 
  
 Database 
 ;

Property Value

Type	Description
Database

name

  name 
 : 
  
 string 
 ;

Property Value

Type	Description
string

Methods

create(schema, gaxOptions)

  create 
 ( 
 schema 
 : 
  
 Schema 
 , 
  
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<CreateTableResponse> 
 ;

Parameters

Type	Name	Description
Schema	schema
CallOptions	gaxOptions

Returns

Type	Description
Promise < CreateTableResponse >

create(schema, callback)

  create 
 ( 
 schema 
 : 
  
 Schema 
 , 
  
 callback 
 : 
  
 CreateTableCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
Schema	schema
CreateTableCallback	callback

Returns

Type	Description
void

create(schema, gaxOptions, callback)

  create 
 ( 
 schema 
 : 
  
 Schema 
 , 
  
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 CreateTableCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
Schema	schema
CallOptions	gaxOptions
CreateTableCallback	callback

Returns

Type	Description
void

createReadStream(request, options)

  createReadStream 
 ( 
 request 
 : 
  
 ReadRequest 
 , 
  
 options 
 ?: 
  
 TimestampBounds 
 ) 
 : 
  
 PartialResultStream 
 ;

Create a readable object stream to receive rows from the database using key lookups and scans.

[StreamingRead API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.Spanner.StreamingRead) [ReadRequest API Documentation](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.ReadRequest)

Parameters

Type	Name	Description
ReadRequest	request
TimestampBounds	options	[Transaction options]( https://cloud.google.com/spanner/docs/timestamp-bounds ).

Returns

Type	Description
PartialResultStream	{PartialResultStream} A readable stream that emits rows.

delete(gaxOptions)

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

Parameter

Type	Name	Description
CallOptions	gaxOptions

Returns

Type	Description
Promise < DropTableResponse >

delete(callback)

  delete 
 ( 
 callback 
 : 
  
 DropTableCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Type	Name	Description
DropTableCallback	callback

Returns

Type	Description
void

delete(gaxOptions, callback)

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

Parameters

Type	Name	Description
CallOptions	gaxOptions
DropTableCallback	callback

Returns

Type	Description
void

deleteRows(keys, options)

  deleteRows 
 ( 
 keys 
 : 
  
 Key 
 [], 
  
 options 
 ?: 
  
 DeleteRowsOptions 
  
 | 
  
 CallOptions 
 ) 
 : 
  
 Promise<DeleteRowsResponse> 
 ;

Parameters

Type	Name	Description
Key []	keys
DeleteRowsOptions \| CallOptions	options

Returns

Type	Description
Promise < DeleteRowsResponse >

deleteRows(keys, callback)

  deleteRows 
 ( 
 keys 
 : 
  
 Key 
 [], 
  
 callback 
 : 
  
 DeleteRowsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
Key []	keys
DeleteRowsCallback	callback

Returns

Type	Description
void

deleteRows(keys, options, callback)

  deleteRows 
 ( 
 keys 
 : 
  
 Key 
 [], 
  
 options 
 : 
  
 DeleteRowsOptions 
  
 | 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 DeleteRowsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
Key []	keys
DeleteRowsOptions \| CallOptions	options
DeleteRowsCallback	callback

Returns

Type	Description
void

drop(gaxOptions)

  drop 
 ( 
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<DropTableResponse> 
 ;

Parameter

Type	Name	Description
CallOptions	gaxOptions

Returns

Type	Description
Promise < DropTableResponse >

drop(callback)

  drop 
 ( 
 callback 
 : 
  
 DropTableCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Type	Name	Description
DropTableCallback	callback

Returns

Type	Description
void

drop(gaxOptions, callback)

  drop 
 ( 
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 DropTableCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
CallOptions	gaxOptions
DropTableCallback	callback

Returns

Type	Description
void

insert(rows, options)

  insert 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 options 
 ?: 
  
 InsertRowsOptions 
  
 | 
  
 CallOptions 
 ) 
 : 
  
 Promise<InsertRowsResponse> 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
InsertRowsOptions \| CallOptions	options

Returns

Type	Description
Promise < InsertRowsResponse >

insert(rows, callback)

  insert 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 callback 
 : 
  
 InsertRowsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
InsertRowsCallback	callback

Returns

Type	Description
void

insert(rows, options, callback)

  insert 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 options 
 : 
  
 InsertRowsOptions 
  
 | 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 InsertRowsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
InsertRowsOptions \| CallOptions	options
InsertRowsCallback	callback

Returns

Type	Description
void

read(request, options)

  read 
 ( 
 request 
 : 
  
 ReadRequest 
 , 
  
 options 
 ?: 
  
 TimestampBounds 
 ) 
 : 
  
 Promise<ReadResponse> 
 ;

Parameters

Type	Name	Description
ReadRequest	request
TimestampBounds	options

Returns

Type	Description
Promise < ReadResponse >

read(request, callback)

  read 
 ( 
 request 
 : 
  
 ReadRequest 
 , 
  
 callback 
 : 
  
 ReadCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
ReadRequest	request
ReadCallback	callback

Returns

Type	Description
void

read(request, options, callback)

  read 
 ( 
 request 
 : 
  
 ReadRequest 
 , 
  
 options 
 : 
  
 TimestampBounds 
 , 
  
 callback 
 : 
  
 ReadCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
ReadRequest	request
TimestampBounds	options
ReadCallback	callback

Returns

Type	Description
void

replace(rows, options)

  replace 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 options 
 ?: 
  
 ReplaceRowsOptions 
  
 | 
  
 CallOptions 
 ) 
 : 
  
 Promise<ReplaceRowsResponse> 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
ReplaceRowsOptions \| CallOptions	options

Returns

Type	Description
Promise < ReplaceRowsResponse >

replace(rows, callback)

  replace 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 callback 
 : 
  
 ReplaceRowsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
ReplaceRowsCallback	callback

Returns

Type	Description
void

replace(rows, options, callback)

  replace 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 options 
 : 
  
 ReplaceRowsOptions 
  
 | 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 ReplaceRowsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
ReplaceRowsOptions \| CallOptions	options
ReplaceRowsCallback	callback

Returns

Type	Description
void

update(rows, options)

  update 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 options 
 ?: 
  
 UpdateRowsOptions 
  
 | 
  
 CallOptions 
 ) 
 : 
  
 Promise<UpdateRowsResponse> 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
UpdateRowsOptions \| CallOptions	options

Returns

Type	Description
Promise < UpdateRowsResponse >

update(rows, callback)

  update 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 callback 
 : 
  
 UpdateRowsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
UpdateRowsCallback	callback

Returns

Type	Description
void

update(rows, options, callback)

  update 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 options 
 : 
  
 UpdateRowsOptions 
  
 | 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 UpdateRowsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
UpdateRowsOptions \| CallOptions	options
UpdateRowsCallback	callback

Returns

Type	Description
void

upsert(rows, options)

  upsert 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 options 
 ?: 
  
 UpsertRowsOptions 
  
 | 
  
 CallOptions 
 ) 
 : 
  
 Promise<UpsertRowsResponse> 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
UpsertRowsOptions \| CallOptions	options

Returns

Type	Description
Promise < UpsertRowsResponse >

upsert(rows, callback)

  upsert 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 callback 
 : 
  
 UpsertRowsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
UpsertRowsCallback	callback

Returns

Type	Description
void

upsert(rows, options, callback)

  upsert 
 ( 
 rows 
 : 
  
 object 
  
 | 
  
 object 
 [], 
  
 options 
 : 
  
 UpsertRowsOptions 
  
 | 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 UpsertRowsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
object \| object[]	rows
UpsertRowsOptions \| CallOptions	options
UpsertRowsCallback	callback

Returns

Type	Description
void

Class Table Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(database, name)

Properties

database

name

Methods

create(schema, gaxOptions)

create(schema, callback)

create(schema, gaxOptions, callback)

createReadStream(request, options)

delete(gaxOptions)

delete(callback)

delete(gaxOptions, callback)

deleteRows(keys, options)

deleteRows(keys, callback)

deleteRows(keys, options, callback)

drop(gaxOptions)

drop(callback)

drop(gaxOptions, callback)

insert(rows, options)

insert(rows, callback)

insert(rows, options, callback)

read(request, options)

read(request, callback)

read(request, options, callback)

replace(rows, options)

replace(rows, callback)

replace(rows, options, callback)

update(rows, options)

update(rows, callback)

update(rows, options, callback)

upsert(rows, options)

upsert(rows, callback)

upsert(rows, options, callback)

Class Table