更新连接

版本 4.0.23.2

使用指定配置更新连接。

请求

PATCH /connections/{connection_name}
数据类型
说明
请求
HTTP 请求
路径
HTTP 路径
展开 HTTPPath 定义...
connection_name
字符串
连接名称
body
HTTP 正文
展开 HTTPBody 定义...
body
连接
展开 DBConnection 定义...
可以
对象
当前用户可以对此对象执行的操作
name
字符串
连接的名称。也用作唯一标识符
方言
（只读）SQL 方言详情
snippets
pdts_enabled
布尔值
如果此连接上启用了 PDT，则为 true
主机
字符串
服务器的主机名/地址；如果是通过 SSH 隧道的连接，则为字符串“localhost”。
端口
字符串
服务器上的端口号。如果通过 SSH 隧道进行连接，则表示与 SSH 隧道关联的本地端口。
用户名
字符串
服务器身份验证用户名
密码
字符串
（只写）服务器身份验证密码
使用 OAuth
布尔值
连接是否使用 OAuth 进行身份验证。
证书
字符串
（只写）采用服务器身份验证的 Base64 编码证书正文（适合使用方言）。
文件类型
字符串
（只写）证书密钥文件类型 - .json 或 .p12
数据库
字符串
数据库名称
数据库时区
字符串
数据库的时区
query_timezone
字符串
要在查询中使用的时区
架构
字符串
架构名称
max_connections
整数
要使用的并发连接数上限
max_billing_gigabytes
字符串
查询的大小上限（以 GB 为单位，BigQuery 仅限 user_attribute 名称）
ssl
布尔值
连接到服务器时使用 SSL/TLS
验证_SSL
布尔值
验证 SSL
tmp_db_name
字符串
临时数据库的名称（如果使用）
jdbc_additional_params
字符串
要添加到 JDBC 连接字符串的其他参数
池超时
整数
连接池超时（秒）
方言名称
字符串
（读/写）SQL 方言名称
support_data_studio_link
布尔值
通过数据库连接，可以通过数据洞察探索开放式数据洞察
创建时间
字符串
此连接的创建日期
user_id
字符串
上次修改此连接配置的用户 ID
示例
布尔值
这是示例连接吗？
user_db_credentials
布尔值
（限制访问功能）是否启用基于用户数据库凭据。启用后，系统将移除之前设置的用户名和密码
user_attribute_fields
字符串 []
维护_cron
字符串
用于指定应在何时执行维护（例如 PDT 触发器检查和丢弃）的 Cron 字符串
上次更新日期
字符串
上次完成 PDT 触发器检查过程时的 Unix 时间戳
上次更新日期
字符串
上次完成 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 [隧道 ID]
字符串
此连接使用的 SSH 隧道的 ID
uses_tns
布尔值
启用透明网络底层 (TNS) 连接
pdt_concurrency
整数
用于并行构建 PDT 的线程数上限
停用上下文相关评论
布尔值
将 disable_context_comment 设为 true 时，不会将注释添加到 SQL 中
oauth_application_id
字符串
用于向数据库进行身份验证的外部 OAuth 应用
始终重试_失败_构建
布尔值
如果为 true，系统会在每次重新生成程序时重试错误 PDT
cost_estimate_enabled
布尔值
如果为 true，则探索费用将显示查询费用估算值。
pdt_api_control_enabled
布尔值
通过 API 可以启动和取消此连接上的 PDT 构建。

响应

200：连接

数据类型
说明
（对象）
可以
对象
当前用户可以对此对象执行的操作
name
字符串
连接的名称。也用作唯一标识符
方言
（只读）SQL 方言详情
展开方言定义...
name
字符串
方言的名称
标签
字符串
直观易懂的连接标签
support_cost_Estimated
布尔值
方言是否支持查询费用估算
费用估算样式
字符串
方言如何处理费用估算
持久表索引
字符串
PDT 索引列
Persistent_table_sortkeys
字符串
PDT 排序键列
Persistent_table_distkey
字符串
PDT distkey 列
support_streaming
布尔值
支持在线播放结果
automated_run_sql_runner_snippets
布尔值
是否应自动运行 SQL Runner 代码段
connection_tests
字符串 []
support_inducer
布尔值
使用触发器（即从 sql 生成）支持
support_Multiple_databases
布尔值
可以使用这种方言从连接访问多个数据库
support_Persistent_derived_tables
布尔值
方言是否支持允许 Looker 构建永久性派生表
has_ssl_support
布尔值
数据库是否明确支持通过 JDBC 字符串设置客户端 SSL 支持？
snippets
展开摘要定义...
name
字符串
摘要的名称
标签
字符串
代码段的标签
sql
字符串
代码段的 SQL 文本
pdts_enabled
布尔值
如果此连接上启用了 PDT，则为 true
主机
字符串
服务器的主机名/地址；如果是通过 SSH 隧道的连接，则为字符串“localhost”。
端口
字符串
服务器上的端口号。如果通过 SSH 隧道进行连接，则表示与 SSH 隧道关联的本地端口。
用户名
字符串
服务器身份验证用户名
密码
字符串
（只写）服务器身份验证密码
使用 OAuth
布尔值
连接是否使用 OAuth 进行身份验证。
证书
字符串
（只写）采用服务器身份验证的 Base64 编码证书正文（适合使用方言）。
文件类型
字符串
（只写）证书密钥文件类型 - .json 或 .p12
数据库
字符串
数据库名称
数据库时区
字符串
数据库的时区
query_timezone
字符串
要在查询中使用的时区
架构
字符串
架构名称
max_connections
整数
要使用的并发连接数上限
max_billing_gigabytes
字符串
查询的大小上限（以 GB 为单位，BigQuery 仅限 user_attribute 名称）
ssl
布尔值
连接到服务器时使用 SSL/TLS
验证_SSL
布尔值
验证 SSL
tmp_db_name
字符串
临时数据库的名称（如果使用）
jdbc_additional_params
字符串
要添加到 JDBC 连接字符串的其他参数
池超时
整数
连接池超时（秒）
方言名称
字符串
（读/写）SQL 方言名称
support_data_studio_link
布尔值
通过数据库连接，可以通过数据洞察探索开放式数据洞察
创建时间
字符串
此连接的创建日期
user_id
字符串
上次修改此连接配置的用户 ID
示例
布尔值
这是示例连接吗？
user_db_credentials
布尔值
（限制访问功能）是否启用基于用户数据库凭据。启用后，系统将移除之前设置的用户名和密码
user_attribute_fields
字符串 []
维护_cron
字符串
用于指定应在何时执行维护（例如 PDT 触发器检查和丢弃）的 Cron 字符串
上次更新日期
字符串
上次完成 PDT 触发器检查过程时的 Unix 时间戳
上次更新日期
字符串
上次完成 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”是唯一允许的值）
主机
字符串
服务器的主机名/地址
端口
字符串
服务器上的端口号
用户名
字符串
服务器身份验证用户名
密码
字符串
（只写）服务器身份验证密码
密码
布尔值
在这种情况下，密码是否会被替换
证书
字符串
（只写）采用服务器身份验证的 Base64 编码证书正文（适合使用方言）。
文件类型
字符串
（只写）证书密钥文件类型 - .json 或 .p12
数据库
字符串
数据库名称
架构
字符串
架构名称
jdbc_additional_params
字符串
要添加到 JDBC 连接字符串的其他参数
after_connect_statements
字符串
在连接到数据库后要发出的 SQL 语句（以英文分号分隔）。需要“custom_after_connect_statements”许可功能
受管理
布尔值
此连接是否由 Looker 创建和管理
custom_local_port
整数
此字段仅适用于通过 SSH 隧道的连接。如果手动配置，此字段的值将是与 SSH 隧道关联的本地端口。否则，请输入 NULL 或排除此字段。
tunnel_id [隧道 ID]
字符串
此连接使用的 SSH 隧道的 ID
uses_tns
布尔值
启用透明网络底层 (TNS) 连接
pdt_concurrency
整数
用于并行构建 PDT 的线程数上限
停用上下文相关评论
布尔值
将 disable_context_comment 设为 true 时，不会将注释添加到 SQL 中
oauth_application_id
字符串
用于向数据库进行身份验证的外部 OAuth 应用
始终重试_失败_构建
布尔值
如果为 true，系统会在每次重新生成程序时重试错误 PDT
cost_estimate_enabled
布尔值
如果为 true，则探索费用将显示查询费用估算值。
pdt_api_control_enabled
布尔值
通过 API 可以启动和取消此连接上的 PDT 构建。

400：错误请求

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

404：未找到

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

422：验证错误

数据类型
说明
（对象）
消息
字符串
错误详情
展开 ValidationErrorDetail 定义...
字段
字符串
出错的字段
代码
字符串
错误代码
消息
字符串
错误信息消息
文档网址
字符串
文档链接
文档网址
字符串
文档链接

429：请求数过多

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接