DESCRIBE SERVICE

Descreve as propriedades de um serviço Snowpark Container Services (incluindo serviços de trabalho). Use este comando para um serviço e um serviço executado como um trabalho.

DESCRIBE pode ser abreviado como DESC.

Consulte também:

CREATE SERVICE , ALTER SERVICE, DROP SERVICE , SHOW SERVICES

Sintaxe

DESC[RIBE] SERVICE <name>
Copy

Parâmetros

name

Especifica o identificador do serviço 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 propriedades de serviço e metadados nas seguintes colunas:

Coluna

Descrição

name

Nome do serviço Snowpark Container Services.

status

Um dos seguintes valores, que indica o status atual do serviço:

  • PENDING

  • RUNNING

  • FAILED

  • DONE

  • SUSPENDING

  • SUSPENDED

  • DELETING

  • DELETED

  • INTERNAL_ERROR

database_name

Banco de dados no qual o serviço é criado.

schema_name

Esquema no qual o serviço é criado.

owner

Função proprietária do serviço.

compute_pool

Nome do pool de computação onde o Snowflake executa o serviço.

spec

Arquivo de especificação de serviço. A saída incluirá esta coluna somente se você estiver usando a função de proprietário do serviço ao executar o comando.

dns_name

Nome do serviço DNS atribuído pelo Snowflake neste formato: service-name.unique-id.svc.spcs.internal.

O unique-id é um identificador alfanumérico de 4 a 8 caracteres exclusivo para uma instância específica de um esquema de banco de dados. Para encontrar o ID único para um esquema, chame a função SYSTEM$GET_SERVICE_DNS_DOMAIN. Por exemplo:

SELECT SYSTEM$GET_SERVICE_DNS_DOMAIN('mydb.myschema');
Copy

Observe o seguinte:

  • Se você renomear um esquema, o identificador permanecerá inalterado.

  • Se você descartar e recriar um esquema com o mesmo nome, o identificador será alterado.

O nome DNS permite comunicações entre serviços (consulte o Tutorial 3).

current_instances

O número atual de instâncias do serviço.

target_instances

O número de destino de instâncias de serviço que devem estar em execução, conforme determinado pelo Snowflake.

Quando o valor de current_instances não é igual ao valor de target_instances, o Snowflake está no processo de encerramento ou inicialização de instâncias de serviço.

Por exemplo,

  • Suponha que você crie um serviço com MIN_INSTANCES = 1 e MAX_INSTANCES = 3. Enquanto o serviço estiver em execução, o Snowflake pode determinar que uma instância não é suficiente. Nesse caso, o valor de target_instances aumentará, indicando que o Snowflake está no processo de iniciar instâncias adicionais.

    Também é possível que o valor de target_instances seja menor que o valor de current_instances, o que indica que o Snowflake está no processo de reduzir o número de instâncias em execução.

  • Se você criar serviços, mas o pool de computação não tiver capacidade para o número mínimo de instâncias solicitado, o valor de target_instances será igual ao valor de min_instances. O valor de current_instances será menor que o valor de target_instances.

min_instances

Número mínimo de instâncias de serviço que o Snowflake deve executar.

max_instances

Número máximo de instâncias de serviço que o Snowflake pode dimensionar quando necessário.

auto_resume

Se for verdadeiro, o Snowflake retoma automaticamente o serviço, se suspenso, quando a função de serviço é chamada ou quando uma solicitação de entrada (ingresso) é recebida (consulte Como usar um serviço).

external_access_integrations

Lista de integrações de acesso externo associadas ao serviço. Para obter mais informações, consulte Saída de rede.

created_on

Carimbo de data/hora em que o serviço foi criado.

updated_on

Carimbo de data/hora quando o serviço foi atualizado pela última vez.

resumed_on

Carimbo de data/hora em que o serviço foi retomado pela última vez.

comment

Comentário relacionado ao serviço.

owner_role_type

O tipo de função que possui o objeto, seja ROLE ou DATABASE_ROLE.

query_warehouse

Quando um contêiner de serviço se conecta ao Snowflake para executar uma consulta e não especifica explicitamente um warehouse para usar, o Snowflake usa esse warehouse como padrão.

is_job

true se o serviço for um serviço de trabalho; caso contrário, false.

spec_digest

O identificador único e imutável que representa o conteúdo da especificação do serviço.

Para observar as alterações no valor da coluna spec_digest ao longo do tempo, um usuário do serviço pode executar o comando SHOW SERVICES periodicamente. Se o usuário do serviço notar uma mudança no valor, ele pode inferir que o serviço foi atualizado.

is_upgrading

TRUE, se a Snowflake estiver no processo de atualização do serviço.

managing_object_domain

O domínio do objeto de gerenciamento (por exemplo, o domínio do notebook que gerencia o serviço). NULL, se o serviço não for gerenciado por uma entidade Snowflake.

managing_object_name

O nome do objeto de gerenciamento (por exemplo, o nome do notebook que gerencia o serviço). NULL, se o serviço não for gerenciado por uma entidade Snowflake.

Requisitos de controle de acesso

Uma função usada para executar este comando SQL deve ter os seguintes privilégios no mínimo:

Privilégio

Objeto

Notas

MONITOR

Serviço

Observe que operar em qualquer objeto de um esquema também requer o privilégio USAGE no banco de dados e esquema principais.

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 a função RESULT_SCAN, que trata a saída como uma tabela que pode ser consultada.

Exemplos

O exemplo a seguir descreve o serviço chamado my_service_with_ebs_volume:

DESCRIBE SERVICE my_service_with_ebs_volume;
Copy
+--------------+---------+---------------+-------------+-----------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-------------------+------------------+---------------+---------------+-------------+------------------------------+-------------------------------+-------------------------------+------------+---------+-----------------+-----------------+--------+------------------------------------------------------------------+--------------+------------------------+----------------------+
| name         | status  | database_name | schema_name | owner     | compute_pool          | spec                                                                                                                                                            | dns_name                            | current_instances | target_instances | min_instances | max_instances | auto_resume | external_access_integrations | created_on                    | updated_on                    | resumed_on | comment | owner_role_type | query_warehouse | is_job | spec_digest                                                      | is_upgrading | managing_object_domain | managing_object_name |
|--------------+---------+---------------+-------------+-----------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-------------------+------------------+---------------+---------------+-------------+------------------------------+-------------------------------+-------------------------------+------------+---------+-----------------+-----------------+--------+------------------------------------------------------------------+--------------+------------------------+----------------------|
| ECHO_SERVICE | RUNNING | TUTORIAL_DB   | DATA_SCHEMA | TEST_ROLE | TUTORIAL_COMPUTE_POOL | ---                                                                                                                                                             | echo-service.fsvv.svc.spcs.internal |                 1 |                1 |             1 |             1 | true        | NULL                         | 2024-08-16 19:05:45.537 -0700 | 2024-08-16 19:05:46.354 -0700 | NULL       | NULL    | ROLE            | NULL            | false  | 58447f146a9591df5a69668f73ea35be9aa1b2829ace05d1c97c6f999246ac31 | false        | NULL                   | NULL                 |
|              |         |               |             |           |                       | spec:                                                                                                                                                           |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |   containers:                                                                                                                                                   |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |   - name: "echo"                                                                                                                                                |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     image: "preprod8-spcsdocs1.awsuswest2preprod8.registry-dev.snowflakecomputing.com/tutorial_db/data_schema/tutorial_repository/my_echo_service_image:latest" |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     sha256: "@sha256:e79089e8862f9b90d9114857a38c6954db4701a973e931277900617fcbecd099"                                                                          |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     env:                                                                                                                                                        |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       SERVER_PORT: "8000"                                                                                                                                       |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       CHARACTER_NAME: "Bob"                                                                                                                                     |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     readinessProbe:                                                                                                                                             |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       port: 8000                                                                                                                                                |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       path: "/healthcheck"                                                                                                                                      |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     resources:                                                                                                                                                  |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       limits:                                                                                                                                                   |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |         memory: "6Gi"                                                                                                                                           |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |         cpu: "1"                                                                                                                                                |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       requests:                                                                                                                                                 |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |         memory: "0.5Gi"                                                                                                                                         |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |         cpu: "0.5"                                                                                                                                              |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |   endpoints:                                                                                                                                                    |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |   - name: "echoendpoint"                                                                                                                                        |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     port: 8000                                                                                                                                                  |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     public: true                                                                                                                                                |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |                                                                                                                                                                 |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
+--------------+---------+---------------+-------------+-----------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-------------------+------------------+---------------+---------------+-------------+------------------------------+-------------------------------+-------------------------------+------------+---------+-----------------+-----------------+--------+------------------------------------------------------------------+--------------+------------------------+----------------------+