ALTER NOTEBOOK

既存の ノートブック のプロパティを変更します。

構文

ALTER NOTEBOOK [ IF EXISTS ] <name> RENAME TO <new_name>

ALTER NOTEBOOK [ IF EXISTS ] <name> SET
  [ VERSION = '<version_alias_name>' ]
  [ COMMENT = '<string_literal>' ]
  [ DEFAULT_VERSION = '<default_version_name_or_alias>' ]
  [ QUERY_WAREHOUSE = <warehouse_to_run_nb_and_sql_queries_in> ]
  [ IDLE_AUTO_SHUTDOWN_TIME_SECONDS = <number_of_seconds> ]
  [ SECRETS = ('<secret_variable_name>' = <secret_name>) [ , ... ] ]

ALTER NOTEBOOK [ IF EXISTS ] <name> UNSET
  [ QUERY_WAREHOUSE ]
  [ COMMENT ]

ALTER NOTEBOOK <name> ADD LIVE VERSION
  [ FROM LAST ]
  [ COMMENT = '<string_literal>' ]

ALTER NOTEBOOK <name> COMMIT [ VERSION '<live_version_alias>' ] [ COMMENT = '<string_literal>' ]
Copy

パラメーター

name

変更するノートブックの識別子を指定します。

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

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

RENAME TO new_name

ノートブックの名前を new_name に変更します。新しい識別子は、スキーマに対して一意にする必要があります。

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

オプションでオブジェクトの名前を変更して、オブジェクトを別のデータベースやスキーマに移動できます。これを実行するには、新しいデータベース名やスキーマ名をそれぞれ db_name.schema_name.object_name または schema_name.object_name の形式で含む、修飾された new_name 値を指定します。

注釈

  • 宛先データベースやスキーマはすでに存在している必要があります。また、同じ名前のオブジェクトが宛先データベースにすでに存在することはできません。存在する場合、ステートメントはエラーを返します。

  • オブジェクトを管理アクセススキーマに移動することは、オブジェクトの所有者（つまり、オブジェクトに対して OWNERSHIP 権限を持つロール）がターゲットスキーマも所有している場合を 除き 禁止されています。

オブジェクトの名前を変更すると、そのオブジェクトを参照する他のオブジェクトも新しい名前で更新する必要があります。

SET ...

ノートブックの1つ以上の指定されたプロパティまたはパラメーターを設定します。

VERSION = 'version_alias_name'

ユーザー指定のバージョンエイリアス。自動生成されたバージョン名識別子と同じ名前空間を共有する 識別子。以下のルールに従う必要があります。

  • バージョンが作成されたノートブックに固有であること。

  • FIRST、 LAST、 LIVE、または DEFAULT に設定されていないこと。これらは予約済みキーワードです。

  • version$ で始まらないこと。自動生成されるバージョン名は version$ で始まります。

  • スラッシュを含まないこと。

以下は、有効なバージョンエイリアス名の例です。

  • 1.0.0

  • prod-1.1.0

COMMENT = 'string_literal'

ノートブックまたはノートブックのバージョンのコメントを設定します。

DEFAULT_VERSION = 'version_name'

ノートブックのデフォルトバージョンを設定します。バージョン名は 識別子 です。

デフォルト: LAST

QUERY_WAREHOUSE = warehouse_name

ノートブックの SQL クエリが実行されるウェアハウスを指定します。このパラメーターはオプションです。ただし、 EXECUTE NOTEBOOK コマンドを実行する必要があります。

IDLE_AUTO_SHUTDOWN_TIME_SECONDS = number_of_seconds

ノートブックが自動的にシャットダウンされるまでのアイドル時間の秒数。このパラメータは、コンテナー・ランタイム上で実行されるノートブックでのみ使用できます。値は60～259200（72時間）の整数でなければなりません。

デフォルト: 3600秒

SECRETS = '(secret_variable_name' = secret_name [ , ... ])

ノートブックのシークレット変数を設定します。

  • secret_variable_name を、シークレットから情報を取得する際にハンドラーコードで使用する変数にします。

  • secret_name - Snowflakeシークレットの名前。

UNSET ...

ノートブックの1つまたは複数の指定されたプロパティまたはパラメーターの設定を解除します。これにより、プロパティはデフォルトにリセットされます。

  • QUERY_WAREHOUSE

  • COMMENT

1つの ALTER ステートメントで複数のプロパティまたはパラメーターの設定を解除するには、各プロパティまたはパラメーターをコンマで区切ります。

プロパティまたはパラメーターの設定を解除する場合は、プロパティ名またはパラメーター名のみを指定します（上記の構文で値を指定するように指示されている場合を除く）。値を指定するとエラーが返されます。

ADD LIVE VERSION

LIVE バージョンをノートブックに追加します（EXECUTE NOTEBOOK で呼び出されるバージョン）。

FROM LAST

LIVE バージョンをノートブックの LAST バージョンに設定します。

COMMENT = 'string_literal''

ノートブックまたはノートブックのバージョンのコメントを設定します。

COMMIT

ノートブックに Git接続が設定されている場合は、 LIVE バージョンのノートブックをGitリポジトリにコミットします。

ノートブックにGitリポジトリが設定されていない場合にこのコマンドを実行すると、 LIVE バージョンが null に設定され、自動生成されたバージョンエイリアスが増分されます。

アクセス制御の要件

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

権限

オブジェクト

メモ

USAGE または OWNERSHIP

ノートブック

OWNERSHIP はオブジェクトの特別な権限で、オブジェクトを作成したロールに自動的に付与されます。

スキーマ内の任意のオブジェクトを操作するには、親データベースとスキーマに対する USAGE 権限も必要であることに注意してください。

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

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

使用上の注意

  • メタデータについて:

    注意

    Snowflakeサービスを使用する場合、お客様は、個人データ（ユーザーオブジェクト向け以外）、機密データ、輸出管理データ、またはその他の規制されたデータがメタデータとして入力されていないことを確認する必要があります。詳細については、 Snowflakeのメタデータフィールド をご参照ください。

例

次の例では、 my_notebook というノートブックの名前を notebook_v2 に変更しています。

ALTER NOTEBOOK my_notebook RENAME notebook_v2;
Copy

次の例では、 QUERY_WAREHOUSE プロパティの設定を解除しています。

ALTER NOTEBOOK my_notebook UNSET QUERY_WAREHOUSE;
Copy

次の例では、 my_notebook の現在の LAST バージョンを LIVE バージョンに設定しています。

ALTER notebook my_notebook ADD LIVE VERSION FROM LAST;
Copy

次の例では、 my_notebook の現在の LIVE バージョンをコミットしています。

ALTER NOTEBOOK my_notebook COMMIT;
Copy
言語: 日本語