CREATE CONNECTION

適用対象:チェックマーク はい Databricks SQL チェック はい Databricks ランタイム 13.3 LTS 以上 チェック はい Unity カタログのみ

このコマンドによって、リモート システムの場所と認証の詳細を提供するシステム固有のオプションを使用して、特定の種類のリモート データ システムを表す外部接続 (またはサーバー) が作成されます。

外部接続により、フェデレーション クエリが有効になります。

Note

CREATE CONNECTION は Lakehouse Federation(フェデレーテッドクエリ)接続および HTTP 接続用です。 Lakeflow Connect でマネージド インジェスト パイプラインの接続を作成するには、 Connections REST API または Databricks CLI (databricks connections create) を使用します。 「デプロイ」を参照してください。

Important

パスワードやトークンなどの資格情報を保持する接続オプションを設定してセキュリティを維持する場合は、secret句にリテラル値を直接入力するのではなく、OPTIONS関数を使用して値を指定します。 これにより、ステートメントに資格情報の値を含めるのではなく、 Databricks シークレット サービス に格納されているシークレットを参照できます。 例を参照してください。

アクセス許可

接続を作成するには、メタストア管理者であるか、メタストアの CREATE CONNECTION 権限を持っている必要があります。 接続がサービス認証情報を参照している場合、そのサービス認証情報を所有しているか、 CREATE CONNECTION を持っている必要があります。 参照されたサービス認証情報は 、現在のワークスペースからもアクセス可能でなければなりません。

構文

CREATE CONNECTION [IF NOT EXISTS] connection_name
  TYPE connection_type
  OPTIONS ( option value [, ...] )
  [ COMMENT comment ]

標準コンプライアンスの場合は、SERVER の代わりに CONNECTION を使用することもできます。

パラメーター

  • connection_name

    Unity Catalog メタストア レベルでの接続の一意識別子。

  • connection_type

    接続の種類を識別し、次のうちの 1 つである必要があります。

    • DATABRICKS
    • HTTP 対象: Databricks SQL( チェックマーク 付き)[はい]Databricks Runtime 16.2 以上
    • MYSQL
    • POSTGRESQL
    • REDSHIFT
    • SNOWFLAKE
    • SQLDW (シナプス)
    • SQLSERVER
  • OPTIONS

    接続の確立に必要な connection_type 固有のパラメーターを設定します。

    • オプション

      プロパティ キー。 キーは、ドットで区切られた 1 つまたは複数の識別子、あるいは STRING リテラルで構成できます。

      プロパティ キーは一意である必要があり、大文字と小文字が区別されます。

    • value

      プロパティの値。 値は、BOOLEAN、STRING、INTEGER、またはDECIMAL定数式でなければなりません。

      パスワードやトークンなど、資格情報を保持するオプションの場合は、値を直接入力する代わりに、 secret 関数を使用します。 たとえば、リテラル パスワードを入力するのではなく、valueのpasswordをsecret('secrets.r.us', 'postgresPassword')として指定します。

接続タイプ別のオプション

各 connection_type は独自の OPTIONSを受け入れています。 以下の表は各タイプに必要なオプションを示しています。 TLSや代替認証モードなどのオプション設定や設定手順については、各データソースの接続ガイドをご覧ください。

接続の種類 必須オプション 接続ガイド
DATABRICKS host、httpPath、personalAccessToken Databricks-to-Databricks
HTTP host、bearer_token HTTPオプション
MYSQL host、port、user、password MySQL
POSTGRESQL host、port、user、password PostgreSQL
REDSHIFT host、port、user、password 赤方偏移
SNOWFLAKE host、port、sfWarehouse、user、password Snowflake
SQLDW host、port、user、password Azure Synapse
SQLSERVER host、port、user、password SQL Server

Note

一部の接続タイプは、異なるオプションを使用する追加の認証モードをサポートしています。 例えば、MySQLとPostgreSQLはAWSのIAM認証( aws_region と credential)をサポートし、SnowflakeはOAuth( client_id と client_secret)をサポートしています。 データソースについては接続ガイドをご覧ください。

HTTP オプション

対象: Databricks SQL( チェックマーク 付き)[はい]Databricks Runtime 16.2 以上

HTTP 接続の種類では、次のオプション キーと値がサポートされています。

  • host

    STRING リテラル。 外部サービスの host_name を指定します。 ホスト パスが正規化された URL でない場合は、例外がスローされます。

  • bearer_token

    外部サービス呼び出しを行うときに使用する認証トークン。 リテラルとしてではなくSTRING 関数を使用してトークンを指定します。 たとえば、値はリテラル トークンを入力するのではなく、 secret('secrets.r.us', 'httpPassword') で構成される場合があります。

  • port ポートを指定するオプションの INTEGER リテラル。 既定値は 443 です。

  • base_path

    STRING リテラル (省略可能)。 既定値は /です。 パスに空の文字列が含まれている場合、またはスペースまたは特殊文字を含む正しくないパスが含まれている場合は、例外がスローされます。

Examples

パスワードまたはトークンを直接入力するのではなく、次の例に示すように、 secret 関数を使用して資格情報を指定します。

-- Create a postgresql connection.
-- Provide the user and password using the secret function rather than
-- entering them directly.
> CREATE CONNECTION postgresql_connection
    TYPE POSTGRESQL
    OPTIONS (
       host '<hostname>',
       port '5432',
       user secret('secrets.r.us', 'postgresUser'),
       password secret('secrets.r.us', 'postgresPassword'));

-- Set up a connection to Slack.
-- Provide the bearer token using the secret function rather than a literal value.
> CREATE CONNECTION slack_conn
  TYPE HTTP
  OPTIONS (
    host 'https://slack.com',
    port '443',
    base_path '/api/',
    bearer_token secret('secrets.r.us', 'slackBearerToken')
  );

-- Request to the external service
> SELECT http_request(
    conn => 'slack_conn',
    method => 'POST',
    path => '/chat.postMessage',
    json => to_json(named_struct(
      'channel', channel,
      'text', text
    ))
    headers => map(
       'Accept', "application/vnd.github+json",
    )
  );