Get catalog details

Retrieving configuration properties exposes metadata for Lakehouse for Apache Iceberg.

Within the Lakehouse runtime catalog, inspecting an existing catalog (such as an Apache Iceberg REST catalog or Apache Hive catalog) reveals its details. For Apache Iceberg REST catalogs, this includes the REST catalog URI required for client connections, authentication method, and associated service account.

Before you begin

  1. Read About the Lakehouse runtime catalog to understand how the Lakehouse runtime catalog works and the limitations for the service.
    2. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

    In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

    Verify that billing is enabled for your Google Cloud project.

    Enable the BigLake API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

    In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

    Verify that billing is enabled for your Google Cloud project.

    Enable the BigLake API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

Required roles

To get the permissions that you need to view catalog details, ask your administrator to grant you the following IAM roles on your project:

For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required permissions through custom roles or other predefined roles.

Get catalog details

Inspect catalog configuration and properties.

Console

  1. In the Google Cloud console, open the Lakehouse page.

    Go to Lakehouse

  2. Click the name of any catalog.

  3. On the Catalog Details page, explore information about the catalog such as catalog ID, creation timestamp, REST catalog URI, authentication method, and service account.

gcloud

To describe a catalog using gcloud, run the gcloud biglake iceberg catalogs describe command.

gcloud biglake iceberg catalogs describe CATALOG_ID \
    --project="PROJECT_ID"

Replace the following:

  • CATALOG_ID: the ID of your catalog.
  • PROJECT_ID: your Google Cloud project ID.

REST

To retrieve catalog details and configuration using the REST API, make a GET request to the GetIcebergCatalog endpoint:

GET /iceberg/v1/restcatalog/extensions/projects/PROJECT_ID/catalogs/CATALOG_ID

The response contains an IcebergCatalog JSON object describing the catalog configuration.

Replace the following:

  • PROJECT_ID: your Google Cloud project ID.
  • CATALOG_ID: the ID of your catalog.