Google Cloud v8.34.0 published on Wednesday, Jun 11, 2025 by Pulumi
gcp.bigquery.getTable
Explore with Pulumi AI
Get a specific table in a BigQuery dataset. For more information see the official documentation and API.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const table = gcp.bigquery.getTable({
project: "my-project",
datasetId: "my-bq-dataset",
tableId: "my-table",
});
import pulumi
import pulumi_gcp as gcp
table = gcp.bigquery.get_table(project="my-project",
dataset_id="my-bq-dataset",
table_id="my-table")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bigquery.LookupTable(ctx, &bigquery.LookupTableArgs{
Project: pulumi.StringRef("my-project"),
DatasetId: "my-bq-dataset",
TableId: "my-table",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var table = Gcp.BigQuery.GetTable.Invoke(new()
{
Project = "my-project",
DatasetId = "my-bq-dataset",
TableId = "my-table",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigquery.BigqueryFunctions;
import com.pulumi.gcp.bigquery.inputs.GetTableArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var table = BigqueryFunctions.getTable(GetTableArgs.builder()
.project("my-project")
.datasetId("my-bq-dataset")
.tableId("my-table")
.build());
}
}
variables:
table:
fn::invoke:
function: gcp:bigquery:getTable
arguments:
project: my-project
datasetId: my-bq-dataset
tableId: my-table
Using getTable
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getTable(args: GetTableArgs, opts?: InvokeOptions): Promise<GetTableResult>
function getTableOutput(args: GetTableOutputArgs, opts?: InvokeOptions): Output<GetTableResult>
def get_table(dataset_id: Optional[str] = None,
project: Optional[str] = None,
table_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTableResult
def get_table_output(dataset_id: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
table_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetTableResult]
func LookupTable(ctx *Context, args *LookupTableArgs, opts ...InvokeOption) (*LookupTableResult, error)
func LookupTableOutput(ctx *Context, args *LookupTableOutputArgs, opts ...InvokeOption) LookupTableResultOutput
> Note: This function is named LookupTable
in the Go SDK.
public static class GetTable
{
public static Task<GetTableResult> InvokeAsync(GetTableArgs args, InvokeOptions? opts = null)
public static Output<GetTableResult> Invoke(GetTableInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
public static Output<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
fn::invoke:
function: gcp:bigquery/getTable:getTable
arguments:
# arguments dictionary
The following arguments are supported:
- dataset_
id str - The dataset ID.
- table_
id str - The table ID.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
getTable Result
The following output properties are available:
- Biglake
Configurations List<GetTable Biglake Configuration> - Clusterings List<string>
- Creation
Time int - Dataset
Id string - Deletion
Protection bool - Description string
- Effective
Labels Dictionary<string, string> - Encryption
Configurations List<GetTable Encryption Configuration> - Etag string
- Expiration
Time int - External
Catalog List<GetTable Options Table External Catalog Table Option> - External
Data List<GetConfigurations Table External Data Configuration> - Friendly
Name string - Id string
- The provider-assigned unique ID for this managed resource.
- Labels Dictionary<string, string>
- Last
Modified intTime - Location string
- Materialized
Views List<GetTable Materialized View> - Max
Staleness string - Num
Bytes int - Num
Long intTerm Bytes - Num
Rows int - Pulumi
Labels Dictionary<string, string> - Range
Partitionings List<GetTable Range Partitioning> - Require
Partition boolFilter - Dictionary<string, string>
- Schema string
- Schema
Foreign List<GetType Infos Table Schema Foreign Type Info> - Self
Link string - Table
Constraints List<GetTable Table Constraint> - Table
Id string - Table
Metadata stringView - Table
Replication List<GetInfos Table Table Replication Info> - Time
Partitionings List<GetTable Time Partitioning> - Type string
- Views
List<Get
Table View> - Project string
- Biglake
Configurations []GetTable Biglake Configuration - Clusterings []string
- Creation
Time int - Dataset
Id string - Deletion
Protection bool - Description string
- Effective
Labels map[string]string - Encryption
Configurations []GetTable Encryption Configuration - Etag string
- Expiration
Time int - External
Catalog []GetTable Options Table External Catalog Table Option - External
Data []GetConfigurations Table External Data Configuration - Friendly
Name string - Id string
- The provider-assigned unique ID for this managed resource.
- Labels map[string]string
- Last
Modified intTime - Location string
- Materialized
Views []GetTable Materialized View - Max
Staleness string - Num
Bytes int - Num
Long intTerm Bytes - Num
Rows int - Pulumi
Labels map[string]string - Range
Partitionings []GetTable Range Partitioning - Require
Partition boolFilter - map[string]string
- Schema string
- Schema
Foreign []GetType Infos Table Schema Foreign Type Info - Self
Link string - Table
Constraints []GetTable Table Constraint - Table
Id string - Table
Metadata stringView - Table
Replication []GetInfos Table Table Replication Info - Time
Partitionings []GetTable Time Partitioning - Type string
- Views
[]Get
Table View - Project string
- biglake
Configurations List<GetTable Biglake Configuration> - clusterings List<String>
- creation
Time Integer - dataset
Id String - deletion
Protection Boolean - description String
- effective
Labels Map<String,String> - encryption
Configurations List<GetTable Encryption Configuration> - etag String
- expiration
Time Integer - external
Catalog List<GetTable Options Table External Catalog Table Option> - external
Data List<GetConfigurations Table External Data Configuration> - friendly
Name String - id String
- The provider-assigned unique ID for this managed resource.
- labels Map<String,String>
- last
Modified IntegerTime - location String
- materialized
Views List<GetTable Materialized View> - max
Staleness String - num
Bytes Integer - num
Long IntegerTerm Bytes - num
Rows Integer - pulumi
Labels Map<String,String> - range
Partitionings List<GetTable Range Partitioning> - require
Partition BooleanFilter - Map<String,String>
- schema String
- schema
Foreign List<GetType Infos Table Schema Foreign Type Info> - self
Link String - table
Constraints List<GetTable Table Constraint> - table
Id String - table
Metadata StringView - table
Replication List<GetInfos Table Table Replication Info> - time
Partitionings List<GetTable Time Partitioning> - type String
- views
List<Get
Table View> - project String
- biglake
Configurations GetTable Biglake Configuration[] - clusterings string[]
- creation
Time number - dataset
Id string - deletion
Protection boolean - description string
- effective
Labels {[key: string]: string} - encryption
Configurations GetTable Encryption Configuration[] - etag string
- expiration
Time number - external
Catalog GetTable Options Table External Catalog Table Option[] - external
Data GetConfigurations Table External Data Configuration[] - friendly
Name string - id string
- The provider-assigned unique ID for this managed resource.
- labels {[key: string]: string}
- last
Modified numberTime - location string
- materialized
Views GetTable Materialized View[] - max
Staleness string - num
Bytes number - num
Long numberTerm Bytes - num
Rows number - pulumi
Labels {[key: string]: string} - range
Partitionings GetTable Range Partitioning[] - require
Partition booleanFilter - {[key: string]: string}
- schema string
- schema
Foreign GetType Infos Table Schema Foreign Type Info[] - self
Link string - table
Constraints GetTable Table Constraint[] - table
Id string - table
Metadata stringView - table
Replication GetInfos Table Table Replication Info[] - time
Partitionings GetTable Time Partitioning[] - type string
- views
Get
Table View[] - project string
- biglake_
configurations Sequence[GetTable Biglake Configuration] - clusterings Sequence[str]
- creation_
time int - dataset_
id str - deletion_
protection bool - description str
- effective_
labels Mapping[str, str] - encryption_
configurations Sequence[GetTable Encryption Configuration] - etag str
- expiration_
time int - external_
catalog_ Sequence[Gettable_ options Table External Catalog Table Option] - external_
data_ Sequence[Getconfigurations Table External Data Configuration] - friendly_
name str - id str
- The provider-assigned unique ID for this managed resource.
- labels Mapping[str, str]
- last_
modified_ inttime - location str
- materialized_
views Sequence[GetTable Materialized View] - max_
staleness str - num_
bytes int - num_
long_ intterm_ bytes - num_
rows int - pulumi_
labels Mapping[str, str] - range_
partitionings Sequence[GetTable Range Partitioning] - require_
partition_ boolfilter - Mapping[str, str]
- schema str
- schema_
foreign_ Sequence[Gettype_ infos Table Schema Foreign Type Info] - self_
link str - table_
constraints Sequence[GetTable Table Constraint] - table_
id str - table_
metadata_ strview - table_
replication_ Sequence[Getinfos Table Table Replication Info] - time_
partitionings Sequence[GetTable Time Partitioning] - type str
- views
Sequence[Get
Table View] - project str
- biglake
Configurations List<Property Map> - clusterings List<String>
- creation
Time Number - dataset
Id String - deletion
Protection Boolean - description String
- effective
Labels Map<String> - encryption
Configurations List<Property Map> - etag String
- expiration
Time Number - external
Catalog List<Property Map>Table Options - external
Data List<Property Map>Configurations - friendly
Name String - id String
- The provider-assigned unique ID for this managed resource.
- labels Map<String>
- last
Modified NumberTime - location String
- materialized
Views List<Property Map> - max
Staleness String - num
Bytes Number - num
Long NumberTerm Bytes - num
Rows Number - pulumi
Labels Map<String> - range
Partitionings List<Property Map> - require
Partition BooleanFilter - Map<String>
- schema String
- schema
Foreign List<Property Map>Type Infos - self
Link String - table
Constraints List<Property Map> - table
Id String - table
Metadata StringView - table
Replication List<Property Map>Infos - time
Partitionings List<Property Map> - type String
- views List<Property Map>
- project String
Supporting Types
GetTableBiglakeConfiguration
- Connection
Id string - The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form "<project_id>.<location_id>.<connection_id>" or "projects/<project_id>/locations/<location_id>/connections/<connection_id>".
- File
Format string - The file format the data is stored in.
- Storage
Uri string - The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format "gs://bucket/path_to_table/"
- Table
Format string - The table format the metadata only snapshots are stored in.
- Connection
Id string - The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form "<project_id>.<location_id>.<connection_id>" or "projects/<project_id>/locations/<location_id>/connections/<connection_id>".
- File
Format string - The file format the data is stored in.
- Storage
Uri string - The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format "gs://bucket/path_to_table/"
- Table
Format string - The table format the metadata only snapshots are stored in.
- connection
Id String - The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form "<project_id>.<location_id>.<connection_id>" or "projects/<project_id>/locations/<location_id>/connections/<connection_id>".
- file
Format String - The file format the data is stored in.
- storage
Uri String - The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format "gs://bucket/path_to_table/"
- table
Format String - The table format the metadata only snapshots are stored in.
- connection
Id string - The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form "<project_id>.<location_id>.<connection_id>" or "projects/<project_id>/locations/<location_id>/connections/<connection_id>".
- file
Format string - The file format the data is stored in.
- storage
Uri string - The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format "gs://bucket/path_to_table/"
- table
Format string - The table format the metadata only snapshots are stored in.
- connection_
id str - The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form "<project_id>.<location_id>.<connection_id>" or "projects/<project_id>/locations/<location_id>/connections/<connection_id>".
- file_
format str - The file format the data is stored in.
- storage_
uri str - The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format "gs://bucket/path_to_table/"
- table_
format str - The table format the metadata only snapshots are stored in.
- connection
Id String - The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form "<project_id>.<location_id>.<connection_id>" or "projects/<project_id>/locations/<location_id>/connections/<connection_id>".
- file
Format String - The file format the data is stored in.
- storage
Uri String - The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format "gs://bucket/path_to_table/"
- table
Format String - The table format the metadata only snapshots are stored in.
GetTableEncryptionConfiguration
- Kms
Key stringName - The self link or full name of a key which should be used to encrypt this table. Note that the default bigquery service account will need to have encrypt/decrypt permissions on this key - you may want to see the gcp.bigquery.getDefaultServiceAccount datasource and the gcp.kms.CryptoKeyIAMBinding resource.
- Kms
Key stringVersion - The self link or full name of the kms key version used to encrypt this table.
- Kms
Key stringName - The self link or full name of a key which should be used to encrypt this table. Note that the default bigquery service account will need to have encrypt/decrypt permissions on this key - you may want to see the gcp.bigquery.getDefaultServiceAccount datasource and the gcp.kms.CryptoKeyIAMBinding resource.
- Kms
Key stringVersion - The self link or full name of the kms key version used to encrypt this table.
- kms
Key StringName - The self link or full name of a key which should be used to encrypt this table. Note that the default bigquery service account will need to have encrypt/decrypt permissions on this key - you may want to see the gcp.bigquery.getDefaultServiceAccount datasource and the gcp.kms.CryptoKeyIAMBinding resource.
- kms
Key StringVersion - The self link or full name of the kms key version used to encrypt this table.
- kms
Key stringName - The self link or full name of a key which should be used to encrypt this table. Note that the default bigquery service account will need to have encrypt/decrypt permissions on this key - you may want to see the gcp.bigquery.getDefaultServiceAccount datasource and the gcp.kms.CryptoKeyIAMBinding resource.
- kms
Key stringVersion - The self link or full name of the kms key version used to encrypt this table.
- kms_
key_ strname - The self link or full name of a key which should be used to encrypt this table. Note that the default bigquery service account will need to have encrypt/decrypt permissions on this key - you may want to see the gcp.bigquery.getDefaultServiceAccount datasource and the gcp.kms.CryptoKeyIAMBinding resource.
- kms_
key_ strversion - The self link or full name of the kms key version used to encrypt this table.
- kms
Key StringName - The self link or full name of a key which should be used to encrypt this table. Note that the default bigquery service account will need to have encrypt/decrypt permissions on this key - you may want to see the gcp.bigquery.getDefaultServiceAccount datasource and the gcp.kms.CryptoKeyIAMBinding resource.
- kms
Key StringVersion - The self link or full name of the kms key version used to encrypt this table.
GetTableExternalCatalogTableOption
- Connection
Id string - 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 <project_id>.<location_id>.<connection_id> or projects/<project_id>/locations/<location_id>/connections/<connection_id>.
- Parameters Dictionary<string, string>
- 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
Descriptors List<GetTable External Catalog Table Option Storage Descriptor> - A storage descriptor containing information about the physical storage of this table.
- Connection
Id string - 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 <project_id>.<location_id>.<connection_id> or projects/<project_id>/locations/<location_id>/connections/<connection_id>.
- Parameters map[string]string
- 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
Descriptors []GetTable External Catalog Table Option Storage Descriptor - A storage descriptor containing information about the physical storage of this table.
- connection
Id String - 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 <project_id>.<location_id>.<connection_id> or projects/<project_id>/locations/<location_id>/connections/<connection_id>.
- parameters Map<String,String>
- 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
Descriptors List<GetTable External Catalog Table Option Storage Descriptor> - A storage descriptor containing information about the physical storage of this table.
- connection
Id string - 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 <project_id>.<location_id>.<connection_id> or projects/<project_id>/locations/<location_id>/connections/<connection_id>.
- parameters {[key: string]: string}
- 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
Descriptors GetTable External Catalog Table Option Storage Descriptor[] - A storage descriptor containing information about the physical storage of this table.
- connection_
id 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 <project_id>.<location_id>.<connection_id> or projects/<project_id>/locations/<location_id>/connections/<connection_id>.
- parameters Mapping[str, str]
- 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_
descriptors Sequence[GetTable External Catalog Table Option Storage Descriptor] - A storage descriptor containing information about the physical storage of this table.
- connection
Id String - 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 <project_id>.<location_id>.<connection_id> or projects/<project_id>/locations/<location_id>/connections/<connection_id>.
- parameters Map<String>
- 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
Descriptors List<Property Map> - A storage descriptor containing information about the physical storage of this table.
GetTableExternalCatalogTableOptionStorageDescriptor
- Input
Format string - Specifies the fully qualified class name of the InputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcInputFormat"). The maximum length is 128 characters.
- Location
Uri string - The physical location of the table (e.g. 'gs://spark-dataproc-data/pangea-data/case_sensitive/' or 'gs://spark-dataproc-data/pangea-data/*'). The maximum length is 2056 bytes.
- Output
Format string - Specifies the fully qualified class name of the OutputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat"). The maximum length is 128 characters.
- Serde
Infos List<GetTable External Catalog Table Option Storage Descriptor Serde Info> - Serializer and deserializer information.
- Input
Format string - Specifies the fully qualified class name of the InputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcInputFormat"). The maximum length is 128 characters.
- Location
Uri string - The physical location of the table (e.g. 'gs://spark-dataproc-data/pangea-data/case_sensitive/' or 'gs://spark-dataproc-data/pangea-data/*'). The maximum length is 2056 bytes.
- Output
Format string - Specifies the fully qualified class name of the OutputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat"). The maximum length is 128 characters.
- Serde
Infos []GetTable External Catalog Table Option Storage Descriptor Serde Info - Serializer and deserializer information.
- input
Format String - Specifies the fully qualified class name of the InputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcInputFormat"). The maximum length is 128 characters.
- location
Uri String - The physical location of the table (e.g. 'gs://spark-dataproc-data/pangea-data/case_sensitive/' or 'gs://spark-dataproc-data/pangea-data/*'). The maximum length is 2056 bytes.
- output
Format String - Specifies the fully qualified class name of the OutputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat"). The maximum length is 128 characters.
- serde
Infos List<GetTable External Catalog Table Option Storage Descriptor Serde Info> - Serializer and deserializer information.
- input
Format string - Specifies the fully qualified class name of the InputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcInputFormat"). The maximum length is 128 characters.
- location
Uri string - The physical location of the table (e.g. 'gs://spark-dataproc-data/pangea-data/case_sensitive/' or 'gs://spark-dataproc-data/pangea-data/*'). The maximum length is 2056 bytes.
- output
Format string - Specifies the fully qualified class name of the OutputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat"). The maximum length is 128 characters.
- serde
Infos GetTable External Catalog Table Option Storage Descriptor Serde Info[] - Serializer and deserializer information.
- input_
format str - Specifies the fully qualified class name of the InputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcInputFormat"). The maximum length is 128 characters.
- location_
uri str - The physical location of the table (e.g. 'gs://spark-dataproc-data/pangea-data/case_sensitive/' or 'gs://spark-dataproc-data/pangea-data/*'). The maximum length is 2056 bytes.
- output_
format str - Specifies the fully qualified class name of the OutputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat"). The maximum length is 128 characters.
- serde_
infos Sequence[GetTable External Catalog Table Option Storage Descriptor Serde Info] - Serializer and deserializer information.
- input
Format String - Specifies the fully qualified class name of the InputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcInputFormat"). The maximum length is 128 characters.
- location
Uri String - The physical location of the table (e.g. 'gs://spark-dataproc-data/pangea-data/case_sensitive/' or 'gs://spark-dataproc-data/pangea-data/*'). The maximum length is 2056 bytes.
- output
Format String - Specifies the fully qualified class name of the OutputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat"). The maximum length is 128 characters.
- serde
Infos List<Property Map> - Serializer and deserializer information.
GetTableExternalCatalogTableOptionStorageDescriptorSerdeInfo
- Name string
- Name of the SerDe. The maximum length is 256 characters.
- Parameters Dictionary<string, string>
- Key-value pairs that define the initialization parameters for the serialization library. Maximum size 10 Kib.
- Serialization
Library string - Specifies a fully-qualified class name of the serialization library that is responsible for the translation of data between table representation and the underlying low-level input and output format structures. The maximum length is 256 characters.
- Name string
- Name of the SerDe. The maximum length is 256 characters.
- Parameters map[string]string
- Key-value pairs that define the initialization parameters for the serialization library. Maximum size 10 Kib.
- Serialization
Library string - Specifies a fully-qualified class name of the serialization library that is responsible for the translation of data between table representation and the underlying low-level input and output format structures. The maximum length is 256 characters.
- name String
- Name of the SerDe. The maximum length is 256 characters.
- parameters Map<String,String>
- Key-value pairs that define the initialization parameters for the serialization library. Maximum size 10 Kib.
- serialization
Library String - Specifies a fully-qualified class name of the serialization library that is responsible for the translation of data between table representation and the underlying low-level input and output format structures. The maximum length is 256 characters.
- name string
- Name of the SerDe. The maximum length is 256 characters.
- parameters {[key: string]: string}
- Key-value pairs that define the initialization parameters for the serialization library. Maximum size 10 Kib.
- serialization
Library string - Specifies a fully-qualified class name of the serialization library that is responsible for the translation of data between table representation and the underlying low-level input and output format structures. The maximum length is 256 characters.
- name str
- Name of the SerDe. The maximum length is 256 characters.
- parameters Mapping[str, str]
- Key-value pairs that define the initialization parameters for the serialization library. Maximum size 10 Kib.
- serialization_
library str - Specifies a fully-qualified class name of the serialization library that is responsible for the translation of data between table representation and the underlying low-level input and output format structures. The maximum length is 256 characters.
- name String
- Name of the SerDe. The maximum length is 256 characters.
- parameters Map<String>
- Key-value pairs that define the initialization parameters for the serialization library. Maximum size 10 Kib.
- serialization
Library String - Specifies a fully-qualified class name of the serialization library that is responsible for the translation of data between table representation and the underlying low-level input and output format structures. The maximum length is 256 characters.
GetTableExternalDataConfiguration
- Autodetect bool
- Let BigQuery try to autodetect the schema and format of the table.
- Avro
Options List<GetTable External Data Configuration Avro Option> - Additional options if source_format is set to "AVRO"
- Bigtable
Options List<GetTable External Data Configuration Bigtable Option> - Additional options if sourceFormat is set to BIGTABLE.
- Compression string
- The compression type of the data source. Valid values are "NONE" or "GZIP".
- Connection
Id string - The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connectionId can have the form "..<connection_id>" or "projects//locations//connections/<connection_id>".
- Csv
Options List<GetTable External Data Configuration Csv Option> - Additional properties to set if source_format is set to "CSV".
- File
Set stringSpec Type - Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- Google
Sheets List<GetOptions Table External Data Configuration Google Sheets Option> - Additional options if source_format is set to "GOOGLE_SHEETS".
- Hive
Partitioning List<GetOptions Table External Data Configuration Hive Partitioning Option> - When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
- Ignore
Unknown boolValues - Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
- Json
Extension string - Load option to be used together with sourceFormat newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and sourceFormat must be set to NEWLINE_DELIMITED_JSON).
- Json
Options List<GetTable External Data Configuration Json Option> - Additional properties to set if sourceFormat is set to JSON.
- Max
Bad intRecords - The maximum number of bad records that BigQuery can ignore when reading data.
- Metadata
Cache stringMode - Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
- Object
Metadata string - Object Metadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the sourceUris. If ObjectMetadata is set, sourceFormat should be omitted.
- Parquet
Options List<GetTable External Data Configuration Parquet Option> - Additional properties to set if sourceFormat is set to PARQUET.
- Reference
File stringSchema Uri - When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
- Schema string
- A JSON schema for the external table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables.
- Source
Format string - Please see sourceFormat under ExternalDataConfiguration in Bigquery's public API documentation (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externaldataconfiguration) for supported formats. To use "GOOGLE_SHEETS" the scopes must include "googleapis.com/auth/drive.readonly".
- Source
Uris List<string> - A list of the fully-qualified URIs that point to your data in Google Cloud.
- Autodetect bool
- Let BigQuery try to autodetect the schema and format of the table.
- Avro
Options []GetTable External Data Configuration Avro Option - Additional options if source_format is set to "AVRO"
- Bigtable
Options []GetTable External Data Configuration Bigtable Option - Additional options if sourceFormat is set to BIGTABLE.
- Compression string
- The compression type of the data source. Valid values are "NONE" or "GZIP".
- Connection
Id string - The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connectionId can have the form "..<connection_id>" or "projects//locations//connections/<connection_id>".
- Csv
Options []GetTable External Data Configuration Csv Option - Additional properties to set if source_format is set to "CSV".
- File
Set stringSpec Type - Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- Google
Sheets []GetOptions Table External Data Configuration Google Sheets Option - Additional options if source_format is set to "GOOGLE_SHEETS".
- Hive
Partitioning []GetOptions Table External Data Configuration Hive Partitioning Option - When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
- Ignore
Unknown boolValues - Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
- Json
Extension string - Load option to be used together with sourceFormat newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and sourceFormat must be set to NEWLINE_DELIMITED_JSON).
- Json
Options []GetTable External Data Configuration Json Option - Additional properties to set if sourceFormat is set to JSON.
- Max
Bad intRecords - The maximum number of bad records that BigQuery can ignore when reading data.
- Metadata
Cache stringMode - Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
- Object
Metadata string - Object Metadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the sourceUris. If ObjectMetadata is set, sourceFormat should be omitted.
- Parquet
Options []GetTable External Data Configuration Parquet Option - Additional properties to set if sourceFormat is set to PARQUET.
- Reference
File stringSchema Uri - When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
- Schema string
- A JSON schema for the external table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables.
- Source
Format string - Please see sourceFormat under ExternalDataConfiguration in Bigquery's public API documentation (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externaldataconfiguration) for supported formats. To use "GOOGLE_SHEETS" the scopes must include "googleapis.com/auth/drive.readonly".
- Source
Uris []string - A list of the fully-qualified URIs that point to your data in Google Cloud.
- autodetect Boolean
- Let BigQuery try to autodetect the schema and format of the table.
- avro
Options List<GetTable External Data Configuration Avro Option> - Additional options if source_format is set to "AVRO"
- bigtable
Options List<GetTable External Data Configuration Bigtable Option> - Additional options if sourceFormat is set to BIGTABLE.
- compression String
- The compression type of the data source. Valid values are "NONE" or "GZIP".
- connection
Id String - The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connectionId can have the form "..<connection_id>" or "projects//locations//connections/<connection_id>".
- csv
Options List<GetTable External Data Configuration Csv Option> - Additional properties to set if source_format is set to "CSV".
- file
Set StringSpec Type - Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- google
Sheets List<GetOptions Table External Data Configuration Google Sheets Option> - Additional options if source_format is set to "GOOGLE_SHEETS".
- hive
Partitioning List<GetOptions Table External Data Configuration Hive Partitioning Option> - When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
- ignore
Unknown BooleanValues - Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
- json
Extension String - Load option to be used together with sourceFormat newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and sourceFormat must be set to NEWLINE_DELIMITED_JSON).
- json
Options List<GetTable External Data Configuration Json Option> - Additional properties to set if sourceFormat is set to JSON.
- max
Bad IntegerRecords - The maximum number of bad records that BigQuery can ignore when reading data.
- metadata
Cache StringMode - Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
- object
Metadata String - Object Metadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the sourceUris. If ObjectMetadata is set, sourceFormat should be omitted.
- parquet
Options List<GetTable External Data Configuration Parquet Option> - Additional properties to set if sourceFormat is set to PARQUET.
- reference
File StringSchema Uri - When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
- schema String
- A JSON schema for the external table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables.
- source
Format String - Please see sourceFormat under ExternalDataConfiguration in Bigquery's public API documentation (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externaldataconfiguration) for supported formats. To use "GOOGLE_SHEETS" the scopes must include "googleapis.com/auth/drive.readonly".
- source
Uris List<String> - A list of the fully-qualified URIs that point to your data in Google Cloud.
- autodetect boolean
- Let BigQuery try to autodetect the schema and format of the table.
- avro
Options GetTable External Data Configuration Avro Option[] - Additional options if source_format is set to "AVRO"
- bigtable
Options GetTable External Data Configuration Bigtable Option[] - Additional options if sourceFormat is set to BIGTABLE.
- compression string
- The compression type of the data source. Valid values are "NONE" or "GZIP".
- connection
Id string - The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connectionId can have the form "..<connection_id>" or "projects//locations//connections/<connection_id>".
- csv
Options GetTable External Data Configuration Csv Option[] - Additional properties to set if source_format is set to "CSV".
- file
Set stringSpec Type - Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- google
Sheets GetOptions Table External Data Configuration Google Sheets Option[] - Additional options if source_format is set to "GOOGLE_SHEETS".
- hive
Partitioning GetOptions Table External Data Configuration Hive Partitioning Option[] - When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
- ignore
Unknown booleanValues - Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
- json
Extension string - Load option to be used together with sourceFormat newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and sourceFormat must be set to NEWLINE_DELIMITED_JSON).
- json
Options GetTable External Data Configuration Json Option[] - Additional properties to set if sourceFormat is set to JSON.
- max
Bad numberRecords - The maximum number of bad records that BigQuery can ignore when reading data.
- metadata
Cache stringMode - Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
- object
Metadata string - Object Metadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the sourceUris. If ObjectMetadata is set, sourceFormat should be omitted.
- parquet
Options GetTable External Data Configuration Parquet Option[] - Additional properties to set if sourceFormat is set to PARQUET.
- reference
File stringSchema Uri - When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
- schema string
- A JSON schema for the external table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables.
- source
Format string - Please see sourceFormat under ExternalDataConfiguration in Bigquery's public API documentation (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externaldataconfiguration) for supported formats. To use "GOOGLE_SHEETS" the scopes must include "googleapis.com/auth/drive.readonly".
- source
Uris string[] - A list of the fully-qualified URIs that point to your data in Google Cloud.
- autodetect bool
- Let BigQuery try to autodetect the schema and format of the table.
- avro_
options Sequence[GetTable External Data Configuration Avro Option] - Additional options if source_format is set to "AVRO"
- bigtable_
options Sequence[GetTable External Data Configuration Bigtable Option] - Additional options if sourceFormat is set to BIGTABLE.
- compression str
- The compression type of the data source. Valid values are "NONE" or "GZIP".
- connection_
id str - The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connectionId can have the form "..<connection_id>" or "projects//locations//connections/<connection_id>".
- csv_
options Sequence[GetTable External Data Configuration Csv Option] - Additional properties to set if source_format is set to "CSV".
- file_
set_ strspec_ type - Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- google_
sheets_ Sequence[Getoptions Table External Data Configuration Google Sheets Option] - Additional options if source_format is set to "GOOGLE_SHEETS".
- hive_
partitioning_ Sequence[Getoptions Table External Data Configuration Hive Partitioning Option] - When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
- ignore_
unknown_ boolvalues - Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
- json_
extension str - Load option to be used together with sourceFormat newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and sourceFormat must be set to NEWLINE_DELIMITED_JSON).
- json_
options Sequence[GetTable External Data Configuration Json Option] - Additional properties to set if sourceFormat is set to JSON.
- max_
bad_ intrecords - The maximum number of bad records that BigQuery can ignore when reading data.
- metadata_
cache_ strmode - Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
- object_
metadata str - Object Metadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the sourceUris. If ObjectMetadata is set, sourceFormat should be omitted.
- parquet_
options Sequence[GetTable External Data Configuration Parquet Option] - Additional properties to set if sourceFormat is set to PARQUET.
- reference_
file_ strschema_ uri - When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
- schema str
- A JSON schema for the external table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables.
- source_
format str - Please see sourceFormat under ExternalDataConfiguration in Bigquery's public API documentation (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externaldataconfiguration) for supported formats. To use "GOOGLE_SHEETS" the scopes must include "googleapis.com/auth/drive.readonly".
- source_
uris Sequence[str] - A list of the fully-qualified URIs that point to your data in Google Cloud.
- autodetect Boolean
- Let BigQuery try to autodetect the schema and format of the table.
- avro
Options List<Property Map> - Additional options if source_format is set to "AVRO"
- bigtable
Options List<Property Map> - Additional options if sourceFormat is set to BIGTABLE.
- compression String
- The compression type of the data source. Valid values are "NONE" or "GZIP".
- connection
Id String - The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connectionId can have the form "..<connection_id>" or "projects//locations//connections/<connection_id>".
- csv
Options List<Property Map> - Additional properties to set if source_format is set to "CSV".
- file
Set StringSpec Type - Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- google
Sheets List<Property Map>Options - Additional options if source_format is set to "GOOGLE_SHEETS".
- hive
Partitioning List<Property Map>Options - When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
- ignore
Unknown BooleanValues - Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
- json
Extension String - Load option to be used together with sourceFormat newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and sourceFormat must be set to NEWLINE_DELIMITED_JSON).
- json
Options List<Property Map> - Additional properties to set if sourceFormat is set to JSON.
- max
Bad NumberRecords - The maximum number of bad records that BigQuery can ignore when reading data.
- metadata
Cache StringMode - Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
- object
Metadata String - Object Metadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the sourceUris. If ObjectMetadata is set, sourceFormat should be omitted.
- parquet
Options List<Property Map> - Additional properties to set if sourceFormat is set to PARQUET.
- reference
File StringSchema Uri - When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
- schema String
- A JSON schema for the external table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables.
- source
Format String - Please see sourceFormat under ExternalDataConfiguration in Bigquery's public API documentation (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externaldataconfiguration) for supported formats. To use "GOOGLE_SHEETS" the scopes must include "googleapis.com/auth/drive.readonly".
- source
Uris List<String> - A list of the fully-qualified URIs that point to your data in Google Cloud.
GetTableExternalDataConfigurationAvroOption
- Use
Avro boolLogical Types - If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- Use
Avro boolLogical Types - If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- use
Avro BooleanLogical Types - If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- use
Avro booleanLogical Types - If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- use_
avro_ boollogical_ types - If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- use
Avro BooleanLogical Types - If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
GetTableExternalDataConfigurationBigtableOption
- Column
Families List<GetTable External Data Configuration Bigtable Option Column Family> - A list of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
- Ignore
Unspecified boolColumn Families - If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
- Output
Column boolFamilies As Json - If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.
- Read
Rowkey boolAs String - If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
- Column
Families []GetTable External Data Configuration Bigtable Option Column Family - A list of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
- Ignore
Unspecified boolColumn Families - If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
- Output
Column boolFamilies As Json - If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.
- Read
Rowkey boolAs String - If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
- column
Families List<GetTable External Data Configuration Bigtable Option Column Family> - A list of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
- ignore
Unspecified BooleanColumn Families - If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
- output
Column BooleanFamilies As Json - If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.
- read
Rowkey BooleanAs String - If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
- column
Families GetTable External Data Configuration Bigtable Option Column Family[] - A list of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
- ignore
Unspecified booleanColumn Families - If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
- output
Column booleanFamilies As Json - If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.
- read
Rowkey booleanAs String - If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
- column_
families Sequence[GetTable External Data Configuration Bigtable Option Column Family] - A list of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
- ignore_
unspecified_ boolcolumn_ families - If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
- output_
column_ boolfamilies_ as_ json - If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.
- read_
rowkey_ boolas_ string - If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
- column
Families List<Property Map> - A list of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
- ignore
Unspecified BooleanColumn Families - If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
- output
Column BooleanFamilies As Json - If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.
- read
Rowkey BooleanAs String - If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
GetTableExternalDataConfigurationBigtableOptionColumnFamily
- Columns
List<Get
Table External Data Configuration Bigtable Option Column Family Column> - A List of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as Other columns can be accessed as a list through column field
- Encoding string
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
- Family
Id string - Identifier of the column family.
- Only
Read boolLatest - If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
- Type string
- The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON". Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
- Columns
[]Get
Table External Data Configuration Bigtable Option Column Family Column - A List of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as Other columns can be accessed as a list through column field
- Encoding string
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
- Family
Id string - Identifier of the column family.
- Only
Read boolLatest - If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
- Type string
- The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON". Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
- columns
List<Get
Table External Data Configuration Bigtable Option Column Family Column> - A List of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as Other columns can be accessed as a list through column field
- encoding String
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
- family
Id String - Identifier of the column family.
- only
Read BooleanLatest - If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
- type String
- The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON". Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
- columns
Get
Table External Data Configuration Bigtable Option Column Family Column[] - A List of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as Other columns can be accessed as a list through column field
- encoding string
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
- family
Id string - Identifier of the column family.
- only
Read booleanLatest - If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
- type string
- The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON". Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
- columns
Sequence[Get
Table External Data Configuration Bigtable Option Column Family Column] - A List of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as Other columns can be accessed as a list through column field
- encoding str
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
- family_
id str - Identifier of the column family.
- only_
read_ boollatest - If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
- type str
- The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON". Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
- columns List<Property Map>
- A List of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as Other columns can be accessed as a list through column field
- encoding String
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
- family
Id String - Identifier of the column family.
- only
Read BooleanLatest - If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
- type String
- The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON". Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
GetTableExternalDataConfigurationBigtableOptionColumnFamilyColumn
- Encoding string
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
- Field
Name string - If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
- Only
Read boolLatest - If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
- Qualifier
Encoded string - Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifierString field. Otherwise, a base-64 encoded value must be set to qualifierEncoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as fieldName.
- Qualifier
String string - Qualifier string.
- Type string
- The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON", Default type is "BYTES". 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
- Encoding string
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
- Field
Name string - If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
- Only
Read boolLatest - If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
- Qualifier
Encoded string - Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifierString field. Otherwise, a base-64 encoded value must be set to qualifierEncoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as fieldName.
- Qualifier
String string - Qualifier string.
- Type string
- The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON", Default type is "BYTES". 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
- encoding String
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
- field
Name String - If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
- only
Read BooleanLatest - If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
- qualifier
Encoded String - Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifierString field. Otherwise, a base-64 encoded value must be set to qualifierEncoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as fieldName.
- qualifier
String String - Qualifier string.
- type String
- The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON", Default type is "BYTES". 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
- encoding string
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
- field
Name string - If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
- only
Read booleanLatest - If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
- qualifier
Encoded string - Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifierString field. Otherwise, a base-64 encoded value must be set to qualifierEncoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as fieldName.
- qualifier
String string - Qualifier string.
- type string
- The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON", Default type is "BYTES". 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
- encoding str
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
- field_
name str - If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
- only_
read_ boollatest - If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
- qualifier_
encoded str - Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifierString field. Otherwise, a base-64 encoded value must be set to qualifierEncoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as fieldName.
- qualifier_
string str - Qualifier string.
- type str
- The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON", Default type is "BYTES". 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
- encoding String
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
- field
Name String - If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
- only
Read BooleanLatest - If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
- qualifier
Encoded String - Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifierString field. Otherwise, a base-64 encoded value must be set to qualifierEncoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as fieldName.
- qualifier
String String - Qualifier string.
- type String
- The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): "BYTES", "STRING", "INTEGER", "FLOAT", "BOOLEAN", "JSON", Default type is "BYTES". 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
GetTableExternalDataConfigurationCsvOption
- Allow
Jagged boolRows - Indicates if BigQuery should accept rows that are missing trailing optional columns.
- Allow
Quoted boolNewlines - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- Encoding string
- The character encoding of the data. The supported values are UTF-8 or ISO-8859-1.
- Field
Delimiter string - The separator for fields in a CSV file.
- Quote string
- Skip
Leading intRows - The number of rows at the top of a CSV file that BigQuery will skip when reading the data.
- Allow
Jagged boolRows - Indicates if BigQuery should accept rows that are missing trailing optional columns.
- Allow
Quoted boolNewlines - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- Encoding string
- The character encoding of the data. The supported values are UTF-8 or ISO-8859-1.
- Field
Delimiter string - The separator for fields in a CSV file.
- Quote string
- Skip
Leading intRows - The number of rows at the top of a CSV file that BigQuery will skip when reading the data.
- allow
Jagged BooleanRows - Indicates if BigQuery should accept rows that are missing trailing optional columns.
- allow
Quoted BooleanNewlines - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- encoding String
- The character encoding of the data. The supported values are UTF-8 or ISO-8859-1.
- field
Delimiter String - The separator for fields in a CSV file.
- quote String
- skip
Leading IntegerRows - The number of rows at the top of a CSV file that BigQuery will skip when reading the data.
- allow
Jagged booleanRows - Indicates if BigQuery should accept rows that are missing trailing optional columns.
- allow
Quoted booleanNewlines - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- encoding string
- The character encoding of the data. The supported values are UTF-8 or ISO-8859-1.
- field
Delimiter string - The separator for fields in a CSV file.
- quote string
- skip
Leading numberRows - The number of rows at the top of a CSV file that BigQuery will skip when reading the data.
- allow_
jagged_ boolrows - Indicates if BigQuery should accept rows that are missing trailing optional columns.
- allow_
quoted_ boolnewlines - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- encoding str
- The character encoding of the data. The supported values are UTF-8 or ISO-8859-1.
- field_
delimiter str - The separator for fields in a CSV file.
- quote str
- skip_
leading_ introws - The number of rows at the top of a CSV file that BigQuery will skip when reading the data.
- allow
Jagged BooleanRows - Indicates if BigQuery should accept rows that are missing trailing optional columns.
- allow
Quoted BooleanNewlines - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- encoding String
- The character encoding of the data. The supported values are UTF-8 or ISO-8859-1.
- field
Delimiter String - The separator for fields in a CSV file.
- quote String
- skip
Leading NumberRows - The number of rows at the top of a CSV file that BigQuery will skip when reading the data.
GetTableExternalDataConfigurationGoogleSheetsOption
- Range string
- Range of a sheet to query from. Only used when non-empty. At least one of range or skip_leading_rows must be set. Typical format: "sheet_name!top_left_cell_id:bottom_right_cell_id" For example: "sheet1!A1:B20
- Skip
Leading intRows - The number of rows at the top of the sheet that BigQuery will skip when reading the data. At least one of range or skip_leading_rows must be set.
- Range string
- Range of a sheet to query from. Only used when non-empty. At least one of range or skip_leading_rows must be set. Typical format: "sheet_name!top_left_cell_id:bottom_right_cell_id" For example: "sheet1!A1:B20
- Skip
Leading intRows - The number of rows at the top of the sheet that BigQuery will skip when reading the data. At least one of range or skip_leading_rows must be set.
- range String
- Range of a sheet to query from. Only used when non-empty. At least one of range or skip_leading_rows must be set. Typical format: "sheet_name!top_left_cell_id:bottom_right_cell_id" For example: "sheet1!A1:B20
- skip
Leading IntegerRows - The number of rows at the top of the sheet that BigQuery will skip when reading the data. At least one of range or skip_leading_rows must be set.
- range string
- Range of a sheet to query from. Only used when non-empty. At least one of range or skip_leading_rows must be set. Typical format: "sheet_name!top_left_cell_id:bottom_right_cell_id" For example: "sheet1!A1:B20
- skip
Leading numberRows - The number of rows at the top of the sheet that BigQuery will skip when reading the data. At least one of range or skip_leading_rows must be set.
- range str
- Range of a sheet to query from. Only used when non-empty. At least one of range or skip_leading_rows must be set. Typical format: "sheet_name!top_left_cell_id:bottom_right_cell_id" For example: "sheet1!A1:B20
- skip_
leading_ introws - The number of rows at the top of the sheet that BigQuery will skip when reading the data. At least one of range or skip_leading_rows must be set.
- range String
- Range of a sheet to query from. Only used when non-empty. At least one of range or skip_leading_rows must be set. Typical format: "sheet_name!top_left_cell_id:bottom_right_cell_id" For example: "sheet1!A1:B20
- skip
Leading NumberRows - The number of rows at the top of the sheet that BigQuery will skip when reading the data. At least one of range or skip_leading_rows must be set.
GetTableExternalDataConfigurationHivePartitioningOption
- Mode string
- When set, what mode of hive partitioning to use when reading data.
- Require
Partition boolFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- Source
Uri stringPrefix - When hive partition detection is requested, a common for all source uris must be required. The prefix must end immediately before the partition key encoding begins.
- Mode string
- When set, what mode of hive partitioning to use when reading data.
- Require
Partition boolFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- Source
Uri stringPrefix - When hive partition detection is requested, a common for all source uris must be required. The prefix must end immediately before the partition key encoding begins.
- mode String
- When set, what mode of hive partitioning to use when reading data.
- require
Partition BooleanFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- source
Uri StringPrefix - When hive partition detection is requested, a common for all source uris must be required. The prefix must end immediately before the partition key encoding begins.
- mode string
- When set, what mode of hive partitioning to use when reading data.
- require
Partition booleanFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- source
Uri stringPrefix - When hive partition detection is requested, a common for all source uris must be required. The prefix must end immediately before the partition key encoding begins.
- mode str
- When set, what mode of hive partitioning to use when reading data.
- require_
partition_ boolfilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- source_
uri_ strprefix - When hive partition detection is requested, a common for all source uris must be required. The prefix must end immediately before the partition key encoding begins.
- mode String
- When set, what mode of hive partitioning to use when reading data.
- require
Partition BooleanFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- source
Uri StringPrefix - When hive partition detection is requested, a common for all source uris must be required. The prefix must end immediately before the partition key encoding begins.
GetTableExternalDataConfigurationJsonOption
- Encoding string
- The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.
- Encoding string
- The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.
- encoding String
- The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.
- encoding string
- The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.
- encoding str
- The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.
- encoding String
- The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.
GetTableExternalDataConfigurationParquetOption
- Enable
List boolInference - Indicates whether to use schema inference specifically for Parquet LIST logical type.
- Enum
As boolString - Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- Enable
List boolInference - Indicates whether to use schema inference specifically for Parquet LIST logical type.
- Enum
As boolString - Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable
List BooleanInference - Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum
As BooleanString - Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable
List booleanInference - Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum
As booleanString - Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable_
list_ boolinference - Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum_
as_ boolstring - Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable
List BooleanInference - Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum
As BooleanString - Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
GetTableMaterializedView
- Allow
Non boolIncremental Definition - Allow non incremental materialized view definition. The default value is false.
- Enable
Refresh bool - Specifies if BigQuery should automatically refresh materialized view when the base table is updated. The default is true.
- Query string
- A query whose result is persisted.
- Refresh
Interval intMs - Specifies maximum frequency at which this materialized view will be refreshed. The default is 1800000.
- Allow
Non boolIncremental Definition - Allow non incremental materialized view definition. The default value is false.
- Enable
Refresh bool - Specifies if BigQuery should automatically refresh materialized view when the base table is updated. The default is true.
- Query string
- A query whose result is persisted.
- Refresh
Interval intMs - Specifies maximum frequency at which this materialized view will be refreshed. The default is 1800000.
- allow
Non BooleanIncremental Definition - Allow non incremental materialized view definition. The default value is false.
- enable
Refresh Boolean - Specifies if BigQuery should automatically refresh materialized view when the base table is updated. The default is true.
- query String
- A query whose result is persisted.
- refresh
Interval IntegerMs - Specifies maximum frequency at which this materialized view will be refreshed. The default is 1800000.
- allow
Non booleanIncremental Definition - Allow non incremental materialized view definition. The default value is false.
- enable
Refresh boolean - Specifies if BigQuery should automatically refresh materialized view when the base table is updated. The default is true.
- query string
- A query whose result is persisted.
- refresh
Interval numberMs - Specifies maximum frequency at which this materialized view will be refreshed. The default is 1800000.
- allow_
non_ boolincremental_ definition - Allow non incremental materialized view definition. The default value is false.
- enable_
refresh bool - Specifies if BigQuery should automatically refresh materialized view when the base table is updated. The default is true.
- query str
- A query whose result is persisted.
- refresh_
interval_ intms - Specifies maximum frequency at which this materialized view will be refreshed. The default is 1800000.
- allow
Non BooleanIncremental Definition - Allow non incremental materialized view definition. The default value is false.
- enable
Refresh Boolean - Specifies if BigQuery should automatically refresh materialized view when the base table is updated. The default is true.
- query String
- A query whose result is persisted.
- refresh
Interval NumberMs - Specifies maximum frequency at which this materialized view will be refreshed. The default is 1800000.
GetTableRangePartitioning
- Field string
- The field used to determine how to create a range-based partition.
- Ranges
List<Get
Table Range Partitioning Range> - Information required to partition based on ranges. Structure is documented below.
- Field string
- The field used to determine how to create a range-based partition.
- Ranges
[]Get
Table Range Partitioning Range - Information required to partition based on ranges. Structure is documented below.
- field String
- The field used to determine how to create a range-based partition.
- ranges
List<Get
Table Range Partitioning Range> - Information required to partition based on ranges. Structure is documented below.
- field string
- The field used to determine how to create a range-based partition.
- ranges
Get
Table Range Partitioning Range[] - Information required to partition based on ranges. Structure is documented below.
- field str
- The field used to determine how to create a range-based partition.
- ranges
Sequence[Get
Table Range Partitioning Range] - Information required to partition based on ranges. Structure is documented below.
- field String
- The field used to determine how to create a range-based partition.
- ranges List<Property Map>
- Information required to partition based on ranges. Structure is documented below.
GetTableRangePartitioningRange
GetTableSchemaForeignTypeInfo
- Type
System string - Specifies the system which defines the foreign data type.
- Type
System string - Specifies the system which defines the foreign data type.
- type
System String - Specifies the system which defines the foreign data type.
- type
System string - Specifies the system which defines the foreign data type.
- type_
system str - Specifies the system which defines the foreign data type.
- type
System String - Specifies the system which defines the foreign data type.
GetTableTableConstraint
- Foreign
Keys List<GetTable Table Constraint Foreign Key> - Present only if the table has a foreign key. The foreign key is not enforced.
- Primary
Keys List<GetTable Table Constraint Primary Key> - Represents a primary key constraint on a table's columns. Present only if the table has a primary key. The primary key is not enforced.
- Foreign
Keys []GetTable Table Constraint Foreign Key - Present only if the table has a foreign key. The foreign key is not enforced.
- Primary
Keys []GetTable Table Constraint Primary Key - Represents a primary key constraint on a table's columns. Present only if the table has a primary key. The primary key is not enforced.
- foreign
Keys List<GetTable Table Constraint Foreign Key> - Present only if the table has a foreign key. The foreign key is not enforced.
- primary
Keys List<GetTable Table Constraint Primary Key> - Represents a primary key constraint on a table's columns. Present only if the table has a primary key. The primary key is not enforced.
- foreign
Keys GetTable Table Constraint Foreign Key[] - Present only if the table has a foreign key. The foreign key is not enforced.
- primary
Keys GetTable Table Constraint Primary Key[] - Represents a primary key constraint on a table's columns. Present only if the table has a primary key. The primary key is not enforced.
- foreign_
keys Sequence[GetTable Table Constraint Foreign Key] - Present only if the table has a foreign key. The foreign key is not enforced.
- primary_
keys Sequence[GetTable Table Constraint Primary Key] - Represents a primary key constraint on a table's columns. Present only if the table has a primary key. The primary key is not enforced.
- foreign
Keys List<Property Map> - Present only if the table has a foreign key. The foreign key is not enforced.
- primary
Keys List<Property Map> - Represents a primary key constraint on a table's columns. Present only if the table has a primary key. The primary key is not enforced.
GetTableTableConstraintForeignKey
- Column
References List<GetTable Table Constraint Foreign Key Column Reference> - The pair of the foreign key column and primary key column.
- Name string
- Set only if the foreign key constraint is named.
- Referenced
Tables List<GetTable Table Constraint Foreign Key Referenced Table> - The table that holds the primary key and is referenced by this foreign key.
- Column
References []GetTable Table Constraint Foreign Key Column Reference - The pair of the foreign key column and primary key column.
- Name string
- Set only if the foreign key constraint is named.
- Referenced
Tables []GetTable Table Constraint Foreign Key Referenced Table - The table that holds the primary key and is referenced by this foreign key.
- column
References List<GetTable Table Constraint Foreign Key Column Reference> - The pair of the foreign key column and primary key column.
- name String
- Set only if the foreign key constraint is named.
- referenced
Tables List<GetTable Table Constraint Foreign Key Referenced Table> - The table that holds the primary key and is referenced by this foreign key.
- column
References GetTable Table Constraint Foreign Key Column Reference[] - The pair of the foreign key column and primary key column.
- name string
- Set only if the foreign key constraint is named.
- referenced
Tables GetTable Table Constraint Foreign Key Referenced Table[] - The table that holds the primary key and is referenced by this foreign key.
- column_
references Sequence[GetTable Table Constraint Foreign Key Column Reference] - The pair of the foreign key column and primary key column.
- name str
- Set only if the foreign key constraint is named.
- referenced_
tables Sequence[GetTable Table Constraint Foreign Key Referenced Table] - The table that holds the primary key and is referenced by this foreign key.
- column
References List<Property Map> - The pair of the foreign key column and primary key column.
- name String
- Set only if the foreign key constraint is named.
- referenced
Tables List<Property Map> - The table that holds the primary key and is referenced by this foreign key.
GetTableTableConstraintForeignKeyColumnReference
- Referenced
Column string - The column in the primary key that are referenced by the referencingColumn.
- Referencing
Column string - The column that composes the foreign key.
- Referenced
Column string - The column in the primary key that are referenced by the referencingColumn.
- Referencing
Column string - The column that composes the foreign key.
- referenced
Column String - The column in the primary key that are referenced by the referencingColumn.
- referencing
Column String - The column that composes the foreign key.
- referenced
Column string - The column in the primary key that are referenced by the referencingColumn.
- referencing
Column string - The column that composes the foreign key.
- referenced_
column str - The column in the primary key that are referenced by the referencingColumn.
- referencing_
column str - The column that composes the foreign key.
- referenced
Column String - The column in the primary key that are referenced by the referencingColumn.
- referencing
Column String - The column that composes the foreign key.
GetTableTableConstraintForeignKeyReferencedTable
- dataset_
id str - The dataset ID.
- project_
id str - The ID of the project containing this table.
- table_
id str - The table ID.
GetTableTableConstraintPrimaryKey
- Columns List<string>
- The columns that are composed of the primary key constraint.
- Columns []string
- The columns that are composed of the primary key constraint.
- columns List<String>
- The columns that are composed of the primary key constraint.
- columns string[]
- The columns that are composed of the primary key constraint.
- columns Sequence[str]
- The columns that are composed of the primary key constraint.
- columns List<String>
- The columns that are composed of the primary key constraint.
GetTableTableReplicationInfo
- Replication
Interval intMs - The interval at which the source materialized view is polled for updates. The default is 300000.
- Source
Dataset stringId - The ID of the source dataset.
- Source
Project stringId - The ID of the source project.
- Source
Table stringId - The ID of the source materialized view.
- Replication
Interval intMs - The interval at which the source materialized view is polled for updates. The default is 300000.
- Source
Dataset stringId - The ID of the source dataset.
- Source
Project stringId - The ID of the source project.
- Source
Table stringId - The ID of the source materialized view.
- replication
Interval IntegerMs - The interval at which the source materialized view is polled for updates. The default is 300000.
- source
Dataset StringId - The ID of the source dataset.
- source
Project StringId - The ID of the source project.
- source
Table StringId - The ID of the source materialized view.
- replication
Interval numberMs - The interval at which the source materialized view is polled for updates. The default is 300000.
- source
Dataset stringId - The ID of the source dataset.
- source
Project stringId - The ID of the source project.
- source
Table stringId - The ID of the source materialized view.
- replication_
interval_ intms - The interval at which the source materialized view is polled for updates. The default is 300000.
- source_
dataset_ strid - The ID of the source dataset.
- source_
project_ strid - The ID of the source project.
- source_
table_ strid - The ID of the source materialized view.
- replication
Interval NumberMs - The interval at which the source materialized view is polled for updates. The default is 300000.
- source
Dataset StringId - The ID of the source dataset.
- source
Project StringId - The ID of the source project.
- source
Table StringId - The ID of the source materialized view.
GetTableTimePartitioning
- Expiration
Ms int - Number of milliseconds for which to keep the storage for a partition.
- Field string
- The field used to determine how to create a time-based partition. If time-based partitioning is enabled without this value, the table is partitioned based on the load time.
- Require
Partition boolFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- Type string
- The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
- Expiration
Ms int - Number of milliseconds for which to keep the storage for a partition.
- Field string
- The field used to determine how to create a time-based partition. If time-based partitioning is enabled without this value, the table is partitioned based on the load time.
- Require
Partition boolFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- Type string
- The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
- expiration
Ms Integer - Number of milliseconds for which to keep the storage for a partition.
- field String
- The field used to determine how to create a time-based partition. If time-based partitioning is enabled without this value, the table is partitioned based on the load time.
- require
Partition BooleanFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- type String
- The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
- expiration
Ms number - Number of milliseconds for which to keep the storage for a partition.
- field string
- The field used to determine how to create a time-based partition. If time-based partitioning is enabled without this value, the table is partitioned based on the load time.
- require
Partition booleanFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- type string
- The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
- expiration_
ms int - Number of milliseconds for which to keep the storage for a partition.
- field str
- The field used to determine how to create a time-based partition. If time-based partitioning is enabled without this value, the table is partitioned based on the load time.
- require_
partition_ boolfilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- type str
- The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
- expiration
Ms Number - Number of milliseconds for which to keep the storage for a partition.
- field String
- The field used to determine how to create a time-based partition. If time-based partitioning is enabled without this value, the table is partitioned based on the load time.
- require
Partition BooleanFilter - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
- type String
- The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
GetTableView
- Query string
- A query that BigQuery executes when the view is referenced.
- Use
Legacy boolSql - Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL
- Query string
- A query that BigQuery executes when the view is referenced.
- Use
Legacy boolSql - Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL
- query String
- A query that BigQuery executes when the view is referenced.
- use
Legacy BooleanSql - Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL
- query string
- A query that BigQuery executes when the view is referenced.
- use
Legacy booleanSql - Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL
- query str
- A query that BigQuery executes when the view is referenced.
- use_
legacy_ boolsql - Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL
- query String
- A query that BigQuery executes when the view is referenced.
- use
Legacy BooleanSql - Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.