SQL 拡張機能の JupyterLab SQL エディタ機能

SQL 拡張機能には、 JupyterLab ノートブックセル内の SQL エディタ機能を有効にするマジックコマンドが用意されています。

SageMaker ディストリビューションイメージバージョン 1.6 のユーザーの場合は、 JupyterLab ノートブック%load_ext amazon_sagemaker_sql_magicで を実行して SQL 拡張機能マジックライブラリをロードする必要があります。これにより、SQL 編集機能がオンになります。

SageMaker ディストリビューションイメージバージョン 1.7 以降のユーザーの場合、アクションは必要ありません。SQL 拡張機能は自動的にロードされます。

拡張機能がロードされたら、セルの先頭に %%sm_sql マジックコマンドを追加して、SQL エディタの次の機能をアクティブ化します。

• 接続選択ドロップダウン： セルに%%sm_sqlマジックコマンドを追加すると、セルの上部にドロップダウンメニューが表示され、使用可能なデータソース接続が表示されます。接続を選択すると、そのデータソースのクエリに必要なパラメータが自動的に入力されます。以下は、 という名前の接続を選択して生成された%%sm_sqlマジックコマンド文字列の例ですconnection-name。

  %%sm_sql --metastore-type GLUE_CONNECTION --metastore-id connection-name

  以下の SQL エディタの機能を使用して SQL クエリを構築し、セルを実行してクエリを実行します。SQL 実行機能の詳細については、「」を参照してくださいSQL 拡張機能の JupyterLab SQL 実行機能。

• クエリ結果ドロップダウン： 接続選択ドロップダウンメニューの横にあるドロップダウンメニューから結果タイプを選択して、クエリ結果のレンダリング方法を指定できます。次の 2 つの代替方法から選択します。

  • セル出力 : (デフォルト) このオプションは、ノートブックセル出力領域にクエリの結果を表示します。

  • Pandas Dataframe : このオプションは、pandas DataFrame にクエリ結果を入力します。このオプションを選択すると、追加の入力ボックス DataFrame で に名前を付けることができます。

• SQL 構文のハイライト: セルは、SQL キーワード、句、演算子などを色とスタイルで自動的に視覚的に区別します。これにより、SQL コードの読み取りと理解が容易になります。SELECT、、FROM、 などのキーワードWHERE、 SUMや などの組み込み関数COUNT、または GROUP BYや などの句は、異なる色と太字のスタイルで強調表示されます。

• SQL フォーマット : 次のいずれかの方法で、一貫したインデント、大文字、スペース、改行をグループ化または分離する SQL ステートメントと句に適用できます。これにより、SQL コードの読み取りと理解が容易になります。

  • SQL セルを右クリックし、SQL のフォーマット を選択します。

  • SQL セルがフォーカスされている場合は、Windows で ALT + F ショートカットを使用するか、MacOS で Option + F を使用します。

• SQL 自動補完 : 拡張機能では、入力時に SQL キーワード、関数、テーブル名、列名などの自動提案と完了が提供されます。SELECT や などの SQL キーワードの入力を開始するとWHERE、拡張機能に残りの単語を自動入力する提案を含むポップアップが表示されます。例えば、テーブル名または列名を入力する場合、データベーススキーマで定義されているテーブル名と列名を一致させることが推奨されます。

  重要

  JupyterLab ノートブックで SQL 自動補完を有効にするには、ディストリビューションイメージバージョン 1.6 の SageMakerユーザーがターミナルで次のnpm install -g vscode-jsonrpc sql-language-serverコマンドを実行する必要があります。インストールが完了したら、 を実行して JupyterLab サーバーを再起動しますrestart-jupyter-server。

  SageMaker ディストリビューションイメージバージョン 1.7 以降のユーザーの場合、アクションは必要ありません。

  セルには、認識された SQL キーワードを自動補完する 2 つの方法があります。

  • 明示的な呼び出し (推奨): Tab キーを選択してコンテキスト対応提案メニューを開始し、Enter を選択して提案した項目を受け入れます。

  • 継続的なヒント: 入力すると、セルは自動的に完了を提案します。

  注記

  • 自動補完は、SQL キーワードが大文字の場合にのみトリガーされます。例えば、 のSELプロンプトは入力selしますがSELECT、 は入力しません。

  • データソースに初めて接続すると、SQL 自動補完によってデータソースのメタデータにインデックスが付けられます。データベースのサイズによっては、このインデックス作成プロセスが完了するまでに時間がかかる場合があります。