BigLake API . projects . locations . catalogs . databases . tables

close()

Close httplib2 connections.

create(parent, body=None, tableId=None, x__xgafv=None)

Creates a new table.

Args:
  parent: string, Required. The parent resource where this table will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a table.
  "createTime": "A String", # Output only. The creation time of the table.
  "deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
  "etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
  "expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
  "hiveOptions": { # Options of a Hive table. # Options of a Hive table.
    "parameters": { # Stores user supplied Hive table parameters.
      "a_key": "A String",
    },
    "storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
      "inputFormat": "A String", # The fully qualified Java class name of the input format.
      "locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
      "outputFormat": "A String", # The fully qualified Java class name of the output format.
      "serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
        "serializationLib": "A String", # The fully qualified Java class name of the serialization library.
      },
    },
    "tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
  },
  "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
  "type": "A String", # The table type.
  "updateTime": "A String", # Output only. The last modification time of the table.
}

  tableId: string, Required. The ID to use for the table, which will become the final component of the table's resource name.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a table.
  "createTime": "A String", # Output only. The creation time of the table.
  "deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
  "etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
  "expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
  "hiveOptions": { # Options of a Hive table. # Options of a Hive table.
    "parameters": { # Stores user supplied Hive table parameters.
      "a_key": "A String",
    },
    "storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
      "inputFormat": "A String", # The fully qualified Java class name of the input format.
      "locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
      "outputFormat": "A String", # The fully qualified Java class name of the output format.
      "serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
        "serializationLib": "A String", # The fully qualified Java class name of the serialization library.
      },
    },
    "tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
  },
  "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
  "type": "A String", # The table type.
  "updateTime": "A String", # Output only. The last modification time of the table.
}

delete(name, x__xgafv=None)

Deletes an existing table specified by the table ID.

Args:
  name: string, Required. The name of the table to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a table.
  "createTime": "A String", # Output only. The creation time of the table.
  "deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
  "etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
  "expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
  "hiveOptions": { # Options of a Hive table. # Options of a Hive table.
    "parameters": { # Stores user supplied Hive table parameters.
      "a_key": "A String",
    },
    "storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
      "inputFormat": "A String", # The fully qualified Java class name of the input format.
      "locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
      "outputFormat": "A String", # The fully qualified Java class name of the output format.
      "serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
        "serializationLib": "A String", # The fully qualified Java class name of the serialization library.
      },
    },
    "tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
  },
  "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
  "type": "A String", # The table type.
  "updateTime": "A String", # Output only. The last modification time of the table.
}

get(name, x__xgafv=None)

Gets the table specified by the resource name.

Args:
  name: string, Required. The name of the table to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a table.
  "createTime": "A String", # Output only. The creation time of the table.
  "deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
  "etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
  "expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
  "hiveOptions": { # Options of a Hive table. # Options of a Hive table.
    "parameters": { # Stores user supplied Hive table parameters.
      "a_key": "A String",
    },
    "storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
      "inputFormat": "A String", # The fully qualified Java class name of the input format.
      "locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
      "outputFormat": "A String", # The fully qualified Java class name of the output format.
      "serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
        "serializationLib": "A String", # The fully qualified Java class name of the serialization library.
      },
    },
    "tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
  },
  "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
  "type": "A String", # The table type.
  "updateTime": "A String", # Output only. The last modification time of the table.
}

list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)

List all tables in a specified database.

Args:
  parent: string, Required. The parent, which owns this collection of tables. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} (required)
  pageSize: integer, The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 50 tables will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, A page token, received from a previous `ListTables` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTables` must match the call that provided the page token.
  view: string, The view for the returned tables.
    Allowed values
      TABLE_VIEW_UNSPECIFIED - Default value. The API will default to the BASIC view.
      BASIC - Include only table names. This is the default value.
      FULL - Include everything.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the ListTables method.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "tables": [ # The tables from the specified database.
    { # Represents a table.
      "createTime": "A String", # Output only. The creation time of the table.
      "deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
      "etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
      "expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
      "hiveOptions": { # Options of a Hive table. # Options of a Hive table.
        "parameters": { # Stores user supplied Hive table parameters.
          "a_key": "A String",
        },
        "storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
          "inputFormat": "A String", # The fully qualified Java class name of the input format.
          "locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
          "outputFormat": "A String", # The fully qualified Java class name of the output format.
          "serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
            "serializationLib": "A String", # The fully qualified Java class name of the serialization library.
          },
        },
        "tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
      },
      "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      "type": "A String", # The table type.
      "updateTime": "A String", # Output only. The last modification time of the table.
    },
  ],
}

list_next()

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(name, body=None, updateMask=None, x__xgafv=None)

Updates an existing table specified by the table ID.

Args:
  name: string, Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a table.
  "createTime": "A String", # Output only. The creation time of the table.
  "deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
  "etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
  "expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
  "hiveOptions": { # Options of a Hive table. # Options of a Hive table.
    "parameters": { # Stores user supplied Hive table parameters.
      "a_key": "A String",
    },
    "storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
      "inputFormat": "A String", # The fully qualified Java class name of the input format.
      "locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
      "outputFormat": "A String", # The fully qualified Java class name of the output format.
      "serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
        "serializationLib": "A String", # The fully qualified Java class name of the serialization library.
      },
    },
    "tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
  },
  "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
  "type": "A String", # The table type.
  "updateTime": "A String", # Output only. The last modification time of the table.
}

  updateMask: string, The list of fields to update. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a table.
  "createTime": "A String", # Output only. The creation time of the table.
  "deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
  "etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
  "expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
  "hiveOptions": { # Options of a Hive table. # Options of a Hive table.
    "parameters": { # Stores user supplied Hive table parameters.
      "a_key": "A String",
    },
    "storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
      "inputFormat": "A String", # The fully qualified Java class name of the input format.
      "locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
      "outputFormat": "A String", # The fully qualified Java class name of the output format.
      "serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
        "serializationLib": "A String", # The fully qualified Java class name of the serialization library.
      },
    },
    "tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
  },
  "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
  "type": "A String", # The table type.
  "updateTime": "A String", # Output only. The last modification time of the table.
}

rename(name, body=None, x__xgafv=None)

Renames an existing table specified by the table ID.

Args:
  name: string, Required. The table's `name` field is used to identify the table to rename. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the RenameTable method in MetastoreService
  "newName": "A String", # Required. The new `name` for the specified table, must be in the same database. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a table.
  "createTime": "A String", # Output only. The creation time of the table.
  "deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
  "etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
  "expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
  "hiveOptions": { # Options of a Hive table. # Options of a Hive table.
    "parameters": { # Stores user supplied Hive table parameters.
      "a_key": "A String",
    },
    "storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
      "inputFormat": "A String", # The fully qualified Java class name of the input format.
      "locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
      "outputFormat": "A String", # The fully qualified Java class name of the output format.
      "serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
        "serializationLib": "A String", # The fully qualified Java class name of the serialization library.
      },
    },
    "tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
  },
  "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
  "type": "A String", # The table type.
  "updateTime": "A String", # Output only. The last modification time of the table.
}