【TcaplusDB知識庫】TcaplusDB CLI工具介紹
前言
TcaplusDB提供了豐富的功能介面來滿足不同使用者使用TcaplusDB的需求。針對騰訊雲控制檯一些的操作,目前已將TcaplusDB控制檯相關操作整合在TencentCloud SDK中,使用者可通過騰訊雲API-Explorer平臺進行線上程式碼除錯。為進一步滿足使用者更便利使用控制檯相關操作的需求,針對現有的TencentCloud SDK中關於TcaplusDB控制檯操作相關的API作進一步的整合,主要目的是提供一個通用工具來實現所有相關控制檯的操作,同時又能滿足TcaplusDB本地Docker環境相關表操作。
TcaplusDB CLI工具主要用於騰訊雲控制檯和本地Docker版本進行TcaplusDB相關操作,如叢集、表格組、表的建立、刪除、查詢、擴容等操作。
獲取方式
工具包 | 下載 |
---|---|
tcapluscli.tgz |
功能列表
本工具支援騰訊雲TcaplusDB控制檯相關操作命令,也支援Docker本地版相關操作命令,具體支援功能如下:
-
支援雲控制檯Secret安全資訊設定(secret_id, secret_key)
-
支援雲控制檯表叢集建立、刪除、查詢
-
支援雲控制檯表格組建立、刪除、查詢
-
支援本地Docker版表格組建立、刪除、查詢
-
支援雲控制檯表建立、刪除、清理、查詢、擴容、回收站恢復、批量建立、批量清理、批量擴容
-
支援本地Docker版表建立、刪除、清理
工具依賴
環境依賴
針對不同的作業系統平臺,已編譯好相關作業系統平臺的二進位制執行檔案,使用者可選擇對應OS平臺的工具來進行相關操作。如下:
作業系統 | 版本 | 平臺 | 工具名稱 |
---|---|---|---|
MacOS | Darwin-17.7.0 | intel/x86_64 | tcapluscli-macos |
CentOS | 7 | intel/x86_64 | tcapluscli-centos7-i386 |
CentOS | 8 | indel/x86_64 | tcapluscli-centos8-i386 |
Debian | 8.2 | amd/x86_64 | tcapluscli-debian8-amd64 |
Windows | 10 | intel/x86_64 | tcapluscli-win10 |
如果需要在其它平臺編譯,可聯絡騰訊雲TcaplusDB售後協助處理。
配置依賴
工具依賴於安全金鑰的設定,主要考慮線上騰訊雲環境的連線使用。對於本地Docker版本,安全金鑰可以設定隨機值,無需設定真實金鑰。
安全金鑰設定方法,請參考:
訪問依賴
tcapluscli在訪問本地Docker環境時,依賴本地docker暴露的endpoint, 這裡統一預設暴露80埠作為api訪問資源的入口地址, 帶上引數endpoint-url, 並指定access-id叢集訪問id(業務id, 2:tdr叢集, 3:pb叢集), 如:
#檢視tdr業務叢集的表格組資訊,access-id=2
./tcapluscli tablegroup describe --endpoint-url=http://localhost --access-id=2 --list
#檢視pb業務叢集的表格組資訊, access-id=3
./tcapluscli tablegroup describe --endpoint-url=http://localhost --access-id=3 --list
授權
由於docker後端服務有設定IP訪問白名單機制,所有操作介面在執行前需要先授權IP訪問,授權方式:
#指定docker容器endpoint地址,埠預設用80, 指定要授權的業務id(2: tdr, 3: pb), #授權所有IP,允許訪問docker本地映象
#tdr授權
./tcapluscli privilege --endpoint-url=http://localhost --access-id=2 --allow-all-ip
#PB授權
./tcapluscli privilege --endpoint-url=http://localhost --access-id=3 --allow-all-ip
叢集操作
叢集相關操作方式,請參考:
表格組操作
表格組相關操作方式,請參考:
表格操作
表格操作相關操作方式,請參考: