倉庫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倉庫的名稱。必須是唯一的。這個字段是必需的。
`cluster_size`	`字符串`	集群的大小分配給倉庫:`“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倉庫”,“cluster_size”:“媒介”,“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倉庫的名稱。
`cluster_size`	`字符串`	集群的大小分配給倉庫:`“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倉庫”,“cluster_size”:“大”,“auto_stop_mins”:60}
              

得到

端點	HTTP方法
`2.0 / sql /倉庫/ {id}`	`得到`
`2.0 / sql /端點/ {id}`(棄用)	`得到`

檢索一個SQL的信息倉庫。

字段名	類型	描述
`id`	`字符串`	SQL倉庫ID。
`的名字`	`字符串`	SQL倉庫的名稱。
`cluster_size`	`字符串`	集群的大小分配給倉庫:`“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”,“cluster_size”:“小”,“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.eheci.com: 443 /違約;運輸方式= http; ssl = 1; AuthMech = 3; httpPath = / sql / 1.0 /倉庫/ 7 f2629a529869126;”,“odbc_params”:{“主機名”:“hostname.cloud.www.eheci.com”,“路徑”:“/ sql / 1.0 /倉庫/ 7 f2629a529869126”,“協議”:“https”,“端口”:443年},“標簽”:{“custom_tags”:({“關鍵”:“mykey”,“價值”:“括號”}]},“spot_instance_policy”:“COST_OPTIMIZED”,“enable_photon”:真正的,“cluster_size”:“小”,“通道”:{“名稱”:“CHANNEL_NAME_CURRENT”}}
              

列表

端點	HTTP方法
`2.0 / sql /倉庫/`	`得到`
`2.0 / sql /端點`(棄用)	`得到`

在工作區中列出所有SQL倉庫。

示例響應

               {“倉庫”:({“id”:“123456790六邊形abcdef”,“名稱”:“我的SQL倉庫”,“cluster_size”:“媒介”},{“id”:“098765321 fedcba”,“名稱”:”另一個SQL倉庫”,“cluster_size”:“大”}]}
              

注意:如果你使用棄用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倉庫設置為當前頻道。