本文介绍如何下载安装polarplus客户端工具。

背景信息

polartools由一组仅适用于Linux的PolarDB客户端工具集组成，包含了以下几种工具：

本文主要介绍polarplus的使用方法，其他工具的使用请参见PostgreSQL官方文档。

下载客户端

polartools提供压缩包免安装下载，解压后即可使用。其中客户端工具分为兼容Oracle语法版本和PostgreSQL版本。

  • 兼容Oracle数据库版本的工具在ora/bin目录下。
  • PostgreSQL版本的工具在pg/bin目录下。

polartools目录结构如下：

polartools
├── ora
│   ├── bin
│   ├── etc
│   │   └── sysconfig
│   ├── help
│   └── lib
└── pg
    ├── bin
    └── lib

如若需要，您可以将工具添加到系统PATH路径。

bin
├── pg_basebackup
├── pg_dump
├── pg_dumpall
├── pg_restore
├── polarplusLauncher.sh
├── polarplus.sh
└── psql

polarplus使用说明

polarplus是一个实用程序，可以为PolarDB提供命令行用户界面。polarplus支持SQL命令、SPL匿名块和polarplus命令。

polarplus提供了如下功能：

  • 查询指定数据库对象
  • 执行存储过程
  • 格式化SQL命令的输出
  • 执行批处理脚本
  • 执行操作系统命令
  • 记录输出内容

以下步骤将指导您如何下载并配置polarplus。

说明 该工具依赖如下：
  • Java的jdk1.8环境（x64）。
  • OpenSSL 1.1版本（x64）。
  1. 使用wget命令下载polartools，下载地址请参见下载客户端。
  2. 解压polartools-linux.zip文件。
    tar -zxf polartools.tar.gz
    解压后文件如下所示。polartools解压后
  3. 进入ora目录下的bin文件夹。
  4. 打开polarplus.sh文件。
  5. 修改export base="/home/adger.lj/polartools/ora"，将/home/adger.lj替换为polartools文件夹所在的绝对路径。
    polartools
  6. 在服务器上使用以下命令调用polarplus：
    polarplus [ -S[ILENT ] ] [ login | /NOLOG ] [ @scriptfile[.ext ] ]
    参数 说明
    -S[ILENT ] 如果指定该参数，则将取消显示polarplus登录横幅以及所有提示。
    login 用于连接到数据库服务器和数据库的登录信息。

    登录采用以下格式：

    username[/password][@{connectstring | variable } ]

    具体信息请参见表 1。

    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是要连接的数据库的名称。
    • 如果需要SSL连接，则在连接字符串中包含？ssl = true参数，连接字符串必须包含host：port；如果未指定SSL参数，则默认值为false。

    连接示例如下所示：

    polarplus  polardb/password@pc-bp1zxxxxxxxxxxx.o.polardb.rds.aliyuncs.com:1521/polardb