Globals

Property

RowStateEnum

Abstract type

ClientConfig

Property

RowStateEnum

Enum for chunk formatter Row state. NEW_ROW: inital state or state after commitRow or resetRow ROW_IN_PROGRESS: state after first valid chunk without commitRow or resetRow CELL_IN_PROGRESS: state when valueSize > 0(partial cell)

Abstract type

ClientConfig object

Properties

Name Type Optional Description

apiEndpoint

string

Yes

Override the default API endpoint used to reach Bigtable. This is useful for connecting to your local Bigtable emulator.

projectId

string

Yes

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.

keyFilename

string

Yes

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 above is not necessary. NOTE: .pem and .p12 require you to specify the email option as well.

appProfileId

string

Yes

An application profile ID, a configuration string value describing how Cloud Bigtable should treat traffic from a particular end user application.

string

Yes

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

credentials

object

Yes

Credentials object.

Values in credentials have the following properties:

Name	Type	Optional	Description
client_email	string	Yes
private_key	string	Yes

autoRetry

boolean

Yes

Automatically retry requests if the response is related to rate limits or certain intermittent server errors. We will exponentially backoff subsequent requests by default.

Defaults to true.

maxRetries

number

Yes

Maximum number of automatic retries attempted before returning the error.

Defaults to 3.

promise

Constructor

Yes

Custom promise module to use instead of native Promises.