tables
Creates, updates, deletes, gets or lists a tables resource.
Overview
| Name | tables |
| Type | Resource |
| Id | google.bigquery.tables |
Fields
| Name | Datatype | Description |
|---|---|---|
id | string | Output only. An opaque ID uniquely identifying the table. |
description | string | Optional. A user-friendly description of this table. |
biglakeConfiguration | object | Configuration for BigLake managed tables. |
cloneDefinition | object | Information about base table and clone time of a table clone. |
clustering | object | Configures table clustering. |
creationTime | string | Output only. The time when this table was created, in milliseconds since the epoch. |
defaultCollation | string | Optional. Defines the default collation specification of new STRING fields in the table. During table creation or update, if a STRING field is added to this table without explicit collation specified, then the table inherits the table default collation. A change to this field affects only fields added afterwards, and does not alter the existing fields. The following values are supported: 'und:ci': undetermined locale, case insensitive. '': empty string. Default to case-sensitive behavior. |
defaultRoundingMode | string | Optional. Defines the default rounding mode specification of new decimal fields (NUMERIC OR BIGNUMERIC) in the table. During table creation or update, if a decimal field is added to this table without an explicit rounding mode specified, then the field inherits the table default rounding mode. Changing this field doesn't affect existing fields. |
encryptionConfiguration | object | Configuration for Cloud KMS encryption settings. |
etag | string | Output only. A hash of this resource. |
expirationTime | string | 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. |
externalCatalogTableOptions | object | Metadata about open source compatible table. The fields contained in these options correspond to hive metastore's table level properties. |
externalDataConfiguration | object | |
friendlyName | string | Optional. A descriptive name for this table. |
kind | string | The type of resource ID. |
labels | object | The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. |
lastModifiedTime | string | Output only. The time when this table was last modified, in milliseconds since the epoch. |
location | string | Output only. The geographic location where the table resides. This value is inherited from the dataset. |
materializedView | object | Definition and configuration of a materialized view. |
materializedViewStatus | object | Status of a materialized view. The last refresh timestamp status is omitted here, but is present in the MaterializedViewDefinition message. |
maxStaleness | string | Optional. The maximum staleness of data that could be returned when the table (or stale MV) is queried. Staleness encoded as a string encoding of sql IntervalValue type. |
model | object | |
numActiveLogicalBytes | string | Output only. Number of logical bytes that are less than 90 days old. |
numActivePhysicalBytes | string | 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. |
numBytes | string | Output only. The size of this table in logical bytes, excluding any data in the streaming buffer. |
numCurrentPhysicalBytes | string | Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. |
numLongTermBytes | string | Output only. The number of logical bytes in the table that are considered "long-term storage". |
numLongTermLogicalBytes | string | Output only. Number of logical bytes that are more than 90 days old. |
numLongTermPhysicalBytes | string | 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. |
numPartitions | string | 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. |
numPhysicalBytes | string | Output only. The physical size of this table in bytes. This includes storage used for time travel. |
numRows | string | Output only. The number of rows of data in this table, excluding any data in the streaming buffer. |
numTimeTravelPhysicalBytes | string | 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. |
numTotalLogicalBytes | string | Output only. Total number of logical bytes in the table or materialized view. |
numTotalPhysicalBytes | string | 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. |
partitionDefinition | object | The partitioning information, which includes managed table, external table and metastore partitioned table partition information. |
rangePartitioning | object | |
replicas | array | Optional. Output only. Table references of all replicas currently active on the table. |
requirePartitionFilter | boolean | Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. |
resourceTags | object | [Optional] The tags associated with this table. Tag keys are globally unique. See additional information on tags. An object containing a list of "key": value pairs. The key is the namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is parent id. The value is the friendly short name of the tag value, e.g. "production". |
restrictions | object | |
schema | object | Schema of a table |
selfLink | string | Output only. A URL that can be used to access this resource again. |
snapshotDefinition | object | Information about base table and snapshot time of the snapshot. |
streamingBuffer | object | |
tableConstraints | object | The TableConstraints defines the primary key and foreign key. |
tableReference | object | |
tableReplicationInfo | object | Replication info of a table created using AS REPLICA DDL like: CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv |
timePartitioning | object | |
type | string | 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. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. MATERIALIZED_VIEW: A precomputed view defined by a SQL query. * SNAPSHOT: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on table snapshots. The default value is TABLE. |
view | object | Describes the definition of a logical view. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get | SELECT | +datasetId, +tableId, projectId | Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. |
list | SELECT | +datasetId, projectId | Lists all tables in the specified dataset. Requires the READER dataset role. |
insert | INSERT | +datasetId, projectId | Creates a new, empty table in the dataset. |
delete | DELETE | +datasetId, +tableId, projectId | Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted. |
patch | UPDATE | +datasetId, +tableId, projectId | Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports RFC5789 patch semantics. |
update | REPLACE | +datasetId, +tableId, projectId | Updates information in an existing table. The update method replaces the entire Table resource, whereas the patch method only replaces fields that are provided in the submitted Table resource. |
SELECT examples
Lists all tables in the specified dataset. Requires the READER dataset role.
SELECT
id,
description,
biglakeConfiguration,
cloneDefinition,
clustering,
creationTime,
defaultCollation,
defaultRoundingMode,
encryptionConfiguration,
etag,
expirationTime,
externalCatalogTableOptions,
externalDataConfiguration,
friendlyName,
kind,
labels,
lastModifiedTime,
location,
materializedView,
materializedViewStatus,
maxStaleness,
model,
numActiveLogicalBytes,
numActivePhysicalBytes,
numBytes,
numCurrentPhysicalBytes,
numLongTermBytes,
numLongTermLogicalBytes,
numLongTermPhysicalBytes,
numPartitions,
numPhysicalBytes,
numRows,
numTimeTravelPhysicalBytes,
numTotalLogicalBytes,
numTotalPhysicalBytes,
partitionDefinition,
rangePartitioning,
replicas,
requirePartitionFilter,
resourceTags,
restrictions,
schema,
selfLink,
snapshotDefinition,
streamingBuffer,
tableConstraints,
tableReference,
tableReplicationInfo,
timePartitioning,
type,
view
FROM google.bigquery.tables
WHERE +datasetId = '{{ +datasetId }}'
AND projectId = '{{ projectId }}';
INSERT example
Use the following StackQL query and manifest file to create a new tables resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO google.bigquery.tables (
+datasetId,
projectId,
biglakeConfiguration,
clustering,
defaultCollation,
defaultRoundingMode,
description,
encryptionConfiguration,
expirationTime,
externalCatalogTableOptions,
externalDataConfiguration,
friendlyName,
labels,
materializedView,
maxStaleness,
model,
partitionDefinition,
rangePartitioning,
requirePartitionFilter,
resourceTags,
schema,
tableConstraints,
tableReference,
tableReplicationInfo,
timePartitioning,
view
)
SELECT
'{{ +datasetId }}',
'{{ projectId }}',
'{{ biglakeConfiguration }}',
'{{ clustering }}',
'{{ defaultCollation }}',
'{{ defaultRoundingMode }}',
'{{ description }}',
'{{ encryptionConfiguration }}',
'{{ expirationTime }}',
'{{ externalCatalogTableOptions }}',
'{{ externalDataConfiguration }}',
'{{ friendlyName }}',
'{{ labels }}',
'{{ materializedView }}',
'{{ maxStaleness }}',
'{{ model }}',
'{{ partitionDefinition }}',
'{{ rangePartitioning }}',
{{ requirePartitionFilter }},
'{{ resourceTags }}',
'{{ schema }}',
'{{ tableConstraints }}',
'{{ tableReference }}',
'{{ tableReplicationInfo }}',
'{{ timePartitioning }}',
'{{ view }}'
;
- name: your_resource_model_name
props:
- name: biglakeConfiguration
value:
- name: connectionId
value: string
- name: fileFormat
value: string
- name: storageUri
value: string
- name: tableFormat
value: string
- name: cloneDefinition
value:
- name: baseTableReference
value:
- name: datasetId
value: string
- name: projectId
value: string
- name: tableId
value: string
- name: cloneTime
value: string
- name: clustering
value:
- name: fields
value:
- string
- name: creationTime
value: string
- name: defaultCollation
value: string
- name: defaultRoundingMode
value: string
- name: description
value: string
- name: encryptionConfiguration
value:
- name: kmsKeyName
value: string
- name: etag
value: string
- name: expirationTime
value: string
- name: externalCatalogTableOptions
value:
- name: connectionId
value: string
- name: parameters
value: object
- name: storageDescriptor
value:
- name: inputFormat
value: string
- name: locationUri
value: string
- name: outputFormat
value: string
- name: serdeInfo
value:
- name: name
value: string
- name: parameters
value: object
- name: serializationLibrary
value: string
- name: externalDataConfiguration
value:
- name: autodetect
value: boolean
- name: avroOptions
value:
- name: useAvroLogicalTypes
value: boolean
- name: bigtableOptions
value:
- name: columnFamilies
value:
- - name: columns
value:
- - name: encoding
value: string
- name: fieldName
value: string
- name: onlyReadLatest
value: boolean
- name: qualifierEncoded
value: string
- name: qualifierString
value: string
- name: type
value: string
- name: encoding
value: string
- name: familyId
value: string
- name: onlyReadLatest
value: boolean
- name: type
value: string
- name: ignoreUnspecifiedColumnFamilies
value: boolean
- name: outputColumnFamiliesAsJson
value: boolean
- name: readRowkeyAsString
value: boolean
- name: compression
value: string
- name: connectionId
value: string
- name: csvOptions
value:
- name: allowJaggedRows
value: boolean
- name: allowQuotedNewlines
value: boolean
- name: encoding
value: string
- name: fieldDelimiter
value: string
- name: nullMarker
value: string
- name: preserveAsciiControlCharacters
value: boolean
- name: quote
value: string
- name: skipLeadingRows
value: string
- name: decimalTargetTypes
value:
- string
- name: fileSetSpecType
value: string
- name: googleSheetsOptions
value:
- name: range
value: string
- name: skipLeadingRows
value: string
- name: hivePartitioningOptions
value:
- name: fields
value:
- string
- name: mode
value: string
- name: requirePartitionFilter
value: boolean
- name: sourceUriPrefix
value: string
- name: ignoreUnknownValues
value: boolean
- name: jsonExtension
value: string
- name: jsonOptions
value:
- name: encoding
value: string
- name: maxBadRecords
value: integer
- name: metadataCacheMode
value: string
- name: objectMetadata
value: string
- name: parquetOptions
value:
- name: enableListInference
value: boolean
- name: enumAsString
value: boolean
- name: mapTargetType
value: string
- name: referenceFileSchemaUri
value: string
- name: schema
value:
- name: fields
value:
- - name: categories
value:
- name: names
value:
- string
- name: collation
value: string
- name: dataPolicies
value:
- - name: name
value: string
- name: defaultValueExpression
value: string
- name: description
value: string
- name: fields
value:
- - name: categories
value:
- name: names
value:
- string
- name: collation
value: string
- name: dataPolicies
value:
- - name: name
value: string
- name: defaultValueExpression
value: string
- name: description
value: string
- name: fields
value:
- - name: categories
value:
- name: names
value:
- string
- name: collation
value: string
- name: dataPolicies
value:
- - name: name
value: string
- name: defaultValueExpression
value: string
- name: description
value: string
- name: fields
value:
- - name: categories
value:
- name: names
value:
- string
- name: collation
value: string
- name: dataPolicies
value:
- - name: name
value: string
- name: defaultValueExpression
value: string
- name: description
value: string
- name: fields
value:
- - name: categories
value:
- name: names
value:
- string
- name: collation
value: string
- name: dataPolicies
value:
- - name: name
value: string
- name: defaultValueExpression
value: string
- name: description
value: string
- name: fields
value:
- - name: categories
value:
- name: names
value:
- string
- name: collation
value: string
- name: dataPolicies
value:
- - name: name
value: string
- name: defaultValueExpression
value: string
- name: description
value: string
- name: fields
value:
- - name: categories
value:
- name: names
value:
- string
- name: collation
value: string
- name: dataPolicies
value:
- - name: name
value: string
- name: defaultValueExpression
value: string
- name: description
value: string
- name: fields
value:
- - name: categories
value: []
- name: collation
value: string
- name: dataPolicies
value:
- []
- name: defaultValueExpression
value: string
- name: description
value: string
- name: fields
value:
- []
- name: foreignTypeDefinition
value: string
- name: maxLength
value: string
- name: mode
value: string
- name: name
value: string
- name: policyTags
value: []
- name: precision
value: string
- name: rangeElementType
value: []
- name: roundingMode
value: string
- name: scale
value: string
- name: type
value: string
- name: foreignTypeDefinition
value: string
- name: maxLength
value: string
- name: mode
value: string
- name: name
value: string
- name: policyTags
value:
- name: names
value:
- string
- name: precision
value: string
- name: rangeElementType
value:
- name: type
value: string
- name: roundingMode
value: string
- name: scale
value: string
- name: type
value: string
- name: foreignTypeDefinition
value: string
- name: maxLength
value: string
- name: mode
value: string
- name: name
value: string
- name: policyTags
value:
- name: names
value:
- string
- name: precision
value: string
- name: rangeElementType
value:
- name: type
value: string
- name: roundingMode
value: string
- name: scale
value: string
- name: type
value: string
- name: foreignTypeDefinition
value: string
- name: maxLength
value: string
- name: mode
value: string
- name: name
value: string
- name: policyTags
value:
- name: names
value:
- string
- name: precision
value: string
- name: rangeElementType
value:
- name: type
value: string
- name: roundingMode
value: string
- name: scale
value: string
- name: type
value: string
- name: foreignTypeDefinition
value: string
- name: maxLength
value: string
- name: mode
value: string
- name: name
value: string
- name: policyTags
value:
- name: names
value:
- string
- name: precision
value: string
- name: rangeElementType
value:
- name: type
value: string
- name: roundingMode
value: string
- name: scale
value: string
- name: type
value: string
- name: foreignTypeDefinition
value: string
- name: maxLength
value: string
- name: mode
value: string
- name: name
value: string
- name: policyTags
value:
- name: names
value:
- string
- name: precision
value: string
- name: rangeElementType
value:
- name: type
value: string
- name: roundingMode
value: string
- name: scale
value: string
- name: type
value: string
- name: foreignTypeDefinition
value: string
- name: maxLength
value: string
- name: mode
value: string
- name: name
value: string
- name: policyTags
value:
- name: names
value:
- string
- name: precision
value: string
- name: rangeElementType
value:
- name: type
value: string
- name: roundingMode
value: string
- name: scale
value: string
- name: type
value: string
- name: foreignTypeDefinition
value: string
- name: maxLength
value: string
- name: mode
value: string
- name: name
value: string
- name: policyTags
value:
- name: names
value:
- string
- name: precision
value: string
- name: rangeElementType
value:
- name: type
value: string
- name: roundingMode
value: string
- name: scale
value: string
- name: type
value: string
- name: foreignTypeInfo
value:
- name: typeSystem
value: string
- name: sourceFormat
value: string
- name: sourceUris
value:
- string
- name: friendlyName
value: string
- name: id
value: string
- name: kind
value: string
- name: labels
value: object
- name: lastModifiedTime
value: string
- name: location
value: string
- name: materializedView
value:
- name: allowNonIncrementalDefinition
value: boolean
- name: enableRefresh
value: boolean
- name: lastRefreshTime
value: string
- name: maxStaleness
value: string
- name: query
value: string
- name: refreshIntervalMs
value: string
- name: materializedViewStatus
value:
- name: lastRefreshStatus
value:
- name: debugInfo
value: string
- name: location
value: string
- name: message
value: string
- name: reason
value: string
- name: refreshWatermark
value: string
- name: maxStaleness
value: string
- name: model
value:
- name: modelOptions
value:
- name: labels
value:
- string
- name: lossType
value: string
- name: modelType
value: string
- name: trainingRuns
value:
- - name: iterationResults
value:
- - name: durationMs
value: string
- name: evalLoss
value: number
- name: index
value: integer
- name: learnRate
value: number
- name: trainingLoss
value: number
- name: startTime
value: string
- name: state
value: string
- name: trainingOptions
value:
- name: earlyStop
value: boolean
- name: l1Reg
value: number
- name: l2Reg
value: number
- name: learnRate
value: number
- name: learnRateStrategy
value: string
- name: lineSearchInitLearnRate
value: number
- name: maxIteration
value: string
- name: minRelProgress
value: number
- name: warmStart
value: boolean
- name: numActiveLogicalBytes
value: string
- name: numActivePhysicalBytes
value: string
- name: numBytes
value: string
- name: numCurrentPhysicalBytes
value: string
- name: numLongTermBytes
value: string
- name: numLongTermLogicalBytes
value: string
- name: numLongTermPhysicalBytes
value: string
- name: numPartitions
value: string
- name: numPhysicalBytes
value: string
- name: numRows
value: string
- name: numTimeTravelPhysicalBytes
value: string
- name: numTotalLogicalBytes
value: string
- name: numTotalPhysicalBytes
value: string
- name: partitionDefinition
value:
- name: partitionedColumn
value:
- - name: field
value: string
- name: rangePartitioning
value:
- name: field
value: string
- name: range
value:
- name: end
value: string
- name: interval
value: string
- name: start
value: string
- name: replicas
value:
- - name: datasetId
value: string
- name: projectId
value: string
- name: tableId
value: string
- name: requirePartitionFilter
value: boolean
- name: resourceTags
value: object
- name: restrictions
value:
- name: type
value: string
- name: selfLink
value: string
- name: snapshotDefinition
value:
- name: snapshotTime
value: string
- name: streamingBuffer
value:
- name: estimatedBytes
value: string
- name: estimatedRows
value: string
- name: oldestEntryTime
value: string
- name: tableConstraints
value:
- name: foreignKeys
value:
- - name: columnReferences
value:
- - name: referencedColumn
value: string
- name: referencingColumn
value: string
- name: name
value: string
- name: referencedTable
value:
- name: datasetId
value: string
- name: projectId
value: string
- name: tableId
value: string
- name: primaryKey
value:
- name: columns
value:
- string
- name: tableReplicationInfo
value:
- name: replicatedSourceLastRefreshTime
value: string
- name: replicationIntervalMs
value: string
- name: replicationStatus
value: string
- name: timePartitioning
value:
- name: expirationMs
value: string
- name: field
value: string
- name: requirePartitionFilter
value: boolean
- name: type
value: string
- name: type
value: string
- name: view
value:
- name: foreignDefinitions
value:
- - name: dialect
value: string
- name: query
value: string
- name: privacyPolicy
value:
- name: aggregationThresholdPolicy
value:
- name: privacyUnitColumns
value:
- string
- name: threshold
value: string
- name: differentialPrivacyPolicy
value:
- name: deltaBudget
value: number
- name: deltaBudgetRemaining
value: number
- name: deltaPerQuery
value: number
- name: epsilonBudget
value: number
- name: epsilonBudgetRemaining
value: number
- name: maxEpsilonPerQuery
value: number
- name: maxGroupsContributed
value: string
- name: privacyUnitColumn
value: string
- name: joinRestrictionPolicy
value:
- name: joinAllowedColumns
value:
- string
- name: joinCondition
value: string
- name: query
value: string
- name: useExplicitColumnNames
value: boolean
- name: useLegacySql
value: boolean
- name: userDefinedFunctionResources
value:
- - name: inlineCode
value: string
- name: resourceUri
value: string
UPDATE example
Updates a tables resource.
/*+ update */
UPDATE google.bigquery.tables
SET
biglakeConfiguration = '{{ biglakeConfiguration }}',
clustering = '{{ clustering }}',
defaultCollation = '{{ defaultCollation }}',
defaultRoundingMode = '{{ defaultRoundingMode }}',
description = '{{ description }}',
encryptionConfiguration = '{{ encryptionConfiguration }}',
expirationTime = '{{ expirationTime }}',
externalCatalogTableOptions = '{{ externalCatalogTableOptions }}',
externalDataConfiguration = '{{ externalDataConfiguration }}',
friendlyName = '{{ friendlyName }}',
labels = '{{ labels }}',
materializedView = '{{ materializedView }}',
maxStaleness = '{{ maxStaleness }}',
model = '{{ model }}',
partitionDefinition = '{{ partitionDefinition }}',
rangePartitioning = '{{ rangePartitioning }}',
requirePartitionFilter = true|false,
resourceTags = '{{ resourceTags }}',
schema = '{{ schema }}',
tableConstraints = '{{ tableConstraints }}',
tableReference = '{{ tableReference }}',
tableReplicationInfo = '{{ tableReplicationInfo }}',
timePartitioning = '{{ timePartitioning }}',
view = '{{ view }}'
WHERE
+datasetId = '{{ +datasetId }}'
AND +tableId = '{{ +tableId }}'
AND projectId = '{{ projectId }}';
REPLACE example
Replaces all fields in the specified tables resource.
/*+ update */
REPLACE google.bigquery.tables
SET
biglakeConfiguration = '{{ biglakeConfiguration }}',
clustering = '{{ clustering }}',
defaultCollation = '{{ defaultCollation }}',
defaultRoundingMode = '{{ defaultRoundingMode }}',
description = '{{ description }}',
encryptionConfiguration = '{{ encryptionConfiguration }}',
expirationTime = '{{ expirationTime }}',
externalCatalogTableOptions = '{{ externalCatalogTableOptions }}',
externalDataConfiguration = '{{ externalDataConfiguration }}',
friendlyName = '{{ friendlyName }}',
labels = '{{ labels }}',
materializedView = '{{ materializedView }}',
maxStaleness = '{{ maxStaleness }}',
model = '{{ model }}',
partitionDefinition = '{{ partitionDefinition }}',
rangePartitioning = '{{ rangePartitioning }}',
requirePartitionFilter = true|false,
resourceTags = '{{ resourceTags }}',
schema = '{{ schema }}',
tableConstraints = '{{ tableConstraints }}',
tableReference = '{{ tableReference }}',
tableReplicationInfo = '{{ tableReplicationInfo }}',
timePartitioning = '{{ timePartitioning }}',
view = '{{ view }}'
WHERE
+datasetId = '{{ +datasetId }}'
AND +tableId = '{{ +tableId }}'
AND projectId = '{{ projectId }}';
DELETE example
Deletes the specified tables resource.
/*+ delete */
DELETE FROM google.bigquery.tables
WHERE +datasetId = '{{ +datasetId }}'
AND +tableId = '{{ +tableId }}'
AND projectId = '{{ projectId }}';