Reference documentation and code samples for the Cloud Bigtable V2 Client class Type.
Type
represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features.
For compatibility with Bigtable's existing untyped APIs, each Type
includes an Encoding
which describes how to convert to/from the underlying data. Each encoding also defines the following properties:
- Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, not the decoded type.
- Example: BYTES values sort in the same order as their raw encodings.
- Counterexample: Encoding INT64 as a fixed-width decimal string does not preserve sort order when dealing with negative numbers.
INT64(1) > INT64(-1)
, butSTRING("-00001") > STRING("00001)
.
- Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins?
- Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign.
- Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends.
- Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?
Generated from protobuf message google.bigtable.admin.v2.Type
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data | array Optional. Data for populating the Message object. |
↳ bytes_type | Google\Cloud\Bigtable\Admin\V2\Type\Bytes Bytes |
↳ string_type | Google\Cloud\Bigtable\Admin\V2\Type\PBString String |
↳ int64_type | Google\Cloud\Bigtable\Admin\V2\Type\Int64 Int64 |
↳ float32_type | Google\Cloud\Bigtable\Admin\V2\Type\Float32 Float32 |
↳ float64_type | Google\Cloud\Bigtable\Admin\V2\Type\Float64 Float64 |
↳ bool_type | Google\Cloud\Bigtable\Admin\V2\Type\PBBool Bool |
↳ timestamp_type | Google\Cloud\Bigtable\Admin\V2\Type\Timestamp Timestamp |
↳ date_type | Google\Cloud\Bigtable\Admin\V2\Type\Date Date |
↳ aggregate_type | Google\Cloud\Bigtable\Admin\V2\Type\Aggregate Aggregate |
↳ struct_type | Google\Cloud\Bigtable\Admin\V2\Type\Struct Struct |
↳ array_type | Google\Cloud\Bigtable\Admin\V2\Type\PBArray Array |
↳ map_type | Google\Cloud\Bigtable\Admin\V2\Type\Map Map |
getBytesType
Bytes
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\Bytes|null |
hasBytesType
setBytesType
Bytes
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\Bytes |
Returns | |
---|---|
Type | Description |
$this |
getStringType
String
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\PBString|null |
hasStringType
setStringType
String
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\PBString |
Returns | |
---|---|
Type | Description |
$this |
getInt64Type
Int64
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\Int64|null |
hasInt64Type
setInt64Type
Int64
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\Int64 |
Returns | |
---|---|
Type | Description |
$this |
getFloat32Type
Float32
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\Float32|null |
hasFloat32Type
setFloat32Type
Float32
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\Float32 |
Returns | |
---|---|
Type | Description |
$this |
getFloat64Type
Float64
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\Float64|null |
hasFloat64Type
setFloat64Type
Float64
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\Float64 |
Returns | |
---|---|
Type | Description |
$this |
getBoolType
Bool
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\PBBool|null |
hasBoolType
setBoolType
Bool
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\PBBool |
Returns | |
---|---|
Type | Description |
$this |
getTimestampType
Timestamp
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\Timestamp|null |
hasTimestampType
setTimestampType
Timestamp
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\Timestamp |
Returns | |
---|---|
Type | Description |
$this |
getDateType
Date
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\Date|null |
hasDateType
setDateType
Date
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\Date |
Returns | |
---|---|
Type | Description |
$this |
getAggregateType
Aggregate
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\Aggregate|null |
hasAggregateType
setAggregateType
Aggregate
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\Aggregate |
Returns | |
---|---|
Type | Description |
$this |
getStructType
Struct
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\Struct|null |
hasStructType
setStructType
Struct
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\Struct |
Returns | |
---|---|
Type | Description |
$this |
getArrayType
Array
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\PBArray|null |
hasArrayType
setArrayType
Array
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\PBArray |
Returns | |
---|---|
Type | Description |
$this |
getMapType
Map
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Type\Map|null |
hasMapType
setMapType
Map
Parameter | |
---|---|
Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Type\Map |
Returns | |
---|---|
Type | Description |
$this |
getKind
Returns | |
---|---|
Type | Description |
string |