CREATE NOTEBOOK

新しい Snowflake Notebook を作成するか、既存のノートブックを置き換えます。

構文

CREATE [ OR REPLACE ] NOTEBOOK [ IF NOT EXISTS ] <name>
  [ VERSION '<version_alias_name>' ]
  [ FROM '<source_location>' ]
  [ MAIN_FILE = '<main_file_name>' ]
  [ COMMENT = '<string_literal>' ]
  [ DEFAULT_VERSION = '<version_name>' ]
  [ QUERY_WAREHOUSE = <warehouse_to_run_nb_and_sql_queries_in> ]
  [ IDLE_AUTO_SHUTDOWN_TIME_SECONDS = <number_of_seconds> ]
Copy

必須パラメーター

name

ノートブックの識別子（つまり、名前）を指定する文字列。ノートブックが作成されるスキーマに対して一意にする必要があります。

また、識別子はアルファベット文字で始まる必要があり、識別子文字列全体が二重引用符で囲まれていない限り、スペースや特殊文字を含めることはできません（例: "My object"）。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

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

オプションのパラメーター

VERSION 'version_alias_name'

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

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

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

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

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

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

  • 1.0.0

  • prod-1.1.0

FROM 'source_location

コピーするファイルのある場所。これはSnowflakeステージの場所である必要があります。

指定された場合は、コピーされたファイルに基づいてノートブックオブジェクトが作成されます。指定されない場合は、ノートブックオブジェクトはテンプレートノートブックから作成されます。

指定する場合は、 MAIN_FILE パラメーターにコピーするファイル名を設定する必要があります。このファイルは、 ipynb ファイルにする必要があります。

MAIN_FILE = 'main_file_name'

ノートブックファイル名のユーザー指定識別子。これは、 name パラメーターで指定されるノートブックオブジェクト名とは別のものです。このファイルは、 ipynb ファイルにする必要があります。

COMMENT = 'string_literal'

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

デフォルト: 値なし

DEFAULT_VERSION = 'version_name'

ノートブックのデフォルトバージョン（EXECUTE NOTEBOOK で呼び出されるバージョン）を設定します。バージョン名は 識別子 です。

デフォルト: LAST

QUERY_WAREHOUSE = warehouse_name

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

IDLE_AUTO_SHUTDOWN_TIME_SECONDS = number_of_seconds

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

デフォルト: 3600秒

アクセス制御の要件

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

権限

オブジェクト

USAGE

データベース

USAGE または OWNERSHIP

スキーマ

CREATE NOTEBOOK

スキーマ

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

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

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

使用上の注意

  • メタデータについて:

    注意

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

  • CREATE OR REPLACE <オブジェクト> ステートメントはアトミックです。つまり、オブジェクトが置き換えられると、単一のトランザクションで、古いオブジェクトが削除されて新しいオブジェクトが作成されます。

例

以下は、 mynotebook という名前のノートブックを作成します。

CREATE NOTEBOOK mynotebook;
Copy

QUERY_WAREHOUSE パラメーターはオプションですが、新しいノートブックを作成するときに指定しておくと、 EXECUTE NOTEBOOK をノートブック上で実行することができるためお勧めします。

CREATE NOTEBOOK mynotebook
 QUERY_WAREHOUSE = my_warehouse;
Copy

次の例では、ステージングされた ipynb ファイルからノートブックを作成しています。

CREATE NOTEBOOK mynotebook
 FROM '@my_db.my_schema.my_stage'
 MAIN_FILE = 'my_notebook_file.ipynb'
 QUERY_WAREHOUSE = my_warehouse;
Copy
言語: 日本語