BigtableTableAdminClient

BigtableTableAdminClient

Service for creating, configuring, and deleting Cloud Bigtable tables.

Provides access to the table schemas only, not the data stored within the tables.

Constructor

new BigtableTableAdminClient(optionsopt)

Construct an instance of BigtableTableAdminClient.

Parameters:
Name Type Attributes Description
options object <optional>

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

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

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

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

keyFilename string <optional>

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

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

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

promise function <optional>

Custom promise module to use instead of native Promises.

apiEndpoint string <optional>

The domain name of the API remote host.

Source:

Members

(static) apiEndpoint

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

Source:

(static) port

The port for this API service.

Source:

(static) scopes

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

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

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

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The unique name of the Table for which to check replication consistency. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

consistencyToken string

The token created using GenerateConsistencyToken for the Table.

options Object <optional>

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

callback function <optional>

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

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedName = client.tablePath('[PROJECT]', '[INSTANCE]', '[TABLE]');
const consistencyToken = '';
const request = {
  name: formattedName,
  consistencyToken: consistencyToken,
};
client.checkConsistency(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

clusterPath(project, instance, cluster) → {String}

Return a fully-qualified cluster resource name string.

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

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

Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

The unique name of the instance in which to create the table. Values are of the form projects/<project>/instances/<instance>.

tableId string

The name by which the new table should be referred to within the parent instance, e.g., foobar rather than <parent>/tables/foobar.

table Object

The Table to create.

This object should have the same structure as Table

initialSplits Array.<Object> <optional>

The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ).

Example:

  • Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"]
  • initial_split_keys := ["apple", "customer_1", "customer_2", "other"]
  • Key assignment:
    • Tablet 1 [, apple) => {"a"}.
    • Tablet 2 [apple, customer_1) => {"apple", "custom"}.
    • Tablet 3 [customer_1, customer_2) => {"customer_1"}.
    • Tablet 4 [customer_2, other) => {"customer_2"}.
    • Tablet 5 [other, ) => {"other", "zz"}.

This object should have the same structure as Split

options Object <optional>

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

callback function <optional>

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

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
const tableId = '';
const table = {};
const request = {
  parent: formattedParent,
  tableId: tableId,
  table: table,
};
client.createTable(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

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

Creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

The unique name of the instance in which to create the table. Values are of the form projects/<project>/instances/<instance>.

tableId string

The name by which the new table should be referred to within the parent instance, e.g., foobar rather than <parent>/tables/foobar.

sourceSnapshot string

The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.

options Object <optional>

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

callback function <optional>

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

The second parameter to the callback is a gax.Operation object.

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
const tableId = '';
const sourceSnapshot = '';
const request = {
  parent: formattedParent,
  tableId: tableId,
  sourceSnapshot: sourceSnapshot,
};

// Handle the operation using the promise pattern.
client.createTableFromSnapshot(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
const tableId = '';
const sourceSnapshot = '';
const request = {
  parent: formattedParent,
  tableId: tableId,
  sourceSnapshot: sourceSnapshot,
};

// Handle the operation using the event emitter pattern.
client.createTableFromSnapshot(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
const tableId = '';
const sourceSnapshot = '';
const request = {
  parent: formattedParent,
  tableId: tableId,
  sourceSnapshot: sourceSnapshot,
};

// Handle the operation using the await pattern.
const [operation] = await client.createTableFromSnapshot(request);

const [response] = await operation.promise();

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

Permanently deletes the specified snapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The unique name of the snapshot to be deleted. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.

options Object <optional>

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

callback function <optional>

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedName = client.snapshotPath('[PROJECT]', '[INSTANCE]', '[CLUSTER]', '[SNAPSHOT]');
client.deleteSnapshot({name: formattedName}).catch(err => {
  console.error(err);
});

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

Permanently deletes a specified table and all of its data.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The unique name of the table to be deleted. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

options Object <optional>

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

callback function <optional>

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedName = client.tablePath('[PROJECT]', '[INSTANCE]', '[TABLE]');
client.deleteTable({name: formattedName}).catch(err => {
  console.error(err);
});

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

Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The unique name of the table on which to drop a range of rows. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

rowKeyPrefix Buffer <optional>

Delete all rows that start with this row key prefix. Prefix cannot be zero length.

deleteAllDataFromTable boolean <optional>

Delete all rows in the table. Setting this to false is a no-op.

options Object <optional>

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

callback function <optional>

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedName = client.tablePath('[PROJECT]', '[INSTANCE]', '[TABLE]');
client.dropRowRange({name: formattedName}).catch(err => {
  console.error(err);
});

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

Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The unique name of the Table for which to create a consistency token. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

options Object <optional>

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

callback function <optional>

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

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

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

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

Gets the access control policy for an instance resource. Returns an empty policy if an table exists but does not have a policy set.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

options Object <optional>

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.

This object should have the same structure as GetPolicyOptions

options Object <optional>

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

callback function <optional>

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

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedResource = client.tablePath('[PROJECT]', '[INSTANCE]', '[TABLE]');
client.getIamPolicy({resource: formattedResource})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.

Source:

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

Gets metadata information about the specified snapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The unique name of the requested snapshot. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.

options Object <optional>

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

callback function <optional>

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

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedName = client.snapshotPath('[PROJECT]', '[INSTANCE]', '[CLUSTER]', '[SNAPSHOT]');
client.getSnapshot({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

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

Gets metadata information about the specified table.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The unique name of the requested table. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

view number <optional>

The view to be applied to the returned table's fields. Defaults to SCHEMA_VIEW if unspecified.

The number should be among the values of View

options Object <optional>

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

callback function <optional>

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

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

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

instancePath(project, instance) → {String}

Return a fully-qualified instance resource name string.

Parameters:
Name Type Description
project String
instance String
Source:

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

Lists all snapshots associated with the specified cluster.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

The unique name of the cluster for which snapshots should be listed. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>. Use <cluster> = '-' to list snapshots for all clusters in an instance, e.g., projects/<project>/instances/<instance>/clusters/-.

pageSize number <optional>

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

options Object <optional>

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

callback function <optional>

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

The second parameter to the callback is Array of Snapshot.

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.clusterPath('[PROJECT]', '[INSTANCE]', '[CLUSTER]');

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

// Or obtain the paged response.
const formattedParent = client.clusterPath('[PROJECT]', '[INSTANCE]', '[CLUSTER]');


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

listSnapshotsStream(request, optionsopt) → {Stream}

Equivalent to listSnapshots, but returns a NodeJS Stream object.

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

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

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

The unique name of the cluster for which snapshots should be listed. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>. Use <cluster> = '-' to list snapshots for all clusters in an instance, e.g., projects/<project>/instances/<instance>/clusters/-.

pageSize number <optional>

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

options Object <optional>

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

Source:
See:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedParent = client.clusterPath('[PROJECT]', '[INSTANCE]', '[CLUSTER]');
client.listSnapshotsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

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

Lists all tables served from a specified instance.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

The unique name of the instance for which tables should be listed. Values are of the form projects/<project>/instances/<instance>.

view number <optional>

The view to be applied to the returned tables' fields. Defaults to NAME_ONLY if unspecified; no others are currently supported.

The number should be among the values of View

pageSize number <optional>

Maximum number of results per page. CURRENTLY UNIMPLEMENTED AND IGNORED.

options Object <optional>

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

callback function <optional>

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

The second parameter to the callback is Array of Table.

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');

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

// Or obtain the paged response.
const formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');


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

listTablesStream(request, optionsopt) → {Stream}

Equivalent to listTables, but returns a NodeJS Stream object.

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

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

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

The unique name of the instance for which tables should be listed. Values are of the form projects/<project>/instances/<instance>.

view number <optional>

The view to be applied to the returned tables' fields. Defaults to NAME_ONLY if unspecified; no others are currently supported.

The number should be among the values of View

pageSize number <optional>

Maximum number of results per page. CURRENTLY UNIMPLEMENTED AND IGNORED.

options Object <optional>

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

Source:
See:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
client.listTablesStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

matchClusterFromClusterName(clusterName) → {String}

Parse the clusterName from a cluster resource.

Parameters:
Name Type Description
clusterName String

A fully-qualified path representing a cluster resources.

Source:

matchClusterFromSnapshotName(snapshotName) → {String}

Parse the snapshotName from a snapshot resource.

Parameters:
Name Type Description
snapshotName String

A fully-qualified path representing a snapshot resources.

Source:

matchInstanceFromClusterName(clusterName) → {String}

Parse the clusterName from a cluster resource.

Parameters:
Name Type Description
clusterName String

A fully-qualified path representing a cluster resources.

Source:

matchInstanceFromInstanceName(instanceName) → {String}

Parse the instanceName from a instance resource.

Parameters:
Name Type Description
instanceName String

A fully-qualified path representing a instance resources.

Source:

matchInstanceFromSnapshotName(snapshotName) → {String}

Parse the snapshotName from a snapshot resource.

Parameters:
Name Type Description
snapshotName String

A fully-qualified path representing a snapshot resources.

Source:

matchInstanceFromTableName(tableName) → {String}

Parse the tableName from a table resource.

Parameters:
Name Type Description
tableName String

A fully-qualified path representing a table resources.

Source:

matchProjectFromClusterName(clusterName) → {String}

Parse the clusterName from a cluster resource.

Parameters:
Name Type Description
clusterName String

A fully-qualified path representing a cluster resources.

Source:

matchProjectFromInstanceName(instanceName) → {String}

Parse the instanceName from a instance resource.

Parameters:
Name Type Description
instanceName String

A fully-qualified path representing a instance resources.

Source:

matchProjectFromSnapshotName(snapshotName) → {String}

Parse the snapshotName from a snapshot resource.

Parameters:
Name Type Description
snapshotName String

A fully-qualified path representing a snapshot resources.

Source:

matchProjectFromTableName(tableName) → {String}

Parse the tableName from a table resource.

Parameters:
Name Type Description
tableName String

A fully-qualified path representing a table resources.

Source:

matchSnapshotFromSnapshotName(snapshotName) → {String}

Parse the snapshotName from a snapshot resource.

Parameters:
Name Type Description
snapshotName String

A fully-qualified path representing a snapshot resources.

Source:

matchTableFromTableName(tableName) → {String}

Parse the tableName from a table resource.

Parameters:
Name Type Description
tableName String

A fully-qualified path representing a table resources.

Source:

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

Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The unique name of the table whose families should be modified. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

modifications Array.<Object>

Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).

This object should have the same structure as Modification

options Object <optional>

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

callback function <optional>

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

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedName = client.tablePath('[PROJECT]', '[INSTANCE]', '[TABLE]');
const modifications = [];
const request = {
  name: formattedName,
  modifications: modifications,
};
client.modifyColumnFamilies(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

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

Sets the access control policy on a table resource. Replaces any existing policy.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
resource string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy Object

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

This object should have the same structure as Policy

options Object <optional>

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

callback function <optional>

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

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedResource = client.tablePath('[PROJECT]', '[INSTANCE]', '[TABLE]');
const policy = {};
const request = {
  resource: formattedResource,
  policy: policy,
};
client.setIamPolicy(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

snapshotPath(project, instance, cluster, snapshot) → {String}

Return a fully-qualified snapshot resource name string.

Parameters:
Name Type Description
project String
instance String
cluster String
snapshot String
Source:

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

Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The unique name of the table to have the snapshot taken. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

cluster string

The name of the cluster where the snapshot will be created in. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>.

snapshotId string

The ID by which the new snapshot should be referred to within the parent cluster, e.g., mysnapshot of the form: [_a-zA-Z0-9][-_.a-zA-Z0-9]* rather than projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/mysnapshot.

description string

Description of the snapshot.

ttl Object <optional>

The amount of time that the new snapshot can stay active after it is created. Once 'ttl' expires, the snapshot will get deleted. The maximum amount of time a snapshot can stay active is 7 days. If 'ttl' is not specified, the default value of 24 hours will be used.

This object should have the same structure as Duration

options Object <optional>

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

callback function <optional>

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

The second parameter to the callback is a gax.Operation object.

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedName = client.tablePath('[PROJECT]', '[INSTANCE]', '[TABLE]');
const cluster = '';
const snapshotId = '';
const description = '';
const request = {
  name: formattedName,
  cluster: cluster,
  snapshotId: snapshotId,
  description: description,
};

// Handle the operation using the promise pattern.
client.snapshotTable(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.tablePath('[PROJECT]', '[INSTANCE]', '[TABLE]');
const cluster = '';
const snapshotId = '';
const description = '';
const request = {
  name: formattedName,
  cluster: cluster,
  snapshotId: snapshotId,
  description: description,
};

// Handle the operation using the event emitter pattern.
client.snapshotTable(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.tablePath('[PROJECT]', '[INSTANCE]', '[TABLE]');
const cluster = '';
const snapshotId = '';
const description = '';
const request = {
  name: formattedName,
  cluster: cluster,
  snapshotId: snapshotId,
  description: description,
};

// Handle the operation using the await pattern.
const [operation] = await client.snapshotTable(request);

const [response] = await operation.promise();

tablePath(project, instance, table) → {String}

Return a fully-qualified table resource name string.

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

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

Returns permissions that the caller has on the specified table resource.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissions Array.<string>

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options Object <optional>

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

callback function <optional>

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

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

Source:
Example
const admin = require('admin.v2');

const client = new admin.v2.BigtableTableAdminClient({
  // optional auth parameters.
});

const formattedResource = client.tablePath('[PROJECT]', '[INSTANCE]', '[TABLE]');
const permissions = [];
const request = {
  resource: formattedResource,
  permissions: permissions,
};
client.testIamPermissions(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });