ノートブックの作成と実行
ノートブックを使用すると、1 つのドキュメント内で複数の SQL クエリを編成、注釈付け、共有できます。ノートブックには、複数の SQL クエリセルと Markdown セルを追加できます。ノートブックは、複数のクエリセルと Markdown セルを使用して、データ分析に関連するクエリと説明を 1 つのドキュメントにグループ化する方法を提供します。Markdown 構文を使用してテキストを追加し、外観の形式を設定して、データ分析タスクのコンテキストと追加情報を提供できます。ノートブックは、チームのメンバーと共有することが可能です。
ノートブックを使用するには、ノートブックの権限を IAM プリンシパル (IAM ユーザーまたは IAM ロール) に追加する必要があります。ベストプラクティスとして、アクセス許可ポリシーを IAM ロールにアタッチし、それを必要に応じてユーザーやグループに割り当てることをお勧めします。詳細については、「Amazon Redshift での Identity and Access Management」を参照してください。権限は、クエリエディタ v2 管理ポリシーのいずれかに追加できます。詳細については、「クエリエディタ v2 へのアクセス」を参照してください。
ノートブックのセルを順番にすべて実行できます。ノートブックの SQL クエリセルには、クエリエディタのタブとほとんど同じ機能があります。詳細については、「クエリの作成と実行」を参照してください。以下は、クエリエディタのタブとノートブックの SQL セルの違いです。
ノートブックには SQL ステートメントで
Explainを実行するコントロールはありません。ノートブックの SQL セルごとに 1 つのグラフのみを作成できます。
クエリエディタ v2 で作成したファイルにノートブックをエクスポートおよびインポートできます。ファイル拡張子は .ipynb で、ファイルサイズは最大 5 MBです。SQL セルと Markdown セルはファイルに保存されます。クラスターまたはワークグループとデータベースは、エクスポートされたノートブックに保存されません。インポートしたノートブックを開くと、クラスターまたはワークグループ、およびそれを実行するデータベースを選択したことになります。SQL セルを実行したら、[Results] (結果) タブで現在の結果ページをグラフとして表示するかどうかを選択できます。クエリの結果セットは、ノートブックには保存されません。
[すべてを実行] または [実行する] を使用してノートブックを実行すると、[実行ステータス] が表示されます。
アイコンをクリックしてパネルを開きます。このパネルには、ノートブック内の最新の [すべてを実行] または [実行する] の SQL セルのステータスの概要が表示されます。複数の SQL セルを実行する場合、ステータス、経過時間、実行に関する詳細が一目で確認できます。表示されるセルを、All、Succeeded、Error、In progress、または Canceled のステータスでフィルタリングできます。このパネルを使用して、エディタ内の SQL セルに移動することもできます。
ノートブックを作成するには
ナビゲーターメニューから、
[Editor] (エディタ) を選択します。
を選択した後、[Notebook] (ノートブック) をクリックします。デフォルトでは、ノートブックに SQL クエリセルが表示されます。
SQL クエリセルで、以下のいずれかの操作を行います。
クエリを入力します。
コピーしたクエリを貼り付けます。
(オプション)
アイコンを選択し、次に [Markdown] (マークダウン) をクリックして、標準の Markdown 構文を使用して説明または解説のためのテキストの提供が可能な Markdown セルを追加します。(オプション)
アイコン、[SQL] の順に選択し、SQL セルを挿入します。
ノートブックの名前は
(鉛筆) アイコンで変更できます。
(詳細) メニューから、ノートブックで次のオペレーションを実行することもできます。
[Share with my team] (チームと共有) — タグで定義されているとおりにノートブックをチームと共有します。詳細については、「クエリの共有」を参照してください。
[Export] (エクスポート) — ノートブックを .ipynb拡張子の付いたローカルファイルにエクスポートします。
[Save version] (バージョンを保存) — ノートブックのバージョンを作成します。ノートブックのバージョンを確認するには、保存したノートブックに移動して [Version history] (バージョン履歴) を開きます。
[Duplicate] (複製) — ノートブックのコピーを作成し、新しいノートブックタブで開きます。
[Shortcuts] (ショートカット) — ノートブックの作成時に使用できるショートカットを表示します。
保存されたノートブックを開くには
ナビゲータメニューから、
[Notebooks] (ノートブック) を選択します。保存したノートブックとノートブックフォルダが表示されます。開きたいノートブックを選択し、それをダブルクリックします。
[ノートブック] タブには、[My notebooks] (マイノートブック)、[Shared by me] (自分が共有した) ノートブック、[Shared to my team] (チームで共有した) ノートブックを表示できます。
ローカルファイルから [My Notebooks] (マイノートブック) にノートブックをインポートするには
[Import] (インポート) を選択し、ノートブックを含む .ipynb ファイルに移動します。ノートブックは、現在開いているノートブックフォルダにインポートされます。これで、ノートブックエディタを使用してノートブックを開くことができます。
ノートブックのコンテキストメニュー (右クリック) から、次のオペレーションを実行できます。
Open notebook (ノートブックを開く) — ノートブックをエディタで開きます。
Save version (バージョンを保存) — ノートブックのバージョンを保存します。
Version history (バージョン履歴) — ノートブックのバージョンを表示します。[Version history] (バージョン履歴) ウィンドウから、バージョンを削除および元に戻すことができます。現在選択されているバージョンからノートブックを作成することもできます。
[Edit tags] (タグを編集) — ノートブックのタグを作成および編集します。
[Share with my team] (チームと共有) — チームとノートブックを共有します。
ノートブックをチームと共有するには、プリンシパルタグ
sqlworkbench-teamをアカウントの残りのチームメンバーと同じ値に設定します。たとえば、管理者はaccounting-teamの値を会計部門のすべての人のために設定します。例については、「クエリエディタv2 を使用するために必要なアクセス許可 」を参照してください。[Export] (エクスポート) — ノートブックをローカルファイルにエクスポートします。
[Rename] (名前を変更) — ノートブックの名前を変更します。
[Duplicate] (複製) — ノートブックのコピーを作成します。
[Delete] (削除) — ノートブックを削除します。
ノートブックのデモについては、次の動画をご覧ください。
