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. If you need to use them, contact Huawei technical support.

spread_collect()

Description: Calculates the difference between the maximum and minimum values in a certain period of time. This function is used for data collection of aggregate functions.

Parameters: s real[], v real[]

Return type: real[]

spread_final()

Description: Calculates the difference between the maximum and minimum values in a certain period of time. This function is used for the final data processing of the aggregate function.

Parameter: s real[]

Return type: real

spread_internal()

Description: Calculates the difference between the maximum and minimum values in a certain period of time. This function is used for the process of aggregate functions.

Parameters: s real[], v real

Return type: real[]

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

gap_fill_internal()

Description: Returns the first non-NULL value in the parameter list.

Parameter: s anyelement, v anyelement

Return type: anyelement

int1send()

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

Parameter: tinyint

Return type: bytea

is_contain_namespace()

Description: Searches for the table name and namespace split location. If no namespace exists, 0 is returned.

Parameter: relationname name

Return type: integer

is_oid_in_group_members()

Description: Not supported

Parameter: node_oid oid, group_members oidvector_extend

Return type: Boolean

isubmit_on_nodes_internal()

Description: Not supported

Parameter: job bigint, node_name name, database name, what text, next_date timestamp without time zone, job_interval text

Return type: integer

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

pg_nodes_memmon()

Description: Not supported.

Parameter: nan

Return type: innernname text, innerusedmem bigint, innertopctxt bigint, nname text, usedmem text, sharedbuffercache text, topcontext text

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 data from the shared buffer.

Parameter: nan

Return type: bufferid integer, relfilenode oid, bucketid smallint, storage_type oid, reltablespace oid, reldatabase oid, relforknumber smallint, relblocknumber bigint, isdirty Boolean, usage_count smallint

pg_check_xidlimit()

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

Parameter: nan

Return type: Boolean

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: Parses Clog to obtain the XID status of a specified bucket ID.

Parameter: bucketid indicates the physical bucket ID of the hash bucket table. The value –1 indicates an ordinary table.

Return type: xid xid, status text

pg_pool_ping()

Description: Sets PoolerPing.

Parameter: Boolean

Return type: SETOF Boolean

pg_pool_validate()

Description: Compares fields in the pgxc_node system catalog to check whether a connection is available.

Parameter: clear Boolean, co_node_name cstring

Return type: pid bigint, node_name text

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

gs_static_threadpool_ctrl_status()

Description: Queries statistics about the static pool threads in the thread pool. When a CN thread pool is enabled, a distributed CN supports the query of related static pool information, and a DN returns a blank line. When the thread pool is disabled, a blank line is returned. If static_thread_pool_num is set to 0 or less than the number of groups in the thread pool, the default value of the static thread pool is 0.

Parameter: nan

Return value: text node_name, int group_id, and text worker_info. The return columns are described in GS_STATIC_THREADPOOL_CTRL_STATUS columns.

Table 1 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 default value of the static thread pool.

expect and expect_s: number of threads, including the expected value of the dynamic thread pool and expected value 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.

pg_stat_get_pooler_status()

Description: Queries the cache connection status in the pooler.

Parameter: nan

Return value type: See Return values of pg_stat_get_pooler_status.

Table 2 Return values of pg_stat_get_pooler_status

Name

Type

Description

database_name

OUT text

Database name.

user_name

OUT text

Username.

tid

OUT bigint

In non-thread pool logic, this parameter indicates the ID of the thread connected to the CN. In thread pool logic, this parameter indicates the ID of the session connected to the CN.

pgoptions

OUT text

Database connection option. For details, see the options column in Connection Parameters.

node_oid

OUT bigint

OID of the node connected.

in_use

OUT boolean

Specifies whether the connection is currently used.
  • t (true): The connection is in use.
  • f (false): The connection is not in use.

session_params

OUT text

GUC session parameter delivered by the connection.

fdsock

OUT bigint

Local socket.

local_host

OUT text

Local IP address.

local_port

OUT bigint

Local port number.

remote_host

OUT text

Peer IP address.

remote_port

OUT bigint

Peer port number.

remote_pid

OUT bigint

If the peer site is not in the thread pool logic, the value is the thread ID of the peer site. If the peer site is in the thread pool logic, the value is the session ID of the peer site.

used_count

OUT bigint

Number of reuse times of a connection.

idx

OUT bigint

Peer DN ID in the local CN.

streamid

OUT bigint

Stream ID in the physical connection.

get_node_modulo()

Description: Computes subscripts of a node in a group.

Parameters: See Table 3 get_node_modulo input parameters.

Table 3 get_node_modulo input parameters

Parameter

Type

Description

Value Range

node_oid

IN oid

Node OID.

[0, 2^32-1]

group_oid

IN oid

OID of a node group.

[0, 2^32-1]

Return type: uint4

check_murmurhash_route_node()

Description: Checks whether the node where the key is distributed is correct.

Parameters: See Table 4 check_murmurhash_route_node input parameters.

Table 4 check_murmurhash_route_node input parameters

Parameter

Type

Description

Value Range

key

IN text

Character string of the hash key.

-

node_modulo

IN uint4

Index of a node in a node group.

[0, 2^32-1]

node_num

IN uint4

Number of nodes in a node group.

[0, 2^32-1]

Return type: uint4

gs_libcomm_fd_info()

Description: Queries the socket persistent connection information of the libcomm communications library.

Parameter: nan

Return value: See Table 5 Return values of gs_libcomm_fd_info.

Table 5 Return values of gs_libcomm_fd_info

Name

Type

Description

node_name

OUT text

DN name.

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

Name of the peer DN.

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.

Parameter: nan

Return value: See Table 6 Return values of gs_libcomm_memory_info.

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_validate_ext_listen_ip()

Description: Connects to DNs, queries invalid worker threads on DNs connected to the original extended IP address, and clears the threads.

Parameters: See Table7 GS_VALIDATE_EXT_LISTEN_IP columns.

Return value: bigint pid, text node_name

Note: This function is used only when old connections still exist on the original extended IP address after the extended IP address is reloaded. This function clears the threads where the original IP connections are located. Executing this function will clear communication listening on the extended IP address. Exercise caution when performing O&M operations. Currently, this command can be executed only by connecting to DNs and delivered by the administrator.

Table 7 GS_VALIDATE_EXT_LISTEN_IP columns

Name

Type

Description

clear

IN cstring

Specifies whether to clear data. The options are as follows: on: clear; off: not clear.

validate_node_name

IN cstring

Name of the DN where the extended IP address connections to be cleared are located.

validate_ip

IN cstring

Extended IP address whose connections are to be cleared.

pid

OUT bigint

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

node_name

OUT text

Name of the instance to which the extended IP address connections to be cleared belong.

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 instance.

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 Table8 GS_COMM_LISTEN_ADDRESS_EXT_INFO columns describes the returned columns.

Table 8 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_get_global_listen_address_ext_info

Description: Queries the global extended IP address configuration on the CN.

Parameters: See Table9 GS_GET_GLOBAL_LISTEN_ADDRESS_EXT_INFO columns.

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

Note: If the input parameter of the function is all, the function depends on the ext_ip_info static configuration file. If the file is abnormal, use the CM/OM tool to rectify the fault. In this case, the configuration cannot be updated in real time. You can set the input parameter to primary to obtain the configuration information about all primary DNs.

Table 9 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 10 GS_GET_LISTEN_ADDRESS_EXT_INFO.

Table 10 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.

psortoptions()

Description: Returns the psort attribute.

Parameters: text[], Boolean

Return type: bytea

remove_job_class_depend()

Description: Removes the job dependency.

Parameter: oid

Return type: void

xideq4()

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

Parameters: xid32, xid32

Return type: Boolean

xideqint8()

Description: Compares two XIDs 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

get_local_cont_query_stat()

Description: Obtains the statistics of a specified continuous computing view on the local node.

Parameter: cq_id oid

Return type: cq oid, w_in_rows int8, w_in_bytes int8, w_out_rows int8, w_out_bytes int8, w_pendings int8, w_errors int8, r_in_rows int8, r_in_bytes int8, r_out_rows int8, r_out_bytes int8, r_errors int8, c_in_rows int8, c_in_bytes int8, c_out_rows int8, c_out_bytes int8, c_pendings int8, c_errors int8

get_local_cont_query_stats()

Description: Obtains all continuous computing view statistics of the local node.

Parameter: nan

Return type: cq oid, w_in_rows int8, w_in_bytes int8, w_out_rows int8, w_out_bytes int8, w_pendings int8, w_errors int8, r_in_rows int8, r_in_bytes int8, r_out_rows int8, r_out_bytes int8, r_errors int8, c_in_rows int8, c_in_bytes int8, c_out_rows int8, c_out_bytes int8, c_pendings int8, c_errors int8

get_cont_query_stats()

Description: Obtains statistics about all continuous computing views on each DN.

Parameter: nan

Return type: node name, cq oid, w_in_rows int8, w_in_bytes int8, w_out_rows int8, w_out_bytes int8, w_pendings int8, w_errors int8, r_in_rows int8, r_in_bytes int8, r_out_rows int8, r_out_bytes int8, r_errors int8, c_in_rows int8, c_in_bytes int8, c_out_rows int8, c_out_bytes int8, c_pendings int8, c_errors int8

reset_local_cont_query_stat()

Description: Resets the statistics of a specified continuous computation view on the local node.

Parameter: cq_id oid

Return type: Boolean

reset_local_cont_query_stats()

Description: Resets association statistics on the specified continuous computation view of the local node.

Parameter: cq_id oid

Return type: Boolean

reset_cont_query_stats()

Description: Resets the continuous computation view statistics corresponding to the STREAM object on each DN.

Parameter: stream_id oid

Return type: Boolean

check_cont_query_schema_changed()

Description: Determines the schema change status of a specified continuous computation view.

Parameter: cq_id oid

Return type: Boolean

gs_get_standby_cluster_barrier_status()

Description: Queries the barrier log replay information of the standby CN or DN, including the latest received barrier, LSN of the latest received barrier, barrier played back last time, and target barrier to be played back.

Parameter: nan

Return type: barrier_id text, barrier_lsn text, recovery_id text, target_id text

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.

gs_set_standby_cluster_target_barrier_id()

Description: Sets the target barrier to be played back.

Parameter: barrier_id

Return type: target_id text

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.

gs_query_standby_cluster_barrier_id_exist()

Description: Queries whether the specified barrier is received by the standby node.

Parameter: barrier_id

Return type: Boolean

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.

standby_read_status()

Description: Obtains the CSN-based snapshot information of all DNs in a cluster, the difference between the primary and standby DNs, and the CSN-based snapshot information used for the last read on standby. This is used for read on standby in the distributed GTM-free scenario.

Parameter: nan

Return type: text, text, text, integer, bigint, bigint, bigint Table 11 standby_read_status columns describes the returned columns.

Table 11 standby_read_status columns

Name

Type

Description

name

text

DN name.

type

text

DN type (primary for the primary node and standby for the standby node).

host

text

IP address used by the DN.

port

integer

Port used by the DN.

collected_csn

bigint

CSN-based snapshot information of the DN. (For the primary node, the value is 0. For the standby node, the value is the collected CSN.)

delay

bigint

Difference between the primary and standby DNs. The unit is ms.

visited_csn

bigint

CSN information used for the last read query on the standby node. (This parameter is valid only for the standby node where the last query is executed.)

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.

The following stream functions exist but are not supported. You are advised not to use them.

streaming_int8_avg_gather, streaming_numeric_avg_gather, streaming_float8_avg_gather, streaming_interval_avg_gather, streaming_int8_sum_gather, streaming_int2_int4_sum_gather

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

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

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)