Tables

A table is a part of a dataset. For more information, see Tables.

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "kind": "bigquery#table",
  "etag": etag,
  "id": string,
  "selfLink": string,
  "tableReference": {
    "projectId": string,
    "datasetId": string,
    "tableId": string
  },
  "friendlyName": string,
  "description": string,
  "schema": {
    "fields": [
      {
        "name": string,
        "type": string,
        "mode": string,
        "fields": [
          (TableFieldSchema)
        ],
        "description": string
      }
    ]
  },
  "timePartitioning": {
    "type": string,
    "expirationMs": long
  },
  "numBytes": long,
  "numLongTermBytes": long,
  "numRows": unsigned long,
  "creationTime": long,
  "expirationTime": long,
  "lastModifiedTime": unsigned long,
  "type": string,
  "view": {
    "query": string,
    "userDefinedFunctionResources": [
      {
        "resourceUri": string,
        "inlineCode": string
      }
    ],
    "useLegacySql": boolean
  },
  "externalDataConfiguration": {
    "sourceUris": [
      string
    ],
    "schema": {
      "fields": [
        {
          "name": string,
          "type": string,
          "mode": string,
          "fields": [
            (TableFieldSchema)
          ],
          "description": string
        }
      ]
    },
    "sourceFormat": string,
    "maxBadRecords": integer,
    "autodetect": boolean,
    "ignoreUnknownValues": boolean,
    "compression": string,
    "csvOptions": {
      "fieldDelimiter": string,
      "skipLeadingRows": long,
      "quote": string,
      "allowQuotedNewlines": boolean,
      "allowJaggedRows": boolean,
      "encoding": string
    },
    "bigtableOptions": {
      "columnFamilies": [
        {
          "familyId": string,
          "type": string,
          "encoding": string,
          "columns": [
            {
              "qualifierEncoded": bytes,
              "qualifierString": string,
              "fieldName": string,
              "type": string,
              "encoding": string,
              "onlyReadLatest": boolean
            }
          ],
          "onlyReadLatest": boolean
        }
      ],
      "ignoreUnspecifiedColumnFamilies": boolean
    },
    "googleSheetsOptions": {
      "skipLeadingRows": long
    }
  },
  "location": string,
  "streamingBuffer": {
    "estimatedRows": unsigned long,
    "estimatedBytes": unsigned long,
    "oldestEntryTime": unsigned long
  }
}
Property name Value Description Notes
creationTime long [Output-only] The time when this table was created, in milliseconds since the epoch.
description string [Optional] A user-friendly description of this table. writable
etag etag [Output-only] A hash of this resource.
expirationTime long [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.
externalDataConfiguration nested object [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.
externalDataConfiguration.autodetect boolean [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
externalDataConfiguration.bigtableOptions nested object [Optional] Additional options if sourceFormat is set to BIGTABLE.
externalDataConfiguration.bigtableOptions.columnFamilies[] list [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.
externalDataConfiguration.bigtableOptions.columnFamilies[].columns[] list [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.
externalDataConfiguration.bigtableOptions.columnFamilies[].columns[].encoding string [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.
externalDataConfiguration.bigtableOptions.columnFamilies[].columns[].fieldName string [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.
externalDataConfiguration.bigtableOptions.columnFamilies[].columns[].onlyReadLatest boolean [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.
externalDataConfiguration.bigtableOptions.columnFamilies[].columns[].qualifierEncoded bytes [Required] 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 qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. 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 field_name.
externalDataConfiguration.bigtableOptions.columnFamilies[].columns[].qualifierString string
externalDataConfiguration.bigtableOptions.columnFamilies[].columns[].type string [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.
externalDataConfiguration.bigtableOptions.columnFamilies[].encoding string [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.
externalDataConfiguration.bigtableOptions.columnFamilies[].familyId string Identifier of the column family.
externalDataConfiguration.bigtableOptions.columnFamilies[].onlyReadLatest boolean [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.
externalDataConfiguration.bigtableOptions.columnFamilies[].type string [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.
externalDataConfiguration.bigtableOptions.ignoreUnspecifiedColumnFamilies boolean [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.
externalDataConfiguration.compression string [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.
externalDataConfiguration.csvOptions nested object Additional properties to set if sourceFormat is set to CSV.
externalDataConfiguration.csvOptions.allowJaggedRows boolean [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.
externalDataConfiguration.csvOptions.allowQuotedNewlines boolean [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
externalDataConfiguration.csvOptions.encoding string [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.
externalDataConfiguration.csvOptions.fieldDelimiter string [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 (',').
externalDataConfiguration.csvOptions.quote string [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.
externalDataConfiguration.csvOptions.skipLeadingRows long [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.
externalDataConfiguration.googleSheetsOptions nested object [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
externalDataConfiguration.googleSheetsOptions.skipLeadingRows long [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.
externalDataConfiguration.ignoreUnknownValues boolean [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.
externalDataConfiguration.maxBadRecords integer [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. 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.
externalDataConfiguration.schema nested object [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.
externalDataConfiguration.schema.fields[] list Describes the fields in a table.
externalDataConfiguration.schema.fields[].description string [Optional] The field description. The maximum length is 16K characters.
externalDataConfiguration.schema.fields[].fields[] list [Optional] Describes the nested schema fields if the type property is set to RECORD.
externalDataConfiguration.schema.fields[].mode string [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
externalDataConfiguration.schema.fields[].name string [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
externalDataConfiguration.schema.fields[].type string [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
externalDataConfiguration.sourceFormat string [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". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
externalDataConfiguration.sourceUris[] list [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, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
friendlyName string [Optional] A descriptive name for this table. writable
id string [Output-only] An opaque ID uniquely identifying the table.
kind bigquery#table The type of resource ID.
lastModifiedTime unsigned long [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.
numBytes long [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
numLongTermBytes long [Output-only] The number of bytes in the table that are considered "long-term storage".
numRows unsigned long [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
schema nested object [Optional] Describes the schema of this table. writable
schema.fields[] list Describes the fields in a table.
schema.fields[].description string [Optional] The field description. The maximum length is 16K characters.
schema.fields[].fields[] list [Optional] Describes the nested schema fields if the type property is set to RECORD.
schema.fields[].mode string [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
schema.fields[].name string [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
schema.fields[].type string [Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
streamingBuffer nested object [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.
streamingBuffer.estimatedBytes unsigned long [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
streamingBuffer.estimatedRows unsigned long [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
streamingBuffer.oldestEntryTime unsigned long [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
tableReference nested object [Required] Reference describing the ID of this table.
tableReference.datasetId string [Required] The ID of the dataset containing this table.
tableReference.projectId string [Required] The ID of the project containing this table.
tableReference.tableId string [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.
timePartitioning nested object [Experimental] If specified, configures time-based partitioning for this table.
timePartitioning.expirationMs long [Optional] Number of milliseconds for which to keep the storage for a partition.
timePartitioning.type string [Required] The only type supported is DAY, which will generate one partition per day based on data loading time.
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. For more information, see views.
  • EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage.
The default value is TABLE.
view nested object [Optional] The view definition. writable
view.query string [Required] A query that BigQuery executes when the view is referenced.
view.useLegacySql boolean [Experimental] 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.
view.userDefinedFunctionResources[] list [Experimental] Describes user-defined function resources used in the query.
view.userDefinedFunctionResources[].inlineCode string [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.
view.userDefinedFunctionResources[].resourceUri string [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

Methods

The following methods are supported:

delete
Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.
get
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.
insert
Creates a new, empty table in the dataset.
list
Lists all tables in the specified dataset. Requires the READER dataset role.
patch
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 patch semantics.
update
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.

Send feedback about...

BigQuery Documentation