gcp_bigquery_table

ancestors

Type: UNORDERED_LIST_STRING

clone_definition

Type: STRUCT
Provider name: cloneDefinition
Description: [Output-only] Clone definition.

  • base_table_reference
    Type: STRUCT
    Provider name: baseTableReference
    Description: [Required] Reference describing the ID of the table that was cloned.
    • dataset_id
      Type: STRING
      Provider name: datasetId
      Description: [Required] The ID of the dataset containing this table.
    • project_id
      Type: STRING
      Provider name: projectId
      Description: [Required] The ID of the project containing this table.
    • table_id
      Type: STRING
      Provider name: tableId
      Description: [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
  • clone_time
    Type: TIMESTAMP
    Provider name: cloneTime
    Description: [Required] The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format.

clustering

Type: STRUCT
Provider name: clustering
Description: [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

creation_time

Type: INT64
Provider name: creationTime
Description: [Output-only] The time when this table was created, in milliseconds since the epoch.

default_collation

Type: STRING
Provider name: defaultCollation
Description: [Output-only] The default collation of the table.

default_rounding_mode

Type: STRING
Provider name: defaultRoundingMode
Description: [Output-only] The default rounding mode of the table.

description

Type: STRING
Provider name: description
Description: [Optional] A user-friendly description of this table.

encryption_configuration

Type: STRUCT
Provider name: encryptionConfiguration
Description: Custom encryption configuration (e.g., Cloud KMS keys).

  • kms_key_name
    Type: STRING
    Provider name: kmsKeyName
    Description: Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

etag

Type: STRING
Provider name: etag
Description: [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

expiration_time

Type: INT64
Provider name: expirationTime
Description: [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

external_data_configuration

Type: STRUCT
Provider name: externalDataConfiguration
Description: [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

  • autodetect
    Type: BOOLEAN
    Provider name: autodetect
    Description: Try to detect schema and format options automatically. Any option specified explicitly will be honored.

  • avro_options
    Type: STRUCT
    Provider name: avroOptions
    Description: Additional properties to set if sourceFormat is set to Avro.

    • use_avro_logical_types
      Type: BOOLEAN
      Provider name: useAvroLogicalTypes
      Description: [Optional] 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).

  • bigtable_options
    Type: STRUCT
    Provider name: bigtableOptions
    Description: [Optional] Additional options if sourceFormat is set to BIGTABLE.

    • column_families
      Type: UNORDERED_LIST_STRUCT
      Provider name: columnFamilies
      Description: [Optional] 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.
      • columns
        Type: UNORDERED_LIST_STRUCT
        Provider name: columns
        Description: [Optional] Lists 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
          Type: STRING
          Provider name: encoding
          Description: [Optional] 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
          Type: STRING
          Provider name: fieldName
          Description: [Optional] 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_latest
          Type: BOOLEAN
          Provider name: onlyReadLatest
          Description: [Optional] 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_string
          Type: STRING
          Provider name: qualifierString
        • type
          Type: STRING
          Provider name: type
          Description: [Optional] 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 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
        Type: STRING
        Provider name: encoding
        Description: [Optional] 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
        Type: STRING
        Provider name: familyId
        Description: Identifier of the column family.
      • only_read_latest
        Type: BOOLEAN
        Provider name: onlyReadLatest
        Description: [Optional] 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
        Type: STRING
        Provider name: type
        Description: [Optional] 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 Default type is BYTES. This can be overridden for a specific column by listing that column in ‘columns’ and specifying a type for it.
    • ignore_unspecified_column_families
      Type: BOOLEAN
      Provider name: ignoreUnspecifiedColumnFamilies
      Description: [Optional] 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.
    • read_rowkey_as_string
      Type: BOOLEAN
      Provider name: readRowkeyAsString
      Description: [Optional] 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.

  • compression
    Type: STRING
    Provider name: compression
    Description: [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

  • connection_id
    Type: STRING
    Provider name: connectionId
    Description: [Optional, Trusted Tester] Connection for external data source.

  • csv_options
    Type: STRUCT
    Provider name: csvOptions
    Description: Additional properties to set if sourceFormat is set to CSV.

    • allow_jagged_rows
      Type: BOOLEAN
      Provider name: allowJaggedRows
      Description: [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing 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.
    • allow_quoted_newlines
      Type: BOOLEAN
      Provider name: allowQuotedNewlines
      Description: [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
    • encoding
      Type: STRING
      Provider name: encoding
      Description: [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
    • field_delimiter
      Type: STRING
      Provider name: fieldDelimiter
      Description: [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence “\t” to specify a tab separator. The default value is a comma (’,’).
    • null_marker
      Type: STRING
      Provider name: null_marker
      Description: [Optional] An custom string that will represent a NULL value in CSV import data.
    • preserve_ascii_control_characters
      Type: BOOLEAN
      Provider name: preserveAsciiControlCharacters
      Description: [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from ‘\x00’ to ‘\x1F’) when loading from CSV. Only applicable to CSV, ignored for other formats.
    • quote
      Type: STRING
      Provider name: quote
      Description: [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (’"’). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
    • skip_leading_rows
      Type: INT64
      Provider name: skipLeadingRows
      Description: [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

  • decimal_target_types
    Type: UNORDERED_LIST_STRING
    Provider name: decimalTargetTypes
    Description: [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [“NUMERIC”, “BIGNUMERIC”]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [“BIGNUMERIC”, “NUMERIC”] is the same as [“NUMERIC”, “BIGNUMERIC”] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [“NUMERIC”, “STRING”] for ORC and [“NUMERIC”] for the other file formats.

  • file_set_spec_type
    Type: STRING
    Provider name: fileSetSpecType
    Description: [Optional] 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_options
    Type: STRUCT
    Provider name: googleSheetsOptions
    Description: [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

    • range
      Type: STRING
      Provider name: range
      Description: [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
    • skip_leading_rows
      Type: INT64
      Provider name: skipLeadingRows
      Description: [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

  • hive_partitioning_options
    Type: STRUCT
    Provider name: hivePartitioningOptions
    Description: [Optional] Options to configure hive partitioning support.

    • mode
      Type: STRING
      Provider name: mode
      Description: [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
    • require_partition_filter
      Type: BOOLEAN
      Provider name: requirePartitionFilter
      Description: [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
    • source_uri_prefix
      Type: STRING
      Provider name: sourceUriPrefix
      Description: [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

  • ignore_unknown_values
    Type: BOOLEAN
    Provider name: ignoreUnknownValues
    Description: [Optional] 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. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don’t match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

  • json_options
    Type: STRUCT
    Provider name: jsonOptions
    Description: Additional properties to set if sourceFormat is set to NEWLINE_DELIMITED_JSON.

    • encoding
      Type: STRING
      Provider name: encoding
      Description: [Optional] 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.

  • max_bad_records
    Type: INT32
    Provider name: maxBadRecords
    Description: [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

  • metadata_cache_mode
    Type: STRING
    Provider name: metadataCacheMode
    Description: [Optional] Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.

  • object_metadata
    Type: STRING
    Provider name: objectMetadata
    Description: ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.

  • parquet_options
    Type: STRUCT
    Provider name: parquetOptions
    Description: Additional properties to set if sourceFormat is set to Parquet.

    • enable_list_inference
      Type: BOOLEAN
      Provider name: enableListInference
      Description: [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
    • enum_as_string
      Type: BOOLEAN
      Provider name: enumAsString
      Description: [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

  • reference_file_schema_uri
    Type: STRING
    Provider name: referenceFileSchemaUri
    Description: [Optional] Provide a referencing file with the expected table schema. Enabled for the format: AVRO, PARQUET, ORC.

  • schema
    Type: STRUCT
    Provider name: schema
    Description: [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

  • source_format
    Type: STRING
    Provider name: sourceFormat
    Description: [Required] The data format. For CSV files, specify “CSV”. For Google sheets, specify “GOOGLE_SHEETS”. For newline-delimited JSON, specify “NEWLINE_DELIMITED_JSON”. For Avro files, specify “AVRO”. For Google Cloud Datastore backups, specify “DATASTORE_BACKUP”. [Beta] For Google Cloud Bigtable, specify “BIGTABLE”.

  • source_uris
    Type: UNORDERED_LIST_STRING
    Provider name: sourceUris
    Description: [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one ‘’ wildcard character and it must come after the ‘bucket’ name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the ‘’ wildcard character is not allowed.

friendly_name

Type: STRING
Provider name: friendlyName
Description: [Optional] A descriptive name for this table.

id

Type: STRING
Provider name: id
Description: [Output-only] An opaque ID uniquely identifying the table.

kind

Type: STRING
Provider name: kind
Description: [Output-only] The type of the resource.

labels

Type: UNORDERED_LIST_STRING

last_modified_time

Type: INT64
Provider name: lastModifiedTime
Description: [Output-only] The time when this table was last modified, in milliseconds since the epoch.

location

Type: STRING
Provider name: location
Description: [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

materialized_view

Type: STRUCT
Provider name: materializedView
Description: [Optional] Materialized view definition.

  • allow_non_incremental_definition
    Type: BOOLEAN
    Provider name: allow_non_incremental_definition
    Description: [Optional] Allow non incremental materialized view definition. The default value is “false”.
  • enable_refresh
    Type: BOOLEAN
    Provider name: enableRefresh
    Description: [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is “true”.
  • last_refresh_time
    Type: INT64
    Provider name: lastRefreshTime
    Description: [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.
  • query
    Type: STRING
    Provider name: query
    Description: [Required] A query whose result is persisted.
  • refresh_interval_ms
    Type: INT64
    Provider name: refreshIntervalMs
    Description: [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is “1800000” (30 minutes).

model

Type: STRUCT
Provider name: model
Description: [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run ‘PREDICT’ queries.

  • model_options
    Type: STRUCT
    Provider name: modelOptions
    Description: [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.
    • loss_type
      Type: STRING
      Provider name: lossType
    • model_type
      Type: STRING
      Provider name: modelType
  • training_runs
    Type: UNORDERED_LIST_STRUCT
    Provider name: trainingRuns
    Description: [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.
    • iteration_results
      Type: UNORDERED_LIST_STRUCT
      Provider name: iterationResults
      Description: [Output-only, Beta] List of each iteration results.
      • duration_ms
        Type: INT64
        Provider name: durationMs
        Description: [Output-only, Beta] Time taken to run the training iteration in milliseconds.
      • eval_loss
        Type: DOUBLE
        Provider name: evalLoss
        Description: [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.
      • index
        Type: INT32
        Provider name: index
        Description: [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.
      • learn_rate
        Type: DOUBLE
        Provider name: learnRate
        Description: [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.
      • training_loss
        Type: DOUBLE
        Provider name: trainingLoss
        Description: [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.
    • start_time
      Type: TIMESTAMP
      Provider name: startTime
      Description: [Output-only, Beta] Training run start time in milliseconds since the epoch.
    • state
      Type: STRING
      Provider name: state
      Description: [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.
    • training_options
      Type: STRUCT
      Provider name: trainingOptions
      Description: [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.
      • early_stop
        Type: BOOLEAN
        Provider name: earlyStop
      • l1_reg
        Type: DOUBLE
        Provider name: l1Reg
      • l2_reg
        Type: DOUBLE
        Provider name: l2Reg
      • learn_rate
        Type: DOUBLE
        Provider name: learnRate
      • learn_rate_strategy
        Type: STRING
        Provider name: learnRateStrategy
      • line_search_init_learn_rate
        Type: DOUBLE
        Provider name: lineSearchInitLearnRate
      • max_iteration
        Type: INT64
        Provider name: maxIteration
      • min_rel_progress
        Type: DOUBLE
        Provider name: minRelProgress
      • warm_start
        Type: BOOLEAN
        Provider name: warmStart

num_active_logical_bytes

Type: INT64
Provider name: numActiveLogicalBytes
Description: [Output-only] Number of logical bytes that are less than 90 days old.

num_active_physical_bytes

Type: INT64
Provider name: numActivePhysicalBytes
Description: [Output-only] Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

num_bytes

Type: INT64
Provider name: numBytes
Description: [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

num_long_term_bytes

Type: INT64
Provider name: numLongTermBytes
Description: [Output-only] The number of bytes in the table that are considered “long-term storage”.

num_long_term_logical_bytes

Type: INT64
Provider name: numLongTermLogicalBytes
Description: [Output-only] Number of logical bytes that are more than 90 days old.

num_long_term_physical_bytes

Type: INT64
Provider name: numLongTermPhysicalBytes
Description: [Output-only] Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

num_partitions

Type: INT64
Provider name: numPartitions
Description: [Output-only] The number of partitions present in the table or materialized view. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

num_physical_bytes

Type: INT64
Provider name: numPhysicalBytes
Description: [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

num_rows

Type: INT64
Provider name: numRows
Description: [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

num_time_travel_physical_bytes

Type: INT64
Provider name: numTimeTravelPhysicalBytes
Description: [Output-only] Number of physical bytes used by time travel storage (deleted or changed data). This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

num_total_logical_bytes

Type: INT64
Provider name: numTotalLogicalBytes
Description: [Output-only] Total number of logical bytes in the table or materialized view.

num_total_physical_bytes

Type: INT64
Provider name: numTotalPhysicalBytes
Description: [Output-only] The physical size of this table in bytes. This also includes storage used for time travel. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

range_partitioning

Type: STRUCT
Provider name: rangePartitioning
Description: [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

  • field
    Type: STRING
    Provider name: field
    Description: [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
  • range
    Type: STRUCT
    Provider name: range
    Description: [TrustedTester] [Required] Defines the ranges for range partitioning.
    • end
      Type: INT64
      Provider name: end
      Description: [TrustedTester] [Required] The end of range partitioning, exclusive.
    • interval
      Type: INT64
      Provider name: interval
      Description: [TrustedTester] [Required] The width of each interval.
    • start
      Type: INT64
      Provider name: start
      Description: [TrustedTester] [Required] The start of range partitioning, inclusive.

require_partition_filter

Type: BOOLEAN
Provider name: requirePartitionFilter
Description: [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

resource_name

Type: STRING

schema

Type: STRUCT
Provider name: schema
Description: [Optional] Describes the schema of this table.

Type: STRING
Provider name: selfLink
Description: [Output-only] A URL that can be used to access this resource again.

snapshot_definition

Type: STRUCT
Provider name: snapshotDefinition
Description: [Output-only] Snapshot definition.

  • base_table_reference
    Type: STRUCT
    Provider name: baseTableReference
    Description: [Required] Reference describing the ID of the table that was snapshot.
    • dataset_id
      Type: STRING
      Provider name: datasetId
      Description: [Required] The ID of the dataset containing this table.
    • project_id
      Type: STRING
      Provider name: projectId
      Description: [Required] The ID of the project containing this table.
    • table_id
      Type: STRING
      Provider name: tableId
      Description: [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
  • snapshot_time
    Type: TIMESTAMP
    Provider name: snapshotTime
    Description: [Required] The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format.

streaming_buffer

Type: STRUCT
Provider name: streamingBuffer
Description: [Output-only] Contains information regarding this table’s streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

  • estimated_bytes
    Type: INT64
    Provider name: estimatedBytes
    Description: [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
  • estimated_rows
    Type: INT64
    Provider name: estimatedRows
    Description: [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
  • oldest_entry_time
    Type: INT64
    Provider name: oldestEntryTime
    Description: [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

table_constraints

Type: STRUCT
Provider name: tableConstraints
Description: [Optional] The table constraints on the table.

  • foreign_keys
    Type: UNORDERED_LIST_STRUCT
    Provider name: foreignKeys
    Description: [Optional] The foreign keys of the tables.
    • column_references
      Type: UNORDERED_LIST_STRUCT
      Provider name: columnReferences
      • referenced_column
        Type: STRING
        Provider name: referencedColumn
      • referencing_column
        Type: STRING
        Provider name: referencingColumn
    • name
      Type: STRING
      Provider name: name
    • referenced_table
      Type: STRUCT
      Provider name: referencedTable
      • dataset_id
        Type: STRING
        Provider name: datasetId
      • project_id
        Type: STRING
        Provider name: projectId
      • table_id
        Type: STRING
        Provider name: tableId
  • primary_key
    Type: STRUCT
    Provider name: primaryKey
    Description: [Optional] The primary key of the table.
    • columns
      Type: UNORDERED_LIST_STRING
      Provider name: columns

table_reference

Type: STRUCT
Provider name: tableReference
Description: [Required] Reference describing the ID of this table.

  • dataset_id
    Type: STRING
    Provider name: datasetId
    Description: [Required] The ID of the dataset containing this table.
  • project_id
    Type: STRING
    Provider name: projectId
    Description: [Required] The ID of the project containing this table.
  • table_id
    Type: STRING
    Provider name: tableId
    Description: [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

tags

Type: UNORDERED_LIST_STRING

time_partitioning

Type: STRUCT
Provider name: timePartitioning
Description: Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

  • expiration_ms
    Type: INT64
    Provider name: expirationMs
    Description: [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
  • field
    Type: STRING
    Provider name: field
    Description: [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either ‘_PARTITIONTIME’ as TIMESTAMP type, or ‘_PARTITIONDATE’ as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
  • require_partition_filter
    Type: BOOLEAN
    Provider name: requirePartitionFilter
  • type
    Type: STRING
    Provider name: type
    Description: [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.

type

Type: STRING
Provider name: type
Description: [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. SNAPSHOT: An immutable, read-only table that is a copy of another table. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

view

Type: STRUCT
Provider name: view
Description: [Optional] The view definition.

  • query
    Type: STRING
    Provider name: query
    Description: [Required] A query that BigQuery executes when the view is referenced.
  • use_explicit_column_names
    Type: BOOLEAN
    Provider name: useExplicitColumnNames
    Description: True if the column names are explicitly specified. For example by using the ‘CREATE VIEW v(c1, c2) AS …’ syntax. Can only be set using BigQuery’s standard SQL: https://cloud.google.com/bigquery/sql-reference/
  • use_legacy_sql
    Type: BOOLEAN
    Provider name: useLegacySql
    Description: 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: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
  • user_defined_function_resources
    Type: UNORDERED_LIST_STRUCT
    Provider name: userDefinedFunctionResources
    Description: Describes user-defined function resources used in the query.
    • inline_code
      Type: STRING
      Provider name: inlineCode
      Description: [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
    • resource_uri
      Type: STRING
      Provider name: resourceUri
      Description: [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).