Execute Query Metadata

This module provides the SqlType class used for specifying types in ExecuteQuery and some utilities.

The SqlTypes are used in Metadata returned by the ExecuteQuery operation as well as for specifying query parameter types explicitly.

class google.cloud.bigtable.data.execute_query.metadata.Metadata()

Bases: object

Base class for metadata returned by the ExecuteQuery operation.

class google.cloud.bigtable.data.execute_query.metadata.ProtoMetadata(columns: Optional[List[Tuple[Optional[str], google.cloud.bigtable.data.execute_query.metadata.SqlType.Type]]] = None)

Bases: google.cloud.bigtable.data.execute_query.metadata.Metadata

Metadata class for the ExecuteQuery operation.

• Parameters

  columns (List[Tuple[Optional[str], **SqlType.Type]]) – List of column metadata tuples. Each tuple contains the column name and the column type.

class google.cloud.bigtable.data.execute_query.metadata.SqlType()

Bases: object

Classes denoting types of values returned by Bigtable’s ExecuteQuery operation.

Used in Metadata.

class Array(element_type: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type)

Bases: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type

Array SQL type.

class Bool()

Bases: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type

Bool SQL type.

expected_type()

alias of bool

class Bytes()

Bases: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type

Bytes SQL type.

expected_type()

alias of bytes

class Date()

Bases: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type

Date SQL type.

expected_type()

alias of datetime.date

class Float64()

Bases: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type

Float64 SQL type.

expected_type()

alias of float

class Int64()

Bases: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type

Int64 SQL type.

expected_type()

alias of int

class Map(key_type: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type, value_type: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type)

Bases: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type

Map SQL type.

class String()

Bases: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type

String SQL type.

expected_type()

alias of str

class Struct(fields: Optional[List[Tuple[Optional[str], google.cloud.bigtable.data.execute_query.values.T]]] = None)

Bases: google.cloud.bigtable.data.execute_query.values._NamedList[google.cloud.bigtable.data.execute_query.metadata.SqlType.Type], google.cloud.bigtable.data.execute_query.metadata.SqlType.Type

Struct SQL type.

class Timestamp()

Bases: google.cloud.bigtable.data.execute_query.metadata.SqlType.Type

Timestamp SQL type.

Timestamp supports DatetimeWithNanoseconds but Bigtable SQL does not currently support nanoseconds precision. We support this for potential compatibility in the future. Nanoseconds are currently ignored.