You can inspect the schema, column comments, properties, and SQL definition of an Apache Iceberg view registered in the Lakehouse runtime catalog by using Spark or the Apache Iceberg REST catalog endpoint.
Before you begin
-
Verify that billing is enabled for your Google Cloud project.
-
Enable the BigLake API, if it is not already enabled.
Roles required to enable APIs
To enable APIs, you need the
serviceusage.services.enablepermission. 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. - Set up the Lakehouse runtime catalog with the Apache Iceberg REST catalog endpoint.
- Review the limitations of Iceberg views.
- Create a view.
Required roles
To get the permissions that you need to get view details, ask your administrator to grant you the following IAM roles on your project and storage bucket:
-
Get view details:
BigLake Viewer (
roles/biglake.viewer) - your project -
Read view metadata files in end-user credentials mode:
Storage Object Viewer (
roles/storage.objectViewer) - the Cloud Storage bucket
For more information about granting roles, see Manage access to projects, folders, and organizations.
These predefined roles contain the permissions required to get view details. To see the exact permissions that are required, expand the Required permissions section:
Required permissions
The following permissions are required to get view details:
-
Get view details:
biglake.views.geton the view -
Read view metadata files in end-user credentials mode:
storage.objects.geton the Cloud Storage bucket
You might also be able to get these permissions with custom roles or other predefined roles.
For a complete list of view permissions, see Required roles and permissions.
Get view details
Inspect a view.
Spark
Show the view schema, column comments, and view properties:
DESCRIBE EXTENDED NAMESPACE_NAME.VIEW_NAME;
Show the SQL statement that defines the view:
SHOW CREATE TABLE NAMESPACE_NAME.VIEW_NAME;
Show only the view properties:
SHOW TBLPROPERTIES NAMESPACE_NAME.VIEW_NAME;
Replace the following:
NAMESPACE_NAME: the name of your namespace.VIEW_NAME: the name of your view.
REST
To load the current metadata of a view using the REST API, make a GET
request to the GetIcebergView endpoint:
GET /iceberg/v1/restcatalog/v1/projects/PROJECT_ID/catalogs/CATALOG_ID/namespaces/NAMESPACE_NAME/views/VIEW_NAME
The response contains the view's metadata-location and metadata.
To check whether a view exists without loading its metadata, make a HEAD
request to the same path. The CheckIcebergViewExists endpoint returns
204 No Content if the view exists, or 404 Not Found if it doesn't.
Replace the following:
PROJECT_ID: your Google Cloud project ID.CATALOG_ID: the ID of your catalog.NAMESPACE_NAME: the name of your catalog namespace.VIEW_NAME: the name of your view.
What's next
- Learn how to query a view.
- Learn how to alter a view.