接続を更新

バージョン 4.0.23.4

指定した構成を使用して接続を更新します。

リクエスト

PATCH /connections/{connection_name}
Datatype
説明
リクエスト
HTTPRequest
パス
HTTPPath
HTTPPath 定義を展開...
connection_name
文字列
接続の名前
body
HTTPBody
HTTPBody 定義を展開...
body
接続
DBConnection の定義を展開...
データ プロダクト
オブジェクト
現在のユーザーがこのオブジェクトに対して実行できるオペレーション
name
文字列
接続の名前。一意の識別子としても使用されます
言語
（読み取り専用）SQL 言語の詳細
snippets
pdts_enabled
ブール値
この接続で PDT が有効な場合は true
ホスト
文字列
サーバーのホスト名またはアドレス SSH トンネル経由の接続の場合は文字列「localhost」。
ポート
文字列
サーバーのポート番号。接続が SSH トンネル経由で行われる場合、SSH トンネルに関連付けられたローカルポート。
ユーザー名
文字列
サーバー認証用のユーザー名
パスワード
文字列
（書き込みのみ）サーバー認証のパスワード
uses_oauth
ブール値
接続が認証に OAuth を使用するかどうか。
証明書
文字列
（書き込みのみ）サーバー認証用の Base64 エンコードの証明書本文（言語に適した場合）。
file_type
文字列
（書き込みのみ）証明書のキーファイル形式 - .json または .p12
database
文字列
データベース名
db_timezone
文字列
データベースのタイムゾーン
query_timezone
文字列
クエリで使用するタイムゾーン
schema
文字列
スキーム名
max_connections
整数
使用する同時接続の最大数
max_billing_gigabytes
文字列
クエリの最大サイズ（GB 単位、BigQuery のみ。user_attributes 名にできる）
ssl
ブール値
サーバーへの接続時に SSL/TLS を使用します
verify_ssl
ブール値
SSL を確認します
tmp_db_name
文字列
一時データベースの名前（使用する場合）
jdbc_additional_params
文字列
JDBC 接続文字列に追加するパラメータ
pool_timeout
整数
接続プールのタイムアウト（秒）
dialect_name
文字列
（読み取り/書き込み）SQL 言語名
supports_data_studio_link
ブール値
データベース接続には、データ探索からオープン データポータルをサポートする機能がある
created_at
文字列
この接続の作成日
user_id
文字列
この接続構成を最後に変更したユーザーの ID
例
ブール値
これは接続の一例ですか？
user_db_credentials
ブール値
（アクセス制限機能）データベース ユーザーごとの認証情報が有効になっています。有効にすると、以前に設定したユーザー名とパスワードが削除されます
user_attribute_fields
string[]
maintenance_cron
文字列
PDT トリガーのチェックやドロップなどのメンテナンスを実行するタイミングを指定する cron 文字列
last_regen_at
文字列
最後に完了した PDT トリガー チェック プロセスの開始時の UNIX タイムスタンプ
last_reap_at
文字列
最後に完了した PDT 除去プロセスの開始時の UNIX タイムスタンプ
sql_runner_precache_tables
ブール値
SQL Runner でテーブルをプリキャッシュする
sql_writing_with_info_schema
ブール値
SQL書き込み用のフェッチ情報スキーマ
after_connect_statements
文字列
データベースへの接続後に発行する SQL ステートメント（セミコロン区切り）。 「custom_after_connect_statements」ライセンス機能が必要
pdt_context_override
pdt メンテナンス コンテキストのこの接続の db_connection_override
マネージド
ブール値
この接続は Looker によって作成、管理されていますか？
custom_local_port
整数
このフィールドは、SSH トンネルを介した接続にのみ適用されます。手動で構成する場合、このフィールドの値は SSH トンネルに関連付けられたローカルポートになります。それ以外の場合は、NULL を入力するか、このフィールドを除外します。
tunnel_id
文字列
この接続が使用する SSH トンネルの ID
uses_tns
ブール値
Transparent Network Substrate（TNS）接続を有効にする
pdt_concurrency
整数
PDT を並列にビルドするために使用するスレッドの最大数
disable_context_comment
ブール値
disable_context_comment が true になっている場合、SQL にコメントは追加されません
oauth_application_id
文字列
データベースに対する認証に使用する外部 OAuth アプリケーション
always_retry_failed_builds
ブール値
true の場合、エラー PDT が再生成ツールのすべてのサイクルで再試行されます。
cost_estimate_enabled
ブール値
true の場合、クエリ費用の見積もりが Explore に表示されます。
pdt_api_control_enabled
ブール値
この接続において、PDT ビルドの開始とキャンセルを API 経由で行うことができます。

レスポンス

200: 接続

Datatype
説明
（オブジェクト）
データ プロダクト
オブジェクト
現在のユーザーがこのオブジェクトに対して実行できるオペレーション
name
文字列
接続の名前。一意の識別子としても使用されます
言語
（読み取り専用）SQL 言語の詳細
言語の定義を展開...
name
文字列
言語の名前
label
文字列
人が読める形式の接続のラベル
サポート費用の見積もり
ブール値
言語がクエリ費用の見積もりをサポートしているかどうか
cost_estimate_style
文字列
言語によるコスト見積もりの処理方法
persistent_table_indexes
文字列
PDT インデックス列
persistent_table_sortkeys
文字列
PDT 並べ替えキーの列
persistent_table_distkey
文字列
PDT の distkey 列
supports_streaming
ブール値
ストリーミング結果をサポート
automatically_run_sql_runner_snippets
ブール値
SQL Runner スニペットを自動的に実行するかどうか
connection_tests
string[]
supports_inducer
ブール値
インデューサでサポートされています（sql から生成されます）。
supports_multiple_databases
ブール値
この言語を使用して、接続から複数のデータベースにアクセスできますか
supports_persistent_derived_tables
ブール値
言語が Looker の永続的な派生テーブルの構築を許可するかどうか
has_ssl_support
ブール値
データベースに、JDBC 文字列によって明示的にクライアント SSL サポートが設定されていますか？
snippets
スニペットの定義を展開...
name
文字列
スニペットの名前
label
文字列
スニペットのラベル
sql
文字列
スニペットの SQL テキスト
pdts_enabled
ブール値
この接続で PDT が有効な場合は true
ホスト
文字列
サーバーのホスト名またはアドレス SSH トンネル経由の接続の場合は文字列「localhost」。
ポート
文字列
サーバーのポート番号。接続が SSH トンネル経由で行われる場合、SSH トンネルに関連付けられたローカルポート。
ユーザー名
文字列
サーバー認証用のユーザー名
パスワード
文字列
（書き込みのみ）サーバー認証のパスワード
uses_oauth
ブール値
接続が認証に OAuth を使用するかどうか。
証明書
文字列
（書き込みのみ）サーバー認証用の Base64 エンコードの証明書本文（言語に適した場合）。
file_type
文字列
（書き込みのみ）証明書のキーファイル形式 - .json または .p12
database
文字列
データベース名
db_timezone
文字列
データベースのタイムゾーン
query_timezone
文字列
クエリで使用するタイムゾーン
schema
文字列
スキーム名
max_connections
整数
使用する同時接続の最大数
max_billing_gigabytes
文字列
クエリの最大サイズ（GB 単位、BigQuery のみ。user_attributes 名にできる）
ssl
ブール値
サーバーへの接続時に SSL/TLS を使用します
verify_ssl
ブール値
SSL を確認します
tmp_db_name
文字列
一時データベースの名前（使用する場合）
jdbc_additional_params
文字列
JDBC 接続文字列に追加するパラメータ
pool_timeout
整数
接続プールのタイムアウト（秒）
dialect_name
文字列
（読み取り/書き込み）SQL 言語名
supports_data_studio_link
ブール値
データベース接続には、データ探索からオープン データポータルをサポートする機能がある
created_at
文字列
この接続の作成日
user_id
文字列
この接続構成を最後に変更したユーザーの ID
例
ブール値
これは接続の一例ですか？
user_db_credentials
ブール値
（アクセス制限機能）データベース ユーザーごとの認証情報が有効になっています。有効にすると、以前に設定したユーザー名とパスワードが削除されます
user_attribute_fields
string[]
maintenance_cron
文字列
PDT トリガーのチェックやドロップなどのメンテナンスを実行するタイミングを指定する cron 文字列
last_regen_at
文字列
最後に完了した PDT トリガー チェック プロセスの開始時の UNIX タイムスタンプ
last_reap_at
文字列
最後に完了した PDT 除去プロセスの開始時の UNIX タイムスタンプ
sql_runner_precache_tables
ブール値
SQL Runner でテーブルをプリキャッシュする
sql_writing_with_info_schema
ブール値
SQL書き込み用のフェッチ情報スキーマ
after_connect_statements
文字列
データベースへの接続後に発行する SQL ステートメント（セミコロン区切り）。 「custom_after_connect_statements」ライセンス機能が必要
pdt_context_override
pdt メンテナンス コンテキストのこの接続の db_connection_override
DBConnectionOverride の定義を展開...
context
文字列
オーバーライドするコンテキスト（「pdt」のみが許可値）
ホスト
文字列
サーバーのホスト名/アドレス
ポート
文字列
サーバーのポート番号
ユーザー名
文字列
サーバー認証用のユーザー名
パスワード
文字列
（書き込みのみ）サーバー認証のパスワード
has_password
ブール値
このコンテキストでパスワードがオーバーライドされるかどうか
証明書
文字列
（書き込みのみ）サーバー認証用の Base64 エンコードの証明書本文（言語に適した場合）。
file_type
文字列
（書き込みのみ）証明書のキーファイル形式 - .json または .p12
database
文字列
データベース名
schema
文字列
スキーム名
jdbc_additional_params
文字列
JDBC 接続文字列に追加するパラメータ
after_connect_statements
文字列
データベースへの接続後に発行する SQL ステートメント（セミコロン区切り）。 「custom_after_connect_statements」ライセンス機能が必要
マネージド
ブール値
この接続は Looker によって作成、管理されていますか？
custom_local_port
整数
このフィールドは、SSH トンネルを介した接続にのみ適用されます。手動で構成する場合、このフィールドの値は SSH トンネルに関連付けられたローカルポートになります。それ以外の場合は、NULL を入力するか、このフィールドを除外します。
tunnel_id
文字列
この接続が使用する SSH トンネルの ID
uses_tns
ブール値
Transparent Network Substrate（TNS）接続を有効にする
pdt_concurrency
整数
PDT を並列にビルドするために使用するスレッドの最大数
disable_context_comment
ブール値
disable_context_comment が true になっている場合、SQL にコメントは追加されません
oauth_application_id
文字列
データベースに対する認証に使用する外部 OAuth アプリケーション
always_retry_failed_builds
ブール値
true の場合、エラー PDT が再生成ツールのすべてのサイクルで再試行されます。
cost_estimate_enabled
ブール値
true の場合、クエリ費用の見積もりが Explore に表示されます。
pdt_api_control_enabled
ブール値
この接続において、PDT ビルドの開始とキャンセルを API 経由で行うことができます。

400: Bad Request

Datatype
説明
（オブジェクト）
クリックします。
文字列
エラーの詳細
documentation_url
文字列
ドキュメント リンク

404: 見つかりません

Datatype
説明
（オブジェクト）
クリックします。
文字列
エラーの詳細
documentation_url
文字列
ドキュメント リンク

422: 検証エラー

Datatype
説明
（オブジェクト）
クリックします。
文字列
エラーの詳細
エラー
ValidationErrorDetail 定義を展開...
フィールド
文字列
エラーのあるフィールド
コード
文字列
Error code（エラーコード）
クリックします。
文字列
エラー情報メッセージ
documentation_url
文字列
ドキュメント リンク
documentation_url
文字列
ドキュメント リンク

429: Too Many Requests

Datatype
説明
（オブジェクト）
クリックします。
文字列
エラーの詳細
documentation_url
文字列
ドキュメント リンク