- NAME
-
- gcloud alpha biglake iceberg catalogs create - create a BigLake Iceberg REST catalog
- SYNOPSIS
-
-
gcloud alpha biglake iceberg catalogs createCATALOG--catalog-type=CATALOG_TYPE[--credential-mode=CREDENTIAL_MODE; default="end-user"] [--description=DESCRIPTION] [--federated-catalog-type=FEDERATED_CATALOG_TYPE] [--namespace-filters=[NAMESPACE,…]] [--primary-location=PRIMARY_LOCATION] [--refresh-interval=REFRESH_INTERVAL] [--secret-name=SECRET_NAME] [--unity-catalog-name=UNITY_CATALOG_NAME] [--unity-instance-name=UNITY_INSTANCE_NAME] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Create a BigLake Iceberg REST catalog. - EXAMPLES
-
To add a catalog using a Cloud Storage bucket
my-catalog-bucket, run:gcloud alpha biglake iceberg catalogs create my-catalog-bucket --catalog-type=gcs-bucketTo create a catalog using a Cloud Storage bucket
my-catalog-bucketwith vended credentials, run: To create a unity federated cataloggcloud alpha biglake iceberg catalogs create my-catalog-bucket --catalog-type=gcs-bucket --credential-mode=vended-credentialsmy-federated-catalog, run:gcloud alpha biglake iceberg catalogs create my-federated-catalog --catalog-type=federated --federated-catalog-type=unity --secret-name=projects/my-project/locations/us/secrets/my-secret --unity-instance-name=instance.cloud.databricks.com --unity-catalog-name=my-catalog --primary-location=us - POSITIONAL ARGUMENTS
-
-
Catalog resource - The Iceberg Catalog to create. This represents a Cloud
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.
To set the
projectattribute:-
provide the argument
catalogon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
CATALOG-
ID of the catalog or fully qualified identifier for the catalog.
To set the
catalogattribute:-
provide the argument
catalogon the command line.
-
provide the argument
-
provide the argument
-
Catalog resource - The Iceberg Catalog to create. This represents a Cloud
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.
- REQUIRED FLAGS
-
--catalog-type=CATALOG_TYPE-
Catalog type to create the catalog with.
CATALOG_TYPEmust be (only one value is supported):gcs-bucket- A catalog backed by a Cloud Storage bucket.
- OPTIONAL FLAGS
-
--credential-mode=CREDENTIAL_MODE; default="end-user"-
Credential mode to create the catalog with.
CREDENTIAL_MODEmust be one of:end-user- Use end user credentials to access the catalog.
vended-credentials- Use vended credentials to access the catalog.
--description=DESCRIPTION- Description of the resource.
--federated-catalog-type=FEDERATED_CATALOG_TYPE-
Type of the federated catalog.
FEDERATED_CATALOG_TYPEmust be (only one value is supported):unity. --namespace-filters=[NAMESPACE,…]- Filters to determine which namespaces are included in the refresh process. Empty list means include all namespaces.
--primary-location=PRIMARY_LOCATION- Primary location for mirroring the remote catalog metadata. It must be a BigLake-supported location, and it should be proximate to the remote catalog's location for better performance and lower cost.
--refresh-interval=REFRESH_INTERVAL- The interval for refreshing metadata from the remote catalog (e.g., "1hr5m30s"). Defaults to seconds if no unit is specified. If unset, the refresh interval will be set to 0s (background refresh disabled).
--secret-name=SECRET_NAME-
The secret resource name in Secret Manager, in the format
projects/{project_id}/locations/{location}/secrets/{secret_id}orprojects/{project_id}/locations/{location}/secrets/{secret_id}/versions/{version_id}. --unity-catalog-name=UNITY_CATALOG_NAME- Name of the catalog in Unity Catalog.
--unity-instance-name=UNITY_INSTANCE_NAME- The instance name is the first part of the URL when you log into your Databricks deployment. For example, for a Databricks on Google Cloud workspace URL https://1.1.gcp.databricks.com, the instance name is 1.1.gcp.databricks.com.
- GCLOUD WIDE FLAGS
-
These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - NOTES
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. These variants are also available:
gcloud biglake iceberg catalogs creategcloud beta biglake iceberg catalogs create
gcloud alpha biglake iceberg catalogs create
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-04-28 UTC.