MetastorePartitionServiceClient

MetastorePartitionServiceClient

BigQuery Metastore Partition Service API. This service is used for managing metastore partitions in BigQuery metastore. The service supports only batch operations for write.

Constructor

new MetastorePartitionServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of MetastorePartitionServiceClient.

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/1.1 REST mode. For more information, please check the documentation.

gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new MetastorePartitionServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

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

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.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

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.

matchDatasetFromTableName(tableName) → {string}

Parse the dataset from Table resource.

Parameters:
Name Type Description
tableName string

A fully-qualified path representing Table resource.

Returns:
Type Description
string

A string representing the dataset.

matchLocationFromReadStreamName(readStreamName) → {string}

Parse the location from ReadStream resource.

Parameters:
Name Type Description
readStreamName string

A fully-qualified path representing ReadStream resource.

Returns:
Type Description
string

A string representing the location.

matchProjectFromReadStreamName(readStreamName) → {string}

Parse the project from ReadStream resource.

Parameters:
Name Type Description
readStreamName string

A fully-qualified path representing ReadStream resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromTableName(tableName) → {string}

Parse the project from Table resource.

Parameters:
Name Type Description
tableName string

A fully-qualified path representing Table resource.

Returns:
Type Description
string

A string representing the project.

matchSessionFromReadStreamName(readStreamName) → {string}

Parse the session from ReadStream resource.

Parameters:
Name Type Description
readStreamName string

A fully-qualified path representing ReadStream resource.

Returns:
Type Description
string

A string representing the session.

matchStreamFromReadStreamName(readStreamName) → {string}

Parse the stream from ReadStream resource.

Parameters:
Name Type Description
readStreamName string

A fully-qualified path representing ReadStream resource.

Returns:
Type Description
string

A string representing the stream.

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.

readStreamPath(project, location, session, stream) → {string}

Return a fully-qualified readStream resource name string.

Parameters:
Name Type Description
project string
location string
session string
stream string
Returns:
Type Description
string

Resource name string.

streamMetastorePartitions(optionsopt) → {Stream}

This is a bi-di streaming rpc method that allows the client to send a stream of partitions and commit all of them atomically at the end. If the commit is successful, the server will return a response and close the stream. If the commit fails (due to duplicate partitions or other reason), the server will close the stream with an error. This method is only available via the gRPC API (not REST).

Parameters:
Name Type Attributes Description
options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

An object stream which is both readable and writable. It accepts objects representing StreamMetastorePartitionsRequest for write() method, and will emit objects representing StreamMetastorePartitionsResponse on 'data' event asynchronously. Please see the documentation for more details and examples.

Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Reference to the table to where the partition to be added, in the
   *  format of
   *  projects/{project}/locations/{location}/datasets/{dataset}/tables/{table}.
   */
  // const parent = 'abc123'
  /**
   *  Optional. A list of metastore partitions to be added to the table.
   */
  // const metastorePartitions = [1,2,3,4]
  /**
   *  Optional. Mimics the ifNotExists flag in IMetaStoreClient
   *  add_partitions(..). If the flag is set to false, the server will return
   *  ALREADY_EXISTS on commit if any partition already exists. If the flag is
   *  set to true:
   *   1) the server will skip existing partitions
   *   insert only the non-existing partitions as part of the commit.
   *   2) The client must set the `skip_existing_partitions` field to true for
   *   all requests in the stream.
   */
  // const skipExistingPartitions = true

  // Imports the Storage library
  const {MetastorePartitionServiceClient} = require('@google-cloud/storage').v1alpha;

  // Instantiates a client
  const storageClient = new MetastorePartitionServiceClient();

  async function callStreamMetastorePartitions() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const stream = await storageClient.streamMetastorePartitions();
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
    stream.write(request);
    stream.end();
  }

  callStreamMetastorePartitions();

tablePath(project, dataset, table) → {string}

Return a fully-qualified table resource name string.

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

Resource name string.