Updated on 2025-05-29 GMT+08:00

Internal Functions

The following table lists the functions used by GaussDB to implement internal system functions. You are advised not to use these functions. Contact Huawei technical support if you need to use them.

pv_compute_pool_workload()

Description: Provides the current load information of the cloud acceleration database instance. (Due to specification changes, the current version no longer supports this feature. Do not use it.)

Return type: record

locktag_decode(locktag text)

Description: Parses lock details from locktag.

Return type: text

smgreq(a smgr, b smgr)

Description: Compares two smgrs to check whether they are the same.

Parameters: smgr, smgr

Return type: Boolean

smgrne(a smgr, b smgr)

Description: Checks whether the two smgrs are different.

Parameters: smgr, smgr

Return type: Boolean

xidin4

Description: Inputs a 4-byte xid.

Parameter: cstring

Return type: xid32

set_hashbucket_info

Description: Sets hash bucket information.

Parameter: text

Return type: Boolean

int1send

Description: Packs unsigned 1-byte integers into the internal data buffer stream.

Parameter: tinyint

Return type: bytea

listagg

Description: Specifies aggregate functions of the list type.

Parameters: smallint, text

Return type: text

log_fdw_validator

Description: Specifies validation functions.

Parameters: text[], oid

Return type: void

nvarchar2typmodin

Description: Obtains the typmod information of the varchar type.

Parameter: cstring[]

Return type: integer

nvarchar2typmodout

Description: Obtains the typmod information of the varchar type, constructs a character string, and returns the character string.

Parameter: integer

Return type: cstring

read_disable_conn_file

Description: Reads forbidden connection files.

Parameter: nan

Return type: disconn_mode text, disconn_host text, disconn_port text, local_host text, local_port text, redo_finished text

regex_like_m

Description: Specifies the regular expression match, which is used to determine whether a character string complies with a specified regular expression.

Parameters: text, text

Return type: Boolean

update_pgjob

Description: Updates a job.

Parameters: bigint, "char", bigint, timestamp without time zone, timestamp without time zone, timestamp without time zone, timestamp without time zone, timestamp without time zone, smallint, text

Return type: void

enum_cmp

Description: Specifies the enumeration comparison function, which is used to determine whether two enumeration classes are equal and determine their relative sizes.

Parameters: anyenum, anyenum

Return type: integer

enum_eq

Description: Specifies the enumeration comparison function, which is used to implement the equal sign (=).

Parameters: anyenum, anyenum

Return type: Boolean

enum_first

Description: Returns the first element in the enumeration class.

Parameter: anyenum

Return type: anyenum

enum_ge

Description: Specifies the enumeration comparison function, which is used to implement the greater-than sign (>) and equal sign (=).

Parameters: anyenum, anyenum

Return type: Boolean

enum_gt

Description: Specifies the enumeration comparison function, which is used to implement the greater-than sign (>).

Parameters: anyenum, anyenum

Return type: Boolean

enum_in

Description: Specifies the enumeration comparison function, which is used to determine whether an element is in an enumeration class.

Parameters: cstring, OID

Return type: anyenum

enum_larger

Description: Specifies the enumeration comparison function, which is used to implement the greater-than sign (>).

Parameters: anyenum, anyenum

Return type: anyenum

enum_last

Description: Returns the last element in the enumeration class.

Parameter: anyenum

Return type: anyenum

enum_le

Description: Specifies the enumeration comparison function, which is used to implement the less-than sign (<) and equal sign (=).

Parameters: anyenum, anyenum

Return type: Boolean

enum_lt

Description: Specifies the enumeration comparison function, which is used to implement the less-than sign (<).

Parameters: anyenum, anyenum

Return type: Boolean

enum_smaller

Description: Specifies the enumeration comparison function, which is used to implement the less-than sign (<).

Parameters: anyenum, anyenum

Return type: Boolean

node_oid_name

Description: Not supported.

Parameter: oid

Return type: cstring

pg_buffercache_pages

Description: Reads status data from a shared buffer. In the multi-tenancy scenario, PDB data is returned to its own PDB, and global data is returned to a non-PDB.

Parameter: nan

Return type: SETOF record. For details about the returned columns, see Table 1.

Table 1 Return columns

Name

Type

Description

bufferid

integer

Internal ID of the buffer.

relfilenode

oid

OID of the page ownership in the buffer.

bucketid

integer

ID of the hash bucket where the buffer is located.

storage_type

bigint

Storage type of data in the buffer.

reltablespace

oid

OID of the tablespace where the data in the buffer is located.

reldatabase

oid

OID of the database where the data in the buffer is located.

relforknumber

integer

Fork type of the relation file where the data in the buffer is located.

relblocknumber

integer

File block number of the data in the buffer in the relation file to which the data belongs.

isdirty

Boolean

Specifies whether the buffer is dirty.

isvalid

Boolean

Specifies whether the buffer is valid.

usage_count

smallint

Number of used buffers.

pinning_backends

integer

Number of backends that are using the buffer.

pg_check_xidlimit

Description: Checks whether nextxid is greater than or equal to xidwarnlimit.

Parameter: nan

Return type: Boolean

gs_static_threadpool_ctrl_status()

Description: Queries statistics about the static pool threads in the thread pool. The centralized mode does not support the query and returns an error message.

Parameter: nan

Return value: text node_name, int group_id, text worker_info For details about the returned columns, see Table 2.

Table 2 GS_STATIC_THREADPOOL_CTRL_STATUS columns

Name

Type

Description

node_name

OUT text

Instance name.

group_id

OUT int

Group ID of the thread pool.

worker_info

OUT text

Dynamic statistics about the running thread pool of the current group. The information includes:

default and default_s: number of threads, including default value of the dynamic thread pool and that of the static thread pool.

expect and expect_s: number of threads, including the expected value of the dynamic thread pool and that of the static thread pool.

actual: actual number of running threads, including dynamic pool threads and static pool threads.

static threads limit: indicates the number of static pool threads configured for the current group.

has static threads: specifies whether a static pool is created for the current group. The default value is 0, indicating no creation.

idle static threads: number of idle static pool threads.

wait session num: number of waiting sessions.

gs_validate_ext_listen_ip

Description: Clears services connected to invalid IP addresses on DNs.

Parameter: For details, see Table 3.

Return value: bigint pid, text node_name

Table 3 GS_VALIDATE_EXT_LISTEN_IP columns

Name

Type

Description

clear

IN cstring

Specifies whether to clear services connected to invalid IP addresses on DNs.

When this function is queried in the current environment, only normal can be entered, indicating that services connected to invalid IP addresses on DNs are cleared. No value is returned.

validate_node_name

IN cstring

Specifies the name of the DN where the IP address connections to be cleared are located.

validate_ip

IN cstring

Specifies the IP address to be cleared.

pid

OUT bigint

ID of the worker thread where the IP address connections to be cleared are located.

node_name

OUT text

Name of the instance where the IP connections to be cleared are located.

gs_comm_listen_address_ext_info

Description: Displays the DFX information about the extended IP address configured for listen_address_ext connected to the current node.

Parameter: nan

Return type: text node_name, text app, bigint tid, integer lwtid, bigint query_id, integer socket, text remote_ip, text remote_port, text local_ip or text local_port For details about the returned columns, see Table 4.

Note: Currently, this function is not supported.

Table 4 GS_COMM_LISTEN_ADDRESS_EXT_INFO columns

Name

Type

Description

node_name

OUT text

Name of the current instance.

app

OUT text

Client connected to the DN.

tid

OUT bigint

Thread ID of the current thread.

lwtid

OUT integer

Lightweight thread ID of the current thread.

query_id

OUT bigint

Query ID of the current thread.

socket

OUT integer

Socket FD of the current physical connection.

remote_ip

OUT text

Peer IP address of the current connection.

remote_port

OUT text

Peer port of the current connection.

local_ip

OUT text

Local IP address of the current connection.

local_port

OUT text

Local port of the current connection.

gs_libcomm_fd_info()

Description: Queries the socket persistent connection information of the libcomm communications library. This function is not supported for centralized.

Parameter: nan

Return value: See Table 5.

Table 5 Return values of gs_libcomm_fd_info

Name

Type

Description

node_name

OUT text

Instance name of the DN.

ip

OUT text

IP address of the DN.

ctrl_port

OUT bigint

Control channel port.

data_port

OUT bigint

Data channel port.

remote_name

OUT text

Instance name of the DN at the peer site.

remote_ip

OUT text

Peer IP address.

remote_port

OUT bigint

Peer port number.

local_ip

OUT text

Local IP address.

local_port

OUT bigint

Local port number.

fd

OUT bigint

Socket connection.

type

OUT text

Type of the TCP connection channel. The options are as follows:

  • DATA_SEND_FD: socket of the sender of the data channel
  • DATA_RECV_FD: socket of the receiver of the data channel.
  • CTL_SEND_FD: socket of the sender of the control channel.
  • CTL_RECV_FD: socket of the receiver of the control channel.

This function can be used only on the DN. If no information is returned, the libcomm persistent connection is not established for the current DN instance.

gs_libcomm_memory_info()

Description: Queries the basic configuration information used by the internal memory of the current libcomm communications library. This function is not supported for centralized.

Parameter: nan

Return value: See Table 6.

Table 6 Return values of gs_libcomm_memory_info

Name

Type

Description

node_name

OUT text

Instance name of the DN.

current_used_memory

OUT bigint

Memory used by the libcomm communications library, in bytes.

current_data_item_num

OUT bigint

Number of data blocks in the libcomm lock-free queue.

init_mailbox_memory

OUT bigint

Memory used by libcomm to initialize the mailbox, in bytes.

max_datanode

OUT bigint

Maximum number of DNs supported by the libcomm communications library.

max_stream

OUT bigint

Maximum number of data streams supported by a single TCP connection of the libcomm.

max_quota_size

OUT bigint

Total buffer size of the libcomm logical connection, in bytes.

max_usable_memory

OUT bigint

Maximum memory that can be used by the libcomm communications library cache, in bytes.

max_memory_pool

OUT bigint

Total size of the memory resource pool that can be used by the libcomm communications library on each DN. The unit is byte.

gs_get_global_listen_address_ext_info

Description: Queries the global extended IP address configuration information.

Parameter: For details, see Table 7.

Return type: text node_name, text host, text port, text ext_listen_ip

Note: Currently, this function is not supported.

Table 7 GS_GET_GLOBAL_LISTEN_ADDRESS_EXT_INFO columns

Name

Type

Description

dn_mode

IN cstring

Specifies the range of DNs to be displayed. If this parameter is set to null, all DNs are queried by default.

node_name

OUT text

DN name.

host

OUT text

Listening IP address of the DN.

port

OUT text

Listening port of the DN.

ext_listen_ip

OUT text

Extended listening IP address of the DN.

gs_get_listen_address_ext_info()

Description: Queries the extended IP address configuration of the current instance.

Parameter: nan

Return type: text node_name, text host, bigint port, text ext_listen_ip For details about the returned columns, see Table 8.

Note: Currently, this function is not supported.

Table 8 GS_GET_LISTEN_ADDRESS_EXT_INFO

Name

Type

Description

node_name

OUT text

DN name.

host

OUT text

Listening IP address of the DN.

port

OUT bigint

Listening port of the DN.

ext_listen_ip

OUT text

Extended listening IP address of the DN.

pg_comm_delay

Description: Displays the delay status of the communications library of a single DN.

Parameter: nan

Return type: text, text, integer, integer, integer, integer

pg_comm_recv_stream

Description: Displays the receiving stream status of all communication libraries on a single DN.

Parameter: nan

Return type: text, bigint, text, bigint, integer, integer, integer, text, bigint, integer, integer, integer, bigint, bigint, bigint, bigint, bigint

pg_comm_send_stream

Description: Displays the sending stream status of all communication libraries on a single DN.

Parameter: nan

Return type: text, bigint, text, bigint, integer, integer, integer, text, bigint, integer, integer, integer, bigint, bigint, bigint, bigint, bigint

pg_comm_status

Description: Displays the communication status of a single DN.

Parameter: nan

Return type: text, integer, integer, bigint, bigint, bigint, bigint, bigint, integer, integer, integer, integer, integer

pg_log_comm_status

Description: Prints some logs on the DN.

Parameter: nan

Return type: Boolean

pg_parse_clog

Description: Parses Clog to obtain the XID status of an ordinary table.

Parameter: nan

Return type: xid xid, status text

pg_parse_clog(bucketid)

Description: The hash bucket table is not supported in the current version in centralized mode. An error is reported when the function is called.

pg_pool_ping

Description: Sets PoolerPing.

Parameter: Boolean

Return type: SETOF Boolean

pg_resume_bkp_flag

Description: Obtains the delay Xlog flag for backup and restoration.

Parameter: slot_name name

Return type: start_backup_flag Boolean, to_delay Boolean, ddl_delay_recycle_ptr text, rewind_time text

pgfadvise_DONTNEED

Description: Sets the DONTNEED flag for the current relationship. This means that if you need to free some memory, the OS will first unload the pages of the file. The main idea is to unload files that are no longer in use (rather than pages that might be used).

Example:

cedric=# SELECT * FROM pgfadvise_dontneed('pgbench_accounts');
      relpath       | os_page_size | rel_os_pages | os_pages_free
--------------------+--------------+--------------+---------------
 base/11874/16447   |         4096 |       262144 |        342071
 base/11874/16447.1 |         4096 |        65726 |        408103

pgfadvise_WILLNEED

Description: Sets the WILLNEED flag for the current relationship. This means that the OS will try to load as many pages as possible for that relationship. The main idea is to preload files during server startup. During file preloading, information such as the cache hit rate, error rate, and relationships and indexes that are most likely to be used may be used.

Example:

cedric=# SELECT * FROM pgfadvise_willneed('pgbench_accounts');
relpath       | os_page_size | rel_os_pages | os_pages_free 
--------------------+--------------+--------------+---------------
base/11874/16447   |         4096 |       262144 |         80650
base/11874/16447.1 |         4096 |        65726 |         80650

pgfadvise_NORMAL

Description: Sets the NORMAL flag for the current relationship.

pgfadvise_SEQUENTIAL

Description: Sets the SEQUENTIAL flag for the current relationship.

pgfadvise_RANDOM

Description: Sets the RANDOM flag for the current relationship.

pgfadvise_loader

Description: Allows direct interaction with the page cache. It may be used to load and/or unload a page from memory according to varbit representing a mapping of the page to be loaded/unloaded.

Example: The relationship name is pgbench_accounts, the segment number is 0, and any varbit mapping is used.

-- Load and unload.
cedric=# SELECT * FROM pgfadvise_loader('pgbench_accounts', 0, true, true, B'111000');
relpath      | os_page_size | os_pages_free | pages_loaded | pages_unloaded 
------------------+--------------+---------------+--------------+----------------
     base/11874/16447 |         4096 |        408376 |            3 |              3

-- Load.
cedric=# SELECT * FROM pgfadvise_loader('pgbench_accounts', 0, true, false, B'111000');
relpath      | os_page_size | os_pages_free | pages_loaded | pages_unloaded 
------------------+--------------+---------------+--------------+----------------
 base/11874/16447 |         4096 |        408370 |            3 |              0

-- Unload.
cedric=# SELECT * FROM pgfadvise_loader('pgbench_accounts', 0, false, true, B'111000');
relpath      | os_page_size | os_pages_free | pages_loaded | pages_unloaded 
------------------+--------------+---------------+--------------+----------------
base/11874/16447 |         4096 |        408370 |            0 |              3

pgfincore

Description: Provides information about the file system cache (page cache).

Example:

cedric=# SELECT * FROM pgfincore('pgbench_accounts');
 relpath       | segment | os_page_size | rel_os_pages | pages_mem | group_mem | os_pages_free | databit | pages_dirty | group_dirty  
--------------------+---------+--------------+--------------+-----------+-----------+---------------+---------+-------------+-------------
base/11874/16447   |       0 |         4096 |       262144 |         3 |         1 |        408444 |         |           0 |           0
base/11874/16447.1 |       1 |         4096 |        65726 |         0 |         0 |        408444 |         |           0 |           0

For a specified relationship, the function returns the following columns:

  • relpath: path of the relationship.
  • segment: number of the segment to be analyzed.
  • os_page_size: size of a page.
  • rel_os_pages: total number of pages of the relationship.
  • pages_mem: total number of pages of the relationship in the page cache (not from the PG shared buffer, but from the OS cache).
  • group_mem: number of groups of adjacent pages_mem.
  • os_page_free: number of idle pages in the OS page cache.
  • databit: varbit mapping of the file. To output this column, use pgfincore('pgbench_accounts', true) to activate it.
  • pages_dirty: If the HAVE_FINCORE constant is defined, the platform provides related information, which is similar to pages_mem except for dirty pages.
  • group_dirty: If the HAVE_FINCORE constant is defined, the platform provides related information, which is similar to group_mem except for dirty pages.

pgsysconf

Description: Outputs the size of the OS block and the number of free pages in the OS page buffer.

Example:

cedric=# SELECT * FROM pgsysconf();
 os_page_size | os_pages_free | os_total_pages 
--------------+---------------+----------------
         4096 |         80431 |        4094174

pgsysconf_pretty

Description: The function is similar to the preceding function. The difference is that the function converts the unit for easy reading.

Example:

cedric=# SELECT * FROM pgsysconf_pretty();
 os_page_size | os_pages_free | os_total_pages 
--------------+---------------+----------------
 4096 bytes   | 314 MB        | 16 GB

pgfincore_drawer

Description: A very simple renderer. This function requires a varbit parameter. Generally, the value of this parameter comes from the databit return column of the pgfincore function. The value of the databit column consists of 0 and 1. If the value is 0, it indicates that the page is not in the page cache of the OS. If the value is 1, it indicates that the page is in the page cache of the OS.

Example:

 cedric=# SELECT * FROM pgfincore_drawer(B'000111');
  drawer       
 --------------
    ...     

cedric=# SELECT * FROM pgfincore_drawer(B'111000');
  drawer       
--------------
   ...    

psortoptions

Description: Returns the psort attribute.

Parameters: text[], Boolean

Return type: bytea

xideq4

Description: Compares two values of the xid type to check whether they are the same.

Parameters: xid32, xid32

Return type: Boolean

xideqint8

Description: Compares values of the xid type and int8 type to check whether they are the same.

Parameters: xid, bigint

Return type: Boolean

xidlt

Description: Returns whether xid1 < xid2 is true.

Parameters: xid, xid

Return type: Boolean

xidlt4

Description: Returns whether xid1 < xid2 is true.

Parameters: xid32, xid32

Return type: Boolean

gs_shutdown_cross_region_walsenders

Description: Interrupts cross-cluster streaming replication.

Parameter: nan

Return type: void

Note: To call this function, the user must have the SYSADMIN or OPRADMIN permission, and operate_mode must be enabled for the O&M administrator role.

is_dblink_in_transaction

Description: Checks whether a database link corresponding to an OID is used in the current transaction.

Parameter: oid

Return type: Boolean

dblink_has_updatasent

Description: Checks whether DML statements are sent using a database link corresponding to an OID in the current transaction and are not committed.

Parameter: oid

Return type: Boolean

get_last_xmin_by_oid

Description: Obtains the maximum xmin value of all columns in a table based on the table OID.

Parameter: oid

Return type: xid

get_relid_by_relname

Description: Obtains the OID of a table based on the table name and relnamespace.

Parameters: cstring, OID

Return type: oid

copy_summary_create

Description: The summary table required by the COPY FROM error tolerance mechanism has been changed to the system catalog created during initialization. Therefore, the current function always returns true for compatibility.

Parameter: none

Return type: Boolean

btint12cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int1, int2

Return type: integer

btint14cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int1, int4

Return type: integer

btint18cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int1, int8

Return type: integer

btint116cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int1, int16

Return type: integer

btint1numericcmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int1, numeric

Return type: integer

btint21cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int2, int1

Return type: integer

btint216cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int2, int16

Return type: integer

btint2numericcmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int2, numeric

Return type: integer

btint41cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int4, int1

Return type: integer

btint416cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int4, int16

Return type: integer

btint4numericcmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int4, numeric

Return type: integer

btint81cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int8, int1

Return type: integer

btint816cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int8, int16

Return type: integer

btint8numericcmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int8, numeric

Return type: integer

btint161cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int16, int1

Return type: integer

btint162cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int16, int2

Return type: integer

btint164cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int16, int4

Return type: integer

btint168cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int16, int8

Return type: integer

btnumericint1cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: numeric, int1

Return type: integer

btnumericint2cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: numeric, int2

Return type: integer

btnumericint4cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: numeric, int4

Return type: integer

btnumericint8cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: numeric, int8

Return type: integer

btint16cmp()

Description: Compares the values of two parameters. If the value is greater than another one, a positive number is returned. If the value is equal to another one, 0 is returned. If the value is less than another one, a negative number is returned.

Parameters: int16, int16

Return type: integer

hashint16()

Description: Calculates the hash value of an input parameter.

Parameter: int16

Return type: integer

hashint1_numeric()

Description: Calculates the hash value of an input parameter.

Parameter: int1

Return type: integer

hashint2_numeric()

Description: Calculates the hash value of an input parameter.

Parameter: int2

Return type: integer

hashint4_numeric()

Description: Calculates the hash value of an input parameter.

Parameter: int4

Return type: integer

hashint8_numeric()

Description: Calculates the hash value of an input parameter.

Parameter: int8

Return type: integer

int12eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int1, int2

Return type: Boolean

int14eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int1, int4

Return type: Boolean

int18eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int1, int8

Return type: Boolean

int116eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int1, int16

Return type: Boolean

int1numericeq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int1, numeric

Return type: Boolean

int21eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int2, int1

Return type: Boolean

int216eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int2, int16

Return type: Boolean

int2numericeq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int2, numeric

Return type: Boolean

int41eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int4, int1

Return type: Boolean

int416eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int4, int16

Return type: Boolean

int4numericeq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int4, numeric

Return type: Boolean

int81eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int8, int1

Return type: Boolean

int816eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int8, int16

Return type: Boolean

int8numericeq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int8, numeric

Return type: Boolean

int161eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int16, int1

Return type: Boolean

int162eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int16, int2

Return type: Boolean

int164eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int16, int4

Return type: Boolean

int168eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: int16, int8

Return type: Boolean

numericint1eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: numeric, int1

Return type: Boolean

numericint2eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: numeric, int2

Return type: Boolean

numericint4eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: numeric, int4

Return type: Boolean

numericint8eq()

Description: Compares whether two parameter values are equal. If they are equal, true is returned. Otherwise, false is returned.

Parameters: numeric, int8

Return type: Boolean

int12ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int1, int2

Return type: Boolean

int14ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int1, int4

Return type: Boolean

int18ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int1, int8

Return type: Boolean

int116ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int1, int16

Return type: Boolean

int1numericne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int1, numeric

Return type: Boolean

int21ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int2, int1

Return type: Boolean

int216ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int2, int16

Return type: Boolean

int2numericne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int2, numeric

Return type: Boolean

int41ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int4, int1

Return type: Boolean

int416ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int4, int16

Return type: Boolean

int4numericne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int4, numeric

Return type: Boolean

int81ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int8, int1

Return type: Boolean

int816ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int8, int16

Return type: Boolean

int8numericne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int8, numeric

Return type: Boolean

int161ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int16, int1

Return type: Boolean

int162ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int16, int2

Return type: Boolean

int164ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int16, int4

Return type: Boolean

int168ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: int16, int8

Return type: Boolean

numericint1ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: numeric, int1

Return type: Boolean

numericint2ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: numeric, int2

Return type: Boolean

numericint4ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: numeric, int4

Return type: Boolean

numericint8ne()

Description: Compares whether two parameter values are equal. If they are not equal, true is returned. Otherwise, false is returned.

Parameters: numeric, int8

Return type: Boolean

int12lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int1, int2

Return type: Boolean

int14lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int1, int4

Return type: Boolean

int18lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int1, int8

Return type: Boolean

int116lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int1, int16

Return type: Boolean

int1numericlt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int1, numeric

Return type: Boolean

int21lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int2, int1

Return type: Boolean

int216lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int2, int16

Return type: Boolean

int2numericlt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int2, numeric

Return type: Boolean

int41lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int4, int1

Return type: Boolean

int416lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int4, int16

Return type: Boolean

int4numericlt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int4, numeric

Return type: Boolean

int81lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int8, int1

Return type: Boolean

int816lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int8, int16

Return type: Boolean

int8numericlt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int8, numeric

Return type: Boolean

int161lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int16, int1

Return type: Boolean

int162lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int16, int2

Return type: Boolean

int164lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int16, int4

Return type: Boolean

int168lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: int16, int8

Return type: Boolean

numericint1lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int1

Return type: Boolean

numericint2lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int2

Return type: Boolean

numericint4lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int4

Return type: Boolean

numericint8lt()

Description: Compares whether a parameter is less than another one. If the parameter is less than another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int8

Return type: Boolean

int12gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int1, int2

Return type: Boolean

int14gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int1, int4

Return type: Boolean

int18gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int1, int8

Return type: Boolean

int116gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int1, int16

Return type: Boolean

int1numericgt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int1, numeric

Return type: Boolean

int21gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int2, int1

Return type: Boolean

int216gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int2, int16

Return type: Boolean

int2numericgt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int2, numeric

Return type: Boolean

int41gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int4, int1

Return type: Boolean

int416gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int4, int16

Return type: Boolean

int4numericgt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int4, numeric

Return type: Boolean

int81gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int8, int1

Return type: Boolean

int816gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int8, int16

Return type: Boolean

int8numericgt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int8, numeric

Return type: Boolean

int161gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int16, int1

Return type: Boolean

int162gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int16, int2

Return type: Boolean

int164gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int16, int4

Return type: Boolean

int168gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: int16, int8

Return type: Boolean

numericint1gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int1

Return type: Boolean

numericint2gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int2

Return type: Boolean

numericint4gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int4

Return type: Boolean

numericint8gt()

Description: Compares whether a parameter is greater than another one. If the parameter is greater than another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int8

Return type: Boolean

int12le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int1, int2

Return type: Boolean

int14le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int1, int4

Return type: Boolean

int18le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int1, int8

Return type: Boolean

int116le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int1, int16

Return type: Boolean

int1numericle()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int1, numeric

Return type: Boolean

int21le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int2, int1

Return type: Boolean

int216le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int2, int16

Return type: Boolean

int2numericle()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int2, numeric

Return type: Boolean

int41le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int4, int1

Return type: Boolean

int416le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int4, int16

Return type: Boolean

int4numericle()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int4, numeric

Return type: Boolean

int81le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int8, int1

Return type: Boolean

int816le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int8, int16

Return type: Boolean

int8numericle()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int8, numeric

Return type: Boolean

int161le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int16, int1

Return type: Boolean

int162le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int16, int2

Return type: Boolean

int164le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int16, int4

Return type: Boolean

int168le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int16, int8

Return type: Boolean

numericint1le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int1

Return type: Boolean

numericint2le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int2

Return type: Boolean

numericint4le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int4

Return type: Boolean

numericint8le()

Description: Compares whether a parameter is less than or equal to another one. If the parameter is less than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int8

Return type: Boolean

int12ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int1, int2

Return type: Boolean

int14ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int1, int4

Return type: Boolean

int18ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int1, int8

Return type: Boolean

int116ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int1, int16

Return type: Boolean

int1numericge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int1, numeric

Return type: Boolean

int21ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int2, int1

Return type: Boolean

int216ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int2, int16

Return type: Boolean

int2numericge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int2, numeric

Return type: Boolean

int41ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int4, int1

Return type: Boolean

int416ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int4, int16

Return type: Boolean

int4numericge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int4, numeric

Return type: Boolean

int81ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int8, int1

Return type: Boolean

int816ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int8, int16

Return type: Boolean

int8numericge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int8, numeric

Return type: Boolean

int161ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int16, int1

Return type: Boolean

int162ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int16, int2

Return type: Boolean

int164ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int16, int4

Return type: Boolean

int168ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: int16, int8

Return type: Boolean

numericint1ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int1

Return type: Boolean

numericint2ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int2

Return type: Boolean

numericint4ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int4

Return type: Boolean

numericint8ge()

Description: Compares whether a parameter is greater than or equal to another one. If the parameter is greater than or equal to another one, true is returned. Otherwise, false is returned.

Parameters: numeric, int8

Return type: Boolean

gs_relation_is_updatable()

Description: Returns whether a relationship can be inserted, updated, or deleted. If the value can be updated, 4 is returned. If the value can be inserted, 8 is returned. If the value can be deleted, 16 is returned. If the value meets the requirements, the value obtained by adding the corresponding values is returned.

Parameters: OID, Boolean

Return type: int32

gs_column_is_updatable()

Description: Returns whether a column can be updated. If the column can be updated, t is returned. Otherwise, f is returned.

Parameters: OID, int16, Boolean

Return type: Boolean

transform_dep_source()

Description: Converts the definitions of functions, stored procedures, and packages in the DBE_PLDEVELOPER.gs_source table to the gs_dep_source table.

Parameter: none

Return type: void

online_ddl_cleanup()

Description: Clears and restores a temporary tool when a fault occurs during the online DDL or online VACUUM FULL execution.

Parameters: text, text

Return type: text

Parameter

Type

Description

Value Range

relschema

text

Schema of a table.

-

relname

text

Name of a table.

-

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
-- Create a table.
gaussdb=#  CREATE TABLE t1(c1 int, c2 int);
-- Execute the online DDL.
gaussdb=# ALTER TABLE ONLINE t1 alter c2 type BIGINT;

-- Clear a fault after it occurs.
gaussdb=#  SELECT online_ddl_cleanup('public','t1');
 online_ddl_cleanup 
--------------------
 cleanup success
(1 row)