# 使用gsql连接
gsql是GaussDB提供的在命令行下运行的数据库连接工具。此工具除了具备操作数据库的基本功能，还提供了若干高级特性，便于用户使用。
#### 注意事项
缺省情况下，客户端连接数据库后处于空闲状态时会根据GUC参数session_timeout的默认值自动断开连接。如果要关闭超时设置，设置GUC参数session_timeout为0即可。
#### 前提条件
已联系管理员获取连接信息。
#### 远程连接数据库-非透明多写
1. 完成远程连接配置，请联系管理员处理。
2. 在客户端机器上，上传客户端工具包并配置gsql的执行环境变量。 
   1. 登录客户端机器。
   
   2. 创建"/tmp/tools"目录（"/tmp/tools"目录仅为示例，也可创建其他目录）。
      ```
      mkdir /tmp/tools
      ```
      
   
   3. 获取软件安装包中的"GaussDB-Kernel_数据库版本号_操作系统版本号_64bit_Gsql.tar.gz"工具包并上传到"/tmp/tools"路径下。
      ![](https://support.huaweicloud.com/distributed-devg-v10-gaussdb/public_sys-resources/note_3.0-zh-cn.png)
      - 软件包相对位置为安装时所放位置，根据实际情况填写。
      
      - 不同的操作系统，工具包文件名称会有差异。请根据实际的操作系统类型选择对应的工具包。
        
   
   4. 解压文件。
      ```
      cd /tmp/tools
      tar -zxvf GaussDB-Kernel_数据库版本号_操作系统版本号_64bit_Gsql.tar.gz
      ```
      
   
   5. 设置环境变量。 打开"\~/.bashrc"文件。
      ```
      vi ~/.bashrc
      ```
      在其中输入如下内容后，使用":wq!"命令保存并退出。
      ```
      export PATH=/tmp/tools/bin:$PATH
      export LD_LIBRARY_PATH=/tmp/tools/lib:$LD_LIBRARY_PATH
      ```
      
   
   6. 使环境变量配置生效。
      ```
      source ~/.bashrc
      ```
      
   
   
   
   
3. 连接数据库。 
   数据库安装完成后，会默认生成名称为postgres的数据库。
   - 使用CN所在的服务器IP地址连接数据库。
     ```
     gsql -d postgres -h 10.10.0.11 -U jack -p 8000
     Password for user jack:
     ```
     postgres为需要连接的数据库名称，10.10.0.11为CN所在的服务器IP地址，jack为登录数据库的用户名，8000为CN的端口号，上述示例中，连接的服务器的IP和端口也可以替换成DN服务器IP和端口。gsql支持使用域名代替IP地址。
     
   
   - 连接成功后，系统显示类似如下信息：
     ```
     gsql ((GaussDB Kernel XXX.X.XXX build 9235acb6) compiled at 2025-06-10 07:15:43 last mr 23922 release)
     Non-SSL connection (SSL connection is recommended when requiring high-security)
     Type "help" for help.
     ```
     jack用户是管理员用户时，系统显示"DBNAME=#"。若使用普通用户身份登录和连接数据库，系统显示"DBNAME=\>"。
     "Non-SSL connection"表示未使用SSL方式连接数据库。如果需要高安全性时，请使用SSL连接。
     
   
   - 使用IPv6地址连接数据库。
     ```
     gsql -d postgres -h 2407:c182:14f0:594:er63:49c5:493q:594c -U jack -p 8000
     ```
     
   
   - 3 CN节点连接数据库。 在多CN数据库实例环境中，当需要跳过故障CN节点时，可以使用gsql连接到正常状态的CN节点。
     以3个CN的数据库实例为例，三个CN节点的IP:port分别是10.10.0.11:8000、10.10.0.12:8002和10.10.0.13:8004，执行以下命令。
     ```
     gsql -d postgres -h 10.10.0.11,10.10.0.12,10.10.0.13 -U jack -p 8000,8002,8004
     ```
     gsql会按从前往后的顺序依次连接三个IP:port，如果当前连接的IP:port不是正常状态的CN节点，则尝试连接下一个IP:port，直到成功连接到正常状态的CN节点为止。
     可通过设置PGTARGETSESSIONATTRS环境变量的值来选择连接到不同类型的节点。
     
   
   
   ![](https://support.huaweicloud.com/distributed-devg-v10-gaussdb/public_sys-resources/note_3.0-zh-cn.png)
   - 上述示例中，jack用户为数据库初始化用户创建的普通用户。
   
   - 默认禁止使用数据库初始化用户进行远程连接数据库，开启集群内部kerberos认证时，允许初始化用户在集群内部进行远程连接。