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
即可。