メインコンテンツまでスキップ
に最終更新

connections コマンド グループ

注記

Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。

Databricks CLI内のconnectionsコマンドグループを使用すると、外部データソースへの接続を作成および管理できます。データソースと外部サービスに接続するを参照してください。

このコマンドグループは、2種類の接続をカバーします。

  • レイクハウスフェデレーション接続 : フェデレーテッドクエリー用の外部データベースへの接続。レイクハウスフェデレーションの接続を管理するを参照してください。
  • マネージドインジェスト接続 (Lakeflow Connect): マネージドインジェストパイプライン向けのSaaSアプリケーションおよびデータベースへの接続です。APIのみの認証を使用するコネクタでサポートされています。デプロイを参照してください。

databricks connections create​

外部データソースへの新しい接続を作成します。これにより、ユーザーは外部サーバーとの対話のための接続の詳細と構成を指定できます。

databricks connections create [flags]

オプション​

--comment string

ユーザー指定の自由形式のテキスト説明。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

--read-only

接続が読み取り専用の場合。

グローバルフラグ

例​

次の例では、コメントを使用して接続を作成します。

Bash
databricks connections create --comment "Connection to external database"

次の例では、読み取り専用接続を作成します。

Bash
databricks connections create --read-only

接続タイプと認証情報を指定するには、--json を使用してリクエストボディを渡します。JSONボディは、Connections REST APIと同じスキーマに従います。次の例では、PostgreSQL ソースへの管理対象の取り込み接続を作成します。

Bash
databricks connections create --json '{
  "name": "my-connection",
  "connection_type": "POSTGRESQL",
  "options": {
    "host": "postgresql-instance.example.com",
    "port": "5432",
    "user": "databricks_replication",
    "password": "your_secure_password"
  }
}'

databricks connections delete​

指定した名前に一致する接続を削除します。

databricks connections delete NAME [flags]

引数​

NAME

削除する接続の名前。

オプション​

グローバルフラグ

例​

次の例では、 my-connectionという名前の接続を削除します。

Bash
databricks connections delete my-connection

databricks connections get​

その名前から接続を取得します。

databricks connections get NAME [flags]

引数​

NAME

接続の名前。

オプション​

グローバルフラグ

例​

次の例では、 my-connectionという名前の接続に関する情報を取得します。

Bash
databricks connections get my-connection

databricks connections list​

すべての接続を一覧表示します。

databricks connections list [flags]

オプション​

--max-results int

返す接続の最大数。

--page-token string

前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。

グローバルフラグ

例​

次の例は、すべての接続をリストします。

Bash
databricks connections list

次の例は、最大 10 個の結果を持つ接続をリストします。

Bash
databricks connections list --max-results 10

databricks connections update​

指定した名前に一致する接続を更新します。

databricks connections update NAME [flags]

引数​

NAME

接続の名前。

オプション​

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

--new-name string

接続の新しい名前。

--owner string

接続の現在の所有者のユーザー名。

グローバルフラグ

例​

次の例では、接続の名前を変更します。

Bash
databricks connections update my-connection --new-name my-renamed-connection

次の例では、接続の所有者を変更します。

Bash
databricks connections update my-connection --owner someone@example.com

グローバルフラグ​

--debug

デバッグログを有効にするかどうか。

-h または --help

Databricks CLI、関連するコマンド グループ、または関連するコマンドのヘルプを表示します。

--log-file string

出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。

--log-format format

ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。

--log-level string

ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。

-o, --output タイプ

コマンド出力タイプ text または json。デフォルト値は textです。

-p, --profile string

コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。

--progress-format format

進行状況ログを表示する形式: default、 append、 inplace、 json

-t, --target string

該当する場合は、使用するバンドル・ターゲット

このページの見出し