REST Resource: hive.v1alpha.projects.catalogs

Resource: 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.

JSON representation 
{
  "name": string,
  "description": string,
  "locationUri": string,
  "replicas": [
    {
      object (Replica)
    }
  ],
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. The resource name. Format: projects/{project_id_or_number}/catalogs/{catalogId}
description

string

Optional. Stores the catalog description. The maximum length is 4000 characters.
locationUri

string

Required. The Cloud Storage location path where the catalog exists. Format: gs://bucket/path/to/catalog The maximum length is 4000 characters.
replicas[]

object (Replica)

Output only. The replicas for the catalog metadata.
createTime

string (Timestamp format)

Output only. The creation time of the catalog.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The update time of the catalog.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Replica

The replica of the Catalog.

JSON representation 
{
  "region": string,
  "state": enum (State)
}
Fields
region

string

Output only. The region of the replica. For example us-east1.
state

enum (State)

Output only. The current state of the replica.

State

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

Enums
STATE_UNSPECIFIED The replica state is unknown.
STATE_PRIMARY Indicates the replica is the writable primary.
STATE_PRIMARY_IN_PROGRESS Indicates the replica has been recently assigned as the primary, but not all databases are writeable yet.
STATE_SECONDARY Indicates the replica is a read-only secondary replica.

Methods

create

 Creates a new hive catalog.

delete

 Deletes an existing catalog specified by the catalog ID.

get

 Gets the catalog specified by the resource name.

list

 List all catalogs in a specified project.

patch

 Updates an existing catalog.