Globals

Properties

methods

Mutation methods

INSERT => setCell DELETE => deleteFrom*

RowStateEnum

constant

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)

Method

ChunkTransformer

ChunkTransformer()

ChunkTransformer formats all incoming chunks in to row keeps all intermediate state until end of stream. Should use new instance for each request.

Abstract type

ClientConfig

object

Properties

Parameter

apiEndpoint

Optional

string

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

projectId

Optional

string

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

Optional

string

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.

email

Optional

string

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

credentials

Optional

object

Credentials object.

Values in credentials have the following properties:

Parameter

client_email

Optional

string

private_key

Optional

string

autoRetry

Optional

boolean

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

maxRetries

Optional

number

Maximum number of automatic retries attempted before returning the error.

promise

Optional

Constructor

Custom promise module to use instead of native Promises.