BigtableSource

The Cloud Bigtable source for importing data.

JSON representation
{
  "projectId": string,
  "instanceId": string,
  "tableId": string,
  "bigtableOptions": {
    object (BigtableOptions)
  }
}
Fields
projectId

string

The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

instanceId

string

Required. The instance ID of the Cloud Bigtable that needs to be imported.

tableId

string

Required. The table ID of the Cloud Bigtable that needs to be imported.

bigtableOptions

object (BigtableOptions)

Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations.

BigtableOptions

The Bigtable Options object that contains information to support the import.

JSON representation
{
  "keyFieldName": string,
  "families": {
    string: {
      object (BigtableColumnFamily)
    },
    ...
  }
}
Fields
keyFieldName

string

The field name used for saving row key value in the document. The name has to match the pattern [a-zA-Z0-9][a-zA-Z0-9-_]*.

families

map (key: string, value: object (BigtableColumnFamily))

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

BigtableColumnFamily

The column family of the Bigtable.

JSON representation
{
  "fieldName": string,
  "encoding": enum (Encoding),
  "type": enum (Type),
  "columns": [
    {
      object (BigtableColumn)
    }
  ]
}
Fields
fieldName

string

The field name to use for this column family in the document. The name has to match the pattern [a-zA-Z0-9][a-zA-Z0-9-_]*. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.

encoding

enum (Encoding)

The encoding mode of the values when the type is not STRING. Acceptable encoding values are:

  • TEXT: indicates values are alphanumeric text strings.
  • BINARY: indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in columns and specifying an encoding for it.
type

enum (Type)

The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY.

columns[]

object (BigtableColumn)

The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.

Encoding

The encoding mode of a Bigtable column or column family.

Enums
ENCODING_UNSPECIFIEDThe encoding is unspecified.
TEXTText encoding.
BINARYBinary encoding.

Type

The type of values in a Bigtable column or column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY.

Enums
TYPE_UNSPECIFIEDThe type is unspecified.
STRINGString type.
NUMBERNumerical type.
INTEGERInteger type.
VAR_INTEGERVariable length integer type.
BIG_NUMERICBigDecimal type.
BOOLEANBoolean type.
JSONJSON type.

BigtableColumn

The column of the Bigtable.

JSON representation
{
  "qualifier": string,
  "fieldName": string,
  "encoding": enum (Encoding),
  "type": enum (Type)
}
Fields
qualifier

string (bytes format)

Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.

A base64-encoded string.

fieldName

string

The field name to use for this column in the document. The name has to match the pattern [a-zA-Z0-9][a-zA-Z0-9-_]*. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.

encoding

enum (Encoding)

The encoding mode of the values when the type is not STRING. Acceptable encoding values are:

  • TEXT: indicates values are alphanumeric text strings.
  • BINARY: indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in columns and specifying an encoding for it.
type

enum (Type)

The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY.