Statistics Information Functions
Statistics information functions are divided into the following two categories: functions that access a database by using the OID of each table or index in the database to mark the database for which statistics are generated; functions that access a server identified by the server process ID whose value ranges from 1 to the number of currently active servers.
- pg_stat_get_db_conflict_tablespace(oid)
Description: Specifies the number of queries canceled due to a conflict between the restored tablespace and the deleted tablespace in the database.
Return type: bigint
- pg_control_group_config()
Description: Prints Cgroup configurations on the current node. Only users with the SYSADMIN permission can execute this function.
Return type: record
- pg_stat_get_db_stat_reset_time(oid)
Description: Specifies the most recent time when database statistics were reset. It is initialized to the system time during the first connection to each database. The reset time is updated when you call pg_stat_reset in the database and execute pg_stat_reset_single_table_counters on any table or index in the database.
Return type: timestamptz
- pg_stat_get_function_total_time(oid)
Description: Specifies the total wall clock time spent in the function, in microseconds. The time spent on this function calling other functions is included.
Return type: bigint
- pg_stat_get_xact_tuples_returned(oid)
Description: Specifies the number of rows read through sequential scans when parameters are in a table in the current transaction or the number of index entries returned when parameters are in an index.
Return type: bigint
- pg_stat_get_xact_numscans(oid)
Description: Specifies the number of sequential scans performed when parameters are in a table in the current transaction or the number of index scans performed when parameters are in an index.
Return type: bigint
- pg_stat_get_xact_blocks_fetched(oid)
Description: Specifies the number of disk block fetch requests for a table or an index in the current transaction.
Return type: bigint
- pg_stat_get_xact_blocks_hit(oid)
Description: Specifies the number of disk block fetch requests for a table or an index found in cache in the current transaction.
Return type: bigint
- pg_stat_get_xact_function_calls(oid)
Description: Specifies the number of times the function is called in the current transaction.
Return type: bigint
- pg_stat_get_xact_function_self_time(oid)
Description: Specifies the time spent on this function in the current transaction, excluding the time spent on this function internally calling other functions.
Return type: bigint
- pg_stat_get_xact_function_total_time(oid)
Description: Specifies the total wall clock time spent on this function in the current transaction, in microseconds. The time spent on other function call inside this function is included.
Return type: bigint
- pg_lock_status()
Description: Queries information about locks held by open transactions. All users can execute this function.
Return type: For details, see the return result of PG_LOCKS, which is obtained by querying this function.
- pg_stat_get_wal_senders()
Description: Queries walsender information on the primary node.
Return type: setofrecord
The following table describes return columns.
Table 1 Return columns Column
Type
Description
pid
bigint
Thread ID of the WAL sender.
sender_pid
integer
Lightweight thread ID of the WAL sender.
local_role
text
Type of the primary node.
peer_role
text
Type of the standby node.
peer_state
text
Status of the standby node.
state
text
Status of the WAL sender.
catchup_start
timestamp with time zone
Startup time of a catchup task.
catchup_end
timestamp with time zone
End time of a catchup task.
sender_sent_location
text
Sending position of the primary node.
sender_write_location
text
Writing position of the primary node.
sender_flush_location
text
Flushing position of the primary node.
sender_replay_location
text
Redo position of the primary node.
receiver_received_location
text
Receiving position of the standby node.
receiver_write_location
text
Writing position of the standby node.
receiver_flush_location
text
Flushing location of the standby node.
receiver_replay_location
text
Redo position of the standby node.
sync_percent
text
Synchronization percentage.
sync_state
text
Synchronization status.
sync_group
text
Group to which the synchronous replication belongs.
sync_priority
text
Priority of synchronous replication.
sync_most_available
text
Maximum availability mode.
channel
text
Channel information of the WAL sender.
- pgxc_get_senders_catchup_time()
Description: Queries whether a standby DN in the log catchup state exists in the CN instance query cluster and details about the log catchup state.
Return type: setofrecord
- pg_stat_get_stream_replications()
Description: Queries the primary-standby replication status.
Return type: setofrecord
The following table describes return values.
Table 2 Return values Return Parameter
Type
Description
local_role
text
Local role.
static_connections
integer
Connection statistics.
db_state
text
Database status.
detail_information
text
Detailed information.
- pg_stat_get_db_numbackends(oid)
Description: Specifies the number of active server processes in a database.
Return type: integer
- pg_stat_get_db_xact_commit(oid)
Description: Specifies the number of transactions committed in a database.
Return type: bigint
- pg_stat_get_db_xact_rollback(oid)
Description: Specifies the number of transactions rolled back in a database.
Return type: bigint
- pg_stat_get_db_blocks_fetched(oid)
Description: Specifies the number of disk block fetch requests in a database.
Return type: bigint
- pg_stat_get_db_blocks_hit(oid)
Description: Specifies the number of disk block fetch requests found in cache in a database.
Return type: bigint
- pg_stat_get_db_tuples_returned(oid)
Description: Specifies the number of tuples returned for a database.
Return type: bigint
- pg_stat_get_db_tuples_fetched(oid)
Description: Specifies the number of tuples fetched for a database.
Return type: bigint
- pg_stat_get_db_tuples_inserted(oid)
Description: Specifies the number of tuples inserted into a database.
Return type: bigint
- pg_stat_get_db_tuples_updated(oid)
Description: Specifies the number of tuples updated in a database.
Return type: bigint
- pg_stat_get_db_tuples_deleted(oid)
Description: Specifies the number of tuples deleted from a database.
Return type: bigint
- pg_stat_get_db_conflict_lock(oid)
Description: Specifies the number of lock conflicts in a database.
Return type: bigint
- pg_stat_get_db_deadlocks(oid)
Description: Specifies the number of deadlocks in a database.
Return type: bigint
- pg_stat_get_numscans(oid)
Description: Specifies the number of sequential row scans done if parameters are in a table, or the number of index rows if parameters are in an index.
Return type: bigint
- pg_stat_get_role_name(oid)
Description: Obtains the username based on the user OID. Only users with the SYSADMIN and MONADMIN permissions can access the information.
Return type: text
Example:
openGauss=# select pg_stat_get_role_name(10); pg_stat_get_role_name ----------------------- aabbcc (1 row)
- pg_stat_get_tuples_returned(oid)
Description: Specifies the number of sequential rows read by sequential scans if parameters are in a table, or the number of index rows if parameters are in an index.
Return type: bigint
- pg_stat_get_tuples_fetched(oid)
Description: Specifies the number of table rows fetched by bitmap scans if parameters are in a table, or the number of table rows fetched by simple index scans if parameters are in an index.
Return type: bigint
- pg_stat_get_tuples_inserted(oid)
Description: Specifies the number of rows inserted into a table.
Return type: bigint
- pg_stat_get_tuples_updated(oid)
Description: Specifies the number of rows updated in a table.
Return type: bigint
- pg_stat_get_tuples_deleted(oid)
Description: Specifies the number of rows deleted from a table.
Return type: bigint
- pg_stat_get_tuples_changed(oid)
Description: Specifies the total number of inserted, updated, and deleted rows after a table was last analyzed or autoanalyzed.
Return type: bigint
- pg_stat_get_tuples_hot_updated(oid)
Description: Specifies the number of rows hot updated in a table.
Return type: bigint
- pg_stat_get_live_tuples(oid)
Description: Specifies the number of live rows in a table.
Return type: bigint
- pg_stat_get_dead_tuples(oid)
Description: Specifies the number of dead rows in a table.
Return type: bigint
- pg_stat_get_blocks_fetched(oid)
Description: Specifies the number of disk block fetch requests for a table or an index.
Return type: bigint
- pg_stat_get_blocks_hit(oid)
Description: Specifies the number of disk block requests found in cache for a table or an index.
Return type: bigint
- pg_stat_get_partition_tuples_inserted(oid)
Description: Specifies the number of rows inserted into the corresponding table partition.
Return type: bigint
- pg_stat_get_partition_tuples_updated(oid)
Description: Specifies the number of rows updated in the corresponding table partition.
Return type: bigint
- pg_stat_get_partition_tuples_deleted(oid)
Description: Specifies the number of rows deleted from the corresponding table partition.
Return type: bigint
- pg_stat_get_partition_tuples_changed(oid)
Description: Specifies the total number of inserted, updated, and deleted rows after a table partition was last analyzed or autoanalyzed.
Return type: bigint
- pg_stat_get_partition_live_tuples(oid)
Description: Specifies the number of live rows in a table partition.
Return type: bigint
- pg_stat_get_partition_dead_tuples(oid)
Description: Specifies the number of dead rows in a table partition.
Return type: bigint
- pg_stat_get_xact_tuples_fetched(oid)
Description: Specifies the number of tuple rows scanned in a transaction.
Return type: bigint
- pg_stat_get_xact_tuples_inserted(oid)
Description: Specifies the number of tuples inserted into the active subtransactions related to a table.
Return type: bigint
- pg_stat_get_xact_tuples_deleted(oid)
Description: Specifies the number of tuples deleted from the active subtransactions related to a table.
Return type: bigint
- pg_stat_get_xact_tuples_hot_updated(oid)
Description: Specifies the number of tuples hot updated in the active subtransactions related to a table.
Return type: bigint
- pg_stat_get_xact_tuples_updated(oid)
Description: Specifies the number of tuples updated in the active subtransactions related to a table.
Return type: bigint
- pg_stat_get_xact_partition_tuples_inserted(oid)
Description: Specifies the number of tuples inserted into the active subtransactions related to a table partition.
Return type: bigint
- pg_stat_get_xact_partition_tuples_deleted(oid)
Description: Specifies the number of tuples deleted from the active subtransactions related to a table partition.
Return type: bigint
- pg_stat_get_xact_partition_tuples_hot_updated(oid)
Description: Specifies the number of tuples hot updated in the active subtransactions related to a table partition.
Return type: bigint
- pg_stat_get_xact_partition_tuples_updated(oid)
Description: Specifies the number of tuples updated in the active subtransactions related to a table partition.
Return type: bigint
- pg_stat_get_last_vacuum_time(oid)
Description: Specifies the most recent time when the user manually cleared a table or when the autovacuum thread was started to clear a table.
Return type: timestamptz
- pg_stat_get_last_autovacuum_time(oid)
Description: Specifies the most recent time when the autovacuum daemon was started to clear a table.
Return type: timestamptz
- pg_stat_get_vacuum_count(oid)
Description: Specifies the number of times a table is manually cleared by the user.
Return type: bigint
- pg_stat_get_autovacuum_count(oid)
Description: Specifies the number of times the autovacuum daemon is started to clear a table.
Return type: bigint
- pg_stat_get_last_analyze_time(oid)
Description: Specifies the most recent time when the user manually analyzed a table or when the autovacuum thread was started to analyze a table.
Return type: timestamptz
- pg_stat_get_last_autoanalyze_time(oid)
Description: Specifies the most recent time when the autovacuum daemon was started to analyze a table.
Return type: timestamptz
- pg_stat_get_analyze_count(oid)
Description: Specifies the number of times a table is manually analyzed by the user.
Return type: bigint
- pg_stat_get_autoanalyze_count(oid)
Description: Specifies the number of times a table is analyzed by the autovacuum daemon.
Return type: bigint
- pg_total_autovac_tuples(bool)
Description: Returns tuple records related to the total autovac, such as nodename, nspname, relname, and tuple IUDs. The input parameter specifies whether to query the relation information.
Return type: setofrecord
The following table describes return parameters.
Table 3 Description Return Parameter
Type
Description
nodename
name
Node name.
nspname
name
Name of a namespace.
relname
name
Name of an object, such as a table, an index, or a view.
partname
name
Partition name.
n_dead_tuples
bigint
Number of dead rows in a table partition.
n_live_tuples
bigint
Number of live rows in a table partition.
changes_since_analyze
bigint
Number of changes generated by ANALYZE.
- pg_autovac_status(oid)
Description: Returns autovac information, such as nodename, nspname, relname, analyze, vacuum, thresholds for the ANALYZE and VACUUM operations, and the number of analyzed or vacuumed tuples. Only users with the SYSADMIN permission can use this function.
Return type: setofrecord
The following table describes return parameters.
Table 4 Return parameters Return Parameter
Type
Description
nspname
text
Name of a namespace.
relname
text
Name of an object, such as a table, an index, or a view.
nodename
text
Node name.
doanalyze
Boolean
Specifies whether to execute ANALYZE.
anltuples
bigint
Number of ANALYZE tuples.
anlthresh
bigint
ANALYZE threshold.
dovacuum
Boolean
Specifies whether to execute VACUUM.
vactuples
bigint
Number of VACUUM tuples.
vacthresh
bigint
VACUUM threshold.
- pg_autovac_timeout(oid)
Description: Returns the number of consecutive timeouts during the autovac operation on a table. If the table information is invalid or the node information is abnormal, NULL is returned.
Return type: bigint
- pg_autovac_coordinator(oid)
Description: Returns the name of the CN performing the autovac operation on a table. If the table information is invalid or the node information is abnormal, NULL is returned.
Return type: text
- pg_stat_get_last_data_changed_time(oid)
Description: Returns the time when INSERT, UPDATE, DELETE, or EXCHANGE/TRUNCATE/DROP PARTITION was performed last time on a table. The data in the last_data_changed column of the PG_STAT_ALL_TABLES view is calculated by using this function. The performance of obtaining the last modification time by using the view is poor when the table has a large amount of data. In this case, you are advised to use this function.
Return type: timestamptz
- pg_stat_set_last_data_changed_time(oid)
Description: Manually changes the time when INSERT, UPDATE, DELETE, or EXCHANGE/TRUNCATE/DROP PARTITION was performed last time on a table.
Return type: void
- pg_backend_pid()
Description: Specifies the thread ID of the server thread attached to the current session.
Return type: integer
- pg_stat_get_activity(integer)
Description: Returns a record about the background process with the specified PID. A record for each active background process in the system is returned if NULL is specified. The returned result does not contain the connection_info column. The initial user, system administrators and users with the MONADMIN permission can view all data. Common users can only query their own results.
Example:
openGauss=# select * from pg_stat_get_activity(139881386280704); datid | pid | sessionid | usesysid | application_name | state | query | waiting | xact_start | query_start | backend_start | state_change | client_addr | client_hostname | client_port | enqueue | query_id | srespool | global_sessionid | unique_sql_id | trace_id -------+-----------------+-----------+----------+------------------+--------+------------------------------------------------------+---------+-------------------------------+-------------------------------+----- --------------------------+------------------------------+-------------+-----------------+-------------+---------+-------------------+--------------+------------------+---------------+---------- 16545 | 139881386280704 | 69 | 10 | gsql | active | select * from pg_stat_get_activity(139881386280704); | f | 2022-01-18 19:43:05.167718+08 | 2022-01-18 19:43:05.167718+08 | 2022 -01-18 19:42:33.513507+08 | 2022-01-18 19:43:05.16773+08 | | | -1 | | 72620543991624410 | default_pool | 1938253334#69#0 | 3751941862 | (1 row)Return type: setofrecord
The following table describes return parameters.
Table 5 Description Return Parameter
Type
Description
datid
oid
OID of the database that the user session connects to in the backend.
pid
bigint
Backend thread ID.
sessionid
bigint
Session ID.
usesysid
oid
OID of the user logged in to the backend.
application_name
text
Name of the application connected to the backend.
state
text
Overall status of the backend.
query
text
Latest query at the backend. If state is active, this column shows the ongoing query. In all other states, it shows the last query that was executed.
waiting
Boolean
Specifies whether the backend is currently waiting for a lock. If the backend is currently waiting for a lock, the value is true.
xact_start
timestamp with time zone
Time when current transaction was started (null if no transaction is active).
If the current query is the first of its transaction, the value of this column is the same as that of the query_start column.
query_start
timestamp with time zone
Time when the currently active query was started, or time when the last query was started if state is not active For a stored procedure, function, or package, the first query time is queried and does not change with the running of statements in the stored procedure. For a stored procedure, function, or package, the first query time is queried and does not change with the running of statements in the stored procedure.
backend_start
timestamp with time zone
Time when this process was started, that is, when the client connected to the server.
state_change
timestamp with time zone
Time when state was last modified.
client_addr
inet
IP address of the client connected to the backend. If this column is null, it indicates either that the client is connected via a Unix socket on the server machine or that this is an internal process, such as autovacuum.
client_hostname
text
Host name of the connected client, as reported by a reverse DNS lookup of client_addr. This column will be non-null only for IP connections and only when log_hostname is enabled.
client_port
integer
TCP port number that the client uses for communication with this backend (–1 if a Unix socket is used).
enqueue
text
Unsupported currently.
query_id
bigint
ID of a query.
srespool
name
Name of the resource pool.
global_sessionid
text
Global session ID.
unique_sql_id
bigint
Unique SQL statement ID.
trace_id
text
Driver-specific trace ID, which is associated with an application request.
- pg_stat_get_activity_with_conninfo(integer)
Description: Returns a record about the background process with the specified PID. A record for each active background process in the system is returned if NULL is specified. The initial user, system administrators and users with the MONADMIN permission can view all data. Common users can only query their own results.
Return type: setofrecord
The following table describes return values.
Table 6 Return values Return Parameter
Return Type
Return values
datid
oid
OID of the database that the user session connects to in the backend.
pid
bigint
Backend thread ID.
sessionid
bigint
Session ID.
usesysid
oid
OID of the user logged in to the backend.
application_name
text
Name of the application connected to the backend.
state
text
Overall status of the backend.
query
text
Latest query at the backend. If state is active, this column shows the ongoing query. In all other states, it shows the last query that was executed.
waiting
Boolean
Specifies whether the backend is currently waiting for a lock. If the backend is currently waiting for a lock, the value is true.
xact_start
timestamp with time zone
Time when current transaction was started (null if no transaction is active). If the current query is the first of its transaction, the value of this column is the same as that of the query_start column.
query_start
timestamp with time zone
Time when the currently active query was started, or time when the last query was started if state is not active For a stored procedure, function, or package, the first query time is queried and does not change with the running of statements in the stored procedure. For a stored procedure, function, or package, the first query time is queried and does not change with the running of statements in the stored procedure.
backend_start
timestamp with time zone
Time when this process was started, that is, when the client connected to the server.
state_change
timestamp with time zone
Time when state was last modified.
client_addr
inet
IP address of the client connected to the backend. If this column is null, it indicates either that the client is connected via a Unix socket on the server machine or that this is an internal process, such as autovacuum.
client_hostname
text
Host name of the connected client, as reported by a reverse DNS lookup of client_addr. This column will be non-null only for IP connections and only when log_hostname is enabled.
client_port
integer
TCP port number that the client uses for communication with this backend (–1 if a Unix socket is used).
enqueue
text
Unsupported currently.
query_id
bigint
ID of a query.
connection_info
text
A string in JSON format recording the driver type, driver version, driver deployment path, and process owner of the connected database.
srespool
name
Name of the resource pool.
global_sessionid
text
Global session ID.
unique_sql_id
bigint
Unique SQL statement ID.
trace_id
text
Driver-specific trace ID, which is associated with an application request.
- pg_stat_get_activity_ng(integer)
Description: Returns a record about the active backend thread with the specified PID. A record for each active backend thread is returned if NULL is specified. System administrators and users with the MONADMIN permission can view all data. Common users can query only their own data.
Return type: setofrecord
The following table describes return fields.
Name
Type
Description
datid
oid
Database OID
pid
biginit
Backend thread ID
sessionid
biginit
Session ID
node_group
text
Node group of the user to which the data belongs.
- pg_stat_get_function_calls(oid)
Description: Specifies the number of times the function has been called.
Return type: bigint
- pg_stat_get_function_self_time(oid)
Description: Specifies the time spent on only this function. The time spent on nested functions to call other functions is excluded.
Return type: bigint
- pg_stat_get_backend_idset()
Description: Sets the number of currently active server processes (from 1 to the number of active server processes).
Return type: setofinteger
- pg_stat_get_backend_pid(integer)
Description: Specifies the ID of a specified server thread.
Return type: bigint
- pg_stat_get_backend_dbid(integer)
Description: Specifies the ID of a database connected to a specified server process.
Return type: oid
- pg_stat_get_backend_userid(integer)
Description: Specifies the user ID of a specified server process. This function can be called only by system administrators.
Return type: oid
- pg_stat_get_backend_activity(integer)
Description: Queries the current activity of a specified server process. The query result can be obtained only when the user who calls this function is a system administrator or the same user as that of the session being queried and track_activities is enabled.
Return type: text
- pg_stat_get_backend_waiting(integer)
Description: Returns a true value if a specified server process is waiting for a lock, but only when the user who calls this function is a system administrator or the same user as that of the session being queried and track_activities is enabled.
Return type: Boolean
- pg_stat_get_backend_activity_start(integer)
Description: Specifies the time when a specified server process's currently executing query is started only when the user who calls this function is a system administrator or the same user as that of the session being queried and track_activities is enabled.
Return type: timestamp with time zone
- pg_stat_get_backend_xact_start(integer)
Description: Specifies the time when a specified server process's currently executing transaction is started only when the user who calls this function is a system administrator or the same user as that of the session being queried and track_activities is enabled.
Return type: timestamp with time zone
- pg_stat_get_backend_start(integer)
Description: Specifies the time when a specified server process is started. If the current user is neither a system administrator nor the same user as that of the session being queried, NULL is returned.
Return type: timestamp with time zone
- pg_stat_get_backend_client_addr(integer)
Description: Specifies the IP address of a backend connected to a specified client. If the connection is over a UDS, or if the current user is neither a system administrator nor the same user as that of the session being queried, NULL will be returned.
Return type: inet
- pg_stat_get_backend_client_port(integer)
Description: Specifies the TCP port of a backend connected to a specified client. If the connection is over a UDS, –1 will be returned. If the current user is neither a system administrator nor the same user as that of the session being queried, NULL will be returned.
Return type: integer
- pg_stat_get_bgwriter_timed_checkpoints()
Description: Specifies the time when the background writer starts scheduled checkpoints (because the time specified by checkpoint_timeout has expired).
Return type: bigint
- pg_stat_get_bgwriter_requested_checkpoints()
Description: Specifies the time when the background writer starts checkpoints based on requests from the backend because the value specified by checkpoint_segments has been exceeded or the CHECKPOINT command has been executed.
Return type: bigint
- pg_stat_get_bgwriter_buf_written_checkpoints()
Description: Specifies the number of buffers written by the background writer during checkpoints.
Return type: bigint
- pg_stat_get_bgwriter_buf_written_clean()
Description: Specifies the number of buffers written by the background writer for routine cleaning of dirty pages.
Return type: bigint
- pg_stat_get_bgwriter_maxwritten_clean()
Description: Specifies the time when the background writer stops its cleaning scan because it has written more buffers than those specified by the bgwriter_lru_maxpages parameter.
Return type: bigint
- pg_stat_get_buf_written_backend()
Description: Specifies the number of buffers written by the backend process because a new buffer needs to be allocated.
Return type: bigint
- pg_stat_get_buf_alloc()
Description: Specifies the total number of the allocated buffers.
Return type: bigint
- pg_stat_clear_snapshot()
Description: Discards the current statistics snapshot. Only users with the SYSADMIN or MONADMIN permission can execute this function.
Return type: void
- pg_stat_reset()
Description: Resets all statistics counters for the current database to zero (the SYSADMIN permission is required).
Return type: void
- gs_stat_reset()
Description: Resets all statistics counters for the current database on each node to zero (the SYSADMIN permission is required).
Return type: void
- pg_stat_reset_shared(text)
Description: Resets all statistics counters for the current database on each node in a shared cluster to zero (the SYSADMIN permission is required).
Return type: void
- pg_stat_reset_single_table_counters(oid)
Description: Resets statistics on a single table or index in the current database to zero (the SYSADMIN permission is required).
Return type: void
- pg_stat_reset_single_function_counters(oid)
Description: Resets statistics on a single function in the current database to zero (the SYSADMIN permission is required).
Return type: void
- pg_stat_get_db_cu_hdd_asyn(oid)
Description: Obtains the times CU is asynchronously read from a disk in a database on the current node.
Return type: bigint
- pgxc_fenced_udf_process(integer)
Description: Displays the number of UDF master and worker processes. Only users with the SYSADMIN or MONADMIN permission can execute this function. If the input parameter is set to 1, the number of master processes is queried. If the input parameter is set to 2, the number of worker processes is queried. If the input parameter is set to 3, all worker processes are terminated.
Return type: text
- fenced_udf_process(integer)
Description: Displays the number of local UDF master and worker processes. If the input parameter is set to 1, the number of Master threads is queried. If the input parameter is set to 2, the number of Worker threads is queried. If the input parameter is set to 3, all Worker threads are terminated.
Return type: text
- total_cpu()
Description: Obtains the CPU time used by the current node, in jiffies.
Return type: bigint
- total_memory()
Description: Obtains the size of the virtual memory used by the current node, in KB.
Return type: bigint
- pgxc_terminate_all_fenced_udf_process()
Description: Kills all UDF worker processes. Only users with the SYSADMIN or MONADMIN permission can execute this function.
Return type: Boolean
- GS_ALL_NODEGROUP_CONTROL_GROUP_INFO(text)
Description: Provides Cgroup information for all node groups. Before calling this function, you need to specify the name of the node group to be queried.
For example, to query the Cgroup information for the 'installation' node group, run the following command:1SELECT * FROM GS_ALL_NODEGROUP_CONTROL_GROUP_INFO('installation')
Return type: record
The following table describes return fields.
Name
Type
Description
name
text
Cgroup name
type
text
Cgroup type
gid
bigint
Cgroup ID
classgid
bigint
ID of the class Cgroup to which a workload Cgroup belongs
class
text
Class Cgroup
workload
text
Workload Cgroup
shares
bigint
CPU quota allocated to a Cgroup
limits
bigint
Limit of CPUs allocated to a Cgroup
wdlevel
bigint
Workload Cgroup level
cpucores
text
Usage of CPU cores in a Cgroup
- gs_get_nodegroup_tablecount(name)
Description: Obtains the total number of user tables in all databases in a node group.
Return type: integer
- pgxc_max_datanode_size(name)
Description: Obtains the maximum disk space occupied by database files on all DNs in a node group. The unit is byte.
Return type: bigint
- gs_check_logic_cluster_consistency()
Description: Checks whether the system information of all node groups in the system is consistent. If no record is returned, the information is consistent. Otherwise, the node group information on CNs and DNs in a node group is inconsistent. This function cannot be called during redistribution in scale-in or scale-out.
Return type: record
- gs_check_tables_distribution()
Description: Checks whether the user table distribution in the system is consistent. If no record is returned, table distribution is consistent. This function cannot be called during redistribution in scale-in or scale-out.
Return type: record
- pg_stat_bad_block(text, int, int, int, int, int, timestamp with time zone, timestamp with time zone)
Description: Obtains damage information about pages or CUs after the current node is started.
Return type: record
- pgxc_stat_bad_block(text, int, int, int, int, int, timestamp with time zone, timestamp with time zone)
Description: Obtains damage information about pages or CUs after all nodes in the cluster are started.
Return type: record
- pg_stat_bad_block_clear()
Description: Deletes the page or CU damage information that is read and recorded on the node (the SYSADMIN permission is required).
Return type: void
- pgxc_stat_bad_block_clear
Description: Deletes the page or CU damage information that is read and recorded on all nodes in the cluster (the SYSADMIN permission is required).
Return type: void
- pgxc_log_comm_status(void)
Description: When the TCP proxy communication is used, the PGXC system view exports the communication layer status of DNs to each log file.
Return type: void
- gs_respool_exception_info(pool text)
Description: Queries the query rule of a specified resource pool.
Return type: record
- gs_control_group_info(pool text)
Description: Queries information about Cgroups associated with a resource pool. Only users with the SYSADMIN permission can execute this function.
Return type: record
The following information is displayed:
Attribute
Value
Description
name
class_a:workload_a1
Class name and workload name
class
class_a
Class Cgroup name
workload
workload_a1
Workload Cgroup name
type
DEFWD
Cgroup type (Top, CLASS, BAKWD, DEFWD, or TSWD)
gid
87
Cgroup ID
shares
30
Percentage of CPU resources to those on the parent node
limits
0
Percentage of CPU cores to those on the parent node
rate
0
Allocation ratio in Timeshare
cpucores
0-3
Number of CPU cores
- gs_all_control_group_info()
Description: Collects information about all Cgroups in the database. For details about the columns returned by the function, see 16.3.48 GS_ALL_CONTROL_GROUP_INFO.
Return type: record
- gs_get_control_group_info()
Description: Collects information about all Cgroups. For details about the columns returned by the function, see 16.3.53 GS_GET_CONTROL_GROUP_INFO. Only users with the SYSADMIN permission can execute this function.
Return type: record
- get_instr_workload_info(integer)
Description: Obtains the transaction volume and time information on the current CN.
Return type: record
Attribute
Value
Description
user_oid
10
User ID
commit_counter
4
Number of frontend transactions that were committed
rollback_counter
1
Number of frontend transactions that were rolled back
resp_min
949
Minimum response time of frontend transactions (unit: μs)
resp_max
201891
Maximum response time of frontend transactions (unit: μs)
resp_avg
43564
Average response time of frontend transactions (unit: μs)
resp_total
217822
Total response time of frontend transactions (unit: μs)
bg_commit_counter
910
Number of background transactions that were committed
bg_rollback_counter
0
Number of background transactions that were rolled back
bg_resp_min
97
Minimum response time of background transactions (unit: μs)
bg_resp_max
678080687
Maximum response time of background transactions (unit: μs)
bg_resp_avg
327847884
Average response time of background transactions (unit: μs)
bg_resp_total
298341575300
Total response time of background transactions (unit: μs)
- pv_instance_time()
Description: Obtains the time consumed in each key phase on the current node.
Return type: record
Stat_name Attribute
Value
Description
DB_TIME
1062385
Total end-to-end wall time consumed by all threads (unit: μs)
CPU_TIME
311777
Total CPU time consumed by all threads (unit: μs)
EXECUTION_TIME
380037
Total time consumed on the executor (unit: μs)
PARSE_TIME
6033
Total time consumed for parsing SQL statements (unit: μs)
PLAN_TIME
173356
Total time consumed for generating an execution plan (unit: μs)
REWRITE_TIME
2274
Total time consumed for rewriting queries (unit: μs)
PL_EXECUTION_TIME
0
Total time consumed for executing PL/pgSQL statements (unit: μs)
PL_COMPILATION_TIME
557
Total time consumed for compiling SQL statements (unit: μs)
NET_SEND_TIME
1673
Total time consumed for sending data over the network (unit: μs)
DATA_IO_TIME
426622
Total time consumed for reading and writing data (unit: μs)
- DBE_PERF.get_global_instance_time()
Description: Provides the time consumed in each key phase in the entire cluster. The time consumed can be queried only on the CN.
Return type: record
- get_instr_unique_sql()
Description: Obtains information about execution statements (normalized SQL statements) on the current node. Only users with the SYSADMIN or MONADMIN permission can query this function.
Return type: record
- get_instr_wait_event(integer)
Description: Obtains the statistics on wait events on the current node.
Return type: record
- get_instr_user_login()
Description: Obtains the number of user login and logout times on the current node. Only users with the SYSADMIN or MONADMIN permission can execute this function.
Return type: record
- get_instr_rt_percentile(integer)
Description: Obtains the distribution information about the response time of 80% and 95% SQL statements in the CCN. The unified cluster information is stored on the CCN. The query result from other nodes is 0.
Return type: record
- get_node_stat_reset_time()
Description: Obtains statistics on reset (restart, primary-standby switchover, and database deletion) time of the current node.
Return type: record
- gs_paxos_stat_replication()
Description: Queries the standby node information on the primary node. Currently, the distributed mode is not supported.
- get_paxos_replication_info()
Description: Queries the primary-standby replication information. Currently, the distributed mode is not supported.
- gs_total_nodegroup_memory_detail
Description: Returns statistics on memory usage of the node group in the current database, in the unit of MB.
NOTE:
If the GUC parameter enable_memory_limit is set to off, this function cannot be used.
Return type: SETOF record
Table 7 Return value description Name
Type
Description
ngname
text
Node group name.
memorytype
text
Memory type. The value must be one of the following:- ng_total_memory: total memory size of the node group.
- ng_used_memory: memory used by the node group.
- ng_estimate_memory: estimated memory used by the node group.
- ng_foreignrp_memsize: total memory of the external resource pool of the node group.
- ng_foreignrp_usedsize: memory used by the external resource pool of the node group.
- ng_foreignrp_peaksize: peak memory used by the external resource pool of the node group.
- ng_foreignrp_mempct: percentage of the external resource pool of the node group to the total memory of the node group.
- ng_foreignrp_estmsize: estimated memory used by the external resource pool of the node group.
memorymbytes
integer
Size of allocated memory
- gs_io_wait_status()
Description: Returns the real-time statistics on I/O control on the current node.
Return type: setof record
Name
Type
Description
node_name
text
Node name
device_name
text
Name of the data disk mounted to the node
read_per_second
float
Number of read operations completed per second
write_per_second
float
Number of write operations completed per second
write_ratio
float
Ratio of the disk write I/Os to the total I/Os
io_util
float
Percentage of the I/O time to the total CPU time per second
total_io_util
integer
Level of the CPU time occupied by the last three I/Os. The value ranges from 0 to 6.
tick_count
integer
Interval for updating disk I/O information. The value is fixed to 1 second. The value is cleared each time before data is read.
io_wait_list_len
integer
Size of the I/O request thread wait queue. If the value is 0, no I/O is under control.
- gs_get_shared_memctx_detail(text)
Description: Returns the memory allocation details of the specified memory context, including the file, line number, and size of each memory allocation (the size of the same line in the same file is accumulated). Only the memory context queried through the pg_shared_memory_detail view can be queried. The input parameter is the memory context name (that is, the contextname column in the result returned by the pg_shared_memory_detail view). To query this function, you must have the SYSADMIN or MONADMIN permission.
Return type: SETOF record
Name
Type
Description
file
text
Name of the file where the memory is allocated to
line
int8
Line number of the code in the file where the memory is allocated to
size
int8
Size of the allocated memory. The value is accumulated if the memory is allocated for multiple times to the same line in the same file.
- gs_get_session_memctx_detail(text)
Description: Returns the memory allocation details of the specified memory context, including the file, line number, and size of each memory allocation (the size of the same line in the same file is accumulated). This function is valid only in thread pool mode. Only the memory context queried through the pv_session_memory_context view can be queried. The input parameter is the memory context name (that is, the contextname column in the result returned by the pv_session_memory_context view). To query this function, you must have the SYSADMIN or MONADMIN permission.
Return type: SETOF record
Name
Type
Description
file
text
Name of the file where the memory is allocated to
line
int8
Line number of the code in the file where the memory is allocated to
size
int8
Size of the allocated memory, in bytes. The value is accumulated if the memory is allocated for multiple times to the same line of the same file.
- gs_get_thread_memctx_detail(tid,text)
Description: Returns the memory allocation details of the specified memory context, including the file, line number, and size of each memory allocation (the size of the same line in the same file is accumulated). Only the memory context queried through the pv_thread_memory_context view can be queried. The first input parameter is the thread ID (the tid column of the data returned by pv_thread_memory_context), and the second parameter is the memory context name (the contextname column of the data returned by pv_thread_memory_context). To query this function, you must have the SYSADMIN or MONADMIN permission.
Return type: SETOF record
Name
Type
Description
file
text
Name of the file where the memory is allocated to
line
int8
Line number of the code in the file where the memory is allocated to
size
int8
Size of the allocated memory, in bytes. The value is accumulated if the memory is allocated for multiple times to the same line of the same file.
- gs_get_history_memory_detail(cstring)
Description: Queries historical memory snapshot information. The input parameter type is cstring. The value can be NULL or the name of the memory snapshot log file.
- If the value of the input parameter is NULL, the list of all memory snapshot log files on the current node is displayed.
- If the value of the input parameter is the name of the memory snapshot log file in the list queried in 1, the detailed information about the memory snapshot recorded in the log file is displayed.
- If you enter any other input parameter, the system displays a message indicating that the input parameter is incorrect or the file fails to be opened.
To query this function, you must have the SYSADMIN or MONADMIN permission.
Return type: text
Name
Type
Description
memory_info
text
Memory information. If the input parameter of the function is set to NULL, the memory snapshot file list is displayed. If the input parameter is set to the name of the memory snapshot file, the content of the file is displayed.
- gs_stat_get_hotkeys_info()
NOTE:
If the GUC parameter enable_hotkeys_collection is set to off, the gs_stat_get_hotkeys_info and global_stat_get_hotkeys_info functions as well as the global_stat_hotkeys_info view cannot be queried. The use of the gs_stat_clean_hotkeys and global_stat_clean_hotkeys APIs is not affected.
Description: Obtains the hotspot key statistics on the current node.
Return type: record
1 2 3 4 5 6
openGauss=# select * from gs_stat_get_hotkeys_info() order by count, hash_value; database_name | schema_name | table_name | key_value | hash_value | count ---------------+-------------+-------------------+-----------+------------+------- regression | public | hotkey_single_col | {22} | 1858004829 | 2 regression | public | hotkey_single_col | {11} | 2011968649 | 2 (2 rows)
Table 1 Return value description
Name
Type
Description
database_name
text
Name of the database where the hotspot key is located
schema_name
text
Name of the schema where the hotspot key is located
table_name
text
Name of the table where the hotspot key is located
key_value
text
Value of the hotspot key
hash_value
bigint
Hash value of the hotspot key in the database. If the table is a list or range distributed table, the value of this column is 0.
count
bigint
Frequency of accessing the hotspot key
- gs_stat_clean_hotkeys()
NOTE:
- Hotspot key detection is designed for high-concurrency and heavy-traffic scenarios. In the scenario where the access is performed for several times, the clearing query result may be inaccurate.
- The clearing API is designed to clear only the statistics in the LRU queue but not the historical data in the FIFO. Therefore, if the historical key value in the FIFO is accessed again after the clearing, the historical key value is still processed as a hotspot key. This rule also applies to global_stat_clean_hotkeys.
Description: Clears statistics on hotspot keys on the current node.
Return type: Boolean
1 2 3 4 5
openGauss=# select * from gs_stat_clean_hotkeys(); gs_stat_clean_hotkeys ----------------------- t (1 row)
- global_stat_get_hotkeys_info()
NOTE:
Run the select * from global_stat_hotkeys_info minus select * from global_stat_get_hotkeys_info() command during service execution. The value may not be 0 due to time difference.
Description: Obtains statistics on hotspot keys in the entire cluster.
Return type: record
1 2 3 4 5 6
openGauss=# select * from global_stat_get_hotkeys_info() order by count, hash_value; database_name | schema_name | table_name | key_value | hash_value | count ---------------+-------------+-------------------+-----------+------------+------- regression | public | hotkey_single_col | {22} | 1858004829 | 2 regression | public | hotkey_single_col | {11} | 2011968649 | 2 (2 rows)
- global_stat_clean_hotkeys()
Description: Clears statistics on hotspot keys in the entire cluster.
Return type: Boolean
1 2 3 4 5
openGauss=# select * from global_stat_clean_hotkeys(); global_stat_clean_hotkeys ----------------------- t (1 row)
- global_comm_get_recv_stream()
Description: Obtains the status of the stream received by all communication libraries on all DNs. For details about the columns returned by the function, see PG_COMM_RECV_STREAM.
Return type: record
- global_comm_get_send_stream()
Description: Obtains the status of the stream sent by all communication libraries on all DNs. For details about the columns returned by the function, see PG_COMM_SEND_STREAM.
Return type: record
- global_comm_get_status()
Description: Obtains the communications library status on all DNs. For details about the columns returned by the function, see PG_COMM_STATUS.
Return type: record
- global_comm_client_info()
Description: Obtains information about active client connections of global nodes. For details about the columns returned by the function, see COMM_CLIENT_INFO.
Return type: record
- global_comm_get_client_info()
Description: Obtains information about client connections of global nodes. For details about the columns returned by the function, see COMM_CLIENT_INFO.
Return type: record
-
Description: Displays information about all CNs in the current cluster queried by the current user. Only users with the SYSADMIN or MONADMIN permission can execute this function, and common users can view only their own information.
Return type: record
Name
Type
Description
coorname
text
Name of a CN in the current cluster
datid
oid
OID of the database that the user session connects to in the backend
datname
text
Name of the database that the user session connects to in the backend
pid
bigint
Backend thread ID
sessionid
bigint
Session ID
usesysid
oid
OID of the user logged in to the backend.
usename
text
Name of the user logged in to the backend.
application_name
text
Name of the application connected to the backend.
client_addr
inet
IP address of the client connected to the backend. If this column is null, it indicates either that the client is connected via a Unix socket on the server machine or that this is an internal process, such as autovacuum.
client_hostname
text
Host name of the connected client, as reported by a reverse DNS lookup of client_addr. This column is not null only for IP connections and only when log_hostname is enabled.
client_port
integer
TCP port number that the client uses for communication with this backend (–1 if a Unix socket is used).
backend_start
timestamp with time zone
Time when this process was started, that is, when the client connected to the server
xact_start
timestamp with time zone
Time when the current transaction was started (null if no transactions are active) If the current query is the first of its transaction, the value of this column is the same as that of the query_start column.
query_start
timestamp with time zone
Time when the currently active query was started, or time when the last query was started if the value of state is not active
state_change
timestamp with time zone
Time when state was last modified
waiting
Boolean
Specifies whether the background is currently waiting for a lock. If it is, the value is true.
enqueue
text
Queuing state of a statement. Possible values are:- waiting in queue: The statement is in the queue.
- Empty: The statement is being executed.
state
text
Overall state of the background. Possible values are:- active: The background is executing a query.
- idle: The background is waiting for a new client command.
- idle in transaction: The background is in a transaction, but there is no statement being executed in the transaction.
- idle in transaction (aborted): The background is in a transaction, but there are statements failed in the transaction.
- fastpath function call: The background is executing a fast-path function.
- disabled: This state is reported if track_activities is disabled in the background.
NOTE:
Only system administrators can view the session status of their accounts. The state information of other accounts is empty. For example, after user judy is connected to the database, the state information of user joe and the initial user omm in pgxc_stat_activity is empty.
SELECT datname, usename, usesysid, state,pid FROM pgxc_stat_activity;
datname | usename | usesysid | state | pid ----------+---------+----------+--------+----------------- postgres | omm | 10 | | 139968752121616 postgres | omm | 10 | | 139968903116560 db_tpcds | judy | 16398 | active | 139968391403280 postgres | omm | 10 | | 139968643069712 postgres | omm | 10 | | 139968680818448 postgres | joe | 16390 | | 139968563377936 (6 rows)
resource_pool
name
Resource pool used by the user
query_id
bigint
ID of a query statement.
query
text
Latest query in the background If the value of state is active, this column shows the ongoing query. In all other states, it shows the last query that was executed.
global_sessionid
text
Global session ID
unique_sql_id
bigint
Unique SQL statement ID
trace_id
text
Driver-specific trace ID, which is associated with an application request
-
pgxc_stat_activity_with_conninfo()
Description: Displays query information about the current user on all CNs in the current cluster. For details, see the pgxc_stat_activity view. Only users with the SYSADMIN or MONADMIN permission can execute this function, and common users can view only their own information.
Return type: record
- pgxc_stat_all_tables()
Description: Displays statistics on a row in each table (including TOAST tables) on each node. Only users with the SYSADMIN or MONADMIN permission can execute this function.
Return type: record
- pgxc_get_thread_wait_status()
Description: Queries the call hierarchy between threads generated by all SQL statements on each node in a cluster and the blocking status of each thread.
Return type: record
- pv_session_memory
Description: Collects statistics on memory usage at the session level, including all the memory allocated to GaussDB and stream threads on DNs for jobs currently executed by users.
NOTE:
If the GUC parameter enable_memory_limit is set to off, this function cannot be used.
Return type: record
Table 8 Return value description Name
Type
Description
sessid
text
Thread start time and ID
init_mem
integer
Memory allocated to the currently executed jobs before they enter the executor, in MB
used_mem
integer
Memory allocated to the currently executed jobs, in MB
peak_mem
integer
Peak memory allocated to the currently executed jobs, in MB
- dbe_perf.gs_stat_activity_timeout(int)
Description: Obtains information about query jobs whose execution time exceeds the timeout threshold on the current node. The correct result can be returned only when the GUC parameter track_activities is set to on. The timeout threshold ranges from 0 to 2147483.
Return type: setof record
Name
Type
Description
database
name
Name of the database connected to the user session
pid
bigint
Backend thread ID
sessionid
bigint
Session ID
usesysid
oid
OID of the user logged in to the backend.
application_name
text
Name of the application connected to the backend.
query
text
Query that is being executed on the backend
xact_start
timestamptz
Time when the current transaction is started
query_start
timestamptz
Time when the current query starts For a stored procedure, function, or package, the first query time is queried and does not change with the running of statements in the stored procedure.
query_id
bigint
ID of a query statement
- dbe_perf.global_stat_activity_timeout(int)
Description: Obtains information about query jobs whose execution time exceeds the timeout threshold in the current system (all CNs). The correct result can be returned only when the GUC parameter track_activities is set to on. The timeout threshold ranges from 0 to 2147483.
Return type: setof record
Name
Type
Description
nodename
text
Name of the CN connected to the user session
database
name
Name of the database connected to the user session
pid
bigint
Backend thread ID
sessionid
bigint
Session ID
usesysid
oid
OID of the user logged in to the backend.
application_name
text
Name of the application connected to the backend.
query
text
Query that is being executed on the backend
xact_start
timestamptz
Time when the current transaction is started
query_start
timestamptz
Time when the current query starts
query_id
bigint
ID of a query.
- DBE_PERF.get_global_active_session()
Description: Displays a summary of samples in the ACTIVE SESSION PROFILE memory on all nodes.
Return type: record
- DBE_PERF.get_global_os_runtime()
Description: Displays the running status of the current OS. This function can be queried only on CNs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_os_threads()
Description: Provides thread status information on all normal nodes in the entire cluster. The information can be queried only on CNs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_os_threads()
Description: Provides thread status information on all normal nodes in the entire cluster. The information can be queried only on CNs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_workload_sql_count()
Description: Provides the count information of SELECT, UPDATE, INSERT, DELETE, DDL, DML, and DCL in different loads in the entire cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_workload_sql_elapse_time()
Description: Provides SELECT, UPDATE, INSERT, DELETE, and response time information (TOTAL, AVG, MIN, and MAX) in different loads in the entire cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_workload_transaction()
Description: Obtains the transaction volume and time information on all nodes in the cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_session_stat()
Description: Obtains the session status information on all nodes in the cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
NOTE:
There are 17 status information items: commit, rollback, sql, table_scan, blocks_fetched, physical_read_operation, shared_blocks_dirtied, local_blocks_dirtied, shared_blocks_read, local_blocks_read, blocks_read_time, blocks_write_time, sort_imemory, sort_idisk, cu_mem_hit, cu_hdd_sync_read, and cu_hdd_asyread.
- DBE_PERF.get_global_session_time()
Description: Provides the time consumed in each key phase on each node in the entire cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_session_memory()
Description: Aggregates statistics on memory usage at the session level on each node in the unit of MB, including all the memory allocated to GaussDB and stream threads on DNs for jobs currently executed by users. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_session_memory_detail()
Description: Aggregates statistics on thread memory usage on each node by the MemoryContext node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_session_stat_activity()
Description: Aggregates information about running threads on each node in the cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_thread_wait_status()
Description: Aggregates the blocking waiting status of the backend thread and auxiliary thread on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_operator_history_table()
Description: Aggregates the operator records (persistent) after jobs are executed by the current user on all CNs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_operator_history()
Description: Aggregates the operator records after jobs are executed by the current user on all CNs. After a cluster is created, by default, you must have the MONADMIN or SYSADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_operator_runtime()
Description: Aggregates real-time operator records of jobs executed by the current user on all CNs. After a cluster is created, by default, you must have the MONADMIN or SYSADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statement_complex_history()
Description: Aggregates the historical records of complex queries executed by the current user on all CNs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statement_complex_history_table()
Description: Aggregates the historical records of complex queries (persistent) executed by the current user on all CNs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statement_complex_runtime()
Description: Aggregates real-time information about complex queries executed by the current user on all CNs. After a cluster is created, by default, you must have the MONADMIN or SYSADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_memory_node_detail()
Description: Aggregates the memory usage of a database on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_shared_memory_detail()
Description: Aggregates the usage information about the shared memory contexts on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_comm_delay()
Description: Aggregates the communications library delay status on all DNs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_comm_recv_stream()
Description: Aggregates the status of the stream received by the communications library on all DNs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_comm_send_stream()
Description: Aggregates the status of the stream sent by the communications library on all DNs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_comm_status()
Description: Aggregates the status of the communications library on all DNs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statio_all_indexes
Description: Aggregates index information and I/O statistics in the current database on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_local_toastname_and_toastindexname()
Description: Provides the mapping between the name and index of the local TOAST table and its associated tables. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_statio_all_indexes
Description: Collects I/O statistics on specific indexes, covering all index lines in the current database on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statio_all_sequences
Description: Provides I/O status information about all sequences in the namespace. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statio_all_tables
Description: Aggregates I/O statistics on each table in the database on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_statio_all_tables
Description: Collects statistics on I/Os of each table in the cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_local_toast_relation()
Description: Provides the mapping between the name of the local TOAST table and its associated tables. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statio_sys_indexes()
Description: Aggregates I/O status information about all system catalog indexes in namespaces on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_statio_sys_indexes()
Description: Collects statistics on I/O status information about all system catalog indexes in namespaces on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statio_sys_sequences()
Description: Provides I/O status information about all system catalog sequences in namespaces. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statio_sys_tables()
Description: Provides I/O status information about all system catalogs in the namespaces on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_statio_sys_tables()
Description: Aggregates I/O status information about all system catalogs in the namespaces of the cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statio_user_indexes()
Description: Provides I/O status information about all user relationship table indexes in the namespaces on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_statio_user_indexes()
Description: Aggregates I/O status information about all user relationship table indexes in the namespaces of the cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statio_user_sequences()
Description: Provides I/O status information about all user sequences in the namespaces on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statio_user_tables()
Description: Provides I/O status information about all user relationship tables in the namespaces on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_statio_user_tables()
Description: Aggregates I/O status information about all user relationship tables in the namespaces of the cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_stat_db_cu()
Description: Collects statistics on the CU hit ratio of all databases on each cluster node in a view. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_dn_stat_all_tables()
Description: Aggregates statistics on all tables in the database on each DN. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_cn_stat_all_tables()
Description: Aggregates statistics on all tables in the database on each CN. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_dn_stat_all_tables()
Description: Collects statistics on all tables in the database on each DN. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_cn_stat_all_tables()
Description: Collects statistics on all tables in the database on each CN. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_all_indexes()
Description: Aggregates statistics on all indexes in the database on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_stat_all_indexes()
Description: Collects statistics on all indexes in the database on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_sys_tables()
Description: Aggregates statistics on the system catalogs of all the namespaces in the pg_catalog or information_schema schema on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_stat_sys_tables()
Description: Collects statistics on the system catalogs of all the namespaces in the pg_catalog or information_schema schema on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_sys_indexes()
Description: Aggregates index status information about all system catalogs in the pg_catalog or information_schema schema on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_stat_sys_indexes()
Description: Collects index status information about all system catalogs in the pg_catalog or information_schema schema on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_user_tables()
Description: Aggregates status information about user-defined ordinary tables in all namespaces. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_stat_user_tables()
Description: Collects status information about user-defined ordinary tables in all namespaces. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_user_indexes()
Description: Aggregates status information about the indexes of user-defined ordinary tables in all databases. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_stat_user_indexes()
Description: Collects status information about the indexes of user-defined ordinary tables in all databases. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_database()
Description: Aggregates statistics on databases on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_database_conflicts()
Description: Collects statistics on databases on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_xact_all_tables()
Description: Aggregates transaction status information about all ordinary tables and TOAST tables in namespaces. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_stat_xact_all_tables()
Description: Collects transaction status information about all ordinary tables and TOAST tables in the namespace. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_xact_sys_tables()
Description: Aggregates transaction status information about system catalogs in namespaces on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_stat_xact_sys_tables()
Description: Collects transaction status information about system catalogs in namespaces on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_xact_user_tables()
Description: Aggregates transaction status information about user tables in namespaces on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_stat_xact_user_tables()
Description: Collects transaction status information about user tables in namespaces on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_user_functions()
Description: Aggregates transaction status information about user-defined functions in namespaces on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_xact_user_functions()
Description: Collects transaction status information about user-defined functions in namespaces on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_stat_bad_block()
Description: Aggregates information about the failure to read files such as tables and indexes on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_file_redo_iostat()
Description: Collects information about the failure to read files such as tables and indexes on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_file_iostat()
Description: Aggregates I/O statistics on data files on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_locks()
Description: Aggregates lock information on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_replication_slots()
Description: Aggregates logical replication information on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_bgwriter_stat()
Description: Aggregates statistics on the backend write process activities on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_replication_stat()
Description: Aggregates status information about log synchronization on all nodes, such as the location where the sender sends logs and the location where the receiver receives logs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_pooler_status()
Description: Aggregates cache connection status in the pooler on all CNs. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_transactions_running_xacts()
Description: Aggregates information about running transactions on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_transactions_running_xacts()
Description: Collects information about running transactions on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_transactions_prepared_xacts()
Description: Aggregates information about transactions that are currently prepared for two-phase commit on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_transactions_prepared_xacts()
Description: Collects information about transactions that are currently prepared for two-phase commit on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_statement()
Description: Aggregates the status of historical statements executed on each node. After a cluster is created, by default, you must have the MONADMIN or SYSADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_statement_count()
Description: Aggregates SELECT, UPDATE, INSERT, DELETE, and response time information (TOTAL, AVG, MIN, and MAX) on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_config_settings()
Description: Aggregates GUC parameter settings on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_wait_events()
Description: Aggregates status information about the wait events on each node. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_statement_responsetime_percentile()
Description: Obtains the distribution information about the response time of 80% and 95% SQL statements in the cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_summary_user_login()
Description: Collects statistics on the number of user login and logout times on each node in the cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.get_global_record_reset_time()
Description: Aggregates statistics on reset (restart, primary-standby switchover, and database deletion) time in the cluster. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- DBE_PERF.track_memory_context(context_list text)
Description: Sets the memory context whose memory allocation details need to be collected. The input parameter contains the memory context names, which are separated by commas (,), for example, ThreadTopMemoryContext, SessionCacheMemoryContext. Note that the memory context names are context-sensitive. In addition, the length of a single memory context is 63, and the exceeded part is truncated. The maximum number of memory contexts for collection at a time is 16. If the number of memory contexts exceeds 16, the setting fails. Each time this function is called, the previous collection result is cleared. When the input parameter is set to "", the collection function is disabled. Only the initial user or a user with the MONADMIN permission can execute this function.
Return type: Boolean
- DBE_PERF.track_memory_context_detail()
Description: Obtains the memory application details of the memory context specified by the DBE_PERF.track_memory_context function. For details, see the DBE_PERF.track_memory_context_detail view. Only the initial user or a user with the MONADMIN permission can execute this function.
Return type: record
- DBE_PERF.global_io_wait_info()
Description: Queries real-time I/O control statistics on all CNs and DNs.
Return type: record
- pg_stat_get_mem_mbytes_reserved(tid)
Description: Collects statistics on variables related to resource management, which is used only for fault locating.
Parameter: thread ID
Return type: text
- pg_stat_get_file_stat()
Description: Collects statistics on data file I/Os to indicate I/O performance and detect performance problems such as abnormal I/O operations.
Return type: record
- pg_stat_get_redo_stat()
Description: Displays statistics on the replay of session thread logs.
Return type: record
- pg_stat_get_status(int8)
Description: Tests the blocking status about the backend thread and auxiliary thread of the current instance.
Return type: record
- get_local_rel_iostat()
Description: Queries the accumulated I/O status of data files on the current node.
Return type: record
- DBE_PERF.get_global_rel_iostat()
Description: Aggregates I/O statistics on data files on all nodes. After a cluster is created, by default, you must have the MONADMIN permission to query this function.
Return type: record
- pg_catalog.plancache_status()
Description: Displays status information about the global plan cache on the current node. The information returned by the function is the same as that in GLOBAL_PLANCACHE_STATUS.
Return type: record
- DBE_PERF.global_plancache_status()
Description: Displays status information about the global plan cache on all nodes. For details about the information returned by the function, see GLOBAL_PLANCACHE_STATUS.
Return type: record
- pg_catalog.prepare_statement_status() (Deprecated)
Description: Displays the PREPARE statement status information on the current node. The information returned by the function is the same as that in GLOBAL_PREPARE_STATEMENT_STATUS (Discarded).
Return type: record
- DBE_PERF.global_prepare_statement_status() (Deprecated)
Description: Displays status information about the PREPARE statement on all nodes. For details about the information returned by the function, see GLOBAL_PREPARE_STATEMENT_STATUS (Discarded).
Return type: record
- DBE_PERF.global_threadpool_status()
Description: Displays status information about worker threads and sessions in thread pools on all nodes. For details about the information returned by the function, see GLOBAL_THREADPOOL_STATUS.
Return type: record
- comm_check_connection_status
Description: Returns the connection status between the CN and all active nodes (CNs and primary DNs). This function can be queried only on CNs and can be used by common users.
Parameter: nan
Return type: node_name text, remote_name text, remote_host text, remote_port integer, is_connected Boolean, and no_error_occur Boolean
- DBE_PERF.global_comm_check_connection_status
Description: Returns the connection status between all CNs and all active nodes (CNs and primary DNs). This function can be queried only on CNs. Permission control is inherited from the DBE_PERF schema.
Parameter: nan
Return type: node_name text, remote_name text, remote_host text, remote_port integer, is_connected Boolean, and no_error_occur Boolean
- remote_candidate_stat()
Description: Displays the number of pages in the candidate buffer chain of the instance and buffer eviction information, including the normal buffer pool and segment buffer pool.
Return type: record
Table 9 remote_candidate_stat parameter description Name
Type
Description
node_name
text
Node name
candidate_slots
integer
Number of pages in the candidate buffer chain of the current normal buffer pool
get_buf_from_list
bigint
Number of times that pages are obtained from the candidate buffer chain during buffer eviction in the current normal buffer pool
get_buf_clock_sweep
bigint
Number of times that pages are obtained from the original eviction solution during buffer eviction in the current normal buffer pool
seg_candidate_slots
integer
Number of pages in the candidate buffer chain of the current segment buffer pool
seg_get_buf_from_list
bigint
Number of times that pages are obtained from the candidate buffer chain during buffer eviction in the current segment buffer pool
seg_get_buf_clock_sweep
bigint
Number of times that pages are obtained from the original eviction solution during buffer eviction in the current segment buffer pool
- remote_ckpt_stat()
Description: Displays the checkpoint information and log flushing information about all instances in the cluster (unavailable on DNs, except for the current node).
Return type: record
Table 10 remote_ckpt_stat parameter description Parameter
Type
Description
node_name
text
Instance name
ckpt_redo_point
text
Checkpoint in the current instance
ckpt_clog_flush_num
int8
Number of Clog flushing pages from the startup time to the current time
ckpt_csnlog_flush_num
int8
Number of CSNlog flushing pages from the startup time to the current time
ckpt_multixact_flush_num
int8
Number of MultiXact flushing pages from the startup time to the current time
ckpt_predicate_flush_num
int8
Number of predicate flushing pages from the startup time to the current time
ckpt_twophase_flush_num
int8
Number of two-phase flushing pages from the startup time to the current time
- remote_double_write_stat()
Description: Displays doublewrite file status of all instances in the cluster (unavailable on DNs, except for the current node).
Return type: record
Table 11 remote_double_write_stat parameter description Parameter
Type
Description
node_name
text
Instance name
curr_dwn
int8
Sequence number of the doublewrite file
curr_start_page
int8
Start page for restoring the doublewrite file
file_trunc_num
int8
Number of times that the doublewrite file is reused
file_reset_num
int8
Number of reset times after the doublewrite file is full
total_writes
int8
Total number of I/Os of the doublewrite file
low_threshold_writes
int8
Number of I/Os for writing the doublewrite file with low efficiency (the number of I/O flushing pages at a time is less than 16.)
high_threshold_writes
int8
Number of I/Os for writing the doublewrite file with high efficiency (the number of I/O flushing pages at a time is more than 421.)
total_pages
int8
Total number of pages that are flushed to the doublewrite file area
low_threshold_pages
int8
Number of pages that are flushed with low efficiency
high_threshold_pages
int8
Number of pages that are flushed with high efficiency
file_id
int8
ID of the doublewrite file
- remote_single_flush_dw_stat()
Description: Displays the single-page doublewrite file eviction status of all instances in the cluster (unavailable on DNs, except for the current node).
Return type: record
Table 12 remote_single_flush_dw_stat parameter description Parameter
Type
Description
node_name
text
Instance name
curr_dwn
integer
Sequence number of the doublewrite file
curr_start_page
integer
Start position of the doublewrite file
total_writes
bigint
Total number of data write pages in the doublewrite file
file_trunc_num
bigint
Number of times that the doublewrite file is reused
file_reset_num
bigint
Number of reset times after the doublewrite file is full
- remote_pagewriter_stat()
Description: Displays the page flushing information and checkpoint information about all instances in the cluster (unavailable on DNs, except for the current node).
Return type: record
Table 13 remote_pagewriter_stat parameter description Parameter
Type
Description
node_name
text
Instance name
pgwr_actual_flush_total_num
int8
Total number of dirty pages flushed from the startup time to the current time
pgwr_last_flush_num
int4
Number of dirty pages flushed in the previous batch
remain_dirty_page_num
int8
Estimated number of dirty pages that are not flushed
queue_head_page_rec_lsn
text
recovery_lsn of the first dirty page in the dirty page queue in the current instance
queue_rec_lsn
text
recovery_lsn of the dirty page queue in the current instance
current_xlog_insert_lsn
text
The write position of Xlogs in the current instance
ckpt_redo_point
text
Checkpoint in the current instance
- remote_recovery_status()
Description: Displays log flow control information about the primary and standby nodes (unavailable on DNs, except for the current node).
Return type: record
Table 14 remote_recovery_status parameter description Parameter
Type
Description
node_name
text
Node name (including the primary and standby nodes)
standby_node_name
text
Name of the standby node
source_ip
text
IP address of the primary node
source_port
int4
Port number of the primary node
dest_ip
text
IP address of the standby node
dest_port
int4
Port number of the standby node
current_rto
int8
Current log flow control time of the standby node (unit: s)
target_rto
int8
Expected flow control time of the standby node specified by the corresponding GUC parameter (unit: s)
current_sleep_time
int8
Sleep time required to achieve the expected flow control time (unit: μs).
- remote_rto_stat()
Description: Displays log flow control information about the primary and standby nodes (except the current node and DNs).
Return type: record
Table 15 remote_rto_stat parameters Parameter
Type
Description
node_name
text
Node name (including the primary and standby nodes)
rto_info
text
Flow control information, including the current log flow control time (unit: second) of the standby node, the expected flow control time (unit: second) specified by the GUC parameter, and the sleep time required by the primary node to achieve the expected flow control time (unit: μs)
- remote_redo_stat()
Description: Displays the log replay status of all instances in the cluster (unavailable on DNs, except for the current node).
Return type: record
Table 16 remote_redo_stat parameter description Parameter
Type
Description
node_name
text
Instance name
redo_start_ptr
int8
Start point for replaying the current instance logs
redo_start_time
int8
Start time (UTC) when the current instance logs are replayed
redo_done_time
int8
End time (UTC) when the current instance logs are replayed
curr_time
int8
Current time (UTC) of the instance
min_recovery_point
int8
Position of the minimum consistency point for the instance logs
read_ptr
int8
Position for reading the instance logs
last_replayed_read_ptr
int8
Position for replaying the instance logs
recovery_done_ptr
int8
Replay position after the instance is started
read_xlog_io_counter
int8
Number of I/Os when the current instance reads and replays logs
read_xlog_io_total_dur
int8
Total I/O latency when the current instance reads and replays logs
read_data_io_counter
int8
Number of data page I/O reads during replay in the current instance
read_data_io_total_dur
int8
Total I/O latency of data page reads during replay in the current instance
write_data_io_counter
int8
Number of data page I/O writes during replay in the current instance
write_data_io_total_dur
int8
Total I/O latency of data page writes during replay in the current instance
process_pending_counter
int8
Number of synchronization times of log distribution threads during replay in the current instance
process_pending_total_dur
int8
Total synchronization latency of log distribution threads during replay in the current instance
apply_counter
int8
Number of synchronization times of replayer threads during replay in the current instance
apply_total_dur
int8
Total synchronization latency of replayer threads during replay in the current instance
speed
int8
Log replay rate of the current instance
local_max_ptr
int8
Maximum number of replay logs received by the localhost after the instance is started.
primary_flush_ptr
int8
Position where the host flushes logs to a disk
worker_info
text
Replayer thread information of the instance. If concurrent replay is not enabled, the value is NULL.
- pgxc_gtm_snapshot_status()
Description: Queries for transaction information on the current GTM. This function is supported only in GTM mode, and is not supported in GTM-LITE or GTM-FREE mode.
Return type: record
The following table describes return parameters.Table 17 PGXC_GTM_SNAPSHOT_STATUS return parameters Name
Type
Description
xmin
xid
Minimum XID of the running transactions
xmax
xid
XID of the transaction next to the executed transaction with the maximum XID
csn
integer
Sequence number of the transaction to be committed
oldestxmin
xid
Minimum XID of the executed transactions
xcnt
integer
Number of the running transactions
running_xids
text
XID of the running transaction.
- pg_stat_get_partition_tuples_hot_updated(oid)
Description: Returns statistics on the number of hot updated tuples in a partition with a specified partition ID.
Parameter: oid
Return type: bigint
- pv_os_run_info()
Description: Displays the running status of the current OS. For details about the columns, see PV_OS_RUN_INFO.
Parameter: nan
Return type: SETOF record
- pv_session_stat()
Description: Collects session status information by session thread or AutoVacuum thread. For details about the columns, see PV_SESSION_STAT.
Parameter: nan
Return type: SETOF record
- pv_session_time()
Description: Collects statistics on the running time of session threads and the time consumed in each execution phase. For details about the columns, see PV_SESSION_TIME.
Parameter: nan
Return type: SETOF record
- pg_stat_get_db_temp_bytes()
Description: Collects statistics on the total amount of data written to temporary files through database query. All temporary files are counted, regardless of why the temporary files were created and regardless of the log_temp_files setting.
Parameter: oid
Return type: bigint
- pg_stat_get_db_temp_files()
Description: Queries the number of temporary files created in the database. All temporary files are counted, regardless of why the temporary files were created (for example, sorting or hashing) and regardless of the log_temp_files setting.
Parameter: oid
Return type: bigint
- local_redo_time_count()
Description: Returns statistics on time consumed in each process of each replayer thread on the current node (valid data exists only on the standby node).
The return values are as follows: - local_xlog_redo_statics()
Description: Returns the statistics on each type of logs that have been replayed on the current node (valid data exists only on the standby node).
The return values are as follows:Table 19 local_xlog_redo_statics parameter description Column Name
Description
xlog_type
Log types.
rmid
Resource manager ID.
info
Xlog operation.
num
Number of logs.
extra
Valid values are available for page replay logs and xact logs.- The page replay logs indicate the number of pages read from the disk.
- The xact logs indicate the number of deleted files.
- remote_bgwriter_stat()
Description: Displays the information about pages flushed by the bgwriter threads of all instances in the entire cluster, number of pages in the candidate buffer chain, and buffer elimination information. (The query result does not contain the information about the current node and cannot be used on DNs.)
Return type: record
Table 20 remote_bgwriter_stat parameter description Parameter
Type
Description
node_name
text
Instance name
bgwr_actual_flush_total_num
bigint
Total number of dirty pages flushed by the bgwriter thread from the startup time to the current time
bgwr_last_flush_num
integer
Number of dirty pages flushed by the bgwriter thread in the previous batch
candidate_slots
integer
Number of pages in the current candidate buffer chain
get_buffer_from_list
bigint
Number of times that pages are obtained from the candidate buffer chain during buffer eviction
get_buf_clock_sweep
bigint
Number of times that pages are obtained from the original eviction solution during buffer eviction
Example:
The remote_bgwriter_stat function displays the information about pages flushed by the bgwriter threads of all instances in the entire cluster, number of pages in the candidate buffer chain, and buffer elimination information. (The query result does not contain the information about the current node and cannot be used on DNs.)
1 2 3 4 5 6
openGauss=# SELECT * FROM remote_bgwriter_stat(); node_name | bgwr_actual_flush_total_num | bgwr_last_flush_num | candidate_slots | get_buffer_from_list | get_buf_clock_sweep -----------+-----------------------------+---------------------+-----------------+----------------------+--------------------- datanode2 | 0 | 0 | 393208 | 665 | 0 datanode1 | 0 | 0 | 393208 | 659 | 0 (2 rows)
- gs_stack()
Description: Displays the call stack of a thread. To query this function, you must have the SYSADMIN or MONADMIN permission.
Parameter: tid, which indicates the thread ID. tid is an optional parameter. If it is specified, the function returns the call stack of the thread corresponding to tid. If it is not specified, the function returns the call stacks of all threads.
Return value: If tid is specified, the return value is text. If tid is not specified, the return value is setof record.
Example:
Run select * from gs_stack(tid) to obtain the call stack of a specified thread.1 2 3 4 5 6 7 8 9 10 11 12 13
openGauss=# select * from gs_stack(139663481165568); gs_stack -------------------------------------------------------------------- __poll + 0x2d + WaitLatchOrSocket(Latch volatile*, int, int, long) + 0x29f + WaitLatch(Latch volatile*, int, long) + 0x2e + JobScheduleMain() + 0x90f + int GaussDbThreadMain<(knl_thread_role)9>(knl_thread_arg*) + 0x456+ InternalThreadFunc(void*) + 0x2d + ThreadStarterFunc(void*) + 0xa4 + start_thread + 0xc5 + clone + 0x6d + (1 row)
Run select * from gs_stack() to obtain the call stacks of all threads.1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
openGauss=# select * from gs_stack(); -[ RECORD 1 ]------------------------------------------------------------------------------------------------------- tid | 139670364324352 lwtid | 308 stack | __poll + 0x2d | CommWaitPollParam::caller(int (*)(pollfd*, unsigned long, int), unsigned long) + 0x34 | int comm_socket_call<CommWaitPollParam, int (*)(pollfd*, unsigned long, int)>(CommWaitPollParam*, int (*)(pollfd*, unsigned long , int)) + 0x28 | comm_poll(pollfd*, unsigned long, int) + 0xb1 | ServerLoop() + 0x72b | PostmasterMain(int, char**) + 0x314e | main + 0x617 | __libc_start_main + 0xf5 | 0x55d38f8db3a7 [ RECORD 2 ]------------------------------------------------------------------------------------------------------- tid | 139664851859200 lwtid | 520 stack | __poll + 0x2d | WaitLatchOrSocket(Latch volatile*, int, int, long) + 0x29f | SysLoggerMain(int) + 0xc86 | int GaussDbThreadMain<(knl_thread_role)17>(knl_thread_arg*) + 0x45d | InternalThreadFunc(void*) + 0x2d | ThreadStarterFunc(void*) + 0xa4 | start_thread + 0xc5 | clone + 0x6d
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
