# BigQuery API . tables

## Instance Methods

Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.

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.

Creates a new, empty table in the dataset.

Lists all tables in the specified dataset. Requires the READER dataset role.

Retrieves the next page of results.

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.

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.

### Method Details

`delete(projectId, datasetId, tableId)`

    Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.

    Args:
      projectId: string, Project ID of the table to delete (required)
      datasetId: string, Dataset ID of the table to delete (required)
      tableId: string, Table ID of the table to delete (required)

`get(projectId, datasetId, tableId)`

    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.

    Args:
      projectId: string, Project ID of the requested table (required)
      datasetId: string, Dataset ID of the requested table (required)
      tableId: string, Table ID of the requested table (required)

    Returns:
      An object of the form:

        {
          "kind": "bigquery#table", # [Output-only] The type of the resource.
          "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
          "description": "A String", # [Optional] A user-friendly description of this table.
          "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
          "tableReference": { # [Required] Reference describing the ID of this table.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A 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.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
          "numRows": "A String", # [Output-only] The number of rows of data in this table. This property is unavailable for tables that are actively receiving streaming inserts.
          "numBytes": "A String", # [Output-only] The size of the table in bytes. This property is unavailable for tables that are actively receiving streaming inserts.
          "etag": "A String", # [Output-only] A hash of this resource.
          "friendlyName": "A String", # [Optional] A descriptive name for this table.
          "expirationTime": "A 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.
          "view": { # [Optional] The view definition.
            "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
          },
          "type": "A 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. The default value is TABLE.
          "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
          "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
          "schema": { # [Optional] Describes the schema of this table.
            "fields": [ # Describes the fields in a table.
              {
                "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
                  # Object with schema name: TableFieldSchema
                ],
                "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
                "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                "name": "A 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.
                "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
              },
            ],
          },
        }

`insert(projectId, datasetId, body)`

    Creates a new, empty table in the dataset.

    Args:
      projectId: string, Project ID of the new table (required)
      datasetId: string, Dataset ID of the new table (required)
      body: object, The request body. (required)
        The object takes the form of:

    {
        "kind": "bigquery#table", # [Output-only] The type of the resource.
        "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
        "description": "A String", # [Optional] A user-friendly description of this table.
        "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
        "tableReference": { # [Required] Reference describing the ID of this table.
          "projectId": "A String", # [Required] The ID of the project containing this table.
          "tableId": "A 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.
          "datasetId": "A String", # [Required] The ID of the dataset containing this table.
        },
        "numRows": "A String", # [Output-only] The number of rows of data in this table. This property is unavailable for tables that are actively receiving streaming inserts.
        "numBytes": "A String", # [Output-only] The size of the table in bytes. This property is unavailable for tables that are actively receiving streaming inserts.
        "etag": "A String", # [Output-only] A hash of this resource.
        "friendlyName": "A String", # [Optional] A descriptive name for this table.
        "expirationTime": "A 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.
        "view": { # [Optional] The view definition.
          "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
        },
        "type": "A 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. The default value is TABLE.
        "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
        "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
        "schema": { # [Optional] Describes the schema of this table.
          "fields": [ # Describes the fields in a table.
            {
              "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
                # Object with schema name: TableFieldSchema
              ],
              "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
              "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
              "name": "A 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.
              "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
            },
          ],
        },
      }

    Returns:
      An object of the form:

        {
          "kind": "bigquery#table", # [Output-only] The type of the resource.
          "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
          "description": "A String", # [Optional] A user-friendly description of this table.
          "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
          "tableReference": { # [Required] Reference describing the ID of this table.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A 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.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
          "numRows": "A String", # [Output-only] The number of rows of data in this table. This property is unavailable for tables that are actively receiving streaming inserts.
          "numBytes": "A String", # [Output-only] The size of the table in bytes. This property is unavailable for tables that are actively receiving streaming inserts.
          "etag": "A String", # [Output-only] A hash of this resource.
          "friendlyName": "A String", # [Optional] A descriptive name for this table.
          "expirationTime": "A 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.
          "view": { # [Optional] The view definition.
            "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
          },
          "type": "A 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. The default value is TABLE.
          "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
          "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
          "schema": { # [Optional] Describes the schema of this table.
            "fields": [ # Describes the fields in a table.
              {
                "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
                  # Object with schema name: TableFieldSchema
                ],
                "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
                "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                "name": "A 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.
                "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
              },
            ],
          },
        }

`list(projectId, datasetId, pageToken=None, maxResults=None)`

    Lists all tables in the specified dataset. Requires the READER dataset role.

    Args:
      projectId: string, Project ID of the tables to list (required)
      datasetId: string, Dataset ID of the tables to list (required)
      pageToken: string, Page token, returned by a previous call, to request the next page of results
      maxResults: integer, Maximum number of results to return

    Returns:
      An object of the form:

        {
        "nextPageToken": "A String", # A token to request the next page of results.
        "tables": [ # Tables in the requested dataset.
          {
            "friendlyName": "A String", # The user-friendly name for this table.
            "kind": "bigquery#table", # The resource type.
            "type": "A String", # The type of table. Possible values are: TABLE, VIEW.
            "id": "A String", # An opaque ID of the table
            "tableReference": { # A reference uniquely identifying the table.
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A 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.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
          },
        ],
        "kind": "bigquery#tableList", # The type of list.
        "etag": "A String", # A hash of this page of results.
        "totalItems": 42, # The total number of tables in the dataset.
      }

`list_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.

`patch(projectId, datasetId, tableId, body)`

    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.

    Args:
      projectId: string, Project ID of the table to update (required)
      datasetId: string, Dataset ID of the table to update (required)
      tableId: string, Table ID of the table to update (required)
      body: object, The request body. (required)
        The object takes the form of:

    {
        "kind": "bigquery#table", # [Output-only] The type of the resource.
        "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
        "description": "A String", # [Optional] A user-friendly description of this table.
        "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
        "tableReference": { # [Required] Reference describing the ID of this table.
          "projectId": "A String", # [Required] The ID of the project containing this table.
          "tableId": "A 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.
          "datasetId": "A String", # [Required] The ID of the dataset containing this table.
        },
        "numRows": "A String", # [Output-only] The number of rows of data in this table. This property is unavailable for tables that are actively receiving streaming inserts.
        "numBytes": "A String", # [Output-only] The size of the table in bytes. This property is unavailable for tables that are actively receiving streaming inserts.
        "etag": "A String", # [Output-only] A hash of this resource.
        "friendlyName": "A String", # [Optional] A descriptive name for this table.
        "expirationTime": "A 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.
        "view": { # [Optional] The view definition.
          "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
        },
        "type": "A 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. The default value is TABLE.
        "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
        "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
        "schema": { # [Optional] Describes the schema of this table.
          "fields": [ # Describes the fields in a table.
            {
              "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
                # Object with schema name: TableFieldSchema
              ],
              "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
              "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
              "name": "A 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.
              "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
            },
          ],
        },
      }

    Returns:
      An object of the form:

        {
          "kind": "bigquery#table", # [Output-only] The type of the resource.
          "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
          "description": "A String", # [Optional] A user-friendly description of this table.
          "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
          "tableReference": { # [Required] Reference describing the ID of this table.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A 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.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
          "numRows": "A String", # [Output-only] The number of rows of data in this table. This property is unavailable for tables that are actively receiving streaming inserts.
          "numBytes": "A String", # [Output-only] The size of the table in bytes. This property is unavailable for tables that are actively receiving streaming inserts.
          "etag": "A String", # [Output-only] A hash of this resource.
          "friendlyName": "A String", # [Optional] A descriptive name for this table.
          "expirationTime": "A 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.
          "view": { # [Optional] The view definition.
            "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
          },
          "type": "A 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. The default value is TABLE.
          "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
          "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
          "schema": { # [Optional] Describes the schema of this table.
            "fields": [ # Describes the fields in a table.
              {
                "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
                  # Object with schema name: TableFieldSchema
                ],
                "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
                "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                "name": "A 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.
                "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
              },
            ],
          },
        }

`update(projectId, datasetId, tableId, body)`

    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.

    Args:
      projectId: string, Project ID of the table to update (required)
      datasetId: string, Dataset ID of the table to update (required)
      tableId: string, Table ID of the table to update (required)
      body: object, The request body. (required)
        The object takes the form of:

    {
        "kind": "bigquery#table", # [Output-only] The type of the resource.
        "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
        "description": "A String", # [Optional] A user-friendly description of this table.
        "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
        "tableReference": { # [Required] Reference describing the ID of this table.
          "projectId": "A String", # [Required] The ID of the project containing this table.
          "tableId": "A 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.
          "datasetId": "A String", # [Required] The ID of the dataset containing this table.
        },
        "numRows": "A String", # [Output-only] The number of rows of data in this table. This property is unavailable for tables that are actively receiving streaming inserts.
        "numBytes": "A String", # [Output-only] The size of the table in bytes. This property is unavailable for tables that are actively receiving streaming inserts.
        "etag": "A String", # [Output-only] A hash of this resource.
        "friendlyName": "A String", # [Optional] A descriptive name for this table.
        "expirationTime": "A 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.
        "view": { # [Optional] The view definition.
          "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
        },
        "type": "A 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. The default value is TABLE.
        "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
        "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
        "schema": { # [Optional] Describes the schema of this table.
          "fields": [ # Describes the fields in a table.
            {
              "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
                # Object with schema name: TableFieldSchema
              ],
              "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
              "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
              "name": "A 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.
              "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
            },
          ],
        },
      }

    Returns:
      An object of the form:

        {
          "kind": "bigquery#table", # [Output-only] The type of the resource.
          "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
          "description": "A String", # [Optional] A user-friendly description of this table.
          "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
          "tableReference": { # [Required] Reference describing the ID of this table.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A 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.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
          "numRows": "A String", # [Output-only] The number of rows of data in this table. This property is unavailable for tables that are actively receiving streaming inserts.
          "numBytes": "A String", # [Output-only] The size of the table in bytes. This property is unavailable for tables that are actively receiving streaming inserts.
          "etag": "A String", # [Output-only] A hash of this resource.
          "friendlyName": "A String", # [Optional] A descriptive name for this table.
          "expirationTime": "A 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.
          "view": { # [Optional] The view definition.
            "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
          },
          "type": "A 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. The default value is TABLE.
          "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
          "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
          "schema": { # [Optional] Describes the schema of this table.
            "fields": [ # Describes the fields in a table.
              {
                "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
                  # Object with schema name: TableFieldSchema
                ],
                "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
                "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                "name": "A 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.
                "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
              },
            ],
          },
        }