PolarPlus是一種兼容Oracle的PolarDB客戶端連接工具。
下載客戶端
PolarPlus提供免安裝的壓縮包,下載后解壓即可在Linux系統上使用。解壓得到的PolarPlus目錄結構如下所示。其中polarplus
文件是可執行文件。如果將polarplus_release/
目錄所在的文件路徑加入到系統PATH
,那么直接執行polarplus
命令即可運行。
polarplus_release
├── polarplus -> ./polarplus.sh
├── polarplus.sh
├── polarplus.jar
├── login.sql
├── etc
│ └── sysconfig
├── help
└── lib
PolarPlus使用說明
簡介
PolarPlus是一個實用程序,可以為PolarDB提供命令行用戶界面。PolarPlus支持SQL命令、PolarPlus命令、PL/SQL匿名塊、函數和存儲過程。該工具提供了如下功能:
查詢指定數據庫對象。
執行存儲過程。
格式化SQL命令的輸出。
執行批處理腳本。
執行操作系統命令。
記錄輸出內容。
與原生工具區別
PolarPlus針對PolarDB進行適配,支持Oracle的SQLPlus工具常見用法。
建議使用PolarDB-Tools來管理PolarDB集群,該工具集已針對PolarDB PostgreSQL版(兼容Oracle)進行適配,其中提供的psql工具支持處理Oracle語法風格的PL/SQL匿名塊、函數和存儲過程。
配置PolarPlus
PolarPlus工具依賴如下:
Java的jdk 1.8環境(x64)。
OpenSSL 1.1版本(x64)。
使用
wget
命令下載PolarPlus并解壓,下載地址請參見下載客戶端。打開
polarplus.sh
文件。修改
export base="{pwd}/polarplus"
,將{pwd}
替換為polarplus
所在的絕對路徑。在服務器上使用以下命令調用PolarPlus:
polarplus [ -S[ILENT ] ] [ login | /NOLOG ] [ @scriptfile[.ext ] ]
參數
說明
-S[ILENT ]
如果指定該參數,則將取消顯示PolarPlus登錄橫幅以及所有提示。
login
用于連接到數據庫服務器和數據庫的登錄信息。
登錄采用以下格式:
username[/password][@{connectstring | variable } ]
具體信息請參見登錄信息。
variable是在login.sql文件中定義的變量,該文件包含數據庫連接字符串。
/NOLOG
如果指定
/NOLOG
啟動PolarPlus,啟動PolarPlus時將不會建立數據庫連接。 需要連接數據庫使用SQL命令或者PolarPlus命令請勿使用該模式。說明使用/NOLOG選項啟動PolarPlus之后, 可以隨后給出CONNECT命令以連接到數據庫。
scriptfile[.ext ]
scriptfile是位于當前工作目錄中的文件名,包含SQL命令以及PolarPlus命令, 這些命令將在PolarPlus啟動后自動執行。
.ext
是文件擴展名。 如果文件擴展名是sql, 可以在指定腳本文件時省略.sql
擴展名。 創建腳本文件時,請使用擴展名命名該文件, 否則PolarPlus將無法訪問該文件。說明PolarPlus將始終對未指定擴展名的文件名采用
.sql
擴展名。表 1. 登錄信息
參數
說明
username
用于連接數據庫的數據庫用戶名。
password
與指定用戶名關聯的密碼。
connectstring
具有以下格式的數據庫連接字符串:
host[:port][/dbname][?ssl={true | false}]
host是數據庫服務器所在的主機名或IP地址。
說明如果未指定
connectstring
或variable
或NOLOG
,則默認主機為本地主機。如果使用IPv6地址進行連接,則IP地址必須放在方括號內。
以下是使用IPv6連接的示例:
polarplus polardb/password@[fe80::20c:29ff:fe7c:78b2]:5444/polardb
port是在數據庫服務器上接收連接的端口號。
說明如果未指定,則默認值為5444。
dbname是要連接的數據庫的名稱。
說明如果未指定,則默認值為polardb。
如果需要SSL連接,則在連接字符串中包含
?ssl = true
參數,連接字符串必須包含host:port
;如果未指定SSL參數,則默認值為false。
連接示例如下所示:
polarplus polardb/password@pc-bp1zxxxxxxxxxxx.o.polardb.rds.aliyuncs.com:1521/polardb
說明PolarPlus僅用于連接PolarDB PostgreSQL版(兼容Oracle)1.0版本。如果需要使用PolarPlus連接PolarDB PostgreSQL版(兼容Oracle)2.0版本,請下載PolarPlus2,其目錄結構和使用方法等與PolarPlus類似,只需要將目錄和命令中的
polarplus
替換為polarplus2
即可。