废弃函数 由于版本升级，HLL（HyperLogLog）有一些旧的函数废弃，用户可以用类似的函数进行替代。 hll_schema_version(hll) 描述：查看当前hll中的schema version。旧版本schema version是常值1，用来进行hll字段的头部校验，重构后的hll在头部增加字段“HLL”进行校验，schema version不再使用。 hll_regwidth(hll) 描述：查看hll数据结构中桶的位数大小。旧版本桶的位数regwidth取值1~5，会存在较大的误差，也限制了基数估计上限。 重构后regwidth为固定值6，不再使用regwidth变量。 hll_expthresh(hll) 描述：得到当前hll中expthresh大小。采用hll_log2explicit(hll)替代类似功能。 hll_sparseon(hll) 描述：是否启用Sparse模式。采用hll_log2sparse(hll)替代类似功能，0表示关闭Sparse模式。

操作符 = 描述：比较hll或hll_hashval的值是否相等。 返回值类型：bool 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 --hll openGauss=# SELECT (hll_empty() || hll_hash_integer(1)) = (hll_empty() || hll_hash_integer(1)); column ---------- t (1 row) --hll_hashval openGauss=# SELECT hll_hash_integer(1) = hll_hash_integer(1); ?column? ---------- t (1 row)

聚合函数 hll_add_agg(hll_hashval) 描述：把哈希后的数据按照分组放到hll中。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 --准备数据 openGauss=# CREATE TABLE t_id(id int); openGauss=# INSERT INTO t_id VALUES(generate_series(1,500)); openGauss=# CREATE TABLE t_data(a int, c text); openGauss=# INSERT INTO t_data SELECT mod(id,2), id FROM t_id; --创建表并指定列为hll openGauss=# CREATE TABLE t_a_c_hll(a int, c hll); --根据a列group by对数据分组，把各组数据加到hll中 openGauss=# INSERT INTO t_a_c_hll SELECT a, hll_add_agg(hll_hash_text(c)) FROM t_data GROUP BY a; --得到每组数据中hll的Distinct值 openGauss=# SELECT a, #c as cardinality FROM t_a_c_hll ORDER BY a; a | cardinality ---+------------------ 0 | 247.862354346299 1 | 250.908710610377 (2 rows)

功能函数 hll_empty() 描述：创建一个空的hll。 返回值类型：hll 示例： 1 2 3 4 5 openGauss=# SELECT hll_empty(); hll_empty ------------------------------------------------------------ \x484c4c00000000002b05000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m) 描述：创建空的hll并指定参数log2m，取值范围是10到16。若输入-1，则采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# SELECT hll_empty(10); hll_empty ------------------------------------------------------------ \x484c4c00000000002b04000000000000000000000000000000000000 (1 row) openGauss=# SELECT hll_empty(-1); hll_empty ------------------------------------------------------------ \x484c4c00000000002b05000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m, int32 log2explicit) 描述：创建空的hll并依次指定参数log2m、log2explicit。log2explicit取值范围是0到12，0表示直接跳过Explicit模式。该参数可以用来设置Explicit模式的阈值大小，在数据段长度达到2log2explicit后切换为Sparse模式或者Full模式。若输入-1，则log2explicit采用内置默认值。 返回值类型: hll 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# SELECT hll_empty(10, 4); hll_empty ------------------------------------------------------------ \x484c4c00000000001304000000000000000000000000000000000000 (1 row) openGauss=# SELECT hll_empty(10, -1); hll_empty ------------------------------------------------------------ \x484c4c00000000002b04000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m, int32 log2explicit, int64 log2sparse) 描述：创建空的hll并依次指定参数log2m、log2explicit、log2sparse。log2sparse取值范围是0到14，0表示直接跳过Sparse模式。该参数可以用来设置Sparse模式的阈值大小，在数据段长度达到2log2sparse后切换为Full模式。若输入-1，则log2sparse采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# SELECT hll_empty(10, 4, 8); hll_empty ------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000 (1 row) openGauss=# SELECT hll_empty(10, 4, -1); hll_empty ------------------------------------------------------------ \x484c4c00000000001304000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m, int32 log2explicit, int64 log2sparse, int32 duplicatecheck) 描述：创建空的hll并依次指定参数log2m、log2explicit、log2sparse、duplicatecheck。duplicatecheck取0或者1，表示是否开启该模式，默认情况下该模式会关闭。若输入-1，则duplicatecheck采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# SELECT hll_empty(10, 4, 8, 0); hll_empty ------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000 (1 row) openGauss=# SELECT hll_empty(10, 4, 8, -1); hll_empty ------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000 (1 row) hll_add(hll, hll_hashval) 描述：把hll_hashval加入到hll中。 返回值类型：hll 示例： 1 2 3 4 5 openGauss=# SELECT hll_add(hll_empty(), hll_hash_integer(1)); hll_add ---------------------------------------------------------------------------- \x484c4c08000002002b0900000000000000f03f3e2921ff133fbaed3e2921ff133fbaed00 (1 row) hll_add_rev(hll_hashval, hll) 描述：把hll_hashval加入到hll中，和hll_add功能一样，只是参数位置进行了交换。 返回值类型：hll 示例： 1 2 3 4 5 openGauss=# SELECT hll_add_rev(hll_hash_integer(1), hll_empty()); hll_add_rev ---------------------------------------------------------------------------- \x484c4c08000002002b0900000000000000f03f3e2921ff133fbaed3e2921ff133fbaed00 (1 row) hll_eq(hll, hll) 描述：比较两个hll是否相等。 返回值类型：bool 示例： 1 2 3 4 5 openGauss=# SELECT hll_eq(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_eq -------- f (1 row) hll_ne(hll, hll) 描述：比较两个hll是否不相等。 返回值类型：bool 示例： 1 2 3 4 5 openGauss=# SELECT hll_ne(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_ne -------- t (1 row) hll_cardinality(hll) 描述：计算hll的distinct值。 返回值类型：int 示例： 1 2 3 4 5 openGauss=# SELECT hll_cardinality(hll_empty() || hll_hash_integer(1)); hll_cardinality ----------------- 1 (1 row) hll_union(hll, hll) 描述：把两个hll数据结构union成一个。 返回值类型：hll 示例： 1 2 3 4 5 openGauss=# SELECT hll_union(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_union -------------------------------------------------------------------------------------------- \x484c4c10002000002b090000000000000000400000000000000000b3ccc49320cca1ae3e2921ff133fbaed00 (1 row)

日志函数 hll主要存在三种模式Explicit，Sparse，Full。当数据规模比较小的时候会使用Explicit模式，这种模式下distinct值的计算是没有误差的；随着distinct值越来越多，hll会先后转换为Sparse模式和Full模式，这两种模式在计算结果上没有任何区别，只影响hll函数的计算效率和hll对象的存储空间。下面的函数可以用于查看hll的一些参数。 hll_print(hll) 描述：打印hll的一些debug参数信息。 示例： 1 2 3 4 5 openGauss=# SELECT hll_print(hll_empty()); hll_print ------------------------------------------------------------------------------- type=1(HLL_EMPTY), log2m=14, log2explicit=10, log2sparse=12, duplicatecheck=0 (1 row)

二进制字符串函数 GaussDB 也提供了函数调用所使用的常用语法。 btrim(string bytea,bytes bytea) 描述：从string的开头和结尾删除只包含bytes中字节的最长的字符串。 返回值类型：bytea 示例： 1 2 3 4 5 openGauss=# SELECT btrim(E'\\000trim\\000'::bytea, E'\\000'::bytea) AS RESULT; result ------------ \x7472696d (1 row) get_bit(string, offset) 描述：从字符串中抽取位。 返回值类型：int 示例： 1 2 3 4 5 openGauss=# SELECT get_bit(E'Th\\000omas'::bytea, 45) AS RESULT; result -------- 1 (1 row) get_byte(string, offset) 描述：从字符串中抽取字节。 返回值类型：int 示例： 1 2 3 4 5 openGauss=# SELECT get_byte(E'Th\\000omas'::bytea, 4) AS RESULT; result -------- 109 (1 row) rawcmp 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：integer raweq 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：boolean rawge 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：boolean rawgt 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：boolean rawin 描述：raw数据类型解析函数。 参数：cstring 返回值类型：bytea rawle 描述：raw数据类型解析函数。 参数：raw, raw 返回值类型：boolean rawlike 描述：raw数据类型解析函数。 参数：raw, raw 返回值类型：boolean rawlt 描述：raw数据类型解析函数。 参数：raw, raw 返回值类型：boolean rawne 描述：比较raw类型是否一样。 参数：raw, raw 返回值类型：boolean rawnlike 描述：比较raw类型与模式是否不匹配。 参数：raw, raw 返回值类型：boolean rawout 描述：RAW类型的输出接口。 参数：bytea 返回值类型：cstring rawsend 描述：转换bytea为二进制类型。 参数：raw 返回值类型：bytea rawtohex 描述：raw格式转换为十六进制。 参数：text 返回值类型：text set_bit(string,offset, newvalue) 描述：设置字符串中的位。 返回值类型：bytea 示例： 1 2 3 4 5 openGauss=# SELECT set_bit(E'Th\\000omas'::bytea, 45, 0) AS RESULT; result ------------------ \x5468006f6d4173 (1 row) set_byte(string,offset, newvalue) 描述：设置字符串中的字节。 返回值类型：bytea 示例： 1 2 3 4 5 openGauss=# SELECT set_byte(E'Th\\000omas'::bytea, 4, 64) AS RESULT; result ------------------ \x5468006f406173 (1 row)

字符串操作符 SQL定义了一些字符串函数，在这些函数里使用关键字而不是逗号来分隔参数。 octet_length(string) 描述：二进制字符串中的字节数。 返回值类型：int 示例： 1 2 3 4 5 openGauss=# SELECT octet_length(E'jo\\000se'::bytea) AS RESULT; result -------- 5 (1 row) overlay(string placing string from int [for int]) 描述：替换子串。 返回值类型：bytea 示例： 1 2 3 4 5 openGauss=# SELECT overlay(E'Th\\000omas'::bytea placing E'\\002\\003'::bytea from 2 for 3) AS RESULT; result ---------------- \x5402036d6173 (1 row) position(substring in string) 描述：特定子字符串的位置。 返回值类型：int 示例： 1 2 3 4 5 openGauss=# SELECT position(E'\\000om'::bytea in E'Th\\000omas'::bytea) AS RESULT; result -------- 3 (1 row) substring(string [from int] [for int]) 描述：截取子串。 返回值类型：bytea 示例： 1 2 3 4 5 openGauss=# SELECT substring(E'Th\\000omas'::bytea from 2 for 3) AS RESULT; result ---------- \x68006f (1 row) substr(string, from int [, for int]) 描述：截取子串。 返回值类型：bytea 示例： 1 2 3 4 5 openGauss=# SELECT substr(E'Th\\000omas'::bytea,2, 3) AS RESULT; result ---------- \x68006f (1 row) trim([both] bytes from string) 描述：从string的开头和结尾删除只包含bytes中字节的最长字符串。 返回值类型：bytea 示例： 1 2 3 4 5 openGauss=# SELECT trim(E'\\000'::bytea from E'\\000Tom\\000'::bytea) AS RESULT; result ---------- \x546f6d (1 row)

动态数据脱敏函数 该函数为内部功能调用函数。 creditcardmasking(col text, letter char default 'x') 描述：将col字符串后四位之前的数字使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text basicmailmasking(col text, letter char default 'x') 描述：将col字符串中第一个'@'之前的字符使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text fullmailmasking(col text, letter char default 'x') 描述：将col字符串中出现最后一个'.'之前的字符(除'@'外)使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text alldigitsmasking(col text, letter char default '0') 描述：将col字符串中出现的数字使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text shufflemasking(col text) 描述：将col字符串中的字符乱序排列。 参数：待替换的字符串、替换字符。 返回值类型：text randommasking(col text) 描述：将col字符串中的字符随机化。 参数：待替换的字符串、替换字符。 返回值类型：text regexpmasking(col text, reg text, replace_text text, pos INTEGER default 0, reg_len INTEGER default -1) 描述：将col字符串使用正则表达式替换。 参数：待替换的字符串、正则表达式、替换的起始位置、替换长度、。 返回值类型：text 父主题： 函数和操作符

废弃函数 GaussDB中下列函数在最新版本中已废弃： gs_wlm_get_session_info gs_wlm_get_user_session_info check_engine_status encode_plan_node model_train_opt gs_stat_get_wlm_plan_operator_info track_model_train_opt array_extend dbe_perf.global_slow_query_info dbe_perf.global_slow_query_info_bytime dbe_perf.global_slow_query_history pg_reload_conf pg_rotate_logfile gs_stat_ustore pgxc_get_searchlet_info() pgxc_get_searchlet_table_attr_info() gs_comm_proxy_thread_status() - - - - 父主题： 函数和操作符

重分布函数 以下函数为重分布期间gs_redis工具所用的系统函数，用户不要主动调用： pg_get_redis_rel_end_ctid(text, name, int, int) pg_get_redis_rel_start_ctid(text, name, int, int) pg_enable_redis_proc_cancelable() pg_disable_redis_proc_cancelable() pg_tupleid_get_blocknum(tid) pg_tupleid_get_offset(tid) pg_tupleid_get_ctid_to_bigint (ctid) 父主题： 函数和操作符

字符串操作符 SQL定义了一些字符串函数，在这些函数里使用关键字而不是逗号来分隔参数。 octet_length(string) 描述：二进制字符串中的字节数。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT octet_length(E'jo\\000se'::bytea) AS RESULT; result -------- 5 (1 row) overlay(string placing string from int [for int]) 描述：替换子串。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT overlay(E'Th\\000omas'::bytea placing E'\\002\\003'::bytea from 2 for 3) AS RESULT; result ---------------- \x5402036d6173 (1 row) position(substring in string) 描述：特定子字符串的位置。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT position(E'\\000om'::bytea in E'Th\\000omas'::bytea) AS RESULT; result -------- 3 (1 row) substring(string [from int] [for int]) 描述：截取子串。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT substring(E'Th\\000omas'::bytea from 2 for 3) AS RESULT; result ---------- \x68006f (1 row) substr(string, from int [, for int]) 描述：截取子串。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT substr(E'Th\\000omas'::bytea,2, 3) as result; result ---------- \x68006f (1 row) trim([both] bytes from string) 描述：从string的开头和结尾删除只包含bytes中字节的最长字符串。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT trim(E'\\000'::bytea from E'\\000Tom\\000'::bytea) AS RESULT; result ---------- \x546f6d (1 row)

二进制字符串函数 GaussDB也提供了函数调用所使用的常用语法。 btrim(string bytea,bytes bytea) 描述：从string的开头和结尾删除只包含bytes中字节的最长的字符串。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT btrim(E'\\000trim\\000'::bytea, E'\\000'::bytea) AS RESULT; result ------------ \x7472696d (1 row) get_bit(string, offset) 描述：从字符串中抽取位。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT get_bit(E'Th\\000omas'::bytea, 45) AS RESULT; result -------- 1 (1 row) get_byte(string, offset) 描述：从字符串中抽取字节。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT get_byte(E'Th\\000omas'::bytea, 4) AS RESULT; result -------- 109 (1 row) set_bit(string,offset, newvalue) 描述：设置字符串中的位。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT set_bit(E'Th\\000omas'::bytea, 45, 0) AS RESULT; result ------------------ \x5468006f6d4173 (1 row) set_byte(string,offset, newvalue) 描述：设置字符串中的字节。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT set_byte(E'Th\\000omas'::bytea, 4, 64) AS RESULT; result ------------------ \x5468006f406173 (1 row) rawcmp 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：integer raweq 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：boolean rawge 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：boolean rawgt 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：boolean rawin 描述：raw数据类型解析函数。 参数：cstring 返回值类型：bytea rawle 描述：raw数据类型解析函数。 参数：raw, raw 返回值类型：boolean rawlike 描述：raw数据类型解析函数。 参数：raw, raw 返回值类型：boolean rawlt 描述：raw数据类型解析函数。 参数：raw, raw 返回值类型：boolean rawne 描述：比较raw类型是否一样。 参数：raw, raw 返回值类型：boolean rawnlike 描述：比较raw类型与模式是否不匹配。 参数：raw, raw 返回值类型：boolean rawout 描述：RAW类型的输出接口。 参数：bytea 返回值类型：cstring rawsend 描述：转换bytea为二进制类型。 参数：raw 返回值类型：bytea rawtohex 描述：raw格式转换为十六进制。 参数：text 返回值类型：text

废弃函数 由于版本升级，HLL（HyperLogLog）有一些旧的函数废弃，用户可以用类似的函数进行替代。 hll_schema_version(hll) 描述：查看当前hll中的schema version。旧版本schema version是常值1，用来进行hll字段的头部校验，重构后的hll在头部增加字段“HLL”进行校验，schema version不再使用。 hll_regwidth(hll) 描述：查看hll数据结构中桶的位数大小。旧版本桶的位数regwidth取值1~5，会存在较大的误差，也限制了基数估计上限。 重构后regwidth为固定值6，不再使用regwidth变量。 hll_expthresh(hll) 描述：得到当前hll中expthresh大小。采用hll_log2explicit(hll)替代类似功能。 hll_sparseon(hll) 描述：是否启用Sparse模式。采用hll_log2sparse(hll)替代类似功能，0表示关闭Sparse模式。

聚合函数 hll_add_agg(hll_hashval) 描述：把哈希后的数据按照分组放到hll中。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 --准备数据 gaussdb=# CREATE TABLE t_id(id int); gaussdb=# INSERT INTO t_id VALUES(generate_series(1,500)); gaussdb=# CREATE TABLE t_data(a int, c text); gaussdb=# INSERT INTO t_data SELECT mod(id,2), id FROM t_id; --创建表并指定列为hll gaussdb=# CREATE TABLE t_a_c_hll(a int, c hll); --根据a列GROUP BY对数据分组，把各组数据加到hll中 gaussdb=# INSERT INTO t_a_c_hll SELECT a, hll_add_agg(hll_hash_text(c)) FROM t_data GROUP BY a; --得到每组数据中hll的Distinct值 gaussdb=# SELECT a, #c AS cardinality FROM t_a_c_hll ORDER BY a; a | cardinality ---+------------------ 0 | 247.862354346299 1 | 250.908710610377 (2 rows)

操作符 = 描述：比较hll或hll_hashval的值是否相等。 返回值类型：bool 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 --hll gaussdb=# SELECT (hll_empty() || hll_hash_integer(1)) = (hll_empty() || hll_hash_integer(1)); column ---------- t (1 row) --hll_hashval gaussdb=# SELECT hll_hash_integer(1) = hll_hash_integer(1); ?column? ---------- t (1 row)