更新时间:2026-10-21 GMT+08:00
分享

双数据库实例容灾控制函数

  • gs_streaming_dr_in_switchover()

    描述:基于流式复制的异地容灾解决方案中主数据库实例在执行计划内switchover过程中截断业务的接口。

    返回值类型:Boolean,表明此次业务截断是否成功,是否可以正常进行switchover流程。

  • gs_get_gaussstor_params_info()

    描述:查询SDK生效的配置参数。

    返回值类型:record

    表1 gs_get_gaussstor_params_info参数说明

    参数类型

    参数名

    类型

    描述

    输出参数

    name

    text

    参数名称。

    输出参数

    value

    text

    参数值。

    示例:
    gaussdb=#  SELECT * FROM gs_get_gaussstor_params_info();
               name            |        value
    ---------------------------+---------------------
     auth_type                 | none
     log_level                 | LOG
     local_cms_url             | 10.243.109.177:8012
     remote_cms_crl            | 10.247.173.78:8012
     local_vfs_name            | vfs1
     remote_vfs_name           | vfs1
     hash_check                | false
     local_client_ip           | 127.0.0.1
     remote_client_ip          | 127.0.0.1
     recycle_ttl               | 5
     run_mode                  | SERIAL
    (11 rows)
  • gs_get_gaussstor_stats()

    描述:查询GaussStor相关的统计信息。

    返回值类型:record

    表2 gs_get_gaussstor_stats参数说明

    参数类型

    参数名

    类型

    描述

    输出参数

    connected

    boolean

    是否已对接GaussStor。

    输出参数

    VFS

    text

    是否已挂载VFS以及VFS名称。

    例如,true, gs_vfs1表示已经挂载了名称为gs_vfs1的vfs。

    输出参数

    flush_lsn

    text

    已经写到GaussStor的Xlog位置。

    备节点和容灾数据库节点该项输出为0。

    输出参数

    sync_commit

    boolean

    是否同步写GaussStor。

    输出参数

    recycle_lsn

    text

    GaussStor里可回收的Xlog位置。

    输出参数

    commit_lsn

    text

    数据库实例内已达成一致的LSN。

    输出参数

    min_valid_lsn

    text

    GaussStor中有效日志的最小LSN,默认值为0,代表无效值。

    可在GaussStor日志不连续等场景下,用于判断灾备failover是否存在RPO>0的可能,如果灾备本地LSN 比min_valid_lsn还小,则RPO>0。

    输出参数

    term

    text

    当前控制文件的任期编号,默认值为0。当创建了新的stream file,term值加1。

    输出参数

    flags

    text

    标记字段,用于主备数据库实例之间的一些信息传递。

    例如:容灾switchover,主降备完成。

    输出参数

    system_identifier

    text

    数据库系统标识符。

    示例:

    gaussdb=#  SELECT * FROM gs_get_gaussstor_stats();
     connected |      VFS      |     flush_lsn     | sync_commit |    recycle_lsn    |    commit_lsn     |   min_valid_lsn   | term | flags |  system_identifier   
    -----------+---------------+-------------------+-------------+-------------------+-------------------+-------------------+------+-------+----------------------
     t         | true,vfstest1 | 00000000/00000000 | f           | 00000000/00000000 | 00000001/8C66A0B8 | 00000000/00000000 | 5    | 0     | 18020659177948799904
    (1 row)
  • gs_check_and_change_gaussstor_mode(op_type, gsstor_cms_url_list, drop_vfs_flag)

    描述:用于命令DN对接或者解除GaussStor,调用该函数需要具有sysadmin权限,或在运维模式下具有运维管理员权限。

    返回值类型:boolean

    表3 gs_check_and_change_gaussstor_mode参数说明

    参数类型

    参数名

    类型

    描述

    输入参数

    op_type

    boolean

    标识是对接GaussStor,还是解除GaussStor。

    • true为对接GaussStor。
    • false为解除GaussStor。

    输入参数

    gsstor_cms_url_list

    text

    本地GaussStor和远端GaussStor的url信息,两个url之间用+连接。

    输入参数

    drop_vfs_flag

    boolean

    标识是否需要在解除GaussStor时删除VFS,只有第一个入参为false时才有效。只有主DN会处理该标记。

    输出参数

    result

    boolean

    命令执行成功或者失败。

    示例:

    --对接:
    gaussdb=# SELECT * FROM gs_check_and_change_gaussstor_mode(true,'xxx.xxx.xxx.xxx:xxxx+xxx.xxx.xxx.xxx:xxxx');
     result
    --------
     t
    (1 row)
    
    --解除:
    gaussdb=# SELECT * FROM gs_check_and_change_gaussstor_mode(false, '');
     result
    --------
     t
    (1 row)
    
    gaussdb=# SELECT * FROM gs_check_and_change_gaussstor_mode(false, '', true);
     result
    --------
     t
    (1 row)
  • gs_get_gaussstor_perf_stat_info()

    描述:用于获取GaussStor客户端的perf统计信息,包括异步读写GaussStor的平均时延、最小时延、最大时延、请求数量、GaussStor客户端和GaussStor间的网络延迟。

    返回值类型:record。

    表4 gs_get_gaussstor_perf_stat_info参数说明

    参数类型

    参数名

    类型

    描述

    输出参数

    type

    text

    统计的事件点位名称:
    • gaussstor_file_async_write_latest:最新统计周期的异步写时延信息。
    • gaussstor_file_async_read_latest:最新统计周期的异步读时延信息。
    • gaussstor_io_comm_latest:最新统计周期的网络通信时延信息。
    • gaussstor_file_async_write_all:所有统计周期的异步写时延信息。
    • gaussstor_file_async_read_all:所有统计周期的异步读时延信息。
    • gaussstor_io_comm_all:所有统计周期的网络通信时延信息。

    输出参数

    avg_time

    bigint

    统计事件的平均等待时间(单位:微秒)。

    输出参数

    min_time

    bigint

    统计事件的最小等待时间(单位:微秒),显示-1代表无效值。

    输出参数

    max_time

    bigint

    统计事件的最大等待时间(单位:微秒)。

    输出参数

    count

    bigint

    统计事件的等待次数。

    示例

    gaussdb=# SELECT * FROM gs_get_gaussstor_perf_stat_info();
                   type                | avg_time | min_time | max_time | count
    -----------------------------------+----------+----------+----------+-------
     gaussstor_file_async_write_latest |   759683 |   363338 |  7130293 |  1274
     gaussstor_file_async_read_latest  |        0 |        0 |        0 |     0
     gaussstor_io_comm_latest          |      119 |       69 |     6431 |  1274
     gaussstor_file_async_write_all    |      762 |      362 |     7130 |  1276
     gaussstor_file_async_read_all     |        0 |         |        0 |     0
     gaussstor_io_comm_all             |      120 |       69 |     6431 |  1277
    (6 rows)
  • gs_set_dr_dest_name()

    描述:用于配置日志发送端数据库实例的所有日志接收端数据库实例ID,入参为与日志发送端数据库实例直接连接的所有日志接收端数据库实例ID拼接成的字符串,并以','作为间隔符;设置成功返回t,否则返回f。容灾流程中会自动设置,不建议用户进行修改。

    入参类型:text,当入参为0时表示未配置日志接收端数据库实例ID信息。

    日志接收端数据库实例ID不可为“invalid_cluster_uuid”,且字符长度不可超过36位。

    返回值类型:boolean

    示例:

    gaussdb=# SELECT * FROM gs_set_dr_dest_name('cluster1,cluster2');
     gs_set_dr_dest_name
    ---------------------
     t
    (1 row)
  • gs_get_dr_dest_name()

    描述:用于查看通过gs_set_dr_dest_name配置的所有日志接收端数据库实例ID信息。

    返回值类型:text,返回值为0时表示配置的日志接收端数据库实例ID信息为空。

    示例:

    gaussdb=# SELECT * FROM gs_get_dr_dest_name();
     gs_get_dr_dest_name
    ---------------------
     cluster1,cluster2
    (1 row)
  • gs_set_hadr_link_info()

    描述:用于容灾链路信息的设置,入参是JSON格式的text;设置成功返回"success",失败则返回"failed"。容灾流程中会自动设置,不建议用户进行修改。

    返回值类型:text

    表5 gs_set_hadr_link_info参数说明

    参数名

    类型

    描述

    meta_version

    string

    容灾链路JSON格式的版本号。

    version

    string

    容灾链路信息的版本号。

    replication_info

    string

    存放容灾链路信息,包含多条链路信息的JSON数组。

    dest_name

    string

    灾备数据库实例ID。

    dest_type

    string

    控制容灾链路的类型。

    取值类型:枚举值

    取值范围:physical_standby_cluster/logical_standby_cluster/gaussstor

    默认值:physical_standby_cluster

    mode

    string

    控制容灾链路日志同步的模式。

    取值类型:枚举值

    取值范围:
    • sync:该链路同步等待日志接收端备机持久化redo日志到磁盘,确保无数据丢失,会影响主机性能。
    • semisync:该链路优先同步传输,若发生断链超时或RPO异常时则降级为异步。
    • async:异步传输,优先主机性能。

    默认值:async

    net_timeout

    string

    半同步模式下超时阈值。

    取值范围:[0,max]

    取值单位:秒

    默认值:0

    rpo_threshold

    int

    半同步模式下RPO阈值。

    取值范围:[0,max]

    取值单位:秒

    默认值:0

    compression

    string

    控制是否打开压缩。

    取值类型:枚举值

    取值范围:enable/disable

    默认值:enable

    compression_algo_setting

    string

    控制压缩算法,当前不支持修改,此参数使用默认值"lz4,1"。

    replication_rate_limit

    int/string

    控制容灾链路的限制速度,带单位:K、M、G,例如:1024K、1M、10M、2048G。

    取值单位:Byte

    取值范围:[-1、0、1MB ~ 2TB]
    • 整型:-1、0、1048576 ~ 2199023255552
    • 字符串:-1、0、1048576 ~ 2199023255552

    默认值:-1

    rate_burst

    int

    控制允许单次发送的最大数据包大小,为replication_rate_limit的倍数关系。

    取值范围:[1, 5]

    默认值:2

    conn_info

    string

    包含连接串和访问权限信息。详见下面示例的具体内容。

    示例:

    gaussdb=# SELECT gs_set_hadr_link_info('{"meta_version": "1", "version": "1", "replication_info": [{"dest_name": "clusterb", "dest_type": "physical_standby_cluster", "mode": "async", "net_timeout": 0, "rpo_threshold": 0, "compression": "enable", "compression_algo_setting": "lz4,1", "replication_rate_limit": -1, "rate_burst": 2, "conn_info": {"shards": {"replconninfo": {"shard_1": {"localinfo": {"dn_6001": {"h": "127.0.0.1", "p": 20024, "hbp": 20028}, "dn_6002": {"h": "127.0.0.1", "p": 20032, "hbp": 20036}, "dn_6003": {"h": "127.0.0.1", "p": 20040, "hbp": 20044}}, "remoteinfo": [{"h": "127.0.0.1", "p": 20048, "hbp": 20052}, {"h": "127.0.0.1", "p": 20056, "hbp": 20060}, {"h": "127.0.0.1", "p": 20064, "hbp": 20068}]}}, "hba": [{"type": "host", "database": "all", "user": "all", "method": "trust"}, {"type": "host", "database": "replication", "user": "all", "method": "sha256"}]}}}]} ');
     gs_set_hadr_link_info 
    -----------------------
     success
    (1 row)
  • gs_get_hadr_link_info()

    描述:用于查看当前所有容灾链路的信息。

    返回值类型:record

    示例:

    gaussdb=# SELECT * FROM gs_get_hadr_link_info();
    -[ RECORD 1 ]------------+-----------------------------------------------------------------------------------------------------------------------------
    dest_name                | clusterb
    dest_type                | physical_standby_cluster
    mode                     | semisync
    net_timeout              | 60
    rpo_threshold            | 10
    compression              | enable
    compression_algo_setting | lz4,1
    replication_rate_limit   | 0
    rate_burst               | 2
    replconninfo             | localhost=127.0.0.1 localport=20001 localheartbeatport=20005 remotehost=127.0.0.1 remoteport=20025 remoteheartbeatport=20029
                             | localhost=127.0.0.1 localport=20001 localheartbeatport=20005 remotehost=127.0.0.1 remoteport=20033 remoteheartbeatport=20037
                             | localhost=127.0.0.1 localport=20001 localheartbeatport=20005 remotehost=127.0.0.1 remoteport=20041 remoteheartbeatport=20045
                             | 
    hba                      | local all all trust
                             | local all all trust
                             | local all all trust
                             | 

  • gs_get_hadr_link_version()

    描述:用于获取容灾链路信息的版本号。

    返回值类型:int8

    示例

    gaussdb=# SELECT * FROM gs_get_hadr_link_version();
     link_info_version 
    -------------------
                    100
    (1 row)

    • gs_get_hadr_sync_status()

    描述:用于查看当前所有容灾链路日志同步的状态信息。

    返回值类型:record

    表6 gs_get_hadr_sync_status参数说明

    参数类型

    参数名

    类型

    描述

    输出参数

    dest_name

    text

    容灾链路日志接收端数据库实例ID。

    输出参数

    sync_state

    text

    当前容灾链路实际的同步状态。

    输出参数

    current_rpo

    int

    当前容灾链路的RPO时间(单位:秒)。

    输出参数

    sender_sent_location

    text

    容灾链路日志发送端发送日志位置。

    输出参数

    sender_write_location

    text

    容灾链路日志发送端写入到文件系统的日志位置。

    输出参数

    sender_flush_location

    text

    容灾链路日志发送端flush磁盘的日志位置。

    输出参数

    sender_replay_location

    text

    容灾链路日志发送端回放日志位置。

    输出参数

    receiver_received_location

    text

    容灾链路日志接收端接收日志位置。

    输出参数

    receiver_flush_location

    text

    容灾链路日志接收端日志flush磁盘位置。

    输出参数

    last_disconnect_time

    timestamptz

    最近一次容灾链路断链的时间。

    输出参数

    last_upgrade_to_sync_time

    timestamptz

    半同步模式下,最近一次升级为同步模式的时间。

    输出参数

    last_downgrade_to_async_time

    timestamptz

    半同步模式下,最近一次降级为异步模式的时间。

    输出参数

    mode

    text

    容灾链路日志同步模式的配置值。

    输出参数

    net_timeout

    text

    容灾链路半同步模式的超时阈值。

    输出参数

    rpo_threshold

    text

    容灾链路半同步模式的RPO阈值。

    示例

    gaussdb=# SELECT * FROM gs_get_hadr_sync_status();
    -[ RECORD 1 ]----------------+------------------------------
    dest_name                    | clusterb
    sync_state                   | Sync
    current_rpo                  | 0
    sender_sent_location         | 0/11380B20
    sender_write_location        | 0/11380B20
    sender_flush_location        | 0/11380B20
    sender_replay_location       | 0/11380B20
    receiver_received_location   | 0/11380B20
    receiver_flush_location      | 0/11380B20
    last_disconnect_time         | 2026-01-15 20:35:42.18516+08
    last_upgrade_to_sync_time    | 2026-01-15 21:29:55.147578+08
    last_downgrade_to_async_time | 2026-01-15 20:36:42.187545+08
    mode                         | semisync
    net_timeout                  | 60
    rpo_threshold                | 10
  • gs_stat_get_replication_limit()

    描述:用于查询当前数据库实例所有链路的限流配置参数值,最近1s、最近5s和最近60s的平均带宽使用情况。

    返回值类型:record。

    表7 gs_stat_get_replication_limit参数说明

    参数类型

    参数名

    类型

    描述

    输出参数

    dest_name

    text

    该发送链路的目标数据库实例名称。

    输出参数

    replication_rate_limit

    text

    该链路限流配置的带宽上限。

    输出参数

    rate_burst

    text

    该链路限流配置的突发流量为带宽上限的倍数,允许瞬时产生的最大流量。

    输出参数

    current_usage

    text

    最近1s链路使用的平均带宽统计,单位Byte/s。

    输出参数

    average_usage_5s

    text

    最近5s链路使用的平均带宽统计,单位Byte/s。

    输出参数

    average_usage_60s

    text

    最近60s链路使用的平均带宽统计,单位Byte/s。

    示例

    gaussdb=# SELECT * FROM gs_stat_get_replication_limit();
    -[ RECORD 1 ]----------+---------
    dest_name              | clusterb
    replication_rate_limit | -1
    rate_burst             | 2
    current_usage          | 0
    average_usage_5s       | 0
    average_usage_60s      | 0
    -[ RECORD 2 ]----------+---------
    dest_name              | clusterc
    replication_rate_limit | -1
    rate_burst             | 2
    current_usage          | 0
    average_usage_5s       | 0
    average_usage_60s      | 0

相关文档