Updated on 2025-09-18 GMT+08:00

Status Information Functions

pgxc_query_wait_status(session_id)

Description: Displays the waiting status between execution unit threads of a specified session.

Return type: record.

The returned information is as follows:

Table 1 pgxc_query_wait_status(session_id) columns

Column

Type

Description

actor_name

text

Actor name.

actor_id

text

Actor ID.

actor_ip

text

Actor IP address.

db_name

text

Database name.

thread_name

text

Thread name.

query_id

bigint

Query ID.

tid

bigint

ID of the current thread.

lwtid

integer

Lightweight thread ID of the current thread.

ptid

integer

Parent thread of the streaming thread.

tlevel

integer

Level of the streaming thread.

smpid

integer

ID of a parallel thread.

wait_status

text

Waiting status of the current thread.

wait_event

text

If wait_status is acquire lock, acquire lwlock, or wait io, this column describes the specific lock, lightweight lock, and I/O information, respectively. Otherwise, this column is empty.

Example:

1
2
3
4
5
6
7
SELECT * FROM pgxc_query_wait_status(139775106588720);
  actor_name  |                   actor_id                   |  actor_ip   | db_name | thread_name |     query_id      |       tid       |  lwtid  | ptid | tlevel | smpid | wait_status | wait_event

--------------+----------------------------------------------+-------------+---------+-------------+-------------------+-----------------+---------+------+--------+-------+-------------+-----------
-
 coordinator1 | runtime-c7010000-0000-4000-8bad-1509e41e3b67 | 10.42.0.240 |         | gsql        | 72339069014638600 | 140406720987184 | 4194244 |      |      0 |     0 | none        |
(1 row)

yr_api_status()

Description: Displays statistics about YuanRong API calls during a session.

Return type: record.

The function returns the following information:

Table 2 yr_api_status() columns

Column

Type

Description

actor_name

text

Actor name.

api

text

API name.

total_call

bigint

Total number of calls.

failed_call

bigint

Number of failed calls.

avg_call_during

bigint

Average API invocation duration.

Unit: millisecond.

min_call_during

bigint

Minimum calling duration.

Unit: millisecond.

max_call_during

bigint

Maximum calling duration.

Unit: millisecond.

total_data

bigint

Total data volume.

Unit: byte.

avg_data_rate

bigint

Average data processing rate.

Unit: byte/ms.

min_data_rate

bigint

Minimum data processing rate.

Unit: byte/ms.

max_data_rate

bigint

Maximum data processing rate.

Unit: byte/ms.

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
SELECT * FROM yr_api_status();
  actor_name  |        api         | total_call | failed_call | avg_call_during | min_call_during | max_call_during | total_data | avg_data_rate | min_data_rate | max_data_rate
--------------+--------------------+------------+-------------+-----------------+-----------------+-----------------+------------+---------------+---------------+---------------
 coordinator1 | YR::Invoke         |         12 |           0 |                 |                 |                 |            |               |               |
 coordinator1 | YR::Get            |         11 |           0 |              13 |               1 |             134 |            |               |               |
 coordinator1 | YR::CreateProducer |          0 |           0 |                 |                 |                 |            |               |               |
 coordinator1 | YR::Subscribe      |          0 |           0 |                 |                 |                 |            |               |               |
 coordinator1 | YR::Send           |          0 |           0 |               0 |               0 |               0 |          0 |             0 |             0 |             0
 coordinator1 | YR::Receive        |          0 |           0 |               0 |               0 |               0 |          0 |             0 |             0 |             0
 coordinator1 | YR::KV::Set        |          0 |           0 |               0 |               0 |               0 |          0 |             0 |             0 |             0
 coordinator1 | YR::KV::Get        |          0 |           0 |               0 |               0 |               0 |          0 |             0 |             0 |             0
 coordinator1 | YR::KV::Del        |          0 |           0 |               0 |               0 |               0 |            |               |               |
(9 rows)