命令参考
| 参数 | 参数说明 | 取值范围 |
|---|---|---|
| -c, --command=COMMAND | 声明gsql要执行一条字符串命令然后退出。 | - |
| -d, --dbname=DBNAME | 指定想要连接的数据库名称。 另外,gsql允许使用扩展的DBNAME,即'postgres[ql]://[user[:password]@][netloc][:port][,...][/dbname][?param1=value1&...]'或'[key=value] [...]'形式的连接串作为DBNAME,gsql将从连接串中解析连接信息,并优先使用这些信息。 须知: gsql使用扩展的DBNAME创建连接时,不支持指定replication参数。 | 字符串。 |
| -f, --file=FILENAME | 使用文件作为命令源而不是交互式输入。gsql将在处理完文件后结束。如果FILENAME是-(连字符),则从标准输入读取。 须知: 当服务端编码为GB18030/GB18030_2022时,若使用类似gsql -f xxx.sql > xxx.log的带管道符('>')的命令导入文件,需确保编码格式与服务端编码格式保持一致;建议在文件中手动设置client_encoding为文件编码格式。 | 绝对路径或相对路径,且满足操作系统路径命名规则。 |
| -l, --list | 列出所有可用的数据库,然后退出。 | - |
| -v, --set, --variable=NAME=VALUE | 设置gsql变量NAME为VALUE。 变量的示例和详细说明请参见变量。 | - |
| -X, --no-gsqlrc | 不读取启动文件(系统范围的gsqlrc或者用户的~/.gsqlrc都不读取)。 说明: 启动文件默认为~/.gsqlrc,或通过PSQLRC环境变量指定。 | - |
| -1 ("one"), --single-transaction | 当gsql使用-f选项执行脚本时,会在脚本的开头和结尾分别加上START TRANSACTION/COMMIT用以把整个脚本当作一个事务执行。这将保证该脚本完全执行成功,或者脚本无效。 说明: 如果脚本中已经使用了START TRANSACTION,COMMIT,ROLLBACK,则该选项无效。 | - |
| -?, --help | 显示关于gsql命令行参数的帮助信息然后退出。 | - |
| -V, --version | 打印gsql版本信息然后退出。 | - |
| 参数 | 参数说明 | 取值范围 |
|---|---|---|
| -a, --echo-all | 在读取行时向标准输出打印所有内容。 须知: 使用此参数可能会暴露部分SQL语句中的敏感信息,如创建用户语句中的password信息等,请谨慎使用。 | - |
| -e, --echo-queries | 把所有发送给服务器的查询同时回显到标准输出。 须知: 使用此参数可能会暴露部分SQL语句中的敏感信息,如创建用户语句中的password信息等,请谨慎使用。 | - |
| -E, --echo-hidden | 回显由\d和其他反斜杠命令生成的实际查询。 | - |
| -k, --with-key=KEY | 使用gsql对导入的加密文件进行解密。 须知:
| - |
| -L, --log-file=FILENAME | 除了正常的输出源之外,把所有查询输出记录到文件FILENAME中。 须知:
| 绝对路径或相对路径,且满足操作系统路径命名规则。 |
| -m, --maintenance | 允许在两阶段事务恢复期间连接数据库。 说明: 该选项是一个开发选项,禁止用户使用,只限专业技术人员使用,功能是:使用该选项时,gsql可以连接到备机,用于校验主备机数据的一致性。 | - |
| -n, --no-libedit | 关闭命令行编辑。 | - |
| -o, --output=FILENAME | 将所有查询输出重定向到文件FILENAME。 | 绝对路径或相对路径,且满足操作系统路径命名规则。 |
| -q, --quiet | 安静模式,执行时不会打印出额外信息。 | 缺省时gsql将打印许多其他输出信息。 |
| -s, --single-step | 单步模式运行。意味着每个查询在发往服务器之前都要提示用户,用这个选项也可以取消执行。此选项主要用于调试脚本。 须知: 使用此参数可能会暴露部分SQL语句中的敏感信息,如创建用户语句中的password信息等,请谨慎使用。 | - |
| -S, --single-line | 单行运行模式,这时每个命令都将由换行符结束,像分号那样。 | - |
| -C,-C1, --enable-client-encryption=1 | 当使用-C参数连接本地数据库或者连接远程数据库时,可通过该选项打开密态数据库开关,此开关为密态等值查询基本能力开关。 | - |
| 参数 | 参数说明 | 取值范围 |
|---|---|---|
| -A, --no-align | 切换为非对齐输出模式。 | 缺省为对齐输出模式。 |
| -F, --field-separator=STRING | 设置域分隔符(默认为“|”)。 | - |
| -H, --html | 指定HTML格式输出。 | - |
| -P, --pset=VAR[=ARG] | 在命令行上以\pset的风格设置打印选项。 说明: 这里必须用等号而不是空格分隔名称和值。例如,把输出格式设置为LaTeX,可以键入-P format=latex | - |
| -R, --record-separator=STRING | 设置记录分隔符。 | - |
| -r | 开启在客户端操作中可以进行编辑的模式。 | 缺省为关闭。 |
| -t, --tuples-only | 只打印行。 | - |
| -T, --table-attr=TEXT | 允许声明放在HTML table标签里的选项。 使用时请搭配参数“-H,--html”,指定为HTML格式输出。 | - |
| -x, --expanded | 打开扩展表格式模式。 | - |
| -z, --field-separator-zero | 设置非对齐输出模式的域分隔符为空。 使用时请搭配参数“-A, --no-align”,指定为非对齐输出模式。 | - |
| -0, --record-separator-zero | 设置非对齐输出模式的记录分隔符为空。 使用时请搭配参数“-A, --no-align”,指定为非对齐输出模式。 | - |
| -2, --pipeline | 使用管道传输密码,禁止在终端使用,必须和-c或者-f参数一起使用。 | - |
| -g, | 打印来自文件的所有SQL。 | - |
| 参数 | 参数说明 | 取值范围 |
|---|---|---|
| -h, --host=HOSTNAME | 指定正在运行服务器的主机名、Unix域套接字的路径、或者域名。接受以“,”分隔的字符串来指定多个主机地址,支持指定多个主机地址。 当指定多个主机地址时,默认情况下会自动选择主节点地址进行连接。可通过设置PGTARGETSESSIONATTRS环境变量的值来选择连接到不同类型的节点,变量与节点类型对应的关系如下: PGTARGETSESSIONATTRS环境变量的值--选择连接的节点类型 read-write--可读写的节点 read-only--只读节点 primary或者不设定--主节点 standby--备节点 prefer-standby--首选备节点,没有备节点则转为any any--不进行角色检查 说明: 当-h只指定一个域名,但是该域名对应多个IP时,无法触发自动选主功能。 | 如果省略主机名,gsql将通过Unix域套接字与本地主机的服务器相连,或者在没有Unix域套接字的机器上,通过TCP/IP与localhost连接。 |
| -p, --port=PORT | 指定数据库服务器的端口号。可以配置一个或多个,当配置一个时,所有的主机地址都使用同一个端口连接;当配置多个时,顺序与主机地址顺序相同,个数必须与主机地址数相等,当不相等时会报错。 可以通过port参数修改默认端口号。 | 默认端口可通过编译参数来指定,不指定的话默认为5432。 |
| -U, --username=USERNAME | 指定连接数据库的用户。 说明:
| 字符串,默认使用与当前操作系统用户同名的用户。 |
| -W, --password=PASSWORD | 当使用-U参数连接本地数据库或者连接远端数据库时,可通过该选项指定密码。 说明:
| 字符串。 |