Package Classes (0.1.0)

Summary of entries of Classes for google-cloud-biglake-hive.

Classes

HiveMetastoreServiceAsyncClient

Hive Metastore Service is a biglake service that allows users to manage their external Hive catalogs. Full API compatibility with OSS Hive Metastore APIs is not supported. The methods match the Hive Metastore API spec mostly except for a few exceptions. These include listing resources with pattern, environment context which are combined in a single List API, return of ListResponse object instead of a list of resources, transactions, locks, etc.

The BigLake Hive Metastore API defines the following resources:

A collection of Google Cloud projects: /projects/*
Each project has a collection of catalogs: /catalogs/*
Each catalog has a collection of databases: /databases/*
Each database has a collection of tables: /tables/*

HiveMetastoreServiceClient

The BigLake Hive Metastore API defines the following resources:

A collection of Google Cloud projects: /projects/*
Each project has a collection of catalogs: /catalogs/*
Each catalog has a collection of databases: /databases/*
Each database has a collection of tables: /tables/*

ListHiveCatalogsAsyncPager

A pager for iterating through list_hive_catalogs requests.

This class thinly wraps an initial ListHiveCatalogsResponse object, and provides an __aiter__ method to iterate through its catalogs field.

If there are more pages, the __aiter__ method will make additional ListHiveCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual ListHiveCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListHiveCatalogsPager

A pager for iterating through list_hive_catalogs requests.

This class thinly wraps an initial ListHiveCatalogsResponse object, and provides an __iter__ method to iterate through its catalogs field.

If there are more pages, the __iter__ method will make additional ListHiveCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual ListHiveCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListHiveDatabasesAsyncPager

A pager for iterating through list_hive_databases requests.

This class thinly wraps an initial ListHiveDatabasesResponse object, and provides an __aiter__ method to iterate through its databases field.

If there are more pages, the __aiter__ method will make additional ListHiveDatabases requests and continue to iterate through the databases field on the corresponding responses.

All the usual ListHiveDatabasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListHiveDatabasesPager

A pager for iterating through list_hive_databases requests.

This class thinly wraps an initial ListHiveDatabasesResponse object, and provides an __iter__ method to iterate through its databases field.

If there are more pages, the __iter__ method will make additional ListHiveDatabases requests and continue to iterate through the databases field on the corresponding responses.

All the usual ListHiveDatabasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListHiveTablesAsyncPager

A pager for iterating through list_hive_tables requests.

This class thinly wraps an initial ListHiveTablesResponse object, and provides an __aiter__ method to iterate through its tables field.

If there are more pages, the __aiter__ method will make additional ListHiveTables requests and continue to iterate through the tables field on the corresponding responses.

All the usual ListHiveTablesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListHiveTablesPager

A pager for iterating through list_hive_tables requests.

This class thinly wraps an initial ListHiveTablesResponse object, and provides an __iter__ method to iterate through its tables field.

If there are more pages, the __iter__ method will make additional ListHiveTables requests and continue to iterate through the tables field on the corresponding responses.

All the usual ListHiveTablesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

BatchCreatePartitionsRequest

Request message for the BatchCreatePartitions method.

BatchCreatePartitionsResponse

Response message for BatchCreatePartitions.

BatchDeletePartitionsRequest

Request message for BatchDeletePartitions. The Partition is uniquely identified by values, which is an ordered list. Hence, there is no separate name or partition id field.

BatchUpdatePartitionsRequest

Request message for BatchUpdatePartitions.

BatchUpdatePartitionsResponse

Response message for BatchUpdatePartitions.

CreateHiveCatalogRequest

Request message for the CreateHiveCatalog method.

CreateHiveDatabaseRequest

Request message for the CreateHiveDatabase method.

CreateHiveTableRequest

Request message for the CreateHiveTable method.

CreatePartitionRequest

Request message for CreatePartition. The Partition is uniquely identified by values, which is an ordered list. Hence, there is no separate name or partition id field.

DeleteHiveCatalogRequest

Request message for the DeleteHiveCatalog method.

DeleteHiveDatabaseRequest

Request message for the DeleteHiveDatabase method.

DeleteHiveTableRequest

Request message for the DeleteHiveTable method.

FieldSchema

Field schema information.

GetHiveCatalogRequest

Request message for the GetHiveCatalog method.

GetHiveDatabaseRequest

Request message for the GetHiveDatabase method.

GetHiveTableRequest

Request message for the GetHiveTable method.

HiveCatalog

The HiveCatalog contains spark/hive databases and tables in the BigLake Metastore. While creating resources under a catalog, ideally ensure that the storage bucket location, spark / hive engine location or any other compute location match. Catalog can be viewed as the destination for migrating an on-prem Hive metastore to GCP.

Replica

The replica of the Catalog.

State

If the catalog is replicated to multiple regions, this enum describes the current state of the replica.

HiveDatabase

Stores the hive database information. It includes the database name, description, location and properties associated with the database.

ParametersEntry

The abstract base class for a message.

HiveTable

Stores the hive table information. It includes the table name, schema (column names and types), data location, storage format, serde info, etc. This message closely matches the Table object in the IMetastoreClient