Cloud Bigtable V2 Client - Class ColumnFamily (2.1.0)

Reference documentation and code samples for the Cloud Bigtable V2 Client class ColumnFamily.

A set of columns within a table which share a common configuration.

Generated from protobuf message google.bigtable.admin.v2.ColumnFamily

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ gc_rule Google\Cloud\Bigtable\Admin\V2\GcRule

Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
↳ value_type Google\Cloud\Bigtable\Admin\V2\Type

The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the Aggregate type is supported. Aggregate can only be set at family creation and is immutable afterwards. If value_type is Aggregate, written data must be compatible with: * value_type.input_type for AddInput mutations

getGcRule

Garbage collection rule specified as a protobuf.

Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.

Returns
Type Description
Google\Cloud\Bigtable\Admin\V2\GcRule|null

hasGcRule

clearGcRule

setGcRule

Garbage collection rule specified as a protobuf.

Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.

Parameter
Name Description
var Google\Cloud\Bigtable\Admin\V2\GcRule
Returns
Type Description
$this

getValueType

The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes.

For now, only the Aggregate type is supported. Aggregate can only be set at family creation and is immutable afterwards. If value_type is Aggregate, written data must be compatible with:

  • value_type.input_type for AddInput mutations
Returns
Type Description
Google\Cloud\Bigtable\Admin\V2\Type|null

hasValueType

clearValueType

setValueType

The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes.

For now, only the Aggregate type is supported. Aggregate can only be set at family creation and is immutable afterwards. If value_type is Aggregate, written data must be compatible with:

  • value_type.input_type for AddInput mutations
Parameter
Name Description
var Google\Cloud\Bigtable\Admin\V2\Type
Returns
Type Description
$this