TablesServiceClient

TablesServiceClient

The Tables Service provides an API for reading and updating tables. It defines the following resource model:

  • The API has a collection of Table resources, named tables/*

  • Each Table has a collection of Row resources, named tables/* /rows/*

Constructor

new TablesServiceClient(optionsopt)

Construct an instance of TablesServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

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

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

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

The port on which to connect to the remote host.
projectId string <optional>

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

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

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.

Members

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

batchCreateRows(request, optionsopt) → {Promise}

Creates multiple rows.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent table where the rows will be created. Format: tables/{table}
requests Array.<number>

Required. The request message specifying the rows to create.

A maximum of 500 rows can be created in a single batch.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing BatchCreateRowsResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.batchCreateRows(request);

batchUpdateRows(request, optionsopt) → {Promise}

Updates multiple rows.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent table shared by all rows being updated. Format: tables/{table}
requests Array.<number>

Required. The request messages specifying the rows to update.

A maximum of 500 rows can be modified in a single batch.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing BatchUpdateRowsResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.batchUpdateRows(request);

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

createRow(request, optionsopt) → {Promise}

Creates a row.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The parent table where this row will be created. Format: tables/{table}
row google.area120.tables.v1alpha1.Row

Required. The row to create.
view google.area120.tables.v1alpha1.View <optional>

Optional. Column key to use for values in the row. Defaults to user entered name.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Row. Please see the documentation for more details and examples.
Example
const [response] = await client.createRow(request);

deleteRow(request, optionsopt) → {Promise}

Deletes a row.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the row to delete. Format: tables/{table}/rows/{row}
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deleteRow(request);

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

getRow(request, optionsopt) → {Promise}

Gets a row. Returns NOT_FOUND if the row does not exist in the table.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

Required. The name of the row to retrieve. Format: tables/{table}/rows/{row}
view google.area120.tables.v1alpha1.View <optional>

Optional. Column key to use for values in the row. Defaults to user entered name.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Row. Please see the documentation for more details and examples.
Example
const [response] = await client.getRow(request);

getTable(request, optionsopt) → {Promise}

Gets a table. Returns NOT_FOUND if the table does not exist.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the table to retrieve. Format: tables/{table}
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Table. Please see the documentation for more details and examples.
Example
const [response] = await client.getTable(request);

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

listRows(request, optionsopt) → {Promise}

Lists rows in a table. Returns NOT_FOUND if the table does not exist.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The parent table. Format: tables/{table}
pageSize number

The maximum number of rows to return. The service may return fewer than this value.

If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.
pageToken string

A page token, received from a previous ListRows call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRows must match the call that provided the page token.
view google.area120.tables.v1alpha1.View <optional>

Optional. Column key to use for values in the row. Defaults to user entered name.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of Row. 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. Note that it can affect your quota. We recommend using listRowsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listRowsAsync(request, optionsopt) → {Object}

Equivalent to listRows, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The parent table. Format: tables/{table}
pageSize number

The maximum number of rows to return. The service may return fewer than this value.

If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.
pageToken string

A page token, received from a previous ListRows call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRows must match the call that provided the page token.
view google.area120.tables.v1alpha1.View <optional>

Optional. Column key to use for values in the row. Defaults to user entered name.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Row. 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 for more details and examples.
Example
const iterable = client.listRowsAsync(request);
for await (const response of iterable) {
  // process response
}

listRowsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The parent table. Format: tables/{table}
pageSize number

The maximum number of rows to return. The service may return fewer than this value.

If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.
pageToken string

A page token, received from a previous ListRows call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRows must match the call that provided the page token.
view google.area120.tables.v1alpha1.View <optional>

Optional. Column key to use for values in the row. Defaults to user entered name.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Row 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 listRowsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTables(request, optionsopt) → {Promise}

Lists tables for the user.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
pageSize number

The maximum number of tables to return. The service may return fewer than this value.

If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.
pageToken string

A page token, received from a previous ListTables call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTables must match the call that provided the page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of Table. 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. Note that it can affect your quota. We recommend using listTablesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTablesAsync(request, optionsopt) → {Object}

Equivalent to listTables, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
pageSize number

The maximum number of tables to return. The service may return fewer than this value.

If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.
pageToken string

A page token, received from a previous ListTables call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTables must match the call that provided the page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Table. 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 for more details and examples.
Example
const iterable = client.listTablesAsync(request);
for await (const response of iterable) {
  // process response
}

listTablesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
pageSize number

The maximum number of tables to return. The service may return fewer than this value.

If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.
pageToken string

A page token, received from a previous ListTables call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTables must match the call that provided the page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Table 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 listTablesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchRowFromRowName(rowName) → {string}

Parse the row from Row resource.

Parameters:
Name Type Description
rowName string

A fully-qualified path representing Row resource.
Returns:
Type Description
string

A string representing the row.

matchTableFromRowName(rowName) → {string}

Parse the table from Row resource.

Parameters:
Name Type Description
rowName string

A fully-qualified path representing Row resource.
Returns:
Type Description
string

A string representing the table.

matchTableFromTableName(tableName) → {string}

Parse the table from Table resource.

Parameters:
Name Type Description
tableName string

A fully-qualified path representing Table resource.
Returns:
Type Description
string

A string representing the table.

rowPath(table, row) → {string}

Return a fully-qualified row resource name string.

Parameters:
Name Type Description
table string
row string
Returns:
Type Description
string

Resource name string.

tablePath(table) → {string}

Return a fully-qualified table resource name string.

Parameters:
Name Type Description
table string
Returns:
Type Description
string

Resource name string.

updateRow(request, optionsopt) → {Promise}

Updates a row.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
row google.area120.tables.v1alpha1.Row

Required. The row to update.
updateMask google.protobuf.FieldMask

The list of fields to update.
view google.area120.tables.v1alpha1.View <optional>

Optional. Column key to use for values in the row. Defaults to user entered name.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Row. Please see the documentation for more details and examples.
Example
const [response] = await client.updateRow(request);