仓库SQL api 2.0

重要的

访问数据砖REST api,你必须进行身份验证。

配置单个SQL仓库使用SQL API仓库。配置所有SQL仓库使用全球仓库SQL API。

需求

你必须创建SQL仓库集群创建权限,启用数据科学与工程工作区。
管理一个SQL仓库必须有可以管理在砖SQL允许仓库。

SQL API仓库

使用这个API来创建、编辑列表,并获得SQL仓库。

在本节中:

创建

端点	HTTP方法
`2.0 / sql /仓库/`	`帖子`
`2.0 / sql /端点`(弃用)	`帖子`

创建一个SQL仓库。

字段名	类型	描述
`的名字`	`字符串`	SQL仓库的名称。必须是唯一的。这个字段是必需的。
`大小`	`字符串`	集群的大小分配给仓库:`“2 x-small”`,`“X-Small”`,`“小”`,`“媒介”`,`“大”`,`“超大号”`,`“2超大号”`,`“3超大号”`,`“4超大号”`。从集群映射到实例的大小,看看集群规模。这个字段是必需的。
`min_num_clusters`	`INT32`	最小数量的集群运行SQL仓库时可用。缺省值是1。
`max_num_clusters`	`INT32`	最大数量的集群运行SQL仓库时可用。这个字段是必需的。如果多集群负载平衡不启用,这是有限的`1`。
`auto_stop_mins`	`INT32`	在分钟直到懒懒的SQL仓库终止所有集群和停止。这个字段是可选的。将其设置为0,可以禁用自动停止。默认值是15和最低为10。
`标签`	WarehouseTags	键-值对描述仓库。砖与这些标签标记所有仓库资源。这个字段是可选的。
`enable_photon`	`布尔`	查询是否在本地执行矢量化引擎加速查询执行。这个字段是可选的。默认值是`真正的`。
`通道`	通道	是否使用SQL仓库计算当前版本或预览版本。预览版本让你尝试之前成为砖SQL标准的功能。通常,预览版本提升为当前版本两周后最初的预览版,但一些预览可能会持续更长时间。你可以了解最新的预览版本的功能检查发布说明。砖不建议使用预览版本生产工作负载。这个字段是可选的。默认值是`CHANNEL_NAME_CURRENT`。
`spot_instance_policy`	WarehouseSpotInstancePolicy	现货政策用于分配实例集群。这个字段是可选的。

示例请求

               {“名称”:“我的SQL仓库”,“大小”:“媒介”,“min_num_clusters”:1,“max_num_clusters”:10,“标签”:{“custom_tags”:({“关键”:“mykey”,“价值”:“括号”}]},“enable_photon”:“真正的”,“通道”:{“名称”:“CHANNEL_NAME_CURRENT”}}
              

示例响应

               {“id”:“0123456789六边形abcdef”}
              

删除

端点	HTTP方法
`2.0 / sql /仓库/ {id}`	`删除`
`2.0 / sql /端点/ {id}`(弃用)	`删除`

删除一个SQL仓库。

编辑

端点	HTTP方法
`2.0 / sql /仓库/ {id} /编辑`	`帖子`
`2.0 / sql /端点/ {id} /编辑`(弃用)	`帖子`

修改SQL仓库。所有字段是可选的。失踪的字段默认为当前值。

字段名	类型	描述
`id`	`字符串`	ID的SQL仓库。
`的名字`	`字符串`	SQL仓库的名称。
`大小`	`字符串`	集群的大小分配给仓库:`“2 x-small”`,`“X-Small”`,`“小”`,`“媒介”`,`“大”`,`“超大号”`,`“2超大号”`,`“3超大号”`,`“4超大号”`。从集群映射到实例的大小,看看集群规模。
`min_num_clusters`	`INT32`	最小数量的集群运行SQL仓库时可用。
`max_num_clusters`	`INT32`	最大数量的集群运行SQL仓库时可用。这个字段是必需的。如果多集群负载平衡不启用,仅限于`1`。
`auto_stop_mins`	`INT32`	在分钟直到懒懒的SQL仓库终止所有集群和停止。将其设置为0,可以禁用自动停止。默认值是15和最低为10。
`标签`	WarehouseTags	键-值对描述仓库。
`spot_instance_policy`	WarehouseSpotInstancePolicy	现货政策用于分配实例集群。
`enable_photon`	`布尔`	查询是否在本地执行矢量化引擎加速查询执行。
`通道`	通道	是否使用SQL仓库计算当前版本或预览版本。预览版本让你尝试之前成为砖SQL标准的功能。通常,预览版本提升为当前版本两周后最初的预览版,但一些预览可能会持续更长时间。你可以了解最新的预览版本的功能检查发布说明。砖不建议使用预览版本生产工作负载。这个字段是可选的。默认值是`CHANNEL_NAME_CURRENT`。

示例请求

               {“名称”:“我的编辑SQL仓库”,“大小”:“大”,“auto_stop_mins”:60}
              

得到

端点	HTTP方法
`2.0 / sql /仓库/ {id}`	`得到`
`2.0 / sql /端点/ {id}`(弃用)	`得到`

检索一个SQL的信息仓库。

字段名	类型	描述
`id`	`字符串`	SQL仓库ID。
`的名字`	`字符串`	SQL仓库的名称。
`大小`	`字符串`	集群的大小分配给仓库:`“2 x-small”`,`“X-Small”`,`“小”`,`“媒介”`,`“大”`,`“超大号”`,`“2超大号”`,`“3超大号”`,`“4超大号”`。从集群映射到实例的大小,看看集群规模。
`spot_instance_policy`	WarehouseSpotInstancePolicy	现货政策用于分配实例集群。
`auto_stop_mins`	`INT32`	数分钟,直到懒懒的SQL仓库终止所有集群和停止。
`num_clusters`	`INT32`	集群的数量分配给仓库。
`min_num_clusters`	`INT32`	最小数量的集群运行SQL仓库时可用。
`max_num_clusters`	`INT32`	最大数量的集群运行SQL仓库时可用。
`num_active_sessions`	`INT32`	活跃JDBC和ODBC会议上运行SQL仓库。
`状态`	WarehouseState	SQL状态仓库。
`creator_name`	`字符串`	电子邮件地址的用户创建了仓库。
`creator_id`	`字符串`	砖的用户ID创建仓库。
`jdbc_url`	`字符串`	URL用于提交SQL命令的SQL仓库使用JDBC。
`odbc_params`	ODBCParams	主机、路径、协议和端口信息需要提交SQL命令的SQL仓库使用ODBC。
`标签`	WarehouseTags	键-值对描述仓库。
`健康`	WarehouseHealth	仓库的健康。
`enable_photon`	`布尔`	查询是否在本地执行矢量化引擎加速查询执行。
`通道`	通道	当前SQL SQL仓库使用仓库是否计算版本或预览版本。预览版本让你尝试之前成为砖SQL标准的功能。通常,预览版本提升为当前版本两周后最初的预览版,但一些预览可能会持续更长时间。你可以了解最新的预览版本的功能检查发布说明。砖不建议使用预览版本生产工作负载。这个字段是可选的。默认值是`CHANNEL_NAME_CURRENT`。

示例响应

               {“id”:“7 f2629a529869126”,“名称”:“MyWarehouse”,“大小”:“小”,“min_num_clusters”:1,“max_num_clusters”:1,“auto_stop_mins”:0,“auto_resume”:真正的,“num_clusters”:0,“num_active_sessions”:0,“状态”:“停止”,“creator_name”:“user@example.com”,“jdbc_url”:" jdbc:火花:/ / hostname.staging.cloud.www.neidfyre.com: 443 /违约;运输方式= http; ssl = 1; AuthMech = 3; httpPath = / sql / 1.0 /仓库/ 7 f2629a529869126;”,“odbc_params”:{“主机名”:“hostname.cloud.www.neidfyre.com”,“路径”:“/ sql / 1.0 /仓库/ 7 f2629a529869126”,“协议”:“https”,“端口”:443年},“标签”:{“custom_tags”:({“关键”:“mykey”,“价值”:“括号”}]},“spot_instance_policy”:“COST_OPTIMIZED”,“enable_photon”:真正的,“大小”:“小”,“通道”:{“名称”:“CHANNEL_NAME_CURRENT”}}
              

列表

端点	HTTP方法
`2.0 / sql /仓库/`	`得到`
`2.0 / sql /端点`(弃用)	`得到`

在工作区中列出所有SQL仓库。

示例响应

               {“仓库”:({“id”:“123456790六边形abcdef”,“名称”:“我的SQL仓库”,“大小”:“媒介”},{“id”:“098765321 fedcba”,“名称”:”另一个SQL仓库”,“大小”:“大”}]}
              

注意:如果你使用弃用2.0 / sql /端点API,顶级响应领域将是“端点”而不是“仓库”。

开始

端点	HTTP方法
`2.0 / sql /仓库/ {id} /开始`	`帖子`
`2.0 / sql /端点/ {id} /开始`(弃用)	`帖子`

开始一个SQL仓库。

停止

端点	HTTP方法
`2.0 / sql /仓库/ {id} /停止`	`帖子`
`2.0 / sql /端点/ {id} /停止`(弃用)	`帖子`

停止一个SQL仓库。

全球仓库SQL API

使用这个API来配置安全策略,数据访问属性,并为所有SQL仓库配置参数。

在本节中:

得到

端点	HTTP方法
`/ 2.0 / sql / config /仓库`	`得到`
`/ 2.0 / sql / config /端点`(弃用)	`得到`

得到所有SQL仓库的配置。

字段名	类型	描述
`security_policy`	WarehouseSecurityPolicy	控制对数据的访问的政策。
`data_access_config`	的数组WarehouseConfPair	一个键值对数组,包含数据访问的属性配置。
`sql_configuration_parameters`	RepeatedWarehouseConfPairs	SQL配置参数。

示例响应

               {“security_policy”:“DATA_ACCESS_CONTROL”,“data_access_config”:({“关键”:“spark.sql.hive.metastore.jars”,“价值”:“/砖/ hive_metastore_jars / *”}),“sql_configuration_parameters”:{“configuration_pairs”:({“关键”:“legacy_time_parser_policy”,“价值”:“遗产”}]}}
              

编辑

所有SQL编辑配置仓库。

重要的

所有字段是必需的。
调用这个方法重启所有正在运行的SQL仓库。

端点	HTTP方法
`/ 2.0 / sql / config /仓库`	`把`
`/ 2.0 / sql / config /端点`(弃用)	`把`

字段名	类型	描述
`security_policy`	WarehouseSecurityPolicy	控制对数据的访问的政策。
`data_access_config`	的数组WarehouseConfPair	一个键值对数组,包含数据访问的属性配置。
`sql_configuration_parameters`	RepeatedWarehouseConfPairs	SQL配置参数。

示例请求

               {“data_access_config”:({“关键”:“spark.sql.hive.metastore.jars”,“价值”:“/砖/ hive_metastore_jars / *”}),“sql_configuration_parameters”:{“configuration_pairs”:({“关键”:“legacy_time_parser_policy”,“价值”:“遗产”}]}}
              

数据结构

在本节中:

WarehouseConfPair

字段名	类型	描述
`关键`	`字符串`	配置键名。
`价值`	`字符串`	配置键值。

WarehouseHealth

字段名	类型	描述
`状态`	WarehouseStatus	仓库的地位。
`消息`	`字符串`	健康状况的描述性信息。包括信息错误导致当前健康状况。

WarehouseSecurityPolicy

选项	描述
`DATA_ACCESS_CONTROL`	使用数据访问控制控制数据访问。

WarehouseSpotInstancePolicy

选项	描述
`COST_OPTIMIZED`	使用一个随需应变的实例集群司机和现货实例集群执行人。最大的现货价格是随需应变的100%价格。这是默认策略。
`RELIABILITY_OPTIMIZED`	使用按需对所有集群节点实例。

WarehouseState

SQL状态仓库。允许的状态转换:

开始- >开始,运行,停止,删除
运行- >停止,删除
停止- >停止,开始
停止- >开始,删除
删除- >删除

状态	描述
`开始`	仓库的过程中开始。
`运行`	启动过程完成,仓库已经可以使用了。
`停止`	仓库的过程中被停止了。
`停止`	仓库是停了。开始通过调用启动或通过提交一个JDBC、ODBC请求。
`删除`	仓库的过程中被摧毁。
`删除`	仓库已被删除,无法恢复。

WarehouseStatus

状态	描述
`健康的`	仓库运作正常,没有问题。
`退化`	仓库可能功能,但有一些已知问题。性能可能会受到影响。
`失败的`	仓库是严重影响和将无法查询。

WarehouseTags

字段名	类型	描述
`custom_tags`	的数组WarehouseTagPair	一个对象包含一个键值对数组。

WarehouseTagPair

字段名	类型	描述
`关键`	`字符串`	标签键名。
`价值`	`字符串`	标签键值。

ODBCParams

字段名	类型	描述
`主机`	`字符串`	ODBC服务器主机名。
`路径`	`字符串`	ODBC服务器路径。
`协议`	`字符串`	ODBC服务器协议。
`港口`	`INT32`	ODBC服务器端口。

RepeatedWarehouseConfPairs

字段名	类型	描述
`configuration_pairs`	的数组WarehouseConfPair	一个对象包含一个键值对数组。

通道

字段名	类型	描述
`的名字`	ChannelName	通道名称

ChannelName

选项	描述
`CHANNEL_NAME_PREVIEW`	SQL仓库将预览通道和使用功能。
`CHANNEL_NAME_CURRENT`	SQL仓库设置为当前频道。