Class BigtableOptions (3.36.0)
Stay organized with collections
Save and categorize content based on your preferences.
Options that describe how to treat Bigtable tables as BigQuery tables.
Properties
column_families
ignore_unspecified_column_families
read_rowkey_as_string
Methods
from_api_repr
from_api_repr(
resource: dict,
) -> google.cloud.bigquery.external_config.BigtableOptions
Factory: construct a .external_config.BigtableOptions
instance given its API representation.
Parameter |
Name |
Description |
resource |
Dict[str, Any]
Definition of a .external_config.BigtableOptions instance in the same representation as is returned from the API.
|
Returns |
Type |
Description |
BigtableOptions |
Configuration parsed from resource . |
to_api_repr
Build an API representation of this object.
Returns |
Type |
Description |
Dict[str, Any] |
A dictionary in the format used by the BigQuery API. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class BigtableOptions (3.36.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.36.0 (latest)](/python/docs/reference/bigquery/latest/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.35.1](/python/docs/reference/bigquery/3.35.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.34.0](/python/docs/reference/bigquery/3.34.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.33.0](/python/docs/reference/bigquery/3.33.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.31.0](/python/docs/reference/bigquery/3.31.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.30.0](/python/docs/reference/bigquery/3.30.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.29.0](/python/docs/reference/bigquery/3.29.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.27.0](/python/docs/reference/bigquery/3.27.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.26.0](/python/docs/reference/bigquery/3.26.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.25.0](/python/docs/reference/bigquery/3.25.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.24.0](/python/docs/reference/bigquery/3.24.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.23.1](/python/docs/reference/bigquery/3.23.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.22.0](/python/docs/reference/bigquery/3.22.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.21.0](/python/docs/reference/bigquery/3.21.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.20.1](/python/docs/reference/bigquery/3.20.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.19.0](/python/docs/reference/bigquery/3.19.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.18.0](/python/docs/reference/bigquery/3.18.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.17.2](/python/docs/reference/bigquery/3.17.2/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.16.0](/python/docs/reference/bigquery/3.16.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.15.0](/python/docs/reference/bigquery/3.15.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.14.1](/python/docs/reference/bigquery/3.14.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.13.0](/python/docs/reference/bigquery/3.13.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.12.0](/python/docs/reference/bigquery/3.12.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.11.4](/python/docs/reference/bigquery/3.11.4/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.4.0](/python/docs/reference/bigquery/3.4.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.3.6](/python/docs/reference/bigquery/3.3.6/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.2.0](/python/docs/reference/bigquery/3.2.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.1.0](/python/docs/reference/bigquery/3.1.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [3.0.1](/python/docs/reference/bigquery/3.0.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.34.4](/python/docs/reference/bigquery/2.34.4/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.33.0](/python/docs/reference/bigquery/2.33.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.32.0](/python/docs/reference/bigquery/2.32.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.31.0](/python/docs/reference/bigquery/2.31.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.30.1](/python/docs/reference/bigquery/2.30.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.29.0](/python/docs/reference/bigquery/2.29.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.28.1](/python/docs/reference/bigquery/2.28.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.27.1](/python/docs/reference/bigquery/2.27.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.26.0](/python/docs/reference/bigquery/2.26.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.25.2](/python/docs/reference/bigquery/2.25.2/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.24.1](/python/docs/reference/bigquery/2.24.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.23.3](/python/docs/reference/bigquery/2.23.3/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.22.1](/python/docs/reference/bigquery/2.22.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.21.0](/python/docs/reference/bigquery/2.21.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.20.0](/python/docs/reference/bigquery/2.20.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.19.0](/python/docs/reference/bigquery/2.19.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.18.0](/python/docs/reference/bigquery/2.18.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.17.0](/python/docs/reference/bigquery/2.17.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.16.1](/python/docs/reference/bigquery/2.16.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.15.0](/python/docs/reference/bigquery/2.15.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.14.0](/python/docs/reference/bigquery/2.14.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.13.1](/python/docs/reference/bigquery/2.13.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.12.0](/python/docs/reference/bigquery/2.12.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.11.0](/python/docs/reference/bigquery/2.11.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.10.0](/python/docs/reference/bigquery/2.10.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.9.0](/python/docs/reference/bigquery/2.9.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.8.0](/python/docs/reference/bigquery/2.8.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.7.0](/python/docs/reference/bigquery/2.7.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.6.2](/python/docs/reference/bigquery/2.6.2/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.5.0](/python/docs/reference/bigquery/2.5.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.4.0](/python/docs/reference/bigquery/2.4.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.3.1](/python/docs/reference/bigquery/2.3.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.2.0](/python/docs/reference/bigquery/2.2.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.1.0](/python/docs/reference/bigquery/2.1.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [2.0.0](/python/docs/reference/bigquery/2.0.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.28.2](/python/docs/reference/bigquery/1.28.2/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.27.2](/python/docs/reference/bigquery/1.27.2/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.26.1](/python/docs/reference/bigquery/1.26.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.25.0](/python/docs/reference/bigquery/1.25.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.24.0](/python/docs/reference/bigquery/1.24.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.23.1](/python/docs/reference/bigquery/1.23.1/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.22.0](/python/docs/reference/bigquery/1.22.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.21.0](/python/docs/reference/bigquery/1.21.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.20.0](/python/docs/reference/bigquery/1.20.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.19.0](/python/docs/reference/bigquery/1.19.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.18.0](/python/docs/reference/bigquery/1.18.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.17.0](/python/docs/reference/bigquery/1.17.0/google.cloud.bigquery.external_config.BigtableOptions)\n- [1.16.0](/python/docs/reference/bigquery/1.16.0/google.cloud.bigquery.external_config.BigtableOptions) \n\n BigtableOptions()\n\nOptions that describe how to treat Bigtable tables as BigQuery tables.\n\nProperties\n----------\n\n### column_families\n\nList\\[`.external_config.BigtableColumnFamily`\\]: List of\ncolumn families to expose in the table schema along with their types.\n\nSee\n\u003chttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.column_families\u003e\n\n### ignore_unspecified_column_families\n\nbool: If :data:`True`, ignore columns not specified in\n`column_families` list. Defaults to :data:`False`.\n\nSee\n\u003chttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.ignore_unspecified_column_families\u003e\n\n### read_rowkey_as_string\n\nbool: If :data:`True`, rowkey column families will be read and\nconverted to string. Defaults to :data:`False`.\n\nSee\n\u003chttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.read_rowkey_as_string\u003e\n\nMethods\n-------\n\n### from_api_repr\n\n from_api_repr(\n resource: dict,\n ) -\u003e google.cloud.bigquery.external_config.BigtableOptions\n\nFactory: construct a `.external_config.BigtableOptions`\ninstance given its API representation.\n\n### to_api_repr\n\n to_api_repr() -\u003e dict\n\nBuild an API representation of this object."]]