DESCRIBE GATEWAY

Décrit les propriétés d’une passerelle.

DESCRIBE peut être abrégé en DESC.

Voir aussi :

CREATE GATEWAY , ALTER GATEWAY, DROP GATEWAY , SHOW GATEWAYS

Syntaxe

DESC[RIBE] GATEWAY <name>
Copy

Paramètres

name

Spécifie l’identificateur de la passerelle à 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.

Pour plus d’informations, voir Exigences relatives à l’identificateur.

Sortie

La sortie de commande fournit les propriétés des politiques et les métadonnées dans les colonnes suivantes :

Colonne

Description

name

Nom de la passerelle.

ingress_url

URL d’entrée de la passerelle.

privatelink_ingress_url

URL d’entrée PrivateLink

database_name

Base de données dans laquelle la passerelle est créée.

schema_name

Schéma dans lequel la passerelle est créée.

owner

Rôle qui possède la passerelle.

owner_role_type

Type de rôle propriétaire de l’objet, soit ROLE soit DATABASE_ROLE.

spec

Spécification de la passerelle (format YAML). Cette colonne n’est affichée que si le rôle exécutant la commande a le privilège USAGE, MODIFY ou OWNERSHIP sur la passerelle.

created_on

Horodatage de la création de la passerelle.

updated_on

Horodatage de la dernière mise à jour de la passerelle.

comment

Commentaire relatif à la passerelle.

Note

Si le rôle utilisé a le privilège USAGE, MODIFY ou OWNERSHIP sur la passerelle, la colonne spec s’affiche. Si ce n’est pas le cas, les autres colonnes seront affichées, mais pas la colonne spec.

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, MODIFY ou OWNERSHIP

Passerelle

N’importe lequel de ces privilèges permet de décrire la passerelle. Seuls les rôles avec ces privilèges peuvent voir la spécification.

USAGE

Base de données

Requis sur la base de données contenant la passerelle.

USAGE

Schéma

Requis sur le schéma contenant la passerelle.

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 l’opérateur de canal (->>) ou la fonction RESULT_SCAN. Les deux constructions traitent la sortie comme un jeu de résultats que vous pouvez interroger.

    Par exemple, vous pouvez utiliser l’opérateur de canal ou la fonction RESULT_SCAN pour sélectionner des colonnes spécifiques à partir de la sortie de la commande SHOW ou pour filtrer les lignes.

    Lorsque vous faites référence aux colonnes de sortie, utilisez des identificateurs entre guillemets doubles pour les noms des colonnes. Par exemple, pour sélectionner la colonne de sortie type, spécifiez SELECT "type".

    Vous devez utiliser des identificateurs entre guillemets doubles, car les noms des colonnes de sortie pour les commandes SHOW sont en minuscules. Les guillemets doubles garantissent que les noms des colonnes dans la liste SELECT ou dans la clause WHERE correspondent aux noms des colonnes dans la sortie de la commande SHOW qui a été analysée.

Exemples

L’exemple suivant décrit la passerelle nommée split_gateway :

DESCRIBE GATEWAY split_gateway;
Copy