DESCRIBE GATEWAY¶

Descreve as propriedades de um gateway.

DESCRIBE pode ser abreviado como DESC.

Consulte também:: CREATE GATEWAY, ALTER GATEWAY, DROP GATEWAY, SHOW GATEWAYS

Sintaxe¶

DESC[RIBE] GATEWAY <name>

Copy

Parâmetros¶

name

Especifica o identificador do gateway a ser descrito.

Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

Para obter mais informações, consulte Requisitos para identificadores.

Saída¶

A saída do comando fornece as propriedades e os metadados do gateway nas seguintes colunas:

Coluna	Descrição
`name`	Nome do gateway.
`ingress_url`	URL de entrada do gateway.
`privatelink_ingress_url`	URL de entrada do PrivateLink.
`database_name`	Banco de dados em que o gateway é criado.
`schema_name`	Esquema em que o gateway é criado.
`owner`	Função proprietária do gateway.
`owner_role_type`	O tipo de função que possui o objeto, seja ROLE ou DATABASE_ROLE.
`spec`	Especificação do gateway (formato YAML). Esta coluna só é mostrada se a função que executa o comando tiver o privilégio USAGE, MODIFY ou OWNERSHIP no gateway.
`created_on`	Carimbo de data/hora da criação do gateway.
`updated_on`	Carimbo de data/hora de quando o gateway foi atualizado pela última vez.
`comment`	Comentário relacionado ao gateway.

Nota

Se a função utilizada tiver o privilégio USAGE, MODIFY ou OWNERSHIP no gateway, a coluna spec será exibida. Caso contrário, as outras colunas serão exibidas, mas não a coluna spec.

Requisitos de controle de acesso¶

A função usada para executar essa operação deve ter, no mínimo, os seguintes privilégios:

Privilégio	Objeto	Notas
USAGE, MODIFY ou OWNERSHIP	Gateway	Qualquer um desses privilégios permite descrever o gateway. Somente funções com esses privilégios podem visualizar a especificação.
USAGE	Banco de dados	Necessário no banco de dados que contém o gateway.
USAGE	Esquema	Necessário no esquema que contém o gateway.

Para instruções sobre como criar uma função personalizada com um conjunto específico de privilégios, consulte Criação de funções personalizadas.

Para informações gerais sobre concessões de funções e privilégios para executar ações de SQL em objetos protegíveis, consulte Visão geral do controle de acesso.

Notas de uso¶

Para pós-processar a saída deste comando, você pode usar o operador de canal (->>) ou a função RESULT_SCAN. Ambos os constructos tratam a saída como um conjunto de resultados que você pode consultar.

Por exemplo, é possível usar o operador de canal ou a função RESULT_SCAN para selecionar colunas específicas da saída do comando SHOW ou filtrar as linhas.

Quando você fizer referência a colunas de saída, use identificadores entre aspas duplas para os nomes das colunas. Por exemplo, para selecionar a coluna de saída type, especifique SELECT "type".

Você deve usar identificadores entre aspas duplas porque os nomes das colunas de saída para os comandos SHOW estão em minúsculas. As aspas duplas garantem que os nomes das colunas na lista SELECT ou na cláusula WHERE correspondam aos nomes das colunas na saída do comando SHOW que foi verificada.

Exemplos¶

O exemplo a seguir descreve o gateway chamado split_gateway:

DESCRIBE GATEWAY split_gateway;

Copy