Class ExternalCatalogTableOptions (3.29.0)

Version latest

• 3.29.0 (latest)
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.1
• 3.22.0
• 3.21.0
• 3.20.1
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.0
• 3.15.0
• 3.14.1
• 3.13.0
• 3.12.0
• 3.11.4
• 3.4.0
• 3.3.6
• 3.2.0
• 3.1.0
• 3.0.1
• 2.34.4
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.1
• 2.29.0
• 2.28.1
• 2.27.1
• 2.26.0
• 2.25.2
• 2.24.1
• 2.23.3
• 2.22.1
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.0
• 2.0.0
• 1.28.2
• 1.27.2
• 1.26.1
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0

ExternalCatalogTableOptions(
    connection_id: typing.Optional[str] = None,
    parameters: typing.Optional[typing.Dict[str, typing.Any]] = None,
    storage_descriptor: typing.Optional[
        google.cloud.bigquery.schema.StorageDescriptor
    ] = None,
)

Metadata about open source compatible table. The fields contained in these options correspond to hive metastore's table level properties.

Parameters
Name	Description
connection_id	Optional[str] The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection is needed to read the open source table from BigQuery Engine. The connection_id can have the form .. or projects//locations//connections/.
parameters	Union[Dict[str, Any], None] A map of key value pairs defining the parameters and properties of the open source table. Corresponds with hive meta store table parameters. Maximum size of 4Mib.
storage_descriptor	Optional[StorageDescriptor] A storage descriptor containing information about the physical storage of this table.

Properties

connection_id

Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection is needed to read the open source table from BigQuery Engine. The connection_id can have the form .. or projects//locations//connections/.

parameters

Optional. A map of key value pairs defining the parameters and properties of the open source table. Corresponds with hive meta store table parameters. Maximum size of 4Mib.

storage_descriptor

Optional. A storage descriptor containing information about the physical storage of this table.

Methods

from_api_repr

from_api_repr(
    api_repr: dict,
) -> google.cloud.bigquery.external_config.ExternalCatalogTableOptions

Factory: constructs an instance of the class (cls) given its API representation.

Parameter
Name	Description
api_repr	Dict[str, Any] API representation of the object to be instantiated.

to_api_repr

to_api_repr() -> dict

Build an API representation of this object.

Returns
Type	Description
Dict[str, Any]	A dictionary in the format used by the BigQuery API.