openGauess 服务端和客户端工具介绍

[TOC]
## 一、服务端工具
### 1. gs_om
#### 1.1 背景信息
```
openGauss提供了gs_om工具帮助对openGauss进行维护，包括
启动openGauss、停止openGauss、查询openGauss状态、
查询静态配置、生成静态配置文件、查询openGauss状态详细信息、
生成动态配置文件、SSL证书替换、显示帮助信息和显示版本号信息等功能。
```
#### 1.2 前提条件
```
需以操作系统用户omm执行gs_om命令。
```
#### 1.3 语法
```
1. 启动openGauss
[omm@node1 ~]$ gs_om -t start
2. 查看openGuass各个实例的状态情况
[omm@node1 ~]$ gs_om -t status --detail
3. 查看openGuass详细状态
[omm@node1 ~]$ gs_om -t status --all
[omm@node1 ~]$ gs_om -t query
4. 关闭openGuass
[omm@node1 ~]$ gs_om -t stop
5. 重启openGauss
[omm@node1 ~]$ gs_om -t restart
```
## 二、客户端工具
### 1. gsql 简介
```
gsql 是openGauss提供在命令行下运行的数据库连接工具，可以通过此工具连接服务器并对其进行操作和维护，除了具备操作数据库的基本功能，gsql还提供了若干高级特性，便于用户使用。
```
### 2. 使用 gsql 连接数据库 - 本地连接
```
1. 以操作系统用户omm登录数据库主节点。

2. 查看帮助
[omm@node1 ~]$ gsql --help

3. gsql常用参数
-d 要连接的数据库名
-p 数据库端口号
-U 指定数据库用户名，默认omm，omm用户是管理员用户。
-W 数据库用户的密码
-h 指定主机名
-r 根据openGauss语法规则，gsql支持使用Tab键进行命令的自动补齐，当编译时指定了选项—with-readline，且客户端连接时指定“-r”参数，此功能被打开。

4. 连接数据库
说明：数据库安装完成后，默认生成名称为postgres的数据库。第一次连接数据库时可以连接到此数据库。

常用如下命令连接数据库：
语法1：gsql -d 要连接的数据库名 -p 数据库端口号 -r
语法2：gsql -d 要连接的数据库名 -p 数据库端口号 -U 数据库用户名 -h 主机名 -r

范例1、使用omm用户连接到本机postgres数据库的26000端口
[omm@node1 ~]$ gsql -d postgres -p 26000 -r

范例2、使用jack用户连接到远程主机192.168.0.5 postgres数据库的26000端口
[omm@node1 ~]$ gsql -h 192.1680.5 -d postgres -p 26000 -U jack -r

范例3、当参数postgres和omm不属于任何选项时，分别被解释为数据库名和用户名
[omm@node1 ~]$ gsql postgres omm -p 26000 等效于 gsql -d postgres -U omm -p 26000

5. 连接成功后，系统显示类似如下信息：
[omm@node1 ~]$ gsql -d postgres -p 26000
postgres=#

说明：
omm用户是管理员用户，因此系统显示“DBNAME=#”。若使用普通用户身份登录和连接数据库，系统显示“DBNAME=>”。

6. 列出当前所有数据库
postgres=# \l

7. 创建用户jack并设置密码为 gauss@123，并给与系统管理员权限。
postgres=# create user jack with sysadmin identified by 'gauss@123';

8. 退出数据库
postgres=# \q

9. openGauss 的连接ip白名单
配置文件为：data_pat/pg_hba.conf

...
# IPv4 local connections:
host all all 127.0.0.1/32 trust
host all all 192.168.0.11/32 trust
#添加ip192.168.0.5到白名单，注意远程登录不能使用trust
#METHOD can be "trust", "reject", "md5", "sha256" or "cert".
host all all 192.168.0.5/32 sha256
...

10.
[omm@node1 ~]$ gsql -h 192.1680.5 -d postgres -p 26000 -U jack -W 'Newcapec_123' -f a.sql

11.

```