DESCRIBE SERVICE

Snowpark Container Servicesサービス (ジョブサービスを含む)のプロパティについて説明します。このコマンドはサービスとジョブのように実行されるサービスの両方に使用します。

DESCRIBE は DESC に短縮できます。

こちらもご参照ください。

CREATE SERVICEALTER SERVICEDROP SERVICESHOW SERVICES

構文

DESC[RIBE] SERVICE <name>
Copy

パラメーター

name

説明するサービスの識別子を指定します。

識別子にスペースまたは特殊文字が含まれる場合は、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

詳細については、 識別子の要件 をご参照ください。

出力

コマンド出力では、次の列にサービスプロパティとメタデータが提供されます。

説明

name

Snowpark Container Servicesのサービス名。

status

サービスの現在のステータスを示す以下の値のいずれか:

  • PENDING

  • RUNNING

  • FAILED

  • DONE

  • SUSPENDING

  • SUSPENDED

  • DELETING

  • DELETED

  • INTERNAL_ERROR

database_name

サービスが作成されるデータベース。

schema_name

サービスが作成されるスキーマ。

owner

サービスを所有するロール。

compute_pool

Snowflakeがサービスを実行するコンピュートプール名。

spec

サービス仕様ファイル。コマンド実行時にサービスの所有者ロールを使用している場合のみ、出力にこの列が含まれます。

dns_name

次の形式のサービスのSnowflakeが割り当てた DNS 名: service-name.unique-id.svc.spcs.internal

unique-id は4~8文字の英数字で、データベース・スキーマの特定のインスタンスに固有の識別子です。スキーマの一意な ID を見つけるには、 SYSTEM$GET_SERVICE_DNS_DOMAIN 関数を呼び出します。例:

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

次の点に注意してください。

  • スキーマの名前を変更しても、識別子は変更されません。

  • 同じ名前のスキーマをドロップして再作成すると、識別子は変更されます。

DNS 名はサービス間通信を可能にします(チュートリアル3 をご参照ください)。

current_instances

サービスの現在のインスタンス数。

target_instances

Snowflakeが判断した、実行する必要のあるサービスインスタンスの目標数。

current_instances 値が target_instances 値と等しくない場合、Snowflakeはシャットダウン、またはサービスインスタンス起動の処理中です。

例:

  • MIN_INSTANCES = 1、 MAX_INSTANCES = 3のサービスを作成したとします。サービスが実行されている間、Snowflakeは1つのインスタンスでは不十分だと判断する可能性があります。この場合、 target_instances 値が増加し、Snowflakeが追加のインスタンスを起動中であることを示します。

    また、 target_instances 値が current_instances 値より小さい可能性もあります。これは、Snowflakeが実行中のインスタンス数を削減中であることを示しています。

  • サービスを作成しても、コンピュートプールに要求した最小インスタンス数のキャパシティがない場合、 target_instances の値は、 min_instances の値と等しくなります。current_instances 値は target_instances 値よりも小さくなります。

min_ready_instances

Snowflakeがサービスをリクエスト処理準備完了とみなすために必要な、サービスインスタンスの最小数を示します。

min_instances

Snowflakeが実行する必要があるサービスインスタンスの最小数。

max_instances

Snowflakeが必要に応じてスケールできるサービスインスタンスの最大数。

auto_resume

trueの場合で、サービス関数が呼び出されたとき、または受信リクエスト(ingres)を受信したとき(サービスの使用 を参照)にサービスが一時停止している場合、Snowflakeはサービスを自動再開します。

external_access_integrations

サービスに関連する外部アクセス統合のリスト。詳細については、 ネットワークエグレスの構成 をご参照ください。

created_on

サービスが作成されたタイムスタンプ。

updated_on

サービスが最後に更新されたタイムスタンプ。

resumed_on

サービスが最後に再開されたタイムスタンプ。

suspended_on

サービスが最後に一時停止された時のタイムスタンプ。suspended_on はSnowflakeがサービスを一時停止した時に設定され、サービスが再開された後も変更されません。suspended_on が NULL の場合、サービスは一時停止されていません。

auto_suspend_secs

Snowflakeが自動的にサービスを一時停止するまでの非アクティブの秒数。auto_suspend_secs が0に設定されているか、設定されていない場合、Snowflakeはサービスを自動的に中断しません。

comment

サービスに関するコメント

owner_role_type

オブジェクトを所有するロールの型(ROLE または DATABASE_ROLE)。

query_warehouse

サービスコンテナがクエリを実行するためにSnowflakeに接続し、使用するウェアハウスを明示的に指定しなかった場合、Snowflakeはデフォルトとしてこのウェアハウスを使用します。

is_job

サービスがジョブサービスの場合は true。それ以外の場合は false

is_async_job

true の場合、ジョブサービスは非同期で実行されています。デフォルトでは、Snowflakeはジョブサービスを同期的に実行します。この列は、 DESC SERVICE、 SHOW SERVICES、 SHOW JOB SERVICES コマンドの出力に含まれますが、 SHOW SERVICES EXCLUDING JOBS コマンドの出力には含まれません。

spec_digest

サービス仕様のコンテンツを表す一意で不変の識別子。

spec_digest 列の値の経時的変化を観察するために、サービスユーザーは定期的に SHOW SERVICES コマンドを実行する場合があります。サービスユーザーは、数値の変化があればサービスがアップグレードされたと推測できます。

is_upgrading

Snowflakeがサービスのアップグレード中である場合は TRUE。

managing_object_domain

管理オブジェクトのドメイン(例: サービスを管理するノートブックのドメイン)。サービスがSnowflakeエンティティによって管理されていない場合は NULL。

managing_object_name

管理オブジェクトの名前(例えば、サービスを管理するノートブックの名前)。サービスがSnowflakeエンティティによって管理されていない場合は NULL。

アクセス制御の要件

この操作の実行に使用される ロール には、少なくとも次の 権限 が必要です。

権限

オブジェクト

注意

Any one of these privileges: OWNERSHIP, USAGE, MONITOR or OPERATE

サービス

スキーマ内のオブジェクトに対して操作を実行するには、親データベースとスキーマに対する USAGE 権限が必要です。スキーマに対する 任意の権限を付与されたロールは、そのロールがスキーマを解決できることに注意してください。たとえば、スキーマに対するCREATE権限を付与されたロールは、そのスキーマにオブジェクトを作成できますが、そのスキーマに対するUSAGE*も*付与されている必要はありません。

指定された権限のセットを使用してカスタムロールを作成する手順については、 カスタムロールの作成 をご参照ください。

セキュリティ保護可能なオブジェクト に対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。

使用上の注意

  • このコマンドの出力を後処理するには、 パイプ演算子->>)または RESULT_SCAN 関数。どちらのコンストラクトも、出力を クエリできる結果セットとして扱います。

    For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.

    When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column type, specify SELECT "type".

    You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.

次の例は、 my_service_with_ebs_volume という名前のサービスについて説明しています。

DESCRIBE SERVICE echo_service;
Copy
+--------------+---------+---------------+-------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-------------------+------------------+---------------------+---------------+---------------+-------------+------------------------------+-------------------------------+-------------------------------+------------+--------------+-------------------+---------+-----------------+-----------------+--------+--------------+------------------------------------------------------------------+--------------+------------------------+----------------------+
| name         | status  | database_name | schema_name | owner     | compute_pool          | spec                                                                                                                                                         | dns_name                            | current_instances | target_instances | min_ready_instances | min_instances | max_instances | auto_resume | external_access_integrations | created_on                    | updated_on                    | resumed_on | suspended_on | auto_suspend_secs | comment | owner_role_type | query_warehouse | is_job | is_async_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.k3m6.svc.spcs.internal |                 1 |                1 |                   1 |             1 |             1 | true        | NULL                         | 2024-11-29 12:12:47.310 -0800 | 2024-11-29 12:12:48.843 -0800 | NULL       | NULL         |                 0 | NULL    | ROLE            | NULL            | false  | false        | edaf548eb0c2744a87426529b53aac75756d0ea1c0ba5edb3cbb4295a381f2b4 | false        | NULL                   | NULL                 |
|              |         |               |             |           |                       | spec:                                                                                                                                                        |                                     |                   |                  |                     |               |               |             |                              |                               |                               |            |              |                   |         |                 |                 |        |              |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |   containers:                                                                                                                                                |                                     |                   |                  |                     |               |               |             |                              |                               |                               |            |              |                   |         |                 |                 |        |              |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |   - name: "echo"                                                                                                                                             |                                     |                   |                  |                     |               |               |             |                              |                               |                               |            |              |                   |         |                 |                 |        |              |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     image: "sfengineering-prod1-snowservices-test2.registry.snowflakecomputing.com/tutorial_db/data_schema/tutorial_repository/my_echo_service_image:latest" |                                     |                   |                  |                     |               |               |             |                              |                               |                               |            |              |                   |         |                 |                 |        |              |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     sha256: "@sha256:d04a2d7b7d9bd607df994926e3cc672edcb541474e4888a01703e8bb0dd3f173"                                                                       |                                     |                   |                  |                     |               |               |             |                              |                               |                               |            |              |                   |         |                 |                 |        |              |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     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                                                                                                                                             |                                     |                   |                  |                     |               |               |             |                              |                               |                               |            |              |                   |         |                 |                 |        |              |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |                                                                                                                                                              |                                     |                   |                  |                     |               |               |             |                              |                               |                               |            |              |                   |         |                 |                 |        |              |                                                                  |              |                        |                      |
+--------------+---------+---------------+-------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-------------------+------------------+---------------------+---------------+---------------+-------------+------------------------------+-------------------------------+-------------------------------+------------+--------------+-------------------+---------+-----------------+-----------------+--------+--------------+------------------------------------------------------------------+--------------+------------------------+----------------------+