【数据库】GaussDB客户端工具介绍

前言

这次我们来看GaussDB的一些客户端工具，帮助我们更好的操作数据库

一、客户端工具介绍

客户端工具的存在主要是为了让用户更加便捷地连接数据库，对数据库进行各种操作和调试。

• zsql介绍：
  GaussDB 100为用户提供的一种交互和查询的客户端工具。
  zsql提供了一个命令行接口，帮助用户连接、使用GaussDB 100。

• gsql介绍：
  GaussDB 200提供在命令行运行的交互式数据库连接工具。

• Data Studio介绍：
  Data Studio是一款GUI工具，可以通过它来连接数据库，调试执行SQL语句和存储过程。

二、zsql安装

1. 安装前提
   • 支持linux操作系统
   • 客户端所在的主机上需要部署python2.7
   • 创建zaql客户端用户和用户端，权限小于等于750
   • 已获取客户端安装包，并完成zsql客户端安装包的完整性校验

2. zsql客户端安装包完整性校验
   执行命令看输出软件包的校验值

sha256sum GAUSSDB100-V300R001C00-ZSQL-EULER20SP8-64bit.tar.gz

将校验值和校验内容进行对比，一致则校验通过，否则校验不通过

3. 以root用户登录gaussDB 100所在的服务器
   zsql客户端部用户以omm为例，把客户端安装包放在目录“/home/omm”，并切改安装包用户组
   改权限：

cd /home/omm chown omm:dbgrp GAUSSDB100-V300R001C00-ZSQL-EULER20SP8-64bit.tar.gz

切换用户：

su - omm

解压安装包

tar -zxvf GAUSSDB100-V300R001C00-ZSQL-EULER20SP8-64bit.tar.gz

4. 安装zsql客户端
   进入主机解压后的目录

cd GAUSSDB100-V300R001C00-ZSQL-EULER20SP8-64bit

运行install_zasl.py 脚本安装zsql客户端

python install_zsql.py -U omm:dbgrp -R /home/omm/app

参数：
-U：运行zsql客户端的用户，如omm
-R：安装zsql客户端目录

5. 以数据库管理员身份登录

zsql { CONNECT | CONN } / AS SYSDBA [ip:port] [-D /home/gaussdba/data1] [-q] [-s "silent_file"] [-w connect_timeout]

参数介绍：

参数	描述
CONN，CONNECT	连接数据库。其中[ip:port] 为可选项，若不指定则默认连接本地主机。当数据库系统管理员起了多个数据库实例时，连接指定的数据库时，需要使用-D参数指定数据库目录。
-q	取消SSL登录认证查看。可和-w参数同时使用。
-s	参数用于设置无提示模式执行SQL。
-w	客户端连接数据库时的等待超时时间，当前默认为10s。可和-q参数同时使用。

例子：

[gaussdba@plat1~]$ zsql / as sysdba -q
connected

6. 以普通数据库用户身份登录
   非交互式登录

zsql user/user_password@ip:port [-D /home/gaussdba/data1] [-q] [-s "silent_file"] [-w connect_timeout]

参数	描述
-w	启动zsql进程时等待响应时间
-s silent.log	无提示模式下执行SQL语句，执行结果会统一输出到指定文件中，而不是回显到当前屏幕。使用该参数时需放置在命令末尾。
-c	在启动时执行单条SQL语句，在-c后面加命令。也可以放多条，但是要用分号隔开 但如果是存储过程的语句 只支持单条输入，并且存储过程需要用斜线“/”结束
-f	执行SQL脚本。该参数不能和-c或-s参数同时使用，且使用该参数时需放置在命令末尾
-a	打印执行的SQL语句。该参数可以和-f同时使用，即表示打印并执行SQL脚本中的SQL语句。-a参数必须位于-f参数前面。

其中，
user为数据库用户名，
password为数据库用户密码。
ip：port为数据库所在主机的IP地址和端口号，
默认端口号为1888，
另外还有两种交互式登录的方法，但是还是非交互式最常用

例子：
用户gaussdba本地登录数据库

[gaussdba@plat1~]$ zsql
SQL> CONN gaussdba/Changeme_123@127.0.0.1:1611
connected.

三、gsql

1. 配置数据库服务器
   以omm用户身份登录GaussDB 200集群任一节点。执行source ${BIGDATA_HOME}/mppdb/.mppdbgs_profile命令启动环境变量。

   执行如下命令增加对外提供服务的网卡IP或者主机名（英文逗号分隔），其中NodeName为当前节点名称，10.11.12.13是CN所在服务器向外提供服务的网卡IP：

gs_guc reload -Z coordinator -N NodeName -I all -c "listen_addresses='localhost,192.168.0.100,10.11.12.13'"

添加客户端IP认证信息（下面的client_ip/mask请替换成真正的客户端IP地址）

 gs_guc set -Z coordinator -N all -I all -h "host all client_ip/mask sha256"

2. gsql连接数据库
   解压 GaussDB-Kernel-VXXXRXXXCXX-XXXX-64bit-gsql.tar.gz
   解压出来有以下几个文件：

文件名	描述
bin	存放gsql的可执行文件的位置；
gsql_env.sh	环境变量文件；
lib	gsql所依赖的动态库。

加载刚刚解压出来的环境变量文件

source gsql_env.sh

然后就可以正常使用gsql啦

gsql –d postgres –h 10.11.12.13 –U username –W password –p 25308

参数	描述
-d	参数指定的是数据库名；
-h	参数指定的是数据库CN地址；
-U	参数指定的是数据库用户名；
-W	参数指定的是数据库用户密码；
-p	参数指定的是数据库CN的端口。

3. 使用方法
   gsql可以直接将查询语句发给数据库执行，并返回执行结果

postgres=# select * from dual;

还有快速查看对象定义

postgres=# \d dual
  View "pg_catalog.dual"

四、Data Studio

Data Studio是一款GUI工具，可以通过它来连接GaussDB数据库，执行SQL语句，开发存储过程，以及管理数据库对象。
Data Studio目前支持GaussDB的大部分基本特性，为数据库开发人员提供友好的图形化界面，简化数据库开发及应用开发任务，能显著提高构建程序的效率。

1. 安装运行Data Studio

• 下载：登录华为support网站，前往技术支持 > 云计算 > FusionInsight > FusionInsight Tool，选择相应版本的Data Studio进行下载。
• 安装：下载完毕后，解压Data Studio 安装包即可
• 然后双击点一下运行即可（注意，要有jdk1.8及以上）

2. 使用 Data Studio 连接 GaussDB 100
   

3. 使用 Data Studio 连接 GaussDB 200
   

4. Data Studio主界面介绍
   

5. Data Studio基本功能

• 对象浏览器
  以数据库连接为根节点，使用树状层级结构展示各类数据库对象；
  通过右键菜单的形式提供各类对象管理操作的入口，如创建数据库、断开连接、创建对象、编辑表数据、查看对象属性信息、执行存储过程等。

• SQL编辑窗口
  编辑、格式化和执行各类SQL语句；
  在SQL编辑过程会根据用户输入进行自动联想并提供补全建议。

• 查询结果窗口
  展示查询语句返回的结果，用户可对结果执行排序、动态筛选、复制、导出、编辑等操作。

• SQL语法助手
  根据用户在SQL编辑窗口中的输入，动态匹配并展示相应的SQL语法。

• 存储过程管理
  查看、修改和编译存储过程的代码；
  执行或调试存储过程；
  针对GaussDB语法提供相应的存储过程创建模板。

• 首选项配置
  用户可针对自身的使用习惯对DS的部分功能进行个性化设置，如自动保存的时间间隔、查询结果每次加载的记录数、SQL语句高亮规则、自定义快捷键等。