- Ressource: IcebergCatalog
- CredentialMode
- CatalogType
- Replikat
- Bundesland
- RestrictedLocationsConfig
- EncryptionConfig
- FederatedCatalogOptions
- IdentityFederationOrganizationServiceAccount
- UnityCatalogInfo
- GlueCatalogInfo
- SnowflakeCatalogInfo
- WorkdayCatalogInfo
- IdentityMode
- UserIdentityFederationOidcClaims
- UserIdentityFederationOidc
- RefreshOptions
- RefreshSchedule
- RefreshScope
- RefreshStatus
- CrossCloudCacheOptions
- Methoden
Ressource: IcebergCatalog
Die Informationen zum Iceberg-REST-Katalog.
| JSON-Darstellung |
|---|
{ "name": string, "credential-mode": enum ( |
| Felder | |
|---|---|
name |
ID. Der Katalogname, |
credential-mode |
Optional. Der Anmeldedatenmodus für den Katalog. |
biglake-service-account |
Nur Ausgabe. Das Dienstkonto, das für die Bereitstellung von Anmeldedaten verwendet wird (nur Ausgabe). Kann leer sein, wenn die Bereitstellung von Anmeldedaten für den Katalog nie aktiviert wurde. Bei föderierten Katalogen wird das Dienstkonto immer bereitgestellt und für den Zugriff auf den Remote-Katalog zur Hintergrundaktualisierung von Metadaten verwendet. Wenn |
biglake-service-account-id |
Nur Ausgabe. Die eindeutige ID des Dienstkontos. Dies wird für Föderationsszenarien verwendet. |
catalog-type |
Erforderlich. Der Katalogtyp. Erforderlich für catalogs.create. Der Katalogtyp ist unveränderlich, außer bei der Konvertierung von CATALOG_TYPE_GCS_BUCKET in CATALOG_TYPE_BIGLAKE. |
default-location |
Optional. Der Standardspeicherort für den Katalog, z.B. Bei BigLake-Katalogen muss dieses Feld angegeben werden und auf einen Google Cloud Storage-Bucket oder einen Pfad in diesem Bucket verweisen. Dieser Pfad dient als Basisverzeichnis für die Erstellung des vollständigen Pfads zu den Daten- und Metadatenverzeichnissen einer Tabelle, wenn kein Speicherort auf Namespace- oder Tabellenebene angegeben ist. Der vollständige Pfad wird gebildet, indem die Namespace- und Tabellenkennungen an den Standardstandort angehängt werden. |
storage-regions[] |
Nur Ausgabe. Die Google Cloud-Regionen des Buckets am Standardstandort, z.B. |
create-time |
Nur Ausgabe. Wann der Katalog erstellt wurde. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
update-time |
Nur Ausgabe. Wann der Katalog zuletzt aktualisiert wurde. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
replicas[] |
Nur Ausgabe. Die Replikate für die Katalogmetadaten. |
description |
Optional. Eine vom Nutzer angegebene Beschreibung des Katalogs. Die Beschreibung muss ein UTF-8-String mit maximal 1.024 Zeichen sein. |
restricted-locations-config |
Optional. Konfiguration für eingeschränkte Standorte. Dieses Feld wird derzeit nur für BigLake-Kataloge verwendet. Wenn dieses Feld nicht festgelegt ist oder |
federated-catalog-options |
Optional. Konfigurationsoptionen für föderierte Kataloge. |
cross-cloud-cache-options |
Optional. Konfigurationsoptionen für das cloudübergreifende Caching von Daten- und Metadatendateien. |
encryption-config |
Optional. Benutzerdefinierte Verschlüsselungskonfiguration (z.B. Cloud KMS-Schlüssel). |
CredentialMode
Der für den Katalog verwendete Anmeldedatenmodus.
| Enums | |
|---|---|
CREDENTIAL_MODE_UNSPECIFIED |
Standardwert/nicht festgelegter Wert. Dieser Wert wird nicht verwendet. |
CREDENTIAL_MODE_END_USER |
Modus für Anmeldedaten von Endnutzern, Standard. Der authentifizierende Nutzer muss Zugriff auf die Katalogressourcen und die zugrunde liegenden Google Cloud Storage-Objekte haben. |
CREDENTIAL_MODE_VENDED_CREDENTIALS |
Modus für Bereitstellung von Anmeldedaten. Der authentifizierende Nutzer benötigt nur Zugriff auf die Katalogressourcen. Das System stellt dem Aufrufer eingeschränkte Anmeldedaten für den Zugriff auf die Google Cloud Storage-Objekte zur Verfügung. Für alle Tabellenvorgänge in diesem Modus muss der Header Weitere Informationen finden Sie unter https://docs.cloud.google.com/lakehouse/docs/credential-vending. |
CatalogType
Bestimmt den Katalogtyp.
| Enums | |
|---|---|
CATALOG_TYPE_UNSPECIFIED |
Standardwert/nicht festgelegter Wert. Dieser Wert wird nicht verwendet. |
CATALOG_TYPE_GCS_BUCKET |
Google Cloud Storage-Bucket-Katalogtyp. |
CATALOG_TYPE_BIGLAKE |
BigLake-Katalogtyp. |
CATALOG_TYPE_FEDERATED |
Typ des föderierten Katalogs. |
CATALOG_TYPE_ALLOYDB_AGENT_MODE |
Katalog zum Abfragen von AlloyDB-Tabellen im Agentenmodus. |
Replikat
Das Replikat des Katalogs.
| JSON-Darstellung |
|---|
{
"region": string,
"state": enum ( |
| Felder | |
|---|---|
region |
Nur Ausgabe. Die Region des Replikats. Beispiel: „us-east1“ |
state |
Nur Ausgabe. Der aktuelle Status des Replikats. |
Bundesland
Wenn der Katalog in mehrere Regionen repliziert wird, beschreibt dieser Enum den aktuellen Status des Replikats.
| Enums | |
|---|---|
STATE_UNKNOWN |
Standardwert/nicht festgelegter Wert. Dieser Wert wird nicht verwendet. |
STATE_PRIMARY |
Das Replikat ist die beschreibbare primäre Instanz. |
STATE_PRIMARY_IN_PROGRESS |
Das Replikat wurde vor Kurzem als primäres Replikat zugewiesen, aber noch nicht alle Namespaces sind beschreibbar. |
STATE_SECONDARY |
Das Replikat ist ein sekundäres Replikat mit Lesezugriff. |
RestrictedLocationsConfig
Konfiguration von Standortbeschränkungen.
| JSON-Darstellung |
|---|
{ "restricted-locations": [ string ] } |
| Felder | |
|---|---|
restricted-locations[] |
Optional. Zusätzliche Google Cloud Storage-Buckets und -Standorte (z.B. Wenn |
EncryptionConfig
Benutzerdefinierte Verschlüsselungskonfiguration (z.B. Cloud KMS-Schlüssel).
| JSON-Darstellung |
|---|
{ "kms-key-name": string } |
| Felder | |
|---|---|
kms-key-name |
Optional. Cloud KMS-Schlüsselname, der zum Verschlüsseln der aus dem Katalog abgerufenen im Cache gespeicherten Daten verwendet wird. Format: |
FederatedCatalogOptions
Konfigurationsoptionen für einen föderierten Katalog.
| JSON-Darstellung |
|---|
{ "identity-mode": enum ( |
| Felder | |
|---|---|
identity-mode |
Optional. Der Identitätsmodus für den föderierten Katalog. |
refresh-options |
Optional. Konfiguration aktualisieren. |
refresh-status |
Nur Ausgabe. Der Status der Hintergrundvorgänge zur Metadatenaktualisierung. |
| Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: | |
identity-federation-organization-service-account |
Nur Ausgabe. Das Dienstkonto auf Organisationsebene, das für die Identitätsföderation verwendet wird. |
| Ende der sich gegenseitig ausschließenden Felder. | |
| Informationen zum Remote-Iceberg-REST-Katalog. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: | |
unity-catalog-info |
Optional. Informationen speziell zu Databricks Unity Catalog. |
glue-catalog-info |
Optional. Spezifische Informationen zu AWS Glue Data Catalog. |
snowflake-catalog-info |
Optional. Informationen speziell zu Snowflake Horizon Catalog. |
workday-catalog-info |
Optional. Spezifische Informationen zu Workday Data Lake. |
| Ende der sich gegenseitig ausschließenden Felder. | |
secret-name |
Optional. Der Name der Secret-Ressource in Secret Manager im Format Die Projekt-ID muss mit dem Projekt des Katalogs und der Standort mit dem Standort des Katalogs übereinstimmen. Wenn keine Version angegeben ist, wird die aktuelle Version verwendet. Dieses Feld wird nicht verwendet, wenn |
service-directory-name |
Optional. Der Name der Service Directory-Ressource, die zum Weiterleiten des Transportschicht-Traffics mit dem Remote-Katalog (z. B. Zugriff auf Datendateien in Storage-Buckets) über eine private Netzwerkverbindung verwendet wird. Format: Wird von BigQuery-Abfragen verwendet, um private Endpunkte zum Abrufen von Datendateien (z.B. Iceberg-Daten in S3 oder Azure Data Lake Storage) über eine private Netzwerkverbindung wie Cross-Cloud Interconnect aufzulösen. |
metadata-service-directory-name |
Optional. Der Name der Service Directory-Ressource, die zum Weiterleiten des Traffics der Metadatenebene mit dem Remote-Katalog über eine private Netzwerkverbindung verwendet wird. Format: Wird verwendet, um Katalogmetadaten (z. B. Iceberg-Konfigurationen, Namespaces und Tabellen) über eine private Netzwerkverbindung wie Cross-Cloud Interconnect abzurufen. Wird auch zum Abrufen von OAuth-Tokens verwendet, wenn |
user-identity-federation-oidc-claims |
Nur Ausgabe. Nicht mehr unterstützt: Verwenden Sie stattdessen Die OIDC-Anforderungen, die im ID-Token für die Nutzeridentitätsföderation ausgegeben werden. |
user-identity-federation-oidc |
Nur Ausgabe. Die OIDC-Konfiguration für die Nutzeridentitätsföderation. |
IdentityFederationOrganizationServiceAccount
Das Dienstkonto auf Organisationsebene, das für die Identitätsföderation verwendet wird (nur Ausgabe). Kann leer sein, wenn die Identitätsföderation für den Katalog nie aktiviert wurde.
| JSON-Darstellung |
|---|
{ "service-account": string, "service-account-unique-id": string } |
| Felder | |
|---|---|
service-account |
Nur Ausgabe. E-Mail-Adresse des Dienstkontos auf Organisationsebene. |
service-account-unique-id |
Nur Ausgabe. Die eindeutige ID des Dienstkontos auf Organisationsebene. |
UnityCatalogInfo
Informationen speziell zu Databricks Unity Catalog. Der Iceberg-REST-Katalogendpunkt hat das folgende Format: https://<instanceName>/api/2.1/unity-catalog/iceberg-rest/v1/config?warehouse=<catalogName>.
| JSON-Darstellung |
|---|
{ "instance-name": string, "catalog-name": string, "service-principal-application-id": string } |
| Felder | |
|---|---|
instance-name |
Erforderlich. Nicht veränderbar. Der Instanzname des Databricks-Arbeitsbereichs. Lautet die URL des Databricks-Arbeitsbereichs beispielsweise |
catalog-name |
Erforderlich. Nicht veränderbar. Der Name des Katalogs in Databricks Unity Catalog. |
service-principal-application-id |
Optional. Die Anwendungs-ID des Databricks-Dienstprinzipals, der für den Zugriff auf Databricks Unity Catalog im OIDC-Authentifizierungsablauf verwendet wird. |
GlueCatalogInfo
Spezifische Informationen zu AWS Glue Data Catalog. Der Iceberg-REST-Katalogendpunkt hat das folgende Format: https://glue.<awsRegion>.amazonaws.com/iceberg/v1/config?warehouse=<warehouse>.
| JSON-Darstellung |
|---|
{ "warehouse": string, "aws-region": string, "aws-role-arn": string } |
| Felder | |
|---|---|
warehouse |
Erforderlich. Nicht veränderbar. Der Warehouse-Standort in AWS Glue Data Catalog. Verwenden Sie für den Katalog des Standardkontos die 12-stellige AWS-Konto-ID (z. B. |
aws-region |
Erforderlich. Nicht veränderbar. Die AWS-Region des AWS Glue Data Catalog (z. B. |
aws-role-arn |
Erforderlich. Der Amazon Resource Name (ARN) der AWS-IAM-Rolle, die der föderierte Katalog für den Zugriff auf AWS Glue Data Catalog übernimmt. |
SnowflakeCatalogInfo
Informationen speziell zu Snowflake Horizon Catalog. Der Iceberg-REST-Katalogendpunkt hat das folgende Format: https://<accountIdentifier>.snowflakecomputing.com/polaris/api/catalog/v1/config?warehouse=<warehouse>.
| JSON-Darstellung |
|---|
{ "account-identifier": string, "warehouse": string, "snowflake-role": string } |
| Felder | |
|---|---|
account-identifier |
Erforderlich. Nicht veränderbar. Die Konto-ID in Snowflake. Lautet die URL der Snowflake-Bereitstellung beispielsweise Die Konto-ID kann Buchstaben, Ziffern und Unterstriche enthalten, wobei die Segmente durch Bindestriche ( |
warehouse |
Erforderlich. Nicht veränderbar. Der Datenbankname in Snowflake Horizon Catalog. |
snowflake-role |
Optional. Die Snowflake-Rolle, die im Authentifizierungsablauf der Workload Identity-Föderation (OIDC) verwendet wird, um den Zugriff auf Snowflake Horizon Catalog einzuschränken. |
WorkdayCatalogInfo
Spezifische Informationen zu Workday Data Lake. Der Iceberg-REST-Katalogendpunkt hat das folgende Format: https://<baseUrl>/datalake/api/catalog/v1/config?warehouse=workday.
| JSON-Darstellung |
|---|
{ "base-url": string, "tenant": string, "api-client-client-id": string } |
| Felder | |
|---|---|
base-url |
Erforderlich. Nicht veränderbar. Die Basis-URL der Workday-Instanz. Beispiel: |
tenant |
Erforderlich. Nicht veränderbar. Der Name des Workday-Mandanten. |
api-client-client-id |
Optional. Die Client-ID des Workday API-Clients, der für den Zugriff auf Workday Data Lake im OIDC-Authentifizierungsablauf verwendet wird. |
IdentityMode
Der Identitätsmodus, der vom Katalog für Abfragen verwendet wird.
| Enums | |
|---|---|
IDENTITY_MODE_UNSPECIFIED |
Standardwert/nicht festgelegter Wert. Dieser Wert wird genauso behandelt wie IDENTITY_MODE_SERVICE_IDENTITY. |
IDENTITY_MODE_SERVICE_IDENTITY |
Abfragen werden mit dem Dienstkonto in google.cloud.biglake.v1main.IcebergCatalog.biglake_service_account ausgeführt. |
IDENTITY_MODE_USER_IDENTITY_FEDERATION |
Abfragen werden mit der Identität des Endnutzers ausgeführt und an den Remote-Katalog weitergegeben. Die Identitätsföderation muss im Remote-Katalog konfiguriert sein. Weitere Informationen finden Sie unter https://docs.cloud.google.com/lakehouse/docs/about-cross-cloud-data-access#identity-mode. |
UserIdentityFederationOidcClaims
OIDC-Anforderungen, die im ID-Token ausgegeben werden, wenn IDENTITY_MODE_USER_IDENTITY_FEDERATION aktiviert ist.
Diese Werte identifizieren den Identitätsanbieter (Aussteller) und den vorgesehenen Empfänger (Zielgruppe) des Tokens. Um die Nutzeridentitätsföderation zu aktivieren, müssen Nutzer ihren Remote-Katalog so konfigurieren, dass er diesem Aussteller vertraut und diese Zielgruppe erwartet.
| JSON-Darstellung |
|---|
{ "issuer-url": string, "audience": string } |
| Felder | |
|---|---|
issuer-url |
Nur Ausgabe. Die Aussteller-URL des Identitätsanbieters. |
audience |
Nur Ausgabe. Die Zielgruppe, die dieser Katalog im Token erwartet. |
UserIdentityFederationOidc
OIDC-Konfiguration, die verwendet wird, wenn IDENTITY_MODE_USER_IDENTITY_FEDERATION aktiviert ist.
Um die Nutzeridentitätsföderation zu aktivieren, müssen Nutzer ihren Remote-Katalog so konfigurieren, dass Tokens mit diesen Parametern vertraut wird.
| JSON-Darstellung |
|---|
{ "issuer-url": string, "audience": string, "jwks-url": string } |
| Felder | |
|---|---|
issuer-url |
Nur Ausgabe. Die Aussteller-URL des Identitätsanbieters. |
audience |
Nur Ausgabe. Die Zielgruppe, die dieser Katalog im Token erwartet. |
jwks-url |
Nur Ausgabe. Die JWKS-URL (JSON Web Key Set), die die öffentlichen Schlüssel bereitstellt, mit denen das Token verifiziert wird. Wird nur für föderierte Snowflake Horizon-Kataloge festgelegt, wobei es als |
RefreshOptions
Konfiguration aktualisieren.
| JSON-Darstellung |
|---|
{ "refresh-schedule": { object ( |
| Felder | |
|---|---|
refresh-schedule |
Optional. Der Zeitplan definiert, ob und wann die Metadatenaktualisierung geplant werden soll. |
refresh-scope |
Optional. Bereichskonfigurationen aktualisieren. |
RefreshSchedule
Der Zeitplan definiert, ob und wann die Metadatenaktualisierung geplant werden soll.
| JSON-Darstellung |
|---|
{ "refresh-interval": string } |
| Felder | |
|---|---|
refresh-interval |
Optional. Das Intervall für die Aktualisierung von Metadaten aus dem Remote-Katalog. Wenn der Wert nicht festgelegt oder <= 0 ist, wird die Hintergrundaktualisierung der Metadaten deaktiviert. Wenn dieses Feld für einen vorhandenen föderierten Katalog aktualisiert wird, muss die vorherige Aktualisierung der Hintergrundmetadaten abgeschlossen sein, bevor das neue Aktualisierungsintervall wirksam wird. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „ |
RefreshScope
Der Bereich definiert eine Teilmenge von Namespaces, die aktualisiert werden sollen.
| JSON-Darstellung |
|---|
{ "namespace-filters": [ string ] } |
| Felder | |
|---|---|
namespace-filters[] |
Optional. Filter, mit denen festgelegt wird, welche Namespaces in den Aktualisierungsprozess einbezogen werden. – Eine leere Liste bedeutet, dass alle Namespaces eingeschlossen werden. – „[namespaces]“ bedeutet, dass die angegebenen Namespaces eingeschlossen werden sollen. ['ns1', 'ns2'] : Nur die Namespaces „ns1“ und „ns2“ werden erkannt. |
RefreshStatus
Status der Metadatenaktualisierung im Hintergrund für den Remote-Katalog.
| JSON-Darstellung |
|---|
{
"start-time": string,
"end-time": string,
"status": {
object ( |
| Felder | |
|---|---|
start-time |
Nur Ausgabe. Wenn die Katalogaktualisierung gestartet wurde, einschließlich laufender Aktualisierungen. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
end-time |
Nur Ausgabe. Wenn die Katalogaktualisierung abgeschlossen ist, wird die Einstellung für laufende Aktualisierungen aufgehoben. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
status |
Nur Ausgabe. Der Status des letzten Vorgangs zur Aktualisierung von Metadaten im Hintergrund. Für laufende Aktualisierungen ist dieser Wert nicht festgelegt. |
CrossCloudCacheOptions
Konfigurationsoptionen für das cloudübergreifende Caching von Daten- und Metadatendateien.
| JSON-Darstellung |
|---|
{ "enabled": boolean } |
| Felder | |
|---|---|
enabled |
Optional. Gibt an, ob das cloudübergreifende Caching von Daten- und Metadatendateien aktiviert ist. Dies betrifft nur Abfragen über BigQuery. Wenn dieser Wert Wenn dieser Wert |
Methoden |
|
|---|---|
|
Erstellt den Iceberg-REST-Katalog. |
|
Löscht den Iceberg-REST-Katalog. |
|
Führen Sie ein Failover des Katalogs in eine neue primäre Replikatregion durch. |
|
Gibt die Konfigurationsoptionen für den Iceberg-REST-Katalog zurück. |
|
Listet die Iceberg-REST-Kataloge auf. |
|
Aktualisieren Sie die Konfigurationsoptionen für den Iceberg-REST-Katalog. |