DESCRIBE CATALOG INTEGRATION¶

Décrit les propriétés d’une intégration de catalogue.

DESCRIBE peut être abrégé en DESC.

Astuce

Outre SQL, vous pouvez également utiliser d’autres interfaces, telles que Snowflake REST APIs, Snowflake Python APIs et Snowflake CLI. Voir Interfaces alternatives.

Voir aussi :: CREATE CATALOG INTEGRATION , ALTER CATALOG INTEGRATION , DROP CATALOG INTEGRATION , SHOW CATALOG INTEGRATIONS

Syntaxe¶

DESC[RIBE] CATALOG INTEGRATION <name>

Copy

Paramètres¶

name: Indique l’identificateur de l’intégration de catalogue à décrire. Si l’identificateur contient des espaces ou des caractères spéciaux, toute la chaîne doit être délimitée par des guillemets doubles. Les identificateurs entre guillemets doubles sont également sensibles à la casse.

Sortie¶

La sortie de la commande comprend les colonnes suivantes, qui décrivent les propriétés et les métadonnées de l’objet :

Colonne	Description
`property`	Nom de la propriété. Cette colonne peut inclure les propriétés répertoriées dans le tableau suivant.
`property_type`	Type de propriété.
`property_value`	Valeur attribuée à la propriété.
`property_default`	Valeur par défaut de la propriété.

La colonne property peut inclure les propriétés d’objet d’intégration de catalogue suivantes :

Propriété	Description
`enabled`	Indique si l’intégration de catalogue peut être utilisée pour des tables Apache Iceberg™.
`catalog_source`	Type de source de catalogue : `ICEBERG_REST`, `POLARIS`, `OBJECT_STORE` ou `GLUE` (pour les intégrations Glue autres que REST).
`refresh_interval_seconds`	Spécifie le nombre de secondes pendant lesquelles Snowflake attend entre les tentatives d’interrogation du catalogue Iceberg externe pour que les mises à jour des métadonnées soient actualisées automatiquement.
`rest_authentication`	Spécifie les paramètres d’authentification REST de l’intégration de catalogue.
`rest_config`	Spécifie les paramètres de configuration REST de l’intégration de catalogue.
`catalog_namespace`	La sortie de cette colonne est la suivante : Si l’intégration de catalogue concerne des tables Iceberg gérées en externe, spécifie l’espace de noms du catalogue Iceberg externe. Si l’espace de noms est spécifié au niveau de la table uniquement, cette colonne n’a aucune valeur dans la sortie de la fonction. Si l’intégration de catalogue vise à synchroniser une table gérée par Snowflake avec Snowflake Open Catalog, cette colonne n’a aucune valeur dans la sortie de la fonction, car ce champ n’est pas obligatoire.
`table_format`	Le format de table fourni par le catalogue ; par exemple, `ICEBERG`.
`glue_aws_role_arn`	(AWS Glue) Le nom de ressource Amazon (Amazon Resource Name ou ARN) du rôle IAM que Snowflake assume pour se connecter à AWS Glue.
`glue_catalog_id`	(AWS Glue) L’ID de votre compte AWS.
`glue_region`	(AWS Glue) La région AWS de votre AWS Glue Data Catalog.
`glue_aws_iam_user_arn`	(AWS Glue) L’ARN de l’utilisateur IAM AWS créé pour votre compte Snowflake lorsque vous avez créé l’intégration de catalogue.
`glue_aws_external_id`	(AWS Glue) L’ID externe que Snowflake utilise pour établir une relation de confiance avec AWS Glue.
`comment`	Le commentaire de l’intégration de catalogue.

Exigences en matière de contrôle d’accès¶

Un rôle utilisé pour exécuter cette opération doit au minimum disposer des privilèges suivants :

Privilège	Objet	Remarques
USAGE	Intégration (catalogue)

Pour obtenir des instructions sur la création d’un rôle personnalisé avec un ensemble spécifique de privilèges, voir Création de rôles personnalisés.

Pour des informations générales sur les rôles et les privilèges accordés pour effectuer des actions SQL sur des objets sécurisables, voir Aperçu du contrôle d’accès.

Notes sur l’utilisation¶

Pour post-traiter la sortie de cette commande, vous pouvez utiliser la fonction RESULT_SCAN qui traite la sortie sous forme de table à interroger. Vous pouvez également utiliser l”opérateur de canal pour interroger la sortie de cette commande.

Exemples¶

Décrivez une intégration de catalogue :

DESC CATALOG INTEGRATION my_catalog_integration;

Copy

L’exemple suivant montre la sortie de DESCRIBE CATALOG INTEGRATION d’une intégration de catalogue AWS Glue. La sortie comprend les propriétés propres à AWS Glue (par exemple, GLUE_AWS_ROLE_ARN) et les propriétés d’intégration de catalogue communes.

+-----------------------+---------------+----------------------------------+------------------+
|       property        | property_type |          property_value          | property_default |
+-----------------------+---------------+----------------------------------+------------------+
| ENABLED               | Boolean       | true                             | false            |
| CATALOG_SOURCE        | String        | GLUE                             |                  |
| CATALOG_NAMESPACE     | String        | dbname                           |                  |
| TABLE_FORMAT          | String        | ICEBERG                          |                  |
| GLUE_AWS_ROLE_ARN     | String        | arn:aws:iam::123:role/dummy-role |                  |
| GLUE_CATALOG_ID       | String        | 123456789012                     |                  |
| GLUE_REGION           | String        | us-west-2                        |                  |
| GLUE_AWS_IAM_USER_ARN | String        | arn:aws:iam::123:user/example    |                  |
| GLUE_AWS_EXTERNAL_ID  | String        | exampleGlueExternalId            |                  |
| COMMENT               | String        |                                  |                  |
+-----------------------+---------------+----------------------------------+------------------+

Interfaces alternatives¶

Snowflake REST APIs
- Récupérer un point de terminaison d’intégration du catalogue
Snowflake Python APIs
- Méthode catalog_integration.CatalogIntegrationResource.fetch
Snowflake CLI
- Non pris en charge