PolarPlus

PolarPlus是一款用于连接PolarDB PostgreSQL版(兼容Oracle)集群的客户端连接工具。可以为PolarDB提供命令行用户界面,同时支持SQL命令、PolarPlus命令、PL/SQL匿名块、函数和存储过程。

下载客户端

PolarPlus2提供免安装的压缩包,下载后解压即可在Linux系统上使用。解压得到的PolarPlus目录结构如下所示。其中polarplus2文件是可执行文件。如果将polarplus2_release/目录所在的文件路径加入到系统PATH,那么直接执行polarplus2命令即可运行。

polarplus2_release
├── polarplus2 -> ./polarplus2.sh
├── polarplus2.sh
├── polarplus.jar
├── login.sql
├── etc
│ └── sysconfig
├── help
└── lib

PolarPlus使用说明

简介

PolarPlus是一个实用程序,可以为PolarDB提供命令行用户界面。PolarPlus支持SQL命令、PolarPlus命令、PL/SQL匿名块、函数和存储过程。该工具提供了如下功能:

  • 查询指定数据库对象。

  • 执行存储过程。

  • 格式化SQL命令的输出。

  • 执行批处理脚本。

  • 执行操作系统命令。

  • 记录输出内容。

与原生工具区别

PolarPlus针对PolarDB进行适配,支持OracleSQLPlus工具常见用法。

说明

建议使用PolarDB-Tools来管理PolarDB集群,该工具集已针对PolarDB PostgreSQL版(兼容Oracle)进行适配,其中提供的psql工具支持处理Oracle语法风格的PL/SQL匿名块、函数和存储过程。

配置PolarPlus

说明

PolarPlus工具依赖如下:

  • Javajdk 1.8环境(x64)。

  • OpenSSL 1.1版本(x64)。

  1. 使用wget命令下载PolarPlus并解压。

  2. 打开polarplus2.sh文件。

  3. 修改export base="xxx",将base的值替换为PolarPlus的绝对路径。例如,若您的PolarPlus文件的绝对路径为/home/polarplus2_release,则应修改为export base="/home/polarplus2_release"

  4. 在服务器上使用以下命令调用PolarPlus:

    polarplus2 [ -S[ILENT ] ] [ login | /NOLOG ] [ @scriptfile[.ext ] ]

    参数

    说明

    -S[ILENT ]

    如果指定该参数,则将取消显示PolarPlus登录横幅以及所有提示。

    login

    用于连接到数据库服务器和数据库的登录信息。具体信息如下:

    username[/password][@{connectstring | variable } ]
    • username:用于连接数据库的数据库用户名。

    • password:与数据库用户名关联的密码。

    • connectstring:数据库连接字符串,具体信息如下:

      host[:port][/dbname][?ssl={true | false}]
      • host:数据库服务器所在的主机名或IP地址。

        说明
        • 如果未指定connectstringvariableNOLOG,则默认主机为本地主机。

        • 如果使用IPv6地址进行连接,则IP地址必须放在方括号内。示例如下:

          polarplus2 <username>/<password>@[fe80::20c:29ff:fe7c:78b2]:<port>/<database>
      • port:数据库服务器上接收连接的端口号。

        说明

        如果未指定,则默认值为5444。

      • dbname:需要连接的数据库的名称。

        说明

        如果未指定,则默认值为polardb。

      • ssl:若需要SSL连接,请在连接字符串中添加?ssl=true,并确保连接字符串包含host:port。如果未指定SSL参数,则默认值为false。

    • variable:在login.sql文件中定义的变量,该文件包含数据库连接字符串。

    /NOLOG

    如果指定/NOLOG启动PolarPlus,则启动PolarPlus时将不会建立数据库连接。如果需要连接数据库使用SQL命令或者PolarPlus命令,请勿使用该模式。

    说明

    使用/NOLOG选项启动PolarPlus之后, 可以随后给出CONNECT命令以连接到数据库。

    scriptfile[.ext ]

    scriptfile是位于当前工作目录中的文件名,包含SQL命令以及PolarPlus命令。这些命令将在PolarPlus启动后自动执行。

    .ext是文件扩展名。如果文件扩展名是.sql,可以在指定脚本文件时省略.sql扩展名。创建脚本文件时,请使用扩展名命名该文件, 否则PolarPlus将无法访问该文件。

    说明

    PolarPlus将始终对未指定扩展名的文件名采用.sql扩展名。

    连接示例如下所示:

    ./polarplus2 <username>/<password>@<host>:<port>/<dbname>