From 6fdb47de97b135041333faefb3c33f05b283e467 Mon Sep 17 00:00:00 2001 From: opengauss_bot Date: Mon, 10 Mar 2025 06:46:30 +0000 Subject: [PATCH] =?UTF-8?q?!7280=20WLM=E7=9B=B8=E5=85=B3=E7=B3=BB=E7=BB=9F?= =?UTF-8?q?=E5=87=BD=E6=95=B0=E5=8F=8A=E8=A7=86=E5=9B=BE=E7=9A=84=E8=A1=A5?= =?UTF-8?q?=E5=85=85=E8=AF=B4=E6=98=8E=20Merge=20pull=20request=20!7280=20?= =?UTF-8?q?from=20=E8=B5=B5=E6=99=A8/master?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../gs_wlm_user_resource_history.md | 24 ++-- .../pg_total_user_resource_info.md | 16 ++- .../pg_total_user_resource_info_oid.md | 24 ++-- .../array-functions-and-operators.md | 14 +- .../docs/SQLReference/obsolete-functions.md | 73 +++++++++- .../en/docs/SQLReference/other-functions.md | 12 +- .../segment-page-storage-functions.md | 114 +-------------- .../statistics-information-functions.md | 135 +++++++++++------- .../system-information-functions.md | 59 ++------ .../SQLReference/wlm_user_resource_runtime.md | 4 +- .../GS_WLM_USER_RESOURCE_HISTORY.md | 23 +-- .../PG_TOTAL_USER_RESOURCE_INFO.md | 23 ++- .../PG_TOTAL_USER_RESOURCE_INFO_OID.md | 24 ++-- ...15\344\275\234\345\256\241\350\256\241.md" | 2 +- .../SQLReference/WLM_USER_RESOURCE_RUNTIME.md | 4 +- ...66\345\256\203\345\207\275\346\225\260.md" | 12 +- ...37\345\274\203\345\207\275\346\225\260.md" | 64 +++++++++ ...14\346\223\215\344\275\234\347\254\246.md" | 14 +- ...30\345\202\250\345\207\275\346\225\260.md" | 114 +-------------- ...41\346\201\257\345\207\275\346\225\260.md" | 37 +---- ...41\346\201\257\345\207\275\346\225\260.md" | 135 ++++++++++++------ .../gs_wlm_user_resource_history.md | 24 ++-- .../pg_total_user_resource_info.md | 16 ++- .../pg_total_user_resource_info_oid.md | 24 ++-- .../array-functions-and-operators.md | 14 +- .../docs/SQLReference/obsolete-functions.md | 73 +++++++++- .../en/docs/SQLReference/other-functions.md | 12 +- .../segment-page-storage-functions.md | 114 +-------------- .../statistics-information-functions.md | 135 +++++++++++------- .../system-information-functions.md | 59 ++------ .../SQLReference/wlm_user_resource_runtime.md | 4 +- .../GS_WLM_USER_RESOURCE_HISTORY.md | 24 ++-- .../PG_TOTAL_USER_RESOURCE_INFO.md | 22 +-- .../PG_TOTAL_USER_RESOURCE_INFO_OID.md | 24 ++-- ...15\344\275\234\345\256\241\350\256\241.md" | 10 +- .../SQLReference/WLM_USER_RESOURCE_RUNTIME.md | 4 +- ...66\345\256\203\345\207\275\346\225\260.md" | 12 +- ...37\345\274\203\345\207\275\346\225\260.md" | 64 +++++++++ ...14\346\223\215\344\275\234\347\254\246.md" | 14 +- ...30\345\202\250\345\207\275\346\225\260.md" | 114 +-------------- ...41\346\201\257\345\207\275\346\225\260.md" | 36 +---- ...41\346\201\257\345\207\275\346\225\260.md" | 134 +++++++++++------ 42 files changed, 820 insertions(+), 1040 deletions(-) diff --git a/content/docs-lite/en/docs/DataBaseReference/gs_wlm_user_resource_history.md b/content/docs-lite/en/docs/DataBaseReference/gs_wlm_user_resource_history.md index e1a0f2e90..a1e73aed2 100644 --- a/content/docs-lite/en/docs/DataBaseReference/gs_wlm_user_resource_history.md +++ b/content/docs-lite/en/docs/DataBaseReference/gs_wlm_user_resource_history.md @@ -31,7 +31,7 @@

integer

-

Size of the memory being used, in MB

+

Size of the memory being used(The total size of memory used by the user's current active session. If no business is running or the session has ended, the dynamic memory will be automatically reclaimed, resulting in a size of 0.), in MB

total_memory

@@ -45,7 +45,7 @@

real

-

Number of CPU cores in use

+

Number of CPU cores in use. CPU usage data is collected only in complex jobs, and the value is the CPU usage of the related Cgroup.

total_cpu

@@ -73,70 +73,70 @@

bigint

-

Used temporary storage space, in KB

+

Used temporary storage space(Reserved field, not in use yet.),, in KB

total_temp_space

bigint

-

Available temporary storage space, in KB. The value –1 indicates that the maximum temporary storage space is not limited.

+

Available temporary storage space(Reserved field, not in use yet.),, in KB. The value –1 indicates that the maximum temporary storage space is not limited.

used_spill_space

bigint

-

Used space of operator flushing, in KB

+

Used space of operator flushing(Reserved field, not in use yet.),, in KB

total_spill_space

bigint

-

Available storage space for operator flushing, in KB. The value –1 indicates that the maximum operator flushing space is not limited.

+

Available storage space for operator flushing(Reserved field, not in use yet.),, in KB. The value –1 indicates that the maximum operator flushing space is not limited.

read_kbytes

bigint

-

Byte traffic of read operations in a monitoring period, in KB

+

Byte traffic of read operations in a monitoring period(Not supported currently, available only in distributed mode.), in KB

write_kbytes

bigint

-

Byte traffic of write operations in a monitoring period, in KB

+

Byte traffic of write operations in a monitoring period(Not supported currently, available only in distributed mode.), in KB

read_counts

bigint

-

Number of read operations in a monitoring period

+

Number of read operations in a monitoring period(Not supported currently, available only in distributed mode.)

write_counts

bigint

-

Number of write operations in a monitoring period

+

Number of write operations in a monitoring period(Not supported currently, available only in distributed mode.)

read_speed

real

-

Byte rate of read operations in a monitoring period, in KB/s

+

Byte rate of read operations in a monitoring period(Not supported currently, available only in distributed mode.), in KB/s

write_speed

real

-

Byte rate of write operations in a monitoring period, in KB/s

+

Byte rate of write operations in a monitoring period(Not supported currently, available only in distributed mode.), in KB/s

diff --git a/content/docs-lite/en/docs/DataBaseReference/pg_total_user_resource_info.md b/content/docs-lite/en/docs/DataBaseReference/pg_total_user_resource_info.md index 5dbe0b92f..6356c671e 100644 --- a/content/docs-lite/en/docs/DataBaseReference/pg_total_user_resource_info.md +++ b/content/docs-lite/en/docs/DataBaseReference/pg_total_user_resource_info.md @@ -24,7 +24,7 @@

integer

-

Used memory, in MB

+

Used memory(The total size of memory used by the user's current active session. If no business is running or the session has ended, the dynamic memory will be automatically reclaimed, resulting in a size of 0.), in MB

total_memory

@@ -66,28 +66,28 @@

bigint

-

Used temporary space, in KB

+

Used temporary space(Reserved field, not in use yet.), in KB

total_temp_space

bigint

-

Total available temporary space, in KB (-1 if the temporary space is not limited)

+

Total available temporary space(Reserved field, not in use yet.), in KB (-1 if the temporary space is not limited)

used_spill_space

bigint

-

Size of the used operator flushing space, in KB

+

Size of the used operator flushing space(Reserved field, not in use yet.), in KB

total_spill_space

bigint

-

Total size of the available operator flushing space, in KB (-1 if the space is not limited)

+

Total size of the available operator flushing space(Reserved field, not in use yet.), in KB (-1 if the space is not limited)

read_kbytes

@@ -96,6 +96,7 @@

Primary database node: total bytes read by the user's complex jobs on all database nodes in the last 5 seconds, in KB

Database node: total bytes read by the user's complex jobs from the instance startup time to the current time, in KB

+

Not supported currently, available only in distributed mode.

write_kbytes

@@ -104,6 +105,7 @@

Primary database node: total bytes written by the user's complex jobs on all database nodes in the last 5 seconds, in KB

Database node: total bytes written by the user's complex jobs from the instance startup time to the current time, in KB

+

Not supported currently, available only in distributed mode.

read_counts

@@ -112,6 +114,7 @@

Primary database node: total number of read times of the user's complex jobs on all database nodes in the last 5 seconds

Database node: total number of read times of the user's complex jobs from the instance startup time to the current time

+

Not supported currently, available only in distributed mode.

write_counts

@@ -120,6 +123,7 @@

Primary database node: total number of write times of the user's complex jobs on all database nodes in the last 5 seconds

Database node: total number of write times of the user's complex jobs from the instance startup time to the current time

+

Not supported currently, available only in distributed mode.

read_speed

@@ -128,6 +132,7 @@

Primary database node: average read rate of the user's complex jobs on a single database node in the last 5 seconds, in KB/s

Database node: average read rate of the user's complex jobs on the database node in the last 5 seconds, in KB/s

+

Not supported currently, available only in distributed mode.

write_speed

@@ -136,6 +141,7 @@

Primary database node: average write rate of the user's complex jobs on a single database node in the last 5 seconds, in KB/s

Database node: average write rate of the user's complex jobs on the database node in the last 5 seconds, in KB/s

+

Not supported currently, available only in distributed mode.

diff --git a/content/docs-lite/en/docs/DataBaseReference/pg_total_user_resource_info_oid.md b/content/docs-lite/en/docs/DataBaseReference/pg_total_user_resource_info_oid.md index ace708cec..e5f000d45 100644 --- a/content/docs-lite/en/docs/DataBaseReference/pg_total_user_resource_info_oid.md +++ b/content/docs-lite/en/docs/DataBaseReference/pg_total_user_resource_info_oid.md @@ -24,7 +24,7 @@

integer

-

Size of the memory being used, in MB.

+

Size of the memory being used(The total size of memory used by the user's current active session. If no business is running or the session has ended, the dynamic memory will be automatically reclaimed, resulting in a size of 0.), in MB.

total_memory

@@ -38,7 +38,7 @@

double precision

-

Number of CPU cores in use.

+

Number of CPU cores in use. CPU usage data is collected only in complex jobs, and the value is the CPU usage of the related Cgroup.

total_cpu

@@ -66,70 +66,70 @@

bigint

-

Used temporary storage space, in KB.

+

Used temporary storage space(Reserved field, not in use yet.), in KB.

total_temp_space

bigint

-

Total available temporary space, in KB (-1 if the temporary space is not limited).

+

Total available temporary space(Reserved field, not in use yet.), in KB (-1 if the temporary space is not limited).

used_spill_space

bigint

-

Used disk space for spilling, in KB.

+

Used disk space for spilling(Reserved field, not in use yet.), in KB.

total_spill_space

bigint

-

Total available disk space for spilling, in KB. The value -1 indicates that the space is not limited.

+

Total available disk space for spilling(Reserved field, not in use yet.), in KB. The value -1 indicates that the space is not limited.

read_kbytes

bigint

-

Amount of data read from the disk, in KB.

+

Amount of data read from the disk(Not supported currently, available only in distributed mode.), in KB.

write_kbytes

bigint

-

Amount of data written to the disk, in KB.

+

Amount of data written to the disk(Not supported currently, available only in distributed mode.), in KB.

read_counts

bigint

-

Number of disk read times.

+

Number of disk read times(Not supported currently, available only in distributed mode.).

write_counts

bigint

-

Number of disk write times.

+

Number of disk write times(Not supported currently, available only in distributed mode.).

read_speed

double precision

-

Disk read rate, in B/ms.

+

Disk read rate(Not supported currently, available only in distributed mode.), in B/ms.

write_speed

double precision

-

Disk write rate, in B/ms.

+

Disk write rate(Not supported currently, available only in distributed mode.), in B/ms.

diff --git a/content/docs-lite/en/docs/SQLReference/array-functions-and-operators.md b/content/docs-lite/en/docs/SQLReference/array-functions-and-operators.md index 8f9906cd7..1156c882d 100644 --- a/content/docs-lite/en/docs/SQLReference/array-functions-and-operators.md +++ b/content/docs-lite/en/docs/SQLReference/array-functions-and-operators.md @@ -501,19 +501,7 @@ Array comparisons compare the array contents element-by-element, using the defau - array\_extendnull\(anyarray, int\) - Description: Adds a specified number of null elements to the end of an array. - - Return type: anyarray - - Example: - - ``` - openGauss=# SELECT array_extendnull(ARRAY[1,8,3,7],1) AS RESULT; - result - -------------- - {1,8,3,7,null} - (1 row) - ``` + Description: This API has been discarded and is unavailable currently. - array\_trim\(anyarray, int\) diff --git a/content/docs-lite/en/docs/SQLReference/obsolete-functions.md b/content/docs-lite/en/docs/SQLReference/obsolete-functions.md index 9b925843f..9e86dcfce 100644 --- a/content/docs-lite/en/docs/SQLReference/obsolete-functions.md +++ b/content/docs-lite/en/docs/SQLReference/obsolete-functions.md @@ -78,19 +78,84 @@ The following functions in openGauss have been discarded in the latest version:

pg_pool_validate

+

gs_stat_ustore

table_skewness(text)

table_skewness(text, text, text)

-

-

+

pg_stat_get_wlm_realtime_operator_info

+ +

pg_stat_get_wlm_realtime_ec_operator_info

+ +

pg_stat_get_wlm_ec_operator_info

+ +

gs_stat_get_wlm_plan_operator_info

+ + + +

pg_stat_get_wlm_operator_info

+ +

gs_wlm_get_resource_pool_info(int)

+ +

gs_wlm_get_all_user_resource_info

+ +

create_wlm_operator_info

+ +

create_wlm_session_info

+ +

gs_wlm_get_workload_records

+ +

gs_wlm_persistent_user_resource_info

+ + + +

gs_wlm_session_respool

+ +

gs_total_nodegroup_memory_detail

+ +

gs_wlm_user_resource_info(name text)

+ +

create_wlm_instance_statistics_info

+ +

pg_stat_get_session_wlmstat

+ +

pg_stat_get_wlm_ec_operator_info

+ +

pg_stat_get_wlm_instance_info

+ + + +

pg_stat_get_wlm_instance_info_with_cleanup

+ +

pg_stat_get_wlm_statistics

+ +

pg_stat_get_wlm_realtime_session_info

+ +

gs_upload_obs_file

+ +

gs_download_obs_file

+ +

gs_set_obs_file_context

+ +

gs_get_hadr_key_cn

+ + + +

gs_hadr_do_switchover

+ +

track_memory_context(context_list text)

+ +

track_memory_context_detail

+ +

pgxc_unlock_for_sp_database

-

-

+

local_segment_space_info

-

-

+

pg_stat_segment_extent_usage

-

-

+

GS_ALL_NODEGROUP_CONTROL_GROUP_INFO

diff --git a/content/docs-lite/en/docs/SQLReference/other-functions.md b/content/docs-lite/en/docs/SQLReference/other-functions.md index 415533454..e4b70f466 100644 --- a/content/docs-lite/en/docs/SQLReference/other-functions.md +++ b/content/docs-lite/en/docs/SQLReference/other-functions.md @@ -641,19 +641,11 @@ - pgxc\_unlock\_for\_sp\_database\(name Name\) - Description: Releases a specified database lock. - - Parameter: database name - - Return type: Boolean + Description: This API has been discarded and is unavailable currently. - pgxc\_lock\_for\_sp\_database\(name Name\) - Description: Locks a specified database. - - Parameter: database name - - Return type: Boolean + Description: This API has been discarded and is unavailable currently. - copy\_error\_log\_create\(\) diff --git a/content/docs-lite/en/docs/SQLReference/segment-page-storage-functions.md b/content/docs-lite/en/docs/SQLReference/segment-page-storage-functions.md index 2695fd506..bef441f81 100644 --- a/content/docs-lite/en/docs/SQLReference/segment-page-storage-functions.md +++ b/content/docs-lite/en/docs/SQLReference/segment-page-storage-functions.md @@ -2,121 +2,11 @@ - local\_segment\_space\_info\(tablespacename TEXT, databasename TEXT\) - Description: Generates usage information about all extent groups in the tablespace. - - Return type: - - - - - - - - - - - - - - - - - - - - - - - - - - - -

node_name

-

Node name

-

extent_size

-

Extent specifications of an extent group. The unit is the number of blocks.

-

forknum

-

Fork number

-

total_blocks

-

Total number of extents in a physical file

-

meta_data_blocks

-

Number of blocks occupied by the metadata managed in a tablespace, including the space header and map page but excluding the segment head

-

used_data_blocks

-

Number of extents used for storing data, including the segment head

-

utilization

-

Percentage of the number of used blocks to the total number of blocks, that is, (the value of used_data_blocks + the value of meta_data_block)/the value of total_blocks

-

high_water_mark

-

High-water mark, indicating the number of allocated extents and maximum physical page number. Blocks that exceed the high-water mark are not used and can be directly recycled.

-
- - Example: - - ``` - select * from local_segment_space_info('pg_default', 'postgres'); - node_name | extent_size | forknum | total_blocks | meta_data_blocks | used_data_blocks | utilization | high_water_mark - -------------------+-------------+---------+--------------+------------------+------------------+-------------+----------------- - dn_6001_6002_6003 | 1 | 0 | 16384 | 4157 | 1 | .253784 | 4158 - dn_6001_6002_6003 | 8 | 0 | 16384 | 4157 | 8 | .254211 | 4165 - (2 rows) - ``` + Description: This API has been discarded and is unavailable currently. - pg\_stat\_segment\_extent\_usage\(int4 tablespace oid, int4 database oid, int4 extent\_type, int4 forknum\) - Description: Specifies the usage information of each allocated extent in an extent group returned each time. **extent\_type** indicates the type of the extent group. The value is an integer ranging from 1 to 5. If the value is not within the range, an error is reported. **forknum** indicates the fork number. The value is an integer ranging from 0 to 4. Currently, only the following values are valid: **0** for data files, **1** for FSM files, and **2** for visibility map files. - - Return type: - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Description

-

start_block

-

Start physical page number of an extent

-

extent_size

-

Size of an extent

-

usage_type

-

Usage type of an extent, for example, segment head and data extent

-

ower_location

-

Object location of an extent to which a pointer points. For example, the owner of a data extent is the head of the segment to which the data extent belongs.

-

special_data

-

Position of an extent in its owner. The value of this field is related to the usage type. For example, special data of a data extent is the extent ID in the segment to which the data extent belongs.

-
- - The value of **usage\_type** is enumerated. The meaning of each value is as follows: - - - **Non-bucket table segment head**: data segment head of a non-hash bucket table - - **Non-bucket table fork head**: fork segment header of a non-segment-page table - - **Data extent**: data block - - Example: - - ``` - select * from pg_stat_segment_extent_usage((select oid::int4 from pg_tablespace where spcname='pg_default'), (select oid::int4 from pg_database where datname='postgres'), 1, 0); - start_block | extent_size | usage_type | ower_location | special_data - -------------+-------------+------------------------+---------------+-------------- - 4157 | 1 | Data extent | 4294967295 | 0 - 4158 | 1 | Data extent | 4157 | 0 - ``` + Description: This API has been discarded and is unavailable currently. - local\_space\_shrink\(tablespacename TEXT, databasename TEXT\) diff --git a/content/docs-lite/en/docs/SQLReference/statistics-information-functions.md b/content/docs-lite/en/docs/SQLReference/statistics-information-functions.md index e67c0197d..09178f56d 100644 --- a/content/docs-lite/en/docs/SQLReference/statistics-information-functions.md +++ b/content/docs-lite/en/docs/SQLReference/statistics-information-functions.md @@ -1931,15 +1931,11 @@ Statistics information functions are divided into the following two categories: - create\_wlm\_session\_info\(int flag\) - Description: Clears top SQL query statement-level statistics recorded in the current memory. Only the administrator can execute this function. - - Return type: int + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_session\_info\(int flag\) - Description: Obtains top SQL query statement-level statistics recorded in the current memory. If the input parameter is not 0, the information is cleared from the memory. Only users with the **system admin** or **monitor admin** permission can execute this function. - - Return type: record + Description: This API has been discarded and is unavailable currently. - gs\_paxos\_stat\_replication\(\) @@ -2077,15 +2073,11 @@ Statistics information functions are divided into the following two categories: - gs\_wlm\_get\_resource\_pool\_info\(int\) - Description: Obtains resource usage statistics of all users. The input parameter can be any value of the INT type or be null. - - Return type: record + Description: This API has been discarded and is unavailable currently. - gs\_wlm\_get\_all\_user\_resource\_info\(\) - Description: Obtains resource usage statistics of all users. - - Return type: record + Description: This API has been discarded and is unavailable currently. - gs\_wlm\_get\_user\_info\(int\) @@ -2093,11 +2085,78 @@ Statistics information functions are divided into the following two categories: Return type: record -- gs\_wlm\_get\_workload\_records\(\) + The following table describes return columns. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Column

+

Type

+

Description

+

userid

+

oid

+

OID of the user

+

sysadmin

+

boolean

+

Whether the user has the sysadmin permission

+

rpoid

+

oid

+

OID of the resource pool

+

parentid

+

oid

+

OID of the parent user

+

totalspace

+

bigint

+

Size of the occupied space

+

spacelimit

+

bigint

+

Upper limit of the space size

+

childcount

+

integer

+

Number of child users

+

childlist

+

text

+

Child user list

+
- Description: Obtains all job information in dynamic load management. This function is valid only when dynamic load management is enabled. +- gs\_wlm\_get\_workload\_records\(\) - Return type: record + Description: This API has been discarded and is unavailable currently. - gs\_wlm\_readjust\_user\_space\(\) @@ -2119,9 +2178,7 @@ Statistics information functions are divided into the following two categories: - gs\_wlm\_session\_respool\(bigint\) - Description: Obtains the session resource pool information about all backend threads. The input parameter can be any value of the bigint type or can be null. - - Return type: record + Description: This API has been discarded and is unavailable currently. - gs\_wlm\_get\_session\_info\(\) @@ -2554,15 +2611,11 @@ Statistics information functions are divided into the following two categories: - DBE\_PERF.track\_memory\_context\(context\_list text\) - Description: Sets the memory context whose memory application details need to be collected. The input parameter is 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 excess part is truncated. The maximum number of memory contexts that can be collected at a time is 16. If the number of memory contexts exceeds 16, the setting fails. Each time this function is called, the previous statistics result is cleared. When the input parameter is set to **""**, the statistics function is disabled. Only the initial user \(super user\) or a user with the **monadmin **permission can execute this function. - - Return type: Boolean + Description: This API has been discarded and is unavailable currently. - 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 \(super user\) or a user with the **monadmin **permission can execute this function. - - Return type: record + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_mem\_mbytes\_reserved\(tid\) @@ -2574,9 +2627,7 @@ Statistics information functions are divided into the following two categories: - gs\_wlm\_user\_resource\_info\(name text\) - Description: Queries a user's resource quota and resource usage. - - Return type: record + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_file\_stat\(\) @@ -2750,17 +2801,11 @@ Statistics information functions are divided into the following two categories: - gs\_wlm\_user\_resource\_info\(name text\) - Description: Queries a user's resource quota and resource usage. Common users can query only their own information. Administrators can query information about all users. - - Return type: record + Description: This API has been discarded and is unavailable currently. - create\_wlm\_instance\_statistics\_info - Description: Saves the historical monitoring data of the current instance persistently. - - Parameter: **nan** - - Return type: integer + Description: This API has been discarded and is unavailable currently. - gs\_session\_memory @@ -2815,25 +2860,15 @@ Statistics information functions are divided into the following two categories: - gs\_wlm\_persistent\_user\_resource\_info\(\) - Description: Archives all user resource usage statistics to the **gs\_wlm\_user\_resource\_history** system catalog. To query this function, you must have the **sysadmin** permission. - - Return type: record + Description: This API has been discarded and is unavailable currently. - create\_wlm\_operator\_info\(int flag\) - Description: Clears top SQL operator-level statistics recorded in the current memory. If the input parameter is greater than 0, the information is archived to **gs\_wlm\_operator\_info** and **gs\_wlm\_ec\_operator\_info**. Otherwise, the information is not archived. Only users with the **sysadmin** permission can execute this function. - - Return type: int + Description: This API has been discarded and is unavailable currently. - GS\_ALL\_NODEGROUP\_CONTROL\_GROUP\_INFO\(text\) - Description: Provides Cgroup information for all logical database instances. Before calling this function, you need to specify the name of the logical database instance to be queried. For example, to query the Cgroup information for the installation logical database instance, run the following command: - - ``` - SELECT * FROM GS_ALL_NODEGROUP_CONTROL_GROUP_INFO('installation') - ``` - - Return type: record + Description: This API has been discarded and is unavailable currently. The following table describes return columns. @@ -2921,9 +2956,7 @@ Statistics information functions are divided into the following two categories: - gs\_total\_nodegroup\_memory\_detail - Description: Returns information about the memory used by the current logical database, in MB. - - Return type: SETOF record + Description: This API has been discarded and is unavailable currently. - local\_redo\_time\_count\(\) diff --git a/content/docs-lite/en/docs/SQLReference/system-information-functions.md b/content/docs-lite/en/docs/SQLReference/system-information-functions.md index 5907364f7..8b154320e 100644 --- a/content/docs-lite/en/docs/SQLReference/system-information-functions.md +++ b/content/docs-lite/en/docs/SQLReference/system-information-functions.md @@ -2031,75 +2031,39 @@ The following functions provide server transaction information in an exportable - pg\_stat\_get\_wlm\_realtime\_operator\_info - Description: Obtains the operator information of the real-time execution plan from the internal hash table. - - Parameter: nan - - Return type: queryid bigint, pid bigint, plan\_node\_id integer, plan\_node\_name text, start\_time timestamp with time zone, duration bigint, status text, query\_dop integer, estimated\_rows bigint, tuple\_processed bigint, min\_peak\_memory integer, max\_peak\_memory integer, average\_peak\_memory integer, memory\_skew\_percent integer, min\_spill\_size integer, max\_spill\_size integer, average\_spill\_size integer, spill\_skew\_percent integer, min\_cpu\_time bigint, max\_cpu\_time bigint, total\_cpu\_time bigint, cpu\_skew\_percent integer, warning text + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_realtime\_ec\_operator\_info - Description: Obtains the operator information of the EC execution plan from the internal hash table. - - Parameter: nan - - Return type: queryid bigint, plan\_node\_id integer, plan\_node\_name text, start\_time timestamp with time zone, ec\_operator integer, ec\_status text, ec\_execute\_datanode text, ec\_dsn text, ec\_username text, ec\_query text, ec\_libodbc\_type text, ec\_fetch\_count bigint + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_operator\_info - Description: Obtains the operator information of the execution plan from the internal hash table. - - Parameter: nan - - Return type: queryid bigint, pid bigint, plan\_node\_id integer, plan\_node\_name text, start\_time timestamp with time zone, duration bigint, query\_dop integer, estimated\_rows bigint, tuple\_processed bigint, min\_peak\_memory integer, max\_peak\_memory integer, average\_peak\_memory integer, memory\_skew\_percent integer, min\_spill\_size integer, max\_spill\_size integer, average\_spill\_size integer, spill\_skew\_percent integer, min\_cpu\_time bigint, max\_cpu\_time bigint, total\_cpu\_time bigint, cpu\_skew\_percent integer, warning text + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_node\_resource\_info - Description: Obtains the resource information of the current node. - - Parameter: nan - - Return type: min\_mem\_util integer, max\_mem\_util integer, min\_cpu\_util integer, max\_cpu\_util integer, min\_io\_util integer, max\_io\_util integer, used\_mem\_rate integer + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_session\_wlmstat - Description: Returns the load information of the current session. - - Parameter: pid integer - - Return type: datid oid, threadid bigint, sessionid bigint, threadpid integer, usesysid oid, appname text, query text, priority bigint, block\_time bigint, elapsed\_time bigint, total\_cpu\_time bigint, skew\_percent integer, statement\_mem integer, active\_points integer, dop\_value integer, current\_cgroup text, current\_status text, enqueue\_state text, attribute text, is\_plana boolean, node\_group text, srespool name + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_ec\_operator\_info - Description: Obtains the operator information of the EC execution plan from the internal hash table. - - Parameter: nan - - Return type: queryid bigint, plan\_node\_id integer, plan\_node\_name text, start\_time timestamp with time zone, duration bigint, tuple\_processed bigint, min\_peak\_memory integer, max\_peak\_memory integer, average\_peak\_memory integer, ec\_operator integer, ec\_status text, ec\_execute\_datanode text, ec\_dsn text, ec\_username text, ec\_query text, ec\_libodbc\_type text, ec\_fetch\_count bigint + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_instance\_info - Description: Returns the load information of the current instance. - - Parameter: nan - - Return type: instancename text, timestamp, timestamp with time zone, used\_cpu integer, free\_memory integer, used\_memory integer, io\_await double precision, io\_util double precision, disk\_read double precision, disk\_write double precision, process\_read bigint, process\_write bigint, logical\_read bigint, logical\_write bigint, read\_counts bigint, write\_counts bigint + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_instance\_info\_with\_cleanup - Description: Returns the load information of the current instance and saves the information to the system catalog. - - Parameter: nan - - Return type: instancename text, timestamp, timestamp with time zone, used\_cpu integer, free\_memory integer, used\_memory integer, io\_await double precision, io\_util double precision, disk\_read double precision, disk\_write double precision, process\_read bigint, process\_write bigint, logical\_read bigint, logical\_write bigint, read\_counts bigint, write\_counts bigint + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_realtime\_session\_info - Description: Returns the load information of the real-time session. - - Parameter: nan - - Return type: nodename text, threadid bigint, block\_time bigint, duration bigint, estimate\_total\_time bigint, estimate\_left\_time bigint, schemaname text, query\_band text, spill\_info text, control\_group text, estimate\_memory integer, min\_peak\_memory integer, max\_peak\_memory integer, average\_peak\_memory integer, memory\_skew\_percent integer, min\_spill\_size integer, max\_spill\_size integer, average\_spill\_size integer, spill\_skew\_percent integer, min\_dn\_time bigint, max\_dn\_time bigint, average\_dn\_time bigint, dntime\_skew\_percent integer, min\_cpu\_time bigint, max\_cpu\_time bigint, total\_cpu\_time bigint, cpu\_skew\_percent integer, min\_peak\_iops integer, max\_peak\_iops integer, average\_peak\_iops integer, iops\_skew\_percent integer, warning text, query text, query\_plan text, cpu\_top1\_node\_name text, cpu\_top2\_node\_name text, cpu\_top3\_node\_name text, cpu\_top4\_node\_name text, cpu\_top5\_node\_name text, mem\_top1\_node\_name text, mem\_top2\_node\_name text, mem\_top3\_node\_name text, mem\_top4\_node\_name text, mem\_top5\_node\_name text, cpu\_top1\_value bigint, cpu\_top2\_value bigint, cpu\_top3\_value bigint, cpu\_top4\_value bigint, cpu\_top5\_value bigint, mem\_top1\_value bigint, mem\_top2\_value bigint, mem\_top3\_value bigint, mem\_top4\_value bigint, mem\_top5\_value bigint, top\_mem\_dn text, top\_cpu\_dn text + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_session\_iostat\_info @@ -2111,8 +2075,5 @@ The following functions provide server transaction information in an exportable - pg\_stat\_get\_wlm\_statistics - Description: Returns session load statistics. - - Parameter: nan + Description: This API has been discarded and is unavailable currently. - Return type: statement text, block\_time bigint, elapsed\_time bigint, total\_cpu\_time bigint, qualification\_time bigint, skew\_percent integer, control\_group text, status text, action text diff --git a/content/docs-lite/en/docs/SQLReference/wlm_user_resource_runtime.md b/content/docs-lite/en/docs/SQLReference/wlm_user_resource_runtime.md index f54cf420e..987b3440b 100644 --- a/content/docs-lite/en/docs/SQLReference/wlm_user_resource_runtime.md +++ b/content/docs-lite/en/docs/SQLReference/wlm_user_resource_runtime.md @@ -24,7 +24,7 @@

integer

-

Used memory (unit: MB)

+

Used memory(The total size of memory used by the user's current active session. If no business is running or the session has ended, the dynamic memory will be automatically reclaimed, resulting in a size of 0.) (unit: MB)

total_memory

@@ -38,7 +38,7 @@

integer

-

Number of CPU cores in use

+

Number of CPU cores in use. CPU usage data is collected only in complex jobs, and the value is the CPU usage of the related Cgroup.

total_cpu

diff --git a/content/docs-lite/zh/docs/DatabaseReference/GS_WLM_USER_RESOURCE_HISTORY.md b/content/docs-lite/zh/docs/DatabaseReference/GS_WLM_USER_RESOURCE_HISTORY.md index 604c63773..b74713ce9 100644 --- a/content/docs-lite/zh/docs/DatabaseReference/GS_WLM_USER_RESOURCE_HISTORY.md +++ b/content/docs-lite/zh/docs/DatabaseReference/GS_WLM_USER_RESOURCE_HISTORY.md @@ -31,7 +31,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

integer

-

正在使用的内存大小，单位MB。

+

正在使用的内存大小（表示用户当前活跃的session已使用的内存总大小，若当前未运行业务或会话已结束，则动态内存会自动回收即为0。），单位MB。

total_memory

@@ -45,7 +45,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

real

-

正在使用的CPU核数。

+

正在使用的CPU核数（仅统计复杂作业CPU使用 情况，且该值为相关控制组的CPU使用统计值）。

total_cpu

@@ -73,28 +73,28 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

bigint

-

已使用的临时存储空间大小，单位KB。

+

已使用的临时存储空间大小（预留字段，暂未使用），单位KB。

total_temp_space

bigint

-

可使用的临存储空间大小，单位KB，值为-1表示未限制最大临时存储空间。

+

可使用的临存储空间大小（预留字段，暂未使用），单位KB，值为-1表示未限制最大临时存储空间。

used_spill_space

bigint

-

已使用的算子落盘存储空间大小，单位KB。

+

已使用的算子落盘存储空间大小（预留字段，暂未使用），单位KB。

total_spill_space

bigint

-

可使用的算子落盘存储空间大小，单位KB，值为-1表示未限制最大算子落盘存储空间。

+

可使用的算子落盘存储空间大小（预留字段，暂未使用），单位KB，值为-1表示未限制最大算子落盘存储空间。

read_kbytes

@@ -102,7 +102,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

bigint

监控周期内，读操作的字节流量，单位KB。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_kbytes

@@ -110,6 +110,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

bigint

监控周期内，写操作的字节流量，单位KB。

+

当前不支持，仅分布式可用。

read_counts

@@ -117,7 +118,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

bigint

监控周期内，读操作的次数，单位次。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_counts

@@ -125,7 +126,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

bigint

监控周期内，写操作的次数，单位次。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

read_speed

@@ -133,7 +134,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

real

监控周期内，读操作的字节速率，单位KB/s。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_speed

@@ -141,7 +142,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

real

监控周期内，写操作的字节速率，单位KB/s。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

diff --git a/content/docs-lite/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO.md b/content/docs-lite/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO.md index 1eb1b816c..c312b7df6 100644 --- a/content/docs-lite/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO.md +++ b/content/docs-lite/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO.md @@ -24,7 +24,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

integer

-

正在使用的内存大小，单位MB。

+

正在使用的内存大小（表示用户当前活跃的session已使用的内存总大小，若当前未运行业务或会话已结束，则动态内存会自动回收即为0。），单位MB。

total_memory

@@ -66,28 +66,28 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

bigint

-

已使用的临时空间大小，单位KB。

+

已使用的临时空间大小（预留字段，暂未使用），单位KB。

total_temp_space

bigint

-

可使用的临时空间总大小，单位KB，值为-1表示未限制。

+

可使用的临时空间总大小（预留字段，暂未使用），单位KB，值为-1表示未限制。

used_spill_space

bigint

-

已使用的算子落盘空间大小，单位KB。

+

已使用的算子落盘空间大小（预留字段，暂未使用），单位KB。

total_spill_space

bigint

-

可使用的算子落盘空间总大小，单位KB，值为-1表示未限制。

+

可使用的算子落盘空间总大小（预留字段，暂未使用），单位KB，值为-1表示未限制。

read_kbytes

@@ -96,7 +96,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在数据库节点上复杂作业read的字节总数（单位KB）。

数据库节点：实例启动至当前时间为止，该用户复杂作业read的字节总数（单位KB）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_kbytes

@@ -105,7 +105,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在数据库节点上复杂作业write的字节总数（单位KB）。

数据库节点：实例启动至当前时间为止，该用户复杂作业write的字节总数（单位KB）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

read_counts

@@ -114,7 +114,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在数据库节点上复杂作业read的次数之和（单位次）。

数据库节点：实例启动至当前时间为止，该用户复杂作业read的次数之和（单位次）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_counts

@@ -123,7 +123,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在数据库节点上复杂作业write的次数之和（单位次）。

数据库节点：实例启动至当前时间为止，该用户复杂作业write的次数之和（单位次）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

read_speed

@@ -132,7 +132,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在单个数据库节点上复杂作业read平均速率（单位KB/s）。

数据库节点：过去5秒内，该用户在该数据库节点上复杂作业read平均速率（单位KB/s）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_speed

@@ -141,9 +141,8 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在单个数据库节点上复杂作业write平均速率（单位KB/s）。

数据库节点：过去5秒内，该用户在该数据库节点上复杂作业write平均速率（单位KB/s）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

- diff --git a/content/docs-lite/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO_OID.md b/content/docs-lite/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO_OID.md index 2ae0174b3..427eeeb0c 100644 --- a/content/docs-lite/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO_OID.md +++ b/content/docs-lite/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO_OID.md @@ -24,7 +24,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO\_OID视图显示所有用户资源使用情况

integer

-

正在使用的内存大小，单位MB。

+

正在使用的内存大小（表示用户当前活跃的session已使用的内存总大小，若当前未运行业务或会话已结束，则动态内存会自动回收即为0。），单位MB。

total_memory

@@ -38,7 +38,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO\_OID视图显示所有用户资源使用情况

double precision

-

正在使用的CPU核数。

+

正在使用的CPU核数（仅统计复杂作业CPU使用 情况，且该值为相关控制组的CPU使用统计值）。

total_cpu

@@ -66,70 +66,70 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO\_OID视图显示所有用户资源使用情况

bigint

-

已使用的临时空间大小，单位KB

+

已使用的临时空间大小（预留字段，暂未使用），单位KB。

total_temp_space

bigint

-

可使用的临时空间总大小，单位KB，值为-1表示未限制。

+

可使用的临时空间总大小（预留字段，暂未使用），单位KB，值为-1表示未限制。

used_spill_space

bigint

-

已使用的下盘空间大小。单位KB。

+

已使用的下盘空间大小（预留字段，暂未使用）。单位KB。

total_spill_space

bigint

-

可使用的下盘空间总大小，单位KB，值为-1表示未限制。

+

可使用的下盘空间总大小（预留字段，暂未使用），单位KB，值为-1表示未限制。

read_kbytes

bigint

-

读磁盘数据量，单位KB。

+

读磁盘数据量，单位KB。（当前不支持，仅分布式可用。）

write_kbytes

bigint

-

写磁盘数据量，单位KB。

+

写磁盘数据量，单位KB。（当前不支持，仅分布式可用。）

read_counts

bigint

-

读磁盘次数。

+

读磁盘次数。（当前不支持，仅分布式可用。）

write_counts

bigint

-

写磁盘次数。

+

写磁盘次数。（当前不支持，仅分布式可用。）

read_speed

double precision

-

读磁盘速率，单位B/ms。

+

读磁盘速率，单位B/ms。（当前不支持，仅分布式可用。）

write_speed

double precision

-

写磁盘速率，单位B/ms。

+

写磁盘速率，单位B/ms。（当前不支持，仅分布式可用。）

diff --git "a/content/docs-lite/zh/docs/DatabaseReference/\346\223\215\344\275\234\345\256\241\350\256\241.md" "b/content/docs-lite/zh/docs/DatabaseReference/\346\223\215\344\275\234\345\256\241\350\256\241.md" index fd30625b7..d1188cc7c 100644 --- "a/content/docs-lite/zh/docs/DatabaseReference/\346\223\215\344\275\234\345\256\241\350\256\241.md" +++ "b/content/docs-lite/zh/docs/DatabaseReference/\346\223\215\344\275\234\345\256\241\350\256\241.md" @@ -344,7 +344,7 @@

gs_set_obs_delete_location

-

gs_hadr_do_switchover

+

gs_hadr_do_switchover(已废除)

gs_set_obs_delete_location_with_slotname

diff --git a/content/docs-lite/zh/docs/SQLReference/WLM_USER_RESOURCE_RUNTIME.md b/content/docs-lite/zh/docs/SQLReference/WLM_USER_RESOURCE_RUNTIME.md index f9001e5c4..402af35ae 100644 --- a/content/docs-lite/zh/docs/SQLReference/WLM_USER_RESOURCE_RUNTIME.md +++ b/content/docs-lite/zh/docs/SQLReference/WLM_USER_RESOURCE_RUNTIME.md @@ -24,7 +24,7 @@ WLM\_USER\_RESOURCE\_RUNTIME视图显示所有用户资源使用情况，需要

integer

-

正在使用的内存大小，单位MB。

+

正在使用的内存大小（表示用户当前活跃的session已使用的内存总大小，若当前未运行业务或会话已结束，则动态内存会自动回收即为0。），单位MB。

total_memory

@@ -38,7 +38,7 @@ WLM\_USER\_RESOURCE\_RUNTIME视图显示所有用户资源使用情况，需要

integer

-

正在使用的CPU核数。

+

正在使用的CPU核数（仅统计复杂作业CPU使用 情况，且该值为相关控制组的CPU使用统计值）。

total_cpu

diff --git "a/content/docs-lite/zh/docs/SQLReference/\345\205\266\345\256\203\345\207\275\346\225\260.md" "b/content/docs-lite/zh/docs/SQLReference/\345\205\266\345\256\203\345\207\275\346\225\260.md" index d2f4e6f88..a32cedb0a 100644 --- "a/content/docs-lite/zh/docs/SQLReference/\345\205\266\345\256\203\345\207\275\346\225\260.md" +++ "b/content/docs-lite/zh/docs/SQLReference/\345\205\266\345\256\203\345\207\275\346\225\260.md" @@ -642,19 +642,11 @@ - pgxc\_unlock\_for\_sp\_database\(name Name\) - 描述：释放指定数据库锁。 - - 参数：数据库名 - - 返回值类型：布尔 + 描述：目前该接口已废弃，暂不可用。 - pgxc\_lock\_for\_sp\_database\(name Name\) - 描述：对指定的数据库加锁。 - - 参数：数据库名 - - 返回值类型：布尔 + 描述：目前该接口已废弃，暂不可用。 - copy\_error\_log\_create\(\) diff --git "a/content/docs-lite/zh/docs/SQLReference/\345\272\237\345\274\203\345\207\275\346\225\260.md" "b/content/docs-lite/zh/docs/SQLReference/\345\272\237\345\274\203\345\207\275\346\225\260.md" index 194416c81..24132e870 100644 --- "a/content/docs-lite/zh/docs/SQLReference/\345\272\237\345\274\203\345\207\275\346\225\260.md" +++ "b/content/docs-lite/zh/docs/SQLReference/\345\272\237\345\274\203\345\207\275\346\225\260.md" @@ -93,6 +93,70 @@ openGauss中下列函数在最新版本中已废弃：

-

+ +

pg_stat_get_wlm_operator_info

+ +

gs_wlm_get_resource_pool_info(int)

+ +

gs_wlm_get_all_user_resource_info

+ +

create_wlm_operator_info

+ +

create_wlm_session_info

+ +

gs_wlm_get_workload_records

+ +

gs_wlm_persistent_user_resource_info

+ + + +

gs_wlm_session_respool

+ +

gs_total_nodegroup_memory_detail

+ +

gs_wlm_user_resource_info(name text)

+ +

create_wlm_instance_statistics_info

+ +

pg_stat_get_session_wlmstat

+ +

pg_stat_get_wlm_ec_operator_info

+ +

pg_stat_get_wlm_instance_info

+ + + +

pg_stat_get_wlm_instance_info_with_cleanup

+ +

pg_stat_get_wlm_statistics

+ +

pg_stat_get_wlm_realtime_session_info

+ +

gs_upload_obs_file

+ +

gs_download_obs_file

+ +

gs_set_obs_file_context

+ +

gs_get_hadr_key_cn

+ + + +

gs_hadr_do_switchover

+ +

track_memory_context(context_list text)

+ +

track_memory_context_detail

+ +

pgxc_unlock_for_sp_database

+ +

local_segment_space_info

+ +

pg_stat_segment_extent_usage

+ +

GS_ALL_NODEGROUP_CONTROL_GROUP_INFO

+ + diff --git "a/content/docs-lite/zh/docs/SQLReference/\346\225\260\347\273\204\345\207\275\346\225\260\345\222\214\346\223\215\344\275\234\347\254\246.md" "b/content/docs-lite/zh/docs/SQLReference/\346\225\260\347\273\204\345\207\275\346\225\260\345\222\214\346\223\215\344\275\234\347\254\246.md" index 8940f31ee..c6759b49c 100644 --- "a/content/docs-lite/zh/docs/SQLReference/\346\225\260\347\273\204\345\207\275\346\225\260\345\222\214\346\223\215\344\275\234\347\254\246.md" +++ "b/content/docs-lite/zh/docs/SQLReference/\346\225\260\347\273\204\345\207\275\346\225\260\345\222\214\346\223\215\344\275\234\347\254\246.md" @@ -405,19 +405,7 @@ - array\_extendnull\(anyarray, int\) - 描述：往数组尾部添加指定个数的null空元素。 - - 返回类型：anyarray - - 示例： - - ``` - openGauss=# SELECT array_extendnull(ARRAY[1,8,3,7],1) AS RESULT; - result - -------------- - {1,8,3,7,null} - (1 row) - ``` + 描述：目前该接口已废弃，暂不可用。 - array\_trim\(anyarray, int\) diff --git "a/content/docs-lite/zh/docs/SQLReference/\346\256\265\351\241\265\345\274\217\345\255\230\345\202\250\345\207\275\346\225\260.md" "b/content/docs-lite/zh/docs/SQLReference/\346\256\265\351\241\265\345\274\217\345\255\230\345\202\250\345\207\275\346\225\260.md" index 5ba23ca08..19ce12e7e 100644 --- "a/content/docs-lite/zh/docs/SQLReference/\346\256\265\351\241\265\345\274\217\345\255\230\345\202\250\345\207\275\346\225\260.md" +++ "b/content/docs-lite/zh/docs/SQLReference/\346\256\265\351\241\265\345\274\217\345\255\230\345\202\250\345\207\275\346\225\260.md" @@ -2,121 +2,11 @@ - local\_segment\_space\_info\(tablespacename TEXT, databasename TEXT\) - 描述：输出为该表空间下所有ExtentGroup的使用信息。 - - 返回值类型： - - - - - - - - - - - - - - - - - - - - - - - - - - - -

node_name

-

节点名称。

-

extent_size

-

该ExtentGroup的extent规格，单位是block数。

-

forknum

-

Fork号。

-

total_blocks

-

物理文件总extent数目。

-

meta_data_blocks

-

表空间管理的metadata占用的block数，只包括space header，map page等，不包括segment head。

-

used_data_blocks

-

存数据占用的extent数目。包括segment head。

-

utilization

-

使用的block数占总block数的百分比。即(used_data_blocks+meta_data_block)/total_blocks。

-

high_water_mark

-

高水位线，被分配出去的extent，最大的物理页号。超过高水位线的block都没有被使用，可以被直接回收。

-
- - 例如： - - ``` - select * from local_segment_space_info('pg_default', 'postgres'); - node_name | extent_size | forknum | total_blocks | meta_data_blocks | used_data_blocks | utilization | high_water_mark - -------------------+-------------+---------+--------------+------------------+------------------+-------------+----------------- - dn_6001_6002_6003 | 1 | 0 | 16384 | 4157 | 1 | .253784 | 4158 - dn_6001_6002_6003 | 8 | 0 | 16384 | 4157 | 8 | .254211 | 4165 - (2 rows) - ``` + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_segment\_extent\_usage\(int4 tablespace oid, int4 database oid, int4 extent\_type, int4 forknum\) - 描述：每次返回一个ExtentGroup中，每个被分配出去的extent的使用情况。extent\_type表示ExtentGroup的类型，合理取值为\[1,5\]的int值。在此范围外的会报error。forknum 表示fork号，合法取值为\[0,4\]的int值，目前只有三种值有效，数据文件为0，FSM文件为1，visibility map文件为2。 - - 返回值类型： - - - - - - - - - - - - - - - - - - - - - - -

名称

-

描述

-

start_block

-

Extent的起始物理页号。

-

extent_size

-

Extent的大小。

-

usage_type

-

Extent的使用类型，比如segment head，data extent等。

-

ower_location

-

有指针指向该extent的对象的位置。比如data extent的owner就是它所属的segment的head位置。

-

special_data

-

该extent在它owner中的位置。该字段的数据跟使用类型有关。比如data extent的special data就是它在所属segment中的extent id。

-
- - 其中，usage\_type为枚举类型，每一项的含义为： - - - Non-bucket table segment head ： 非hashbucket表的数据段头。 - - Non-bucket table fork head： 非段页式表的fork段头。 - - Data extent： 数据块。 - - 例如： - - ``` - select * from pg_stat_segment_extent_usage((select oid::int4 from pg_tablespace where spcname='pg_default'), (select oid::int4 from pg_database where datname='postgres'), 1, 0); - start_block | extent_size | usage_type | ower_location | special_data - -------------+-------------+------------------------+---------------+-------------- - 4157 | 1 | Data extent | 4294967295 | 0 - 4158 | 1 | Data extent | 4157 | 0 - ``` + 描述：目前该接口已废弃，暂不可用。 - local\_space\_shrink\(tablespacename TEXT, databasename TEXT\) diff --git "a/content/docs-lite/zh/docs/SQLReference/\347\263\273\347\273\237\344\277\241\346\201\257\345\207\275\346\225\260.md" "b/content/docs-lite/zh/docs/SQLReference/\347\263\273\347\273\237\344\277\241\346\201\257\345\207\275\346\225\260.md" index 44032a696..4bed7259d 100644 --- "a/content/docs-lite/zh/docs/SQLReference/\347\263\273\347\273\237\344\277\241\346\201\257\345\207\275\346\225\260.md" +++ "b/content/docs-lite/zh/docs/SQLReference/\347\263\273\347\273\237\344\277\241\346\201\257\345\207\275\346\225\260.md" @@ -2048,19 +2048,11 @@ txid\_snapshot的文本表示为：xmin:xmax:xip\_list。 - pg\_stat\_get\_wlm\_node\_resource\_info - 描述：获取当前节点资源信息。 - - 参数：nan - - 返回值类型：min\_mem\_util integer, max\_mem\_util integer, min\_cpu\_util integer, max\_cpu\_util integer, min\_io\_util integer, max\_io\_util integer, used\_mem\_rate integer + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_session\_wlmstat - 描述：返回当前会话负载信息。 - - 参数：pid integer - - 返回值类型：datid oid, threadid bigint, sessionid bigint, threadpid integer, usesysid oid, appname text, query text, priority bigint, block\_time bigint, elapsed\_time bigint, total\_cpu\_time bigint, skew\_percent integer, statement\_mem integer, active\_points integer, dop\_value integer, current\_cgroup text, current\_status text, enqueue\_state text, attribute text, is\_plana boolean, node\_group text, srespool name + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_wlm\_ec\_operator\_info @@ -2072,27 +2064,15 @@ txid\_snapshot的文本表示为：xmin:xmax:xip\_list。 - pg\_stat\_get\_wlm\_instance\_info - 描述：返回当前实例负载信息。 - - 参数：nan - - 返回值类型：instancename text, timestamp timestamp with time zone, used\_cpu integer, free\_memory integer, used\_memory integer, io\_await double precision, io\_util double precision, disk\_read double precision, disk\_write double precision, process\_read bigint, process\_write bigint, logical\_read bigint, logical\_write bigint, read\_counts bigint, write\_counts bigint + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_wlm\_instance\_info\_with\_cleanup - 描述：返回当前实例负载信息，并且保存到系统表中。 - - 参数：nan - - 返回值类型：instancename text, timestamp timestamp with time zone, used\_cpu integer, free\_memory integer, used\_memory integer, io\_await double precision, io\_util double precision, disk\_read double precision, disk\_write double precision, process\_read bigint, process\_write bigint, logical\_read bigint, logical\_write bigint, read\_counts bigint, write\_counts bigint + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_wlm\_realtime\_session\_info - 描述：返回实时会话负载信息。 - - 参数：nan - - 返回值类型：nodename text, threadid bigint, block\_time bigint, duration bigint, estimate\_total\_time bigint, estimate\_left\_time bigint, schemaname text, query\_band text, spill\_info text, control\_group text, estimate\_memory integer, min\_peak\_memory integer, max\_peak\_memory integer, average\_peak\_memory integer, memory\_skew\_percent integer, min\_spill\_size integer, max\_spill\_size integer, average\_spill\_size integer, spill\_skew\_percent integer, min\_dn\_time bigint, max\_dn\_time bigint, average\_dn\_time bigint, dntime\_skew\_percent integer, min\_cpu\_time bigint, max\_cpu\_time bigint, total\_cpu\_time bigint, cpu\_skew\_percent integer, min\_peak\_iops integer, max\_peak\_iops integer, average\_peak\_iops integer, iops\_skew\_percent integer, warning text, query text, query\_plan text, cpu\_top1\_node\_name text, cpu\_top2\_node\_name text, cpu\_top3\_node\_name text, cpu\_top4\_node\_name text, cpu\_top5\_node\_name text, mem\_top1\_node\_name text, mem\_top2\_node\_name text, mem\_top3\_node\_name text, mem\_top4\_node\_name text, mem\_top5\_node\_name text, cpu\_top1\_value bigint, cpu\_top2\_value bigint, cpu\_top3\_value bigint, cpu\_top4\_value bigint, cpu\_top5\_value bigint, mem\_top1\_value bigint, mem\_top2\_value bigint, mem\_top3\_value bigint, mem\_top4\_value bigint, mem\_top5\_value bigint, top\_mem\_dn text, top\_cpu\_dn text + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_wlm\_session\_iostat\_info @@ -2104,10 +2084,5 @@ txid\_snapshot的文本表示为：xmin:xmax:xip\_list。 - pg\_stat\_get\_wlm\_statistics - 描述：返回会话负载统计数据。 - - 参数：nan - - 返回值类型：statement text, block\_time bigint, elapsed\_time bigint, total\_cpu\_time bigint, qualification\_time bigint, skew\_percent integer, control\_group text, status text, action text - + Description: This API has been discarded and is unavailable currently. diff --git "a/content/docs-lite/zh/docs/SQLReference/\347\273\237\350\256\241\344\277\241\346\201\257\345\207\275\346\225\260.md" "b/content/docs-lite/zh/docs/SQLReference/\347\273\237\350\256\241\344\277\241\346\201\257\345\207\275\346\225\260.md" index 966b42cdf..4d7ae41b9 100644 --- "a/content/docs-lite/zh/docs/SQLReference/\347\273\237\350\256\241\344\277\241\346\201\257\345\207\275\346\225\260.md" +++ "b/content/docs-lite/zh/docs/SQLReference/\347\273\237\350\256\241\344\277\241\346\201\257\345\207\275\346\225\260.md" @@ -1941,15 +1941,11 @@ - create\_wlm\_session\_info\(int flag\) - 描述：将当前内存中记录的TopSQL查询语句级别相关统计信息清理。该函数只有管理员用户可以执行。 - - 返回值类型：int + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_wlm\_session\_info\(int flag\) - 描述：获取当前内存中记录的TopSQL查询语句级别相关统计信息，当传入的参数不为0时，会将这部分信息从内存中清理掉。该函数只有system admin和monitor admin用户可以执行。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - gs\_paxos\_stat\_replication\(\) @@ -2088,15 +2084,11 @@ - gs\_wlm\_get\_resource\_pool\_info\(int\) - 描述：获取所有用户的资源使用统计信息，入参为int类型可以为可以为任意int值或NULL。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - gs\_wlm\_get\_all\_user\_resource\_info\(\) - 描述：获取所有用户的资源使用统计信息。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - gs\_wlm\_get\_user\_info\(int\) @@ -2104,11 +2096,77 @@ 返回值类型：record -- gs\_wlm\_get\_workload\_records\(\) + 返回字段说明如下： + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

字段名称

+

字段类型

+

字段说明

+

userid

+

oid

+

用户OID。

+

sysadmin

+

boolean

+

是否是管理员用户。

+

rpoid

+

oid

+

关联的资源池的OID。

+

parentid

+

oid

+

用户组的OID

+

totalspace

+

bigint

+

用户可用的空间上限。

+

spacelimit

+

bigint

+

用户的表空间限制。

+

childcount

+

integer

+

子用户的个数。

+

childlist

+

text

+

子用户列表。

+
- 描述：获取动态负载管理下的所有作业信息，该函数只在动态负载管理开的情况下有效。 +- gs\_wlm\_get\_workload\_records\(\) - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - gs\_wlm\_readjust\_user\_space\(\) @@ -2116,6 +2174,11 @@ 返回值类型：record + >![](public_sys-resources/icon-note.png) **说明：** + > + >在use_workload_manager参数由off变为on状态后，不会统计off时的存储资源。如果需要统计off时用户使用的存储资源，在数据库中执行SQL语句： + SELECT gs_wlm_readjust_user_space(0); + - gs\_wlm\_readjust\_user\_space\_through\_username\(text name\) 描述：修正指定用户的存储空间使用情况。该函数普通用户只能修正自己的使用情况，只有管理员用户可以修正所有用户的使用情况。当name指定位“0000”，表示需要修正所有用户的使用情况。 @@ -2130,9 +2193,7 @@ - gs\_wlm\_session\_respool\(bigint\) - 描述：获取当前所有后台线程的session resouce pool相关信息，入参为bigint类型可以为可以为任意bigint值或NULL。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - gs\_wlm\_get\_session\_info\(\) @@ -2565,15 +2626,11 @@ - DBE\_PERF.track\_memory\_context\(context\_list text\) - 描述：设置需要统计内存申请详细信息的内存上下文。入参为内存上下文的名称，使用“，”分隔，如“ThreadTopMemoryContext, SessionCacheMemoryContext”，注意该内存上下文名称是上下文敏感的。此外，单个内存上下文的长度为63，超过的部分会被截断。而且一次能够统计的内存上下文上限为16个，设置超过16个内存上下文会设置失败。每一次调用该函数都会将上次统计的结果清空，当入参指定为“”时，表示取消该统计功能。只有初始用户（super user）或者具有monadmin权限的用户可以执行该函数。 - - 返回值类型：boolean + 描述：目前该接口已废弃，暂不可用。 - DBE\_PERF.track\_memory\_context\_detail\(\) - 描述：获取DBE\_PERF.track\_memory\_context函数指定的内存上下文的内存申请详细信息。返回值的定义见视图DBE\_PERF.track\_memory\_context\_detail。只有初始用户（super user）或者具有monadmin权限的用户可以执行该函数。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_mem\_mbytes\_reserved\(tid\) @@ -2585,9 +2642,7 @@ - gs\_wlm\_user\_resource\_info\(name text\) - 描述：查询具体某个用户的资源限额和资源使用情况。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_file\_stat\(\) @@ -2761,17 +2816,11 @@ - gs\_wlm\_user\_resource\_info\(name text\) - 描述：查询具体某个用户的资源限额和资源使用情况。普通用户只能查询到自己相关的信息，管理员权限的用户可以查看全部用户的信息。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - create\_wlm\_instance\_statistics\_info - 描述：将当前实例的历史监控数据进行持久化保存。 - - 参数：nan - - 返回值类型：integer + 描述：目前该接口已废弃，暂不可用。 - gs\_session\_memory @@ -2827,19 +2876,15 @@ - gs\_wlm\_persistent\_user\_resource\_info\(\) - 描述：将当前所有的用户资源使用统计信息归档到gs\_wlm\_user\_resource\_history系统表中，只有sysadmin有权限查询。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - create\_wlm\_operator\_info\(int flag\) - 描述：将当前内存中记录的TopSQL算子级别相关统计信息清理，当传入的参数大于0时，会将这部分信息归档到gs\_wlm\_operator\_info和gs\_wlm\_ec\_operator\_info中，否则不会归档。该函数只有sysadmin权限的用户可以执行。 - - 返回值类型：int + 描述：目前该接口已废弃，暂不可用。 - GS\_ALL\_NODEGROUP\_CONTROL\_GROUP\_INFO\(text\) - 描述：提供了所有逻辑数据库实例的控制组信息。该函数在调用的时候需要指定要查询逻辑数据库实例的名称。例如要查询'installation'逻辑数据库实例的控制组信息： + 描述：目前该接口已废弃，暂不可用。 ``` SELECT * FROM GS_ALL_NODEGROUP_CONTROL_GROUP_INFO('installation') @@ -2933,11 +2978,7 @@ - gs\_total\_nodegroup\_memory\_detail - 描述：返回当前数据库逻辑数据库使用内存的信息，单位为MB得到一个逻辑数据 - - 库。 - - 返回值类型：setof record + 描述：目前该接口已废弃，暂不可用。 - local\_redo\_time\_count\(\) diff --git a/content/en/docs/DatabaseReference/gs_wlm_user_resource_history.md b/content/en/docs/DatabaseReference/gs_wlm_user_resource_history.md index e1a0f2e90..09c4384b2 100644 --- a/content/en/docs/DatabaseReference/gs_wlm_user_resource_history.md +++ b/content/en/docs/DatabaseReference/gs_wlm_user_resource_history.md @@ -31,7 +31,7 @@

integer

-

Size of the memory being used, in MB

+

Size of the memory being used(The total size of memory used by the user's current active session. If no business is running or the session has ended, the dynamic memory will be automatically reclaimed, resulting in a size of 0.), in MB

total_memory

@@ -45,7 +45,7 @@

real

-

Number of CPU cores in use

+

Number of CPU cores in use. CPU usage data is collected only in complex jobs, and the value is the CPU usage of the related Cgroup.

total_cpu

@@ -73,70 +73,70 @@

bigint

-

Used temporary storage space, in KB

+

Used temporary storage space(Reserved field, not in use yet.), in KB

total_temp_space

bigint

-

Available temporary storage space, in KB. The value –1 indicates that the maximum temporary storage space is not limited.

+

Available temporary storage space(Reserved field, not in use yet.), in KB. The value –1 indicates that the maximum temporary storage space is not limited.

used_spill_space

bigint

-

Used space of operator flushing, in KB

+

Used space of operator flushing(Reserved field, not in use yet.), in KB

total_spill_space

bigint

-

Available storage space for operator flushing, in KB. The value –1 indicates that the maximum operator flushing space is not limited.

+

Available storage space for operator flushing(Reserved field, not in use yet.), in KB. The value –1 indicates that the maximum operator flushing space is not limited.

read_kbytes

bigint

-

Byte traffic of read operations in a monitoring period, in KB

+

Byte traffic of read operations in a monitoring period(Not supported currently, available only in distributed mode.), in KB

write_kbytes

bigint

-

Byte traffic of write operations in a monitoring period, in KB

+

Byte traffic of write operations in a monitoring period(Not supported currently, available only in distributed mode.), in KB

read_counts

bigint

-

Number of read operations in a monitoring period

+

Number of read operations in a monitoring period(Not supported currently, available only in distributed mode.)

write_counts

bigint

-

Number of write operations in a monitoring period

+

Number of write operations in a monitoring period(Not supported currently, available only in distributed mode.)

read_speed

real

-

Byte rate of read operations in a monitoring period, in KB/s

+

Byte rate of read operations in a monitoring period(Not supported currently, available only in distributed mode.), in KB/s

write_speed

real

-

Byte rate of write operations in a monitoring period, in KB/s

+

Byte rate of write operations in a monitoring period(Not supported currently, available only in distributed mode.), in KB/s

diff --git a/content/en/docs/DatabaseReference/pg_total_user_resource_info.md b/content/en/docs/DatabaseReference/pg_total_user_resource_info.md index 41697bb52..d9ed2f762 100644 --- a/content/en/docs/DatabaseReference/pg_total_user_resource_info.md +++ b/content/en/docs/DatabaseReference/pg_total_user_resource_info.md @@ -24,7 +24,7 @@

integer

-

Used memory, in MB

+

Used memory(The total size of memory used by the user's current active session. If no business is running or the session has ended, the dynamic memory will be automatically reclaimed, resulting in a size of 0.), in MB

total_memory

@@ -66,28 +66,28 @@

bigint

-

Used temporary space, in KB

+

Used temporary space(Reserved field, not in use yet.), in KB

total_temp_space

bigint

-

Total available temporary space, in KB (-1 if the temporary space is not limited)

+

Total available temporary space(Reserved field, not in use yet.), in KB (-1 if the temporary space is not limited)

used_spill_space

bigint

-

Size of the used operator flushing space, in KB

+

Size of the used operator flushing space(Reserved field, not in use yet.), in KB

total_spill_space

bigint

-

Total size of the available operator flushing space, in KB (-1 if the space is not limited)

+

Total size of the available operator flushing space(Reserved field, not in use yet.), in KB (-1 if the space is not limited)

read_kbytes

@@ -96,6 +96,7 @@

Primary database node: total bytes read by the user's complex jobs on all database nodes in the last 5 seconds, in KB

Database node: total bytes read by the user's complex jobs from the instance startup time to the current time, in KB

+

Not supported currently, available only in distributed mode.

write_kbytes

@@ -104,6 +105,7 @@

Primary database node: total bytes written by the user's complex jobs on all database nodes in the last 5 seconds, in KB

Database node: total bytes written by the user's complex jobs from the instance startup time to the current time, in KB

+

Not supported currently, available only in distributed mode.

read_counts

@@ -112,6 +114,7 @@

Primary database node: total number of read times of the user's complex jobs on all database nodes in the last 5 seconds

Database node: total number of read times of the user's complex jobs from the instance startup time to the current time

+

Not supported currently, available only in distributed mode.

write_counts

@@ -120,6 +123,7 @@

Primary database node: total number of write times of the user's complex jobs on all database nodes in the last 5 seconds

Database node: total number of write times of the user's complex jobs from the instance startup time to the current time

+

Not supported currently, available only in distributed mode.

read_speed

@@ -128,6 +132,7 @@

Primary database node: average read rate of the user's complex jobs on a single database node in the last 5 seconds, in KB/s

Database node: average read rate of the user's complex jobs on the database node in the last 5 seconds, in KB/s

+

Not supported currently, available only in distributed mode.

write_speed

@@ -136,6 +141,7 @@

Primary database node: average write rate of the user's complex jobs on a single database node in the last 5 seconds, in KB/s

Database node: average write rate of the user's complex jobs on the database node in the last 5 seconds, in KB/s

+

Not supported currently, available only in distributed mode.

diff --git a/content/en/docs/DatabaseReference/pg_total_user_resource_info_oid.md b/content/en/docs/DatabaseReference/pg_total_user_resource_info_oid.md index 77a677639..abca839ac 100644 --- a/content/en/docs/DatabaseReference/pg_total_user_resource_info_oid.md +++ b/content/en/docs/DatabaseReference/pg_total_user_resource_info_oid.md @@ -24,7 +24,7 @@

integer

-

Size of the memory being used, in MB.

+

Size of the memory being used(The total size of memory used by the user's current active session. If no business is running or the session has ended, the dynamic memory will be automatically reclaimed, resulting in a size of 0.), in MB.

total_memory

@@ -38,7 +38,7 @@

double precision

-

Number of CPU cores in use.

+

Number of CPU cores in use. CPU usage data is collected only in complex jobs, and the value is the CPU usage of the related Cgroup.

total_cpu

@@ -66,70 +66,70 @@

bigint

-

Used temporary storage space, in KB.

+

Used temporary storage space(Reserved field, not in use yet.), in KB.

total_temp_space

bigint

-

Total available temporary space, in KB (-1 if the temporary space is not limited).

+

Total available temporary space(Reserved field, not in use yet.), in KB (-1 if the temporary space is not limited).

used_spill_space

bigint

-

Used disk space for spilling, in KB.

+

Used disk space for spilling(Reserved field, not in use yet.), in KB.

total_spill_space

bigint

-

Total available disk space for spilling, in KB. The value -1 indicates that the space is not limited.

+

Total available disk space for spilling(Reserved field, not in use yet.), in KB. The value -1 indicates that the space is not limited.

read_kbytes

bigint

-

Amount of data read from the disk, in KB.

+

Amount of data read from the disk(Not supported currently, available only in distributed mode.), in KB.

write_kbytes

bigint

-

Amount of data written to the disk, in KB.

+

Amount of data written to the disk(Not supported currently, available only in distributed mode.), in KB.

read_counts

bigint

-

Number of disk read times.

+

Number of disk read times(Not supported currently, available only in distributed mode.).

write_counts

bigint

-

Number of disk write times.

+

Number of disk write times(Not supported currently, available only in distributed mode.).

read_speed

double precision

-

Disk read rate, in B/ms.

+

Disk read rate(Not supported currently, available only in distributed mode.), in B/ms.

write_speed

double precision

-

Disk write rate, in B/ms.

+

Disk write rate(Not supported currently, available only in distributed mode.), in B/ms.

diff --git a/content/en/docs/SQLReference/array-functions-and-operators.md b/content/en/docs/SQLReference/array-functions-and-operators.md index 8f9906cd7..1156c882d 100644 --- a/content/en/docs/SQLReference/array-functions-and-operators.md +++ b/content/en/docs/SQLReference/array-functions-and-operators.md @@ -501,19 +501,7 @@ Array comparisons compare the array contents element-by-element, using the defau - array\_extendnull\(anyarray, int\) - Description: Adds a specified number of null elements to the end of an array. - - Return type: anyarray - - Example: - - ``` - openGauss=# SELECT array_extendnull(ARRAY[1,8,3,7],1) AS RESULT; - result - -------------- - {1,8,3,7,null} - (1 row) - ``` + Description: This API has been discarded and is unavailable currently. - array\_trim\(anyarray, int\) diff --git a/content/en/docs/SQLReference/obsolete-functions.md b/content/en/docs/SQLReference/obsolete-functions.md index 9b925843f..9e86dcfce 100644 --- a/content/en/docs/SQLReference/obsolete-functions.md +++ b/content/en/docs/SQLReference/obsolete-functions.md @@ -78,19 +78,84 @@ The following functions in openGauss have been discarded in the latest version:

pg_pool_validate

+

gs_stat_ustore

table_skewness(text)

table_skewness(text, text, text)

-

-

+

pg_stat_get_wlm_realtime_operator_info

+ +

pg_stat_get_wlm_realtime_ec_operator_info

+ +

pg_stat_get_wlm_ec_operator_info

+ +

gs_stat_get_wlm_plan_operator_info

+ + + +

pg_stat_get_wlm_operator_info

+ +

gs_wlm_get_resource_pool_info(int)

+ +

gs_wlm_get_all_user_resource_info

+ +

create_wlm_operator_info

+ +

create_wlm_session_info

+ +

gs_wlm_get_workload_records

+ +

gs_wlm_persistent_user_resource_info

+ + + +

gs_wlm_session_respool

+ +

gs_total_nodegroup_memory_detail

+ +

gs_wlm_user_resource_info(name text)

+ +

create_wlm_instance_statistics_info

+ +

pg_stat_get_session_wlmstat

+ +

pg_stat_get_wlm_ec_operator_info

+ +

pg_stat_get_wlm_instance_info

+ + + +

pg_stat_get_wlm_instance_info_with_cleanup

+ +

pg_stat_get_wlm_statistics

+ +

pg_stat_get_wlm_realtime_session_info

+ +

gs_upload_obs_file

+ +

gs_download_obs_file

+ +

gs_set_obs_file_context

+ +

gs_get_hadr_key_cn

+ + + +

gs_hadr_do_switchover

+ +

track_memory_context(context_list text)

+ +

track_memory_context_detail

+ +

pgxc_unlock_for_sp_database

-

-

+

local_segment_space_info

-

-

+

pg_stat_segment_extent_usage

-

-

+

GS_ALL_NODEGROUP_CONTROL_GROUP_INFO

diff --git a/content/en/docs/SQLReference/other-functions.md b/content/en/docs/SQLReference/other-functions.md index 3a836bd22..8d9ab11fc 100644 --- a/content/en/docs/SQLReference/other-functions.md +++ b/content/en/docs/SQLReference/other-functions.md @@ -641,19 +641,11 @@ - pgxc\_unlock\_for\_sp\_database\(name Name\) - Description: Releases a specified database lock. - - Parameter: database name - - Return type: Boolean + Description: This API has been discarded and is unavailable currently. - pgxc\_lock\_for\_sp\_database\(name Name\) - Description: Locks a specified database. - - Parameter: database name - - Return type: Boolean + Description: This API has been discarded and is unavailable currently. - copy\_error\_log\_create\(\) diff --git a/content/en/docs/SQLReference/segment-page-storage-functions.md b/content/en/docs/SQLReference/segment-page-storage-functions.md index 2695fd506..bef441f81 100644 --- a/content/en/docs/SQLReference/segment-page-storage-functions.md +++ b/content/en/docs/SQLReference/segment-page-storage-functions.md @@ -2,121 +2,11 @@ - local\_segment\_space\_info\(tablespacename TEXT, databasename TEXT\) - Description: Generates usage information about all extent groups in the tablespace. - - Return type: - - - - - - - - - - - - - - - - - - - - - - - - - - - -

node_name

-

Node name

-

extent_size

-

Extent specifications of an extent group. The unit is the number of blocks.

-

forknum

-

Fork number

-

total_blocks

-

Total number of extents in a physical file

-

meta_data_blocks

-

Number of blocks occupied by the metadata managed in a tablespace, including the space header and map page but excluding the segment head

-

used_data_blocks

-

Number of extents used for storing data, including the segment head

-

utilization

-

Percentage of the number of used blocks to the total number of blocks, that is, (the value of used_data_blocks + the value of meta_data_block)/the value of total_blocks

-

high_water_mark

-

High-water mark, indicating the number of allocated extents and maximum physical page number. Blocks that exceed the high-water mark are not used and can be directly recycled.

-
- - Example: - - ``` - select * from local_segment_space_info('pg_default', 'postgres'); - node_name | extent_size | forknum | total_blocks | meta_data_blocks | used_data_blocks | utilization | high_water_mark - -------------------+-------------+---------+--------------+------------------+------------------+-------------+----------------- - dn_6001_6002_6003 | 1 | 0 | 16384 | 4157 | 1 | .253784 | 4158 - dn_6001_6002_6003 | 8 | 0 | 16384 | 4157 | 8 | .254211 | 4165 - (2 rows) - ``` + Description: This API has been discarded and is unavailable currently. - pg\_stat\_segment\_extent\_usage\(int4 tablespace oid, int4 database oid, int4 extent\_type, int4 forknum\) - Description: Specifies the usage information of each allocated extent in an extent group returned each time. **extent\_type** indicates the type of the extent group. The value is an integer ranging from 1 to 5. If the value is not within the range, an error is reported. **forknum** indicates the fork number. The value is an integer ranging from 0 to 4. Currently, only the following values are valid: **0** for data files, **1** for FSM files, and **2** for visibility map files. - - Return type: - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Description

-

start_block

-

Start physical page number of an extent

-

extent_size

-

Size of an extent

-

usage_type

-

Usage type of an extent, for example, segment head and data extent

-

ower_location

-

Object location of an extent to which a pointer points. For example, the owner of a data extent is the head of the segment to which the data extent belongs.

-

special_data

-

Position of an extent in its owner. The value of this field is related to the usage type. For example, special data of a data extent is the extent ID in the segment to which the data extent belongs.

-
- - The value of **usage\_type** is enumerated. The meaning of each value is as follows: - - - **Non-bucket table segment head**: data segment head of a non-hash bucket table - - **Non-bucket table fork head**: fork segment header of a non-segment-page table - - **Data extent**: data block - - Example: - - ``` - select * from pg_stat_segment_extent_usage((select oid::int4 from pg_tablespace where spcname='pg_default'), (select oid::int4 from pg_database where datname='postgres'), 1, 0); - start_block | extent_size | usage_type | ower_location | special_data - -------------+-------------+------------------------+---------------+-------------- - 4157 | 1 | Data extent | 4294967295 | 0 - 4158 | 1 | Data extent | 4157 | 0 - ``` + Description: This API has been discarded and is unavailable currently. - local\_space\_shrink\(tablespacename TEXT, databasename TEXT\) diff --git a/content/en/docs/SQLReference/statistics-information-functions.md b/content/en/docs/SQLReference/statistics-information-functions.md index 24215a7aa..5c35242c2 100644 --- a/content/en/docs/SQLReference/statistics-information-functions.md +++ b/content/en/docs/SQLReference/statistics-information-functions.md @@ -1923,15 +1923,11 @@ Statistics information functions are divided into the following two categories: - create\_wlm\_session\_info\(int flag\) - Description: Clears top SQL query statement-level statistics recorded in the current memory. Only the administrator can execute this function. - - Return type: int + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_session\_info\(int flag\) - Description: Obtains top SQL query statement-level statistics recorded in the current memory. If the input parameter is not 0, the information is cleared from the memory. Only users with the **system admin** or **monitor admin** permission can execute this function. - - Return type: record + Description: This API has been discarded and is unavailable currently. - gs\_paxos\_stat\_replication\(\) @@ -2066,15 +2062,11 @@ Statistics information functions are divided into the following two categories: - gs\_wlm\_get\_resource\_pool\_info\(int\) - Description: Obtains resource usage statistics of all users. The input parameter can be any value of the INT type or be null. - - Return type: record + Description: This API has been discarded and is unavailable currently. - gs\_wlm\_get\_all\_user\_resource\_info\(\) - Description: Obtains resource usage statistics of all users. - - Return type: record + Description: This API has been discarded and is unavailable currently. - gs\_wlm\_get\_user\_info\(int\) @@ -2082,11 +2074,78 @@ Statistics information functions are divided into the following two categories: Return type: record -- gs\_wlm\_get\_workload\_records\(\) + The following table describes return columns. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Column

+

Type

+

Description

+

userid

+

oid

+

OID of the user

+

sysadmin

+

boolean

+

Whether the user has the sysadmin permission

+

rpoid

+

oid

+

OID of the resource pool

+

parentid

+

oid

+

OID of the parent user

+

totalspace

+

bigint

+

Size of the occupied space

+

spacelimit

+

bigint

+

Upper limit of the space size

+

childcount

+

integer

+

Number of child users

+

childlist

+

text

+

Child user list

+
- Description: Obtains all job information in dynamic load management. This function is valid only when dynamic load management is enabled. +- gs\_wlm\_get\_workload\_records\(\) - Return type: record + Description: This API has been discarded and is unavailable currently. - gs\_wlm\_readjust\_user\_space\(\) @@ -2108,9 +2167,7 @@ Statistics information functions are divided into the following two categories: - gs\_wlm\_session\_respool\(bigint\) - Description: Obtains the session resource pool information about all backend threads. The input parameter can be any value of the bigint type or can be null. - - Return type: record + Description: This API has been discarded and is unavailable currently. - gs\_wlm\_get\_session\_info\(\) @@ -2543,15 +2600,11 @@ Statistics information functions are divided into the following two categories: - DBE\_PERF.track\_memory\_context\(context\_list text\) - Description: Sets the memory context whose memory application details need to be collected. The input parameter is 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 excess part is truncated. The maximum number of memory contexts that can be collected at a time is 16. If the number of memory contexts exceeds 16, the setting fails. Each time this function is called, the previous statistics result is cleared. When the input parameter is set to **""**, the statistics function is disabled. Only the initial user \(super user\) or a user with the **monadmin **permission can execute this function. - - Return type: Boolean + Description: This API has been discarded and is unavailable currently. - 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 \(super user\) or a user with the **monadmin **permission can execute this function. - - Return type: record + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_mem\_mbytes\_reserved\(tid\) @@ -2563,9 +2616,7 @@ Statistics information functions are divided into the following two categories: - gs\_wlm\_user\_resource\_info\(name text\) - Description: Queries a user's resource quota and resource usage. - - Return type: record + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_file\_stat\(\) @@ -2739,17 +2790,11 @@ Statistics information functions are divided into the following two categories: - gs\_wlm\_user\_resource\_info\(name text\) - Description: Queries a user's resource quota and resource usage. Common users can query only their own information. Administrators can query information about all users. - - Return type: record + Description: This API has been discarded and is unavailable currently. - create\_wlm\_instance\_statistics\_info - Description: Saves the historical monitoring data of the current instance persistently. - - Parameter: **nan** - - Return type: integer + Description: This API has been discarded and is unavailable currently. - gs\_session\_memory @@ -2804,25 +2849,15 @@ Statistics information functions are divided into the following two categories: - gs\_wlm\_persistent\_user\_resource\_info\(\) - Description: Archives all user resource usage statistics to the **gs\_wlm\_user\_resource\_history** system catalog. To query this function, you must have the **sysadmin** permission. - - Return type: record + Description: This API has been discarded and is unavailable currently. - create\_wlm\_operator\_info\(int flag\) - Description: Clears top SQL operator-level statistics recorded in the current memory. If the input parameter is greater than 0, the information is archived to **gs\_wlm\_operator\_info** and **gs\_wlm\_ec\_operator\_info**. Otherwise, the information is not archived. Only users with the **sysadmin** permission can execute this function. - - Return type: int + Description: This API has been discarded and is unavailable currently. - GS\_ALL\_NODEGROUP\_CONTROL\_GROUP\_INFO\(text\) - Description: Provides Cgroup information for all logical database instances. Before calling this function, you need to specify the name of the logical database instance to be queried. For example, to query the Cgroup information for the installation logical database instance, run the following command: - - ``` - SELECT * FROM GS_ALL_NODEGROUP_CONTROL_GROUP_INFO('installation') - ``` - - Return type: record + Description: This API has been discarded and is unavailable currently. The following table describes return columns. @@ -2910,9 +2945,7 @@ Statistics information functions are divided into the following two categories: - gs\_total\_nodegroup\_memory\_detail - Description: Returns information about the memory used by the current logical database, in MB. - - Return type: SETOF record + Description: This API has been discarded and is unavailable currently. - local\_redo\_time\_count\(\) diff --git a/content/en/docs/SQLReference/system-information-functions.md b/content/en/docs/SQLReference/system-information-functions.md index 08a9f21ff..d0a4ebc4b 100644 --- a/content/en/docs/SQLReference/system-information-functions.md +++ b/content/en/docs/SQLReference/system-information-functions.md @@ -2019,75 +2019,39 @@ The following functions provide server transaction information in an exportable - pg\_stat\_get\_wlm\_realtime\_operator\_info - Description: Obtains the operator information of the real-time execution plan from the internal hash table. - - Parameter: nan - - Return type: queryid bigint, pid bigint, plan\_node\_id integer, plan\_node\_name text, start\_time timestamp with time zone, duration bigint, status text, query\_dop integer, estimated\_rows bigint, tuple\_processed bigint, min\_peak\_memory integer, max\_peak\_memory integer, average\_peak\_memory integer, memory\_skew\_percent integer, min\_spill\_size integer, max\_spill\_size integer, average\_spill\_size integer, spill\_skew\_percent integer, min\_cpu\_time bigint, max\_cpu\_time bigint, total\_cpu\_time bigint, cpu\_skew\_percent integer, warning text + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_realtime\_ec\_operator\_info - Description: Obtains the operator information of the EC execution plan from the internal hash table. - - Parameter: nan - - Return type: queryid bigint, plan\_node\_id integer, plan\_node\_name text, start\_time timestamp with time zone, ec\_operator integer, ec\_status text, ec\_execute\_datanode text, ec\_dsn text, ec\_username text, ec\_query text, ec\_libodbc\_type text, ec\_fetch\_count bigint + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_operator\_info - Description: Obtains the operator information of the execution plan from the internal hash table. - - Parameter: nan - - Return type: queryid bigint, pid bigint, plan\_node\_id integer, plan\_node\_name text, start\_time timestamp with time zone, duration bigint, query\_dop integer, estimated\_rows bigint, tuple\_processed bigint, min\_peak\_memory integer, max\_peak\_memory integer, average\_peak\_memory integer, memory\_skew\_percent integer, min\_spill\_size integer, max\_spill\_size integer, average\_spill\_size integer, spill\_skew\_percent integer, min\_cpu\_time bigint, max\_cpu\_time bigint, total\_cpu\_time bigint, cpu\_skew\_percent integer, warning text + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_node\_resource\_info - Description: Obtains the resource information of the current node. - - Parameter: nan - - Return type: min\_mem\_util integer, max\_mem\_util integer, min\_cpu\_util integer, max\_cpu\_util integer, min\_io\_util integer, max\_io\_util integer, used\_mem\_rate integer + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_session\_wlmstat - Description: Returns the load information of the current session. - - Parameter: pid integer - - Return type: datid oid, threadid bigint, sessionid bigint, threadpid integer, usesysid oid, appname text, query text, priority bigint, block\_time bigint, elapsed\_time bigint, total\_cpu\_time bigint, skew\_percent integer, statement\_mem integer, active\_points integer, dop\_value integer, current\_cgroup text, current\_status text, enqueue\_state text, attribute text, is\_plana boolean, node\_group text, srespool name + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_ec\_operator\_info - Description: Obtains the operator information of the EC execution plan from the internal hash table. - - Parameter: nan - - Return type: queryid bigint, plan\_node\_id integer, plan\_node\_name text, start\_time timestamp with time zone, duration bigint, tuple\_processed bigint, min\_peak\_memory integer, max\_peak\_memory integer, average\_peak\_memory integer, ec\_operator integer, ec\_status text, ec\_execute\_datanode text, ec\_dsn text, ec\_username text, ec\_query text, ec\_libodbc\_type text, ec\_fetch\_count bigint + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_instance\_info - Description: Returns the load information of the current instance. - - Parameter: nan - - Return type: instancename text, timestamp, timestamp with time zone, used\_cpu integer, free\_memory integer, used\_memory integer, io\_await double precision, io\_util double precision, disk\_read double precision, disk\_write double precision, process\_read bigint, process\_write bigint, logical\_read bigint, logical\_write bigint, read\_counts bigint, write\_counts bigint + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_instance\_info\_with\_cleanup - Description: Returns the load information of the current instance and saves the information to the system catalog. - - Parameter: nan - - Return type: instancename text, timestamp, timestamp with time zone, used\_cpu integer, free\_memory integer, used\_memory integer, io\_await double precision, io\_util double precision, disk\_read double precision, disk\_write double precision, process\_read bigint, process\_write bigint, logical\_read bigint, logical\_write bigint, read\_counts bigint, write\_counts bigint + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_realtime\_session\_info - Description: Returns the load information of the real-time session. - - Parameter: nan - - Return type: nodename text, threadid bigint, block\_time bigint, duration bigint, estimate\_total\_time bigint, estimate\_left\_time bigint, schemaname text, query\_band text, spill\_info text, control\_group text, estimate\_memory integer, min\_peak\_memory integer, max\_peak\_memory integer, average\_peak\_memory integer, memory\_skew\_percent integer, min\_spill\_size integer, max\_spill\_size integer, average\_spill\_size integer, spill\_skew\_percent integer, min\_dn\_time bigint, max\_dn\_time bigint, average\_dn\_time bigint, dntime\_skew\_percent integer, min\_cpu\_time bigint, max\_cpu\_time bigint, total\_cpu\_time bigint, cpu\_skew\_percent integer, min\_peak\_iops integer, max\_peak\_iops integer, average\_peak\_iops integer, iops\_skew\_percent integer, warning text, query text, query\_plan text, cpu\_top1\_node\_name text, cpu\_top2\_node\_name text, cpu\_top3\_node\_name text, cpu\_top4\_node\_name text, cpu\_top5\_node\_name text, mem\_top1\_node\_name text, mem\_top2\_node\_name text, mem\_top3\_node\_name text, mem\_top4\_node\_name text, mem\_top5\_node\_name text, cpu\_top1\_value bigint, cpu\_top2\_value bigint, cpu\_top3\_value bigint, cpu\_top4\_value bigint, cpu\_top5\_value bigint, mem\_top1\_value bigint, mem\_top2\_value bigint, mem\_top3\_value bigint, mem\_top4\_value bigint, mem\_top5\_value bigint, top\_mem\_dn text, top\_cpu\_dn text + Description: This API has been discarded and is unavailable currently. - pg\_stat\_get\_wlm\_session\_iostat\_info @@ -2099,8 +2063,5 @@ The following functions provide server transaction information in an exportable - pg\_stat\_get\_wlm\_statistics - Description: Returns session load statistics. - - Parameter: nan + Description: This API has been discarded and is unavailable currently. - Return type: statement text, block\_time bigint, elapsed\_time bigint, total\_cpu\_time bigint, qualification\_time bigint, skew\_percent integer, control\_group text, status text, action text diff --git a/content/en/docs/SQLReference/wlm_user_resource_runtime.md b/content/en/docs/SQLReference/wlm_user_resource_runtime.md index e2ee469ec..5a0ad6cce 100644 --- a/content/en/docs/SQLReference/wlm_user_resource_runtime.md +++ b/content/en/docs/SQLReference/wlm_user_resource_runtime.md @@ -24,7 +24,7 @@

integer

-

Used memory (unit: MB)

+

Used memory(The total size of memory used by the user's current active session. If no business is running or the session has ended, the dynamic memory will be automatically reclaimed, resulting in a size of 0.) (unit: MB)

total_memory

@@ -38,7 +38,7 @@

integer

-

Number of CPU cores in use

+

Number of CPU cores in use. CPU usage data is collected only in complex jobs, and the value is the CPU usage of the related Cgroup.

total_cpu

diff --git a/content/zh/docs/DatabaseReference/GS_WLM_USER_RESOURCE_HISTORY.md b/content/zh/docs/DatabaseReference/GS_WLM_USER_RESOURCE_HISTORY.md index 31ae77e47..c688191cb 100644 --- a/content/zh/docs/DatabaseReference/GS_WLM_USER_RESOURCE_HISTORY.md +++ b/content/zh/docs/DatabaseReference/GS_WLM_USER_RESOURCE_HISTORY.md @@ -31,7 +31,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

integer

-

正在使用的内存大小，单位MB。

+

正在使用的内存大小（表示用户当前活跃的session已使用的内存总大小，若当前未运行业务或会话已结束，则动态内存会自动回收即为0。），单位MB。

total_memory

@@ -45,7 +45,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

real

-

正在使用的CPU核数。

+

正在使用的CPU核数（仅统计复杂作业CPU使用 情况，且该值为相关控制组的CPU使用统计值）。

total_cpu

@@ -73,28 +73,28 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

bigint

-

已使用的临时存储空间大小，单位KB。

+

已使用的临时存储空间大小（预留字段，暂未使用），单位KB。

total_temp_space

bigint

-

可使用的临存储空间大小，单位KB，值为-1表示未限制最大临时存储空间。

+

可使用的临存储空间大小（预留字段，暂未使用），单位KB，值为-1表示未限制最大临时存储空间。

used_spill_space

bigint

-

已使用的算子落盘存储空间大小，单位KB。

+

已使用的算子落盘存储空间大小（预留字段，暂未使用），单位KB。

total_spill_space

bigint

-

可使用的算子落盘存储空间大小，单位KB，值为-1表示未限制最大算子落盘存储空间。

+

可使用的算子落盘存储空间大小（预留字段，暂未使用），单位KB，值为-1表示未限制最大算子落盘存储空间。

read_kbytes

@@ -102,7 +102,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

bigint

监控周期内，读操作的字节流量，单位KB。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_kbytes

@@ -110,7 +110,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

bigint

监控周期内，写操作的字节流量，单位KB。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

read_counts

@@ -118,7 +118,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

bigint

监控周期内，读操作的次数，单位次。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_counts

@@ -126,7 +126,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

bigint

监控周期内，写操作的次数，单位次。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

read_speed

@@ -134,7 +134,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

real

监控周期内，读操作的字节速率，单位KB/s。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_speed

@@ -142,7 +142,7 @@ GS\_WLM\_USER\_RESOURCE\_HISTORY系统表存储与用户使用资源相关的信

real

监控周期内，写操作的字节速率，单位KB/s。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

diff --git a/content/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO.md b/content/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO.md index 2b5ff18c1..790eb47a0 100644 --- a/content/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO.md +++ b/content/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO.md @@ -24,7 +24,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

integer

-

正在使用的内存大小，单位MB。

+

正在使用的内存大小（表示用户当前活跃的session已使用的内存总大小，若当前未运行业务或会话已结束，则动态内存会自动回收即为0。），单位MB。

total_memory

@@ -66,28 +66,28 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

bigint

-

已使用的临时空间大小，单位KB。

+

已使用的临时空间大小（预留字段，暂未使用），单位KB。

total_temp_space

bigint

-

可使用的临时空间总大小，单位KB，值为-1表示未限制。

+

可使用的临时空间总大小（预留字段，暂未使用），单位KB，值为-1表示未限制。

used_spill_space

bigint

-

已使用的算子落盘空间大小，单位KB。

+

已使用的算子落盘空间大小（预留字段，暂未使用），单位KB。

total_spill_space

bigint

-

可使用的算子落盘空间总大小，单位KB，值为-1表示未限制。

+

可使用的算子落盘空间总大小（预留字段，暂未使用），单位KB，值为-1表示未限制。

read_kbytes

@@ -96,7 +96,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在数据库节点上复杂作业read的字节总数（单位KB）。

数据库节点：实例启动至当前时间为止，该用户复杂作业read的字节总数（单位KB）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_kbytes

@@ -105,7 +105,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在数据库节点上复杂作业write的字节总数（单位KB）。

数据库节点：实例启动至当前时间为止，该用户复杂作业write的字节总数（单位KB）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

read_counts

@@ -114,7 +114,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在数据库节点上复杂作业read的次数之和（单位次）。

数据库节点：实例启动至当前时间为止，该用户复杂作业read的次数之和（单位次）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_counts

@@ -123,7 +123,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在数据库节点上复杂作业write的次数之和（单位次）。

数据库节点：实例启动至当前时间为止，该用户复杂作业write的次数之和（单位次）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

read_speed

@@ -132,7 +132,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在单个数据库节点上复杂作业read平均速率（单位KB/s）。

数据库节点：过去5秒内，该用户在该数据库节点上复杂作业read平均速率（单位KB/s）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

write_speed

@@ -141,7 +141,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO视图显示所有用户资源使用情况，需

数据库主节点：过去5秒内，该用户在单个数据库节点上复杂作业write平均速率（单位KB/s）。

数据库节点：过去5秒内，该用户在该数据库节点上复杂作业write平均速率（单位KB/s）。

-

仅分布式可用。

+

当前不支持，仅分布式可用。

diff --git a/content/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO_OID.md b/content/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO_OID.md index 8e2ee61a5..34d91afe6 100644 --- a/content/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO_OID.md +++ b/content/zh/docs/DatabaseReference/PG_TOTAL_USER_RESOURCE_INFO_OID.md @@ -24,7 +24,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO\_OID视图显示所有用户资源使用情况

integer

-

正在使用的内存大小，单位MB。

+

正在使用的内存大小（表示用户当前活跃的session已使用的内存总大小，若当前未运行业务或会话已结束，则动态内存会自动回收即为0。），单位MB。

total_memory

@@ -38,7 +38,7 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO\_OID视图显示所有用户资源使用情况

double precision

-

正在使用的CPU核数。

+

正在使用的CPU核数（仅统计复杂作业CPU使用 情况，且该值为相关控制组的CPU使用统计值）。

total_cpu

@@ -66,70 +66,70 @@ PG\_TOTAL\_USER\_RESOURCE\_INFO\_OID视图显示所有用户资源使用情况

bigint

-

已使用的临时空间大小，单位KB。

+

已使用的临时空间大小（预留字段，暂未使用），单位KB。

total_temp_space

bigint

-

可使用的临时空间总大小，单位KB，值为-1表示未限制。

+

可使用的临时空间总大小（预留字段，暂未使用），单位KB，值为-1表示未限制。

used_spill_space

bigint

-

已使用的下盘空间大小。单位KB。

+

已使用的下盘空间大小（预留字段，暂未使用）。单位KB。

total_spill_space

bigint

-

可使用的下盘空间总大小，单位KB，值为-1表示未限制。

+

可使用的下盘空间总大小（预留字段，暂未使用），单位KB，值为-1表示未限制。

read_kbytes

bigint

-

读磁盘数据量，单位KB。

+

读磁盘数据量，单位KB。（当前不支持，仅分布式可用。）

write_kbytes

bigint

-

写磁盘数据量，单位KB。

+

写磁盘数据量，单位KB。（当前不支持，仅分布式可用。）

read_counts

bigint

-

读磁盘次数。

+

读磁盘次数。（当前不支持，仅分布式可用。）

write_counts

bigint

-

写磁盘次数。

+

写磁盘次数。（当前不支持，仅分布式可用。）

read_speed

double precision

-

读磁盘速率，单位B/ms。

+

读磁盘速率，单位B/ms。（当前不支持，仅分布式可用。）

write_speed

double precision

-

写磁盘速率，单位B/ms。

+

写磁盘速率，单位B/ms。（当前不支持，仅分布式可用。）

diff --git "a/content/zh/docs/DatabaseReference/\346\223\215\344\275\234\345\256\241\350\256\241.md" "b/content/zh/docs/DatabaseReference/\346\223\215\344\275\234\345\256\241\350\256\241.md" index 722717ebb..cfff3f15a 100644 --- "a/content/zh/docs/DatabaseReference/\346\223\215\344\275\234\345\256\241\350\256\241.md" +++ "b/content/zh/docs/DatabaseReference/\346\223\215\344\275\234\345\256\241\350\256\241.md" @@ -349,20 +349,20 @@

gs_set_obs_delete_location

-

gs_hadr_do_switchover

+

gs_hadr_do_switchover(已废除)

gs_set_obs_delete_location_with_slotname

gs_streaming_dr_in_switchover

-

gs_upload_obs_file

+

gs_upload_obs_file(已废除)

-

gs_download_obs_file

+

gs_download_obs_file(已废除)

-

gs_set_obs_file_context

+

gs_set_obs_file_context(已废除)

-

gs_get_hadr_key_cn

+

gs_get_hadr_key_cn(已废除)

pg_advisory_lock

diff --git a/content/zh/docs/SQLReference/WLM_USER_RESOURCE_RUNTIME.md b/content/zh/docs/SQLReference/WLM_USER_RESOURCE_RUNTIME.md index deb392335..6e28a8d2f 100644 --- a/content/zh/docs/SQLReference/WLM_USER_RESOURCE_RUNTIME.md +++ b/content/zh/docs/SQLReference/WLM_USER_RESOURCE_RUNTIME.md @@ -24,7 +24,7 @@ WLM\_USER\_RESOURCE\_RUNTIME视图显示所有用户资源使用情况，需要

integer

-

正在使用的内存大小，单位MB。

+

正在使用的内存大小（表示用户当前活跃的session已使用的内存总大小，若当前未运行业务或会话已结束，则动态内存会自动回收即为0。），单位MB。

total_memory

@@ -38,7 +38,7 @@ WLM\_USER\_RESOURCE\_RUNTIME视图显示所有用户资源使用情况，需要

integer

-

正在使用的CPU核数。

+

正在使用的CPU核数（仅统计复杂作业CPU使用 情况，且该值为相关控制组的CPU使用统计值）。

total_cpu

diff --git "a/content/zh/docs/SQLReference/\345\205\266\345\256\203\345\207\275\346\225\260.md" "b/content/zh/docs/SQLReference/\345\205\266\345\256\203\345\207\275\346\225\260.md" index fa3573e71..620434a4e 100644 --- "a/content/zh/docs/SQLReference/\345\205\266\345\256\203\345\207\275\346\225\260.md" +++ "b/content/zh/docs/SQLReference/\345\205\266\345\256\203\345\207\275\346\225\260.md" @@ -645,19 +645,11 @@ - pgxc\_unlock\_for\_sp\_database\(name Name\) - 描述：释放指定数据库锁。 - - 参数：数据库名 - - 返回值类型：布尔 + 描述：目前该接口已废弃，暂不可用。 - pgxc\_lock\_for\_sp\_database\(name Name\) - 描述：对指定的数据库加锁。 - - 参数：数据库名 - - 返回值类型：布尔 + 描述：目前该接口已废弃，暂不可用。 - copy\_error\_log\_create\(\) diff --git "a/content/zh/docs/SQLReference/\345\272\237\345\274\203\345\207\275\346\225\260.md" "b/content/zh/docs/SQLReference/\345\272\237\345\274\203\345\207\275\346\225\260.md" index 477493303..6190c9835 100644 --- "a/content/zh/docs/SQLReference/\345\272\237\345\274\203\345\207\275\346\225\260.md" +++ "b/content/zh/docs/SQLReference/\345\272\237\345\274\203\345\207\275\346\225\260.md" @@ -93,6 +93,70 @@ openGauss中下列函数在最新版本中已废弃：

-

+ +

pg_stat_get_wlm_operator_info

+ +

gs_wlm_get_resource_pool_info(int)

+ +

gs_wlm_get_all_user_resource_info

+ +

create_wlm_operator_info

+ +

create_wlm_session_info

+ +

gs_wlm_get_workload_records

+ +

gs_wlm_persistent_user_resource_info

+ + + +

gs_wlm_session_respool

+ +

gs_total_nodegroup_memory_detail

+ +

gs_wlm_user_resource_info(name text)

+ +

create_wlm_instance_statistics_info

+ +

pg_stat_get_session_wlmstat

+ +

pg_stat_get_wlm_ec_operator_info

+ +

pg_stat_get_wlm_instance_info

+ + + +

pg_stat_get_wlm_instance_info_with_cleanup

+ +

pg_stat_get_wlm_statistics

+ +

pg_stat_get_wlm_realtime_session_info

+ +

gs_upload_obs_file

+ +

gs_download_obs_file

+ +

gs_set_obs_file_context

+ +

gs_get_hadr_key_cn

+ + + +

gs_hadr_do_switchover

+ +

track_memory_context(context_list text)

+ +

track_memory_context_detail

+ +

pgxc_unlock_for_sp_database

+ +

local_segment_space_info

+ +

pg_stat_segment_extent_usage

+ +

GS_ALL_NODEGROUP_CONTROL_GROUP_INFO

+ + diff --git "a/content/zh/docs/SQLReference/\346\225\260\347\273\204\345\207\275\346\225\260\345\222\214\346\223\215\344\275\234\347\254\246.md" "b/content/zh/docs/SQLReference/\346\225\260\347\273\204\345\207\275\346\225\260\345\222\214\346\223\215\344\275\234\347\254\246.md" index 22cc88b3f..e44860256 100644 --- "a/content/zh/docs/SQLReference/\346\225\260\347\273\204\345\207\275\346\225\260\345\222\214\346\223\215\344\275\234\347\254\246.md" +++ "b/content/zh/docs/SQLReference/\346\225\260\347\273\204\345\207\275\346\225\260\345\222\214\346\223\215\344\275\234\347\254\246.md" @@ -405,19 +405,7 @@ - array\_extendnull\(anyarray, int\) - 描述：往数组尾部添加指定个数的null空元素。 - - 返回类型：anyarray - - 示例： - - ``` - openGauss=# SELECT array_extendnull(ARRAY[1,8,3,7],1) AS RESULT; - result - -------------- - {1,8,3,7,null} - (1 row) - ``` + 描述：目前该接口已废弃，暂不可用。 - array\_trim\(anyarray, int\) diff --git "a/content/zh/docs/SQLReference/\346\256\265\351\241\265\345\274\217\345\255\230\345\202\250\345\207\275\346\225\260.md" "b/content/zh/docs/SQLReference/\346\256\265\351\241\265\345\274\217\345\255\230\345\202\250\345\207\275\346\225\260.md" index 6746b73cb..dd2146681 100644 --- "a/content/zh/docs/SQLReference/\346\256\265\351\241\265\345\274\217\345\255\230\345\202\250\345\207\275\346\225\260.md" +++ "b/content/zh/docs/SQLReference/\346\256\265\351\241\265\345\274\217\345\255\230\345\202\250\345\207\275\346\225\260.md" @@ -2,121 +2,11 @@ - local\_segment\_space\_info\(tablespacename TEXT, databasename TEXT\) - 描述：输出为该表空间下所有ExtentGroup的使用信息。 - - 返回值类型： - - - - - - - - - - - - - - - - - - - - - - - - - - - -

node_name

-

节点名称。

-

extent_size

-

该ExtentGroup的extent规格，单位是block数。

-

forknum

-

Fork号。

-

total_blocks

-

物理文件总extent数目。

-

meta_data_blocks

-

表空间管理的metadata占用的block数，只包括space header、map page等，不包括segment head。

-

used_data_blocks

-

存数据占用的extent数目。包括segment head。

-

utilization

-

使用的block数占总block数的百分比。即(used_data_blocks+meta_data_block)/total_blocks。

-

high_water_mark

-

高水位线，被分配出去的extent，最大的物理页号。超过高水位线的block都没有被使用，可以被直接回收。

-
- - 例如： - - ``` - select * from local_segment_space_info('pg_default', 'postgres'); - node_name | extent_size | forknum | total_blocks | meta_data_blocks | used_data_blocks | utilization | high_water_mark - -------------------+-------------+---------+--------------+------------------+------------------+-------------+----------------- - dn_6001_6002_6003 | 1 | 0 | 16384 | 4157 | 1 | .253784 | 4158 - dn_6001_6002_6003 | 8 | 0 | 16384 | 4157 | 8 | .254211 | 4165 - (2 rows) - ``` + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_segment\_extent\_usage\(int4 tablespace oid, int4 database oid, int4 extent\_type, int4 forknum\) - 描述：每次返回一个ExtentGroup中，每个被分配出去的extent的使用情况。extent\_type表示ExtentGroup的类型，合理取值为\[1,5\]的int值。在此范围外的会报error。forknum 表示fork号，合法取值为\[0,4\]的int值，目前只有三种值有效，数据文件为0，FSM文件为1，visibility map文件为2。 - - 返回值类型： - - - - - - - - - - - - - - - - - - - - - - -

名称

-

描述

-

start_block

-

Extent的起始物理页号。

-

extent_size

-

Extent的大小。

-

usage_type

-

Extent的使用类型，比如segment head、data extent等。

-

ower_location

-

有指针指向该extent的对象的位置。比如data extent的owner就是它所属的segment的head位置。

-

special_data

-

该extent在它owner中的位置。该字段的数据跟使用类型有关。比如data extent的special data就是它在所属segment中的extent id。

-
- - 其中，usage\_type为枚举类型，每一项的含义为： - - - Non-bucket table segment head ：非hashbucket表的数据段头。 - - Non-bucket table fork head：非段页式表的fork段头。 - - Data extent：数据块。 - - 例如： - - ``` - select * from pg_stat_segment_extent_usage((select oid::int4 from pg_tablespace where spcname='pg_default'), (select oid::int4 from pg_database where datname='postgres'), 1, 0); - start_block | extent_size | usage_type | ower_location | special_data - -------------+-------------+------------------------+---------------+-------------- - 4157 | 1 | Data extent | 4294967295 | 0 - 4158 | 1 | Data extent | 4157 | 0 - ``` + 描述：目前该接口已废弃，暂不可用。 - local\_space\_shrink\(tablespacename TEXT, databasename TEXT\) diff --git "a/content/zh/docs/SQLReference/\347\263\273\347\273\237\344\277\241\346\201\257\345\207\275\346\225\260.md" "b/content/zh/docs/SQLReference/\347\263\273\347\273\237\344\277\241\346\201\257\345\207\275\346\225\260.md" index e650ec154..f47828e9b 100644 --- "a/content/zh/docs/SQLReference/\347\263\273\347\273\237\344\277\241\346\201\257\345\207\275\346\225\260.md" +++ "b/content/zh/docs/SQLReference/\347\263\273\347\273\237\344\277\241\346\201\257\345\207\275\346\225\260.md" @@ -2092,19 +2092,11 @@ txid\_snapshot的文本表示为：xmin:xmax:xip\_list。 - pg\_stat\_get\_wlm\_node\_resource\_info - 描述：获取当前节点资源信息。 - - 参数：nan - - 返回值类型：min\_mem\_util integer, max\_mem\_util integer, min\_cpu\_util integer, max\_cpu\_util integer, min\_io\_util integer, max\_io\_util integer, used\_mem\_rate integer + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_session\_wlmstat - 描述：返回当前会话负载信息。 - - 参数：pid integer - - 返回值类型：datid oid, threadid bigint, sessionid bigint, threadpid integer, usesysid oid, appname text, query text, priority bigint, block\_time bigint, elapsed\_time bigint, total\_cpu\_time bigint, skew\_percent integer, statement\_mem integer, active\_points integer, dop\_value integer, current\_cgroup text, current\_status text, enqueue\_state text, attribute text, is\_plana boolean, node\_group text, srespool name + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_wlm\_ec\_operator\_info @@ -2116,27 +2108,15 @@ txid\_snapshot的文本表示为：xmin:xmax:xip\_list。 - pg\_stat\_get\_wlm\_instance\_info - 描述：返回当前实例负载信息。 - - 参数：nan - - 返回值类型：instancename text, timestamp timestamp with time zone, used\_cpu integer, free\_memory integer, used\_memory integer, io\_await double precision, io\_util double precision, disk\_read double precision, disk\_write double precision, process\_read bigint, process\_write bigint, logical\_read bigint, logical\_write bigint, read\_counts bigint, write\_counts bigint + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_wlm\_instance\_info\_with\_cleanup - 描述：返回当前实例负载信息，并且保存到系统表中。 - - 参数：nan - - 返回值类型：instancename text, timestamp timestamp with time zone, used\_cpu integer, free\_memory integer, used\_memory integer, io\_await double precision, io\_util double precision, disk\_read double precision, disk\_write double precision, process\_read bigint, process\_write bigint, logical\_read bigint, logical\_write bigint, read\_counts bigint, write\_counts bigint + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_wlm\_realtime\_session\_info - 描述：返回实时会话负载信息。 - - 参数：nan - - 返回值类型：nodename text, threadid bigint, block\_time bigint, duration bigint, estimate\_total\_time bigint, estimate\_left\_time bigint, schemaname text, query\_band text, spill\_info text, control\_group text, estimate\_memory integer, min\_peak\_memory integer, max\_peak\_memory integer, average\_peak\_memory integer, memory\_skew\_percent integer, min\_spill\_size integer, max\_spill\_size integer, average\_spill\_size integer, spill\_skew\_percent integer, min\_dn\_time bigint, max\_dn\_time bigint, average\_dn\_time bigint, dntime\_skew\_percent integer, min\_cpu\_time bigint, max\_cpu\_time bigint, total\_cpu\_time bigint, cpu\_skew\_percent integer, min\_peak\_iops integer, max\_peak\_iops integer, average\_peak\_iops integer, iops\_skew\_percent integer, warning text, query text, query\_plan text, cpu\_top1\_node\_name text, cpu\_top2\_node\_name text, cpu\_top3\_node\_name text, cpu\_top4\_node\_name text, cpu\_top5\_node\_name text, mem\_top1\_node\_name text, mem\_top2\_node\_name text, mem\_top3\_node\_name text, mem\_top4\_node\_name text, mem\_top5\_node\_name text, cpu\_top1\_value bigint, cpu\_top2\_value bigint, cpu\_top3\_value bigint, cpu\_top4\_value bigint, cpu\_top5\_value bigint, mem\_top1\_value bigint, mem\_top2\_value bigint, mem\_top3\_value bigint, mem\_top4\_value bigint, mem\_top5\_value bigint, top\_mem\_dn text, top\_cpu\_dn text + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_wlm\_session\_iostat\_info @@ -2148,9 +2128,5 @@ txid\_snapshot的文本表示为：xmin:xmax:xip\_list。 - pg\_stat\_get\_wlm\_statistics - 描述：返回会话负载统计数据。 - - 参数：nan - - 返回值类型：statement text, block\_time bigint, elapsed\_time bigint, total\_cpu\_time bigint, qualification\_time bigint, skew\_percent integer, control\_group text, status text, action text + Description: This API has been discarded and is unavailable currently. diff --git "a/content/zh/docs/SQLReference/\347\273\237\350\256\241\344\277\241\346\201\257\345\207\275\346\225\260.md" "b/content/zh/docs/SQLReference/\347\273\237\350\256\241\344\277\241\346\201\257\345\207\275\346\225\260.md" index 62f0e818f..b5563c4d4 100644 --- "a/content/zh/docs/SQLReference/\347\273\237\350\256\241\344\277\241\346\201\257\345\207\275\346\225\260.md" +++ "b/content/zh/docs/SQLReference/\347\273\237\350\256\241\344\277\241\346\201\257\345\207\275\346\225\260.md" @@ -1920,15 +1920,11 @@ - create\_wlm\_session\_info\(int flag\) - 描述：将当前内存中记录的TopSQL查询语句级别相关统计信息清理。该函数只有管理员用户可以执行。 - - 返回值类型：int + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_wlm\_session\_info\(int flag\) - 描述：获取当前内存中记录的TopSQL查询语句级别相关统计信息，当传入的参数不为0时，会将这部分信息从内存中清理掉。该函数只有system admin和monitor admin用户可以执行。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - gs\_paxos\_stat\_replication\(\) @@ -2063,15 +2059,11 @@ - gs\_wlm\_get\_resource\_pool\_info\(int\) - 描述：获取所有用户的资源使用统计信息，入参为int类型可以为可以为任意int值或NULL。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - gs\_wlm\_get\_all\_user\_resource\_info\(\) - 描述：获取所有用户的资源使用统计信息。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - gs\_wlm\_get\_user\_info\(int\) @@ -2079,18 +2071,89 @@ 返回值类型：record -- gs\_wlm\_get\_workload\_records\(\) + 返回字段说明如下： + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

字段名称

+

字段类型

+

字段说明

+

userid

+

oid

+

用户OID。

+

sysadmin

+

boolean

+

是否是管理员用户。

+

rpoid

+

oid

+

关联的资源池的OID。

+

parentid

+

oid

+

用户组的OID

+

totalspace

+

bigint

+

用户可用的空间上限。

+

spacelimit

+

bigint

+

用户的表空间限制。

+

childcount

+

integer

+

子用户的个数。

+

childlist

+

text

+

子用户列表。

+
- 描述：获取动态负载管理下的所有作业信息，该函数只在动态负载管理开的情况下有效。 +- gs\_wlm\_get\_workload\_records\(\) - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 -- gs\_wlm\_readjust\_user\_space\(\) +- gs\_wlm\_readjust\_user\_space\(oid) 描述：修正所有用户的存储空间使用情况。该函数只有管理员用户可以执行。 返回值类型：record + >![](public_sys-resources/icon-note.png) **说明：** + > + >在use_workload_manager参数由off变为on状态后，不会统计off时的存储资源。如果需要统计off时用户使用的存储资源，在数据库中执行SQL语句： + SELECT gs_wlm_readjust_user_space(0); + - gs\_wlm\_readjust\_user\_space\_through\_username\(text name\) 描述：修正指定用户的存储空间使用情况。该函数普通用户只能修正自己的使用情况，只有管理员用户可以修正所有用户的使用情况。当name指定位“0000”，表示需要修正所有用户的使用情况。 @@ -2105,9 +2168,7 @@ - gs\_wlm\_session\_respool\(bigint\) - 描述：获取当前所有后台线程的session resouce pool相关信息，入参为bigint类型可以为可以为任意bigint值或NULL。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - gs\_wlm\_get\_session\_info\(\) @@ -2540,15 +2601,17 @@ - DBE\_PERF.track\_memory\_context\(context\_list text\) - 描述：设置需要统计内存申请详细信息的内存上下文。入参为内存上下文的名称，使用“，”分隔，如“ThreadTopMemoryContext, SessionCacheMemoryContext”，注意该内存上下文名称是上下文敏感的。此外，单个内存上下文的长度为63，超过的部分会被截断。而且一次能够统计的内存上下文上限为16个，设置超过16个内存上下文会设置失败。每一次调用该函数都会将上次统计的结果清空，当入参指定为“”时，表示取消该统计功能。只有初始用户（super user）或者具有monadmin权限的用户可以执行该函数。 - - 返回值类型：boolean + 描述：目前该接口已废弃，暂不可用。 - DBE\_PERF.track\_memory\_context\_detail\(\) +<<<<<<< HEAD 描述：获取DBE\_PERF.track\_memory\_context函数指定的内存上下文的内存申请详细信息。返回值的定义见视图DBE\_PERF.track\_memory\_context\_detail。只有初始用户（super user）或者具有monadmin权限的用户可以执行该函数。 返回值类型：record +======= + 描述：目前该接口已废弃，暂不可用。 +>>>>>>> 6ea8cdb94 (!7280 WLM相关系统函数及视图的补充说明) - pg\_stat\_get\_mem\_mbytes\_reserved\(tid\) @@ -2560,9 +2623,7 @@ - gs\_wlm\_user\_resource\_info\(name text\) - 描述：查询具体某个用户的资源限额和资源使用情况。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - pg\_stat\_get\_file\_stat\(\) @@ -2736,17 +2797,11 @@ - gs\_wlm\_user\_resource\_info\(name text\) - 描述：查询具体某个用户的资源限额和资源使用情况。普通用户只能查询到自己相关的信息，管理员权限的用户可以查看全部用户的信息。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - create\_wlm\_instance\_statistics\_info - 描述：将当前实例的历史监控数据进行持久化保存。 - - 参数：nan - - 返回值类型：integer + 描述：目前该接口已废弃，暂不可用。 - gs\_session\_memory @@ -2801,19 +2856,15 @@ - gs\_wlm\_persistent\_user\_resource\_info\(\) - 描述：将当前所有的用户资源使用统计信息归档到gs\_wlm\_user\_resource\_history系统表中，只有sysadmin有权限查询。 - - 返回值类型：record + 描述：目前该接口已废弃，暂不可用。 - create\_wlm\_operator\_info\(int flag\) - 描述：将当前内存中记录的TopSQL算子级别相关统计信息清理，当传入的参数大于0时，会将这部分信息归档到gs\_wlm\_operator\_info和gs\_wlm\_ec\_operator\_info中，否则不会归档。该函数只有sysadmin权限的用户可以执行。 - - 返回值类型：int + 描述：目前该接口已废弃，暂不可用。 - GS\_ALL\_NODEGROUP\_CONTROL\_GROUP\_INFO\(text\) - 描述：提供了所有逻辑数据库实例的控制组信息。该函数在调用的时候需要指定要查询逻辑数据库实例的名称。例如要查询'InstallationGuide'逻辑数据库实例的控制组信息： + 描述：目前该接口已废弃，暂不可用。 ``` SELECT * FROM GS_ALL_NODEGROUP_CONTROL_GROUP_INFO('InstallationGuide') @@ -2907,8 +2958,7 @@ - gs\_total\_nodegroup\_memory\_detail - 描述：返回当前数据库逻辑数据库使用内存的信息，单位为MB得到一个逻辑数据库。此函数依赖内存保护功能开启。 - 返回值类型：setof record + 描述：目前该接口已废弃，暂不可用。 - local\_redo\_time\_count\(\) -- Gitee