gs_ctl

    gs_ctl工具由操作系统用户omm执行。

    • 启动、停止、重启openGauss节点。
    • 在不停止数据库的情况下,重新加载配置文件(postgresql.conf,pg_hba.conf)。
    • 主备切换、主备状态查询、重建和重建状态查询。

    参数说明

    gs_ctl参数可分为如下几类:

    • option参数,详细请参见。
    • start和restart模式的参数,详细请参见表3
    • stop和restart模式的参数,详细请参见。
    • switchover模式的参数,详细请参见表5
    • build参数,详细请参见。
    • restore参数,详细请参见表7

      表 1 option参数

    表 2 公共参数

    参数

    参数说明

    取值范围

    -D, –pgdata=DATADIR

    指定数据目录的位置。

    DATADIR的取值必须为有效的数据目录。

    -s, –silent

    仅打印错误,没有参考消息。

    -

    -t, –timeout=SECS

    取值范围:整型(秒)。

    默认值:等待数据库启动、关闭或者主备切换完成:60秒。

    -V , –version

    打印gs_ctl的版本信息然后退出。

    -

    -M

    -M后面需要跟SERVERMODE参数,表示在启动时指定数据库的启动模式。

    说明:

    当前主机处于一主零备,或单机环境时,不支持-M参数。

    SERVERMODE的取值范围:

    • primary:本端以主机模式启动。
    • pending:本端处于等待状态,等待提升为主机或者备机。

    -T

    -T 后面跟term,升主命令时会用此term作为主机term,build时会连接大于等于此term的主机进行build

    term的取值范围,无符号整型。

    -d

    打印更多调试信息

    无参数

    -P PASSWORD

    与-U参数配合使用,指定连接本地数据库的用户密码。

    说明:

    当省略-U参数,且认证方法为trust时,-P参数无效。

    -

    -U USERNAME

    指定连接数据库的用户。此参数只能与notify、query、failover、switchover和querybuild参数配合使用。

    对于域用户,使用DOMAIN\username格式。

    取值范围:openGauss中存在的用户。

    默认值:省略此参数则使用与当前操作系统用户同名的用户。

    -?, –help

    显示关于gs_ctl命令行参数的帮助信息。

    -

    表 3 start或restart共有参数

    表 4 stop和restart共有参数

    参数

    参数说明

    取值范围

    声明关闭模式。

    mode的取值:

    • fast:不等待客户端中断连接,所有活跃事务都被回滚并且客户端都被强制断开,然后服务器将被关闭。
    • immediate:强行关闭,在下次重新启动的时候将导致故障恢复。

    默认值:fast

    表 5 switchover参数

    表 6 build参数

    参数

    参数说明

    取值范围

    -b MODE

    指定重建备机的模式。

    mode的取值:

    ● full:通过全量镜像的方式重新同步 主机的数据目录。

    ● incremental:通过解析Xlog日志获 取主备机差异的数据进行增量修复备机。

    警告 ● 增量重建适用于主备双主等因日志 造成的不一致场景。

    ● 增量重建不适用于一主一备并且没有开启最大高可用的场景,此种场景下需要使用全量重建或者开启最大高可用后再进行增量重建。

    ● 备机数据文件损坏、数据目录丢失 等故障通过增量重建的方式无法修复,此时可通过全量重建的方式重 新修复备机。

    ● auto(不指定):先增量,增量失败后进行会自动进行一次全量重建。

    默认值:auto

    -r, –recvtimeout=INTERVAL

    指定重建过程中备机日志接收等待主机响应的超时时间。

    取值范围:整型(秒)。

    默认值:120秒

    提示:超时时间需根据业务繁忙程度设置,业务繁忙等待主机的响应时间需加长,建议超时时间=checkpoint的执行时间+1min。

    -q

    重建结束后,是否自动重启。

    指定参数场合,不自动重启。

    未指定场合,自动重启。

    无参数

    表 7 restore参数

    表 8 query参数

    参数

    参数说明

    取值范围

    -L

    查询lsn并展示最大长度。

    无参数