GUC参数说明

GUC参数说明

dolphin.sql_mode

取值范围：字符串

默认值：’sql_mode_strict,sql_mode_full_group,pipes_as_concat,ansi_quotes,no_zero_date,pad_char_to_full_length’

参数说明：参数值为逗号间隔的字符串，仅允许合法字符串设定，不合法情况下，启动后报warning。同样，设置时候，如果新值非法，则报warning并且不修改老值。当前有几种场景会用到sql_mode：

sql_mode_strict：插入不符合当前列类型的值时,进行数据转换;分两种场景，insert into table values(…) 和insert into table select … 主要涉及到各种数据类型之间的互相转换，目前涉及的类型有tinyint[unsigned],smallint[unsigned],int[unsigned],bigint[unsigned],float,double,numeric,clob,char和varchar；
sql_mode_strict：插入的列值长度超过此列所限定的长度时,赋予该列最大或最小值，涉及的类型有tinyint[unsigned],smallint[unsigned],int[unsigned],bigint[unsigned],float,double,numeric,clob,char和varchar;
sql_mode_strict：insert时，属性是非空且没有默认值的列，且没有在insert的列表中，则为其添加默认值;（涉及的类型同上）
sql_mode_strict：支持对属性是非空且没有默认值的列显式插入default;（涉及的类型同上）
sql_mode_full_group：
- 出现在select列表中的列（不使用聚合函数），是否一定要出现在group by子句中。当处在sql_mode_full_group模式（默认模式）下，如果select列表中的列没有使用聚合函数，也没有出现在group by子句，那么会报错，如果不在此模式下，则会执行成功，并在所有符合条件的元组中选取第一个元组。
- 出现在order by中的列，是否一定要出现在distinct中（注意是distinct，不是distinct on）。当处在sql_mode_full_group模式（默认模式）下，不允许没有出现在distinct中的列出现在order by子句中，否则允许。
pipes_as_concat：控制 || 当成连接符还是或操作符

ansi_quotes：主要是针对出现在各种需要使用双引号表示字符串值的地方。当ansi_quotes打开，就表示此时的双引号中的内容要作为对象引用看待；当ansi_quotes关闭时，表示双引号中的内容要作为字符串的值看待。当关闭ansi_quotes时，会导致部分元命令失效，失效的元命令如下表所示：

参数	参数说明
\d[S+]	列出当前search_path中模式下所有的表、视图和序列。当search_path中不同模式存在同名对象时，只显示search_path中位置靠前模式下的同名对象。
\d+ [PATTERN]	列出所有表、视图和索引。
\da[S] [PATTERN]	列出所有可用的聚集函数以及它们操作的数据类型和返回值类型。
\db[+] [PATTERN]	列出所有可用的表空间。
\dc[S+] [PATTERN]	列出所有字符集之间的可用转换。
\dC[+] [PATTERN]	列出所有类型转换。
\dd[S] [PATTERN]	显示所有匹配PATTERN的描述。
\ddp [PATTERN]	显示所有默认的使用权限。
\dD[S+] [PATTERN]	列出所有可用域。
\ded[+] [PATTERN]	列出所有的Data Source对象。
\det[+] [PATTERN]	列出所有的外部表。
\des[+] [PATTERN]	列出所有的外部服务器。
\deu[+] [PATTERN]	列出用户映射信息。
\dew[+] [PATTERN]	列出封装的外部数据。
\df[antw][S+] [PATTERN]	列出所有可用函数以及它们的参数和返回的数据类型。a代表聚集函数，n代表普通函数，t代表触发器，w代表窗口函数。
\dF[+] [PATTERN]	列出所有的文本搜索配置信息。
\dFd[+] [PATTERN]	列出所有的文本搜索字典。
\dFp[+] [PATTERN]	列出所有的文本搜索分析器。
\dFt[+] [PATTERN]	列出所有的文本搜索模板。
\dl	\lo_list的别名，显示一个大对象的列表。
\dL[S+] [PATTERN]	列出可用的程序语言。
\dm[S+] [PATTERN]	列出物化视图
\dn[S+] [PATTERN]	列出所有的模式（名称空间）。
\do[S] [PATTERN]	列出所有可用的操作符以及它们的操作数和返回的数据类型。
\dO[S+] [PATTERN]	列出排序规则
\dp [PATTERN]	列出一列可用的表、视图以及相关的权限信息。
\dT[S+] [PATTERN]	列出所有的数据类型。
\dE[S+] [PATTERN]	这一组命令，字母E、i、s、t和v分别代表着外部表、索引、序列、表和视图。可以以任意顺序指定其中一个或者它们的组合来列出这些对象。例如：\dit列出所有的索引和表。在命令名称后面追加+，则每一个对象的物理尺寸以及相关的描述也会被列出。
\dx[+] [PATTERN]	列出安装数据库的扩展信息。
\l[+]	列出服务器上所有数据库的名称、所有者、字符集编码以及使用权限。
\z [PATTERN]	列出数据库中所有表、视图和序列以及它们相关的访问特权。

ansi_quotes关闭情况下，如果需要用到数据库关键字作为对象标识符，或者出于规范性要求需要包裹所有对象标识符，可以使用反引号(`)替代双引号。

使用反引号(`)的情况下，表名称（受到参数lower_case_table_names控制）之外，其他包围的列名称，索引名称等都会做自动的小写化处理，返回数据的列也均为小写名称。

no_zero_date：控制 ‘0000-00-00’ 是否为合法日期，支持DATE、DATETIME类型

参数	表现
no_zero_date, sql_mode_strict	非法日期，报错（使用update/insert ignore时告警）
no_zero_date	非法日期，告警
sql_mode_strict	合法日期，无告警
–	合法日期，无告警

pad_char_to_full_length：控制char类型查询时是否删除尾部空格。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

示例：

--创建表test1。
openGauss=# CREATE TABLE test1
(
  a1 smallint not null,
  a2 int not null,
  a3 bigint not null,
  a4 float not null,
  a5 double not null,
  a6 numeric not null,
  a7 varchar(5) not null
);
CREATE TABLE
--向表中插入记录失败。
openGauss=# insert into test1(a1,a2) values(123412342342314,3453453453434324);
ERROR:  smallint out of range
CONTEXT:  referenced column: a1
--查询表失败
openGauss=# select a1,a2 from test1 group by a1;
ERROR:  column "test1.a2" must appear in the GROUP BY clause or be used in an aggregate function
LINE 1: select a1,a2 from test1 group by a1;
--向表中插入记录成功。
openGauss=# set dolphin.sql_mode = '';
SET
openGauss=# insert into test1(a1,a2) values(123412342342314,3453453453434324);
WARNING:  invalid input syntax for numeric: ""
CONTEXT:  referenced column: a6
WARNING:  smallint out of range
CONTEXT:  referenced column: a1
WARNING:  integer out of range
CONTEXT:  referenced column: a2
INSERT 0 1
--查询表成功
openGauss=# select a1,a2 from test1 group by a1;
  a1   |     a2
-------+------------
 32767 | 2147483647
(1 row)
--删除表
openGauss=# DROP TABLE test1;
DROP TABLE
--ansi_quotes效果展示
openGauss=# create database test_db dbcompatibility 'B';
CREATE DATABASE
openGauss=# \c test_db 
Non-SSL connection (SSL connection is recommended when requiring high-security)
You are now connected to database "test_db" as user "luozihao".
test_db=# show dolphin.sql_mode ;
                                           dolphin.sql_mode                                           
------------------------------------------------------------------------------------------------------
 sql_mode_strict,sql_mode_full_group,pipes_as_concat,ansi_quotes,no_zero_date,pad_char_to_full_length
(1 row)
test_db=# create table test(a varchar(20));
CREATE TABLE
test_db=# insert into test values('test');
INSERT 0 1
test_db=# select "a" from test;
  a   
------
 test
(1 row)
test_db=# set dolphin.sql_mode to 'sql_mode_strict,sql_mode_full_group,pipes_as_concat,no_zero_date,pad_char_to_full_length';
SET
test_db=# select "a" from test;
 ?column? 
----------
 a
(1 row)

dolphin.b_db_timestamp

参数说明：参数值为浮点数，该参数影响dolphin中的curdate/current_time/curtime/current_timestamp/localtime/localtimestamp/now函数。当此参数值为0时，以上函数返回当前日期或时间；若参数值位于区间[1,2147483647]，则上述函数以该GUC参数的值作为秒数偏移，返回1970年01月01日 00:00:00 UTC + 秒数偏移 + 当前时区偏移的对应日期或时间。设置此参数时，若值不在上述合法区间内，会报错。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：0∪[1.0, 2147483647.0]

默认值：0

示例：

openGauss=# show dolphin.b_db_timestamp;
 b_db_timestamp
----------------
 0
(1 row)
openGauss=# select now();
        now()
---------------------
 2022-09-18 19:52:23
(1 row)
openGauss=# set dolphin.b_db_timestamp = 1.0;
SET
openGauss=# select now();
        now()
---------------------
 1970-01-01 08:00:01
(1 row)

dolphin.default_week_format

参数说明：参数值为整数，该参数影响dolphin插件中的week函数，该参数的取值范围为[0,7]，分别对应8种不同的计算策略，这些策略的详细内容参见时间/日期函数中的week函数说明。当此GUC参数设置的值超过对应边界值时，会报warning，并且将此GUC参数的值设置为对应边界值。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：[0, 7]

默认值：0

示例：

openGauss=# show dolphin.default_week_format;
dolphin.default_week_format
---------------------
0
(1 row)
openGauss=# select week('2000-1-1');
week
------
    0
(1 row)
openGauss=# alter system set dolphin.default_week_format = 2;
ALTER SYSTEM SET
openGauss=# select week('2000-1-1');
week
------
52
(1 row)

dolphin.lc_time_names

参数说明：参数值为字符串，该参数控制dolphin插件中dayname/monthname函数以何种语言输出结果。该参数的取值有111种。设置参数时，若值不在合法取值范围内，则会报错。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围： lc_time_names语言集有如下可供选择的值：

参数值	语言集
ar_AE	Arabic - United Arab Emirates
ar_BH	Arabic - Bahrain
ar_DZ	Arabic - Algeria
ar_EG	Arabic - Egypt
ar_IN	Arabic - India
ar_IQ	Arabic - Iraq
ar_JO	Arabic - Jordan
ar_KW	Arabic - Kuwait
ar_LB	Arabic - Lebanon
ar_LY	Arabic - Libya
ar_MA	Arabic - Morocco
ar_OM	Arabic - Oman
ar_QA	Arabic - Qatar
ar_SA	Arabic - Saudi Arabia
ar_SD	Arabic - Sudan
ar_SY	Arabic - Syria
ar_TN	Arabic - Tunisia
ar_YE	Arabic - Yemen
be_BY	Belarusian - Belarus
bg_BG	Bulgarian - Bulgaria
ca_ES	Catalan - Spain
cs_CZ	Czech - Czech Republic
da_DK	Danish - Denmark
de_AT	German - Austria
de_BE	German - Belgium
de_CH	German - Switzerland
de_DE	German - Germany
de_LU	German - Luxembourg
el_GR	Greek - Greece
en_AU	English - Australia
en_CA	English - Canada
en_GB	English - United Kingdom
en_IN	English - India
en_NZ	English - New Zealand
en_PH	English - Philippines
en_US	English - United States
en_ZA	English - South Africa
en_ZW	English - Zimbabwe
es_AR	Spanish - Argentina
es_BO	Spanish - Bolivia
es_CL	Spanish - Chile
es_CO	Spanish - Colombia
es_CR	Spanish - Costa Rica
es_DO	Spanish - Dominican Republic
es_EC	Spanish - Ecuador
es_ES	Spanish - Spain
es_GT	Spanish - Guatemala
es_HN	Spanish - Honduras
es_MX	Spanish - Mexico
es_NI	Spanish - Nicaragua
es_PA	Spanish - Panama
es_PE	Spanish - Peru
es_PR	Spanish - Puerto Rico
es_PY	Spanish - Paraguay
es_SV	Spanish - El Salvador
es_US	Spanish - United States
es_UY	Spanish - Uruguay
es_VE	Spanish - Venezuela
et_EE	Estonian - Estonia
eu_ES	Basque - Spain
fi_FI	Finnish - Finland
fo_FO	Faroese - Faroe Islands
fr_BE	French - Belgium
fr_CA	French - Canada
fr_CH	French - Switzerland
fr_FR	French - France
fr_LU	French - Luxembourg
gl_ES	Galician - Spain
gu_IN	Gujarati - India
he_IL	Hebrew - Israel
hi_IN	Hindi - India
hr_HR	Croatian - Croatia
hu_HU	Hungarian - Hungary
id_ID	Indonesian - Indonesia
is_IS	Icelandic - Iceland
it_CH	Italian - Switzerland
it_IT	Italian - Italy
ja_JP	Japanese - Japan
ko_KR	Korean - Republic of Korea
lt_LT	Lithuanian - Lithuania
lv_LV	Latvian - Latvia
mk_MK	Macedonian - North Macedonia
mn_MN	Mongolia - Mongolian
ms_MY	Malay - Malaysia
nb_NO	Norwegian(Bokmål) - Norway
nl_BE	Dutch - Belgium
nl_NL	Dutch - The Netherlands
no_NO	Norwegian - Norway
pl_PL	Polish - Poland
pt_BR	Portugese - Brazil
pt_PT	Portugese - Portugal
rm_CH	Romansh - Switzerland
ro_RO	Romanian - Romania
ru_RU	Russian - Russia
ru_UA	Russian - Ukraine
sk_SK	Slovak - Slovakia
sl_SI	Slovenian - Slovenia
sq_AL	Albanian - Albania
sr_RS	Serbian - Serbia
sv_FI	Swedish - Finland
sv_SE	Swedish - Sweden
ta_IN	Tamil - India
te_IN	Telugu - India
th_TH	Thai - Thailand
tr_TR	Turkish - Turkey
uk_UA	Ukrainian - Ukraine
ur_PK	Urdu - Pakistan
vi_VN	Vietnamese - Vietnam
zh_CN	Chinese - China
zh_HK	Chinese - Hong Kong
zh_TW	Chinese - Taiwan

默认值：’en_US’

示例：

openGauss=# select dayname('2000-1-1');
dayname
----------
Saturday
(1 row)
openGauss=# alter system set dolphin.lc_time_names = 'zh_CN';
ALTER SYSTEM SET
openGauss=# select dayname('2000-1-1');
dayname
---------
星期六
(1 row)

dolphin.b_compatibility_mode

参数说明：参数值为布尔类型，该参数影响dolphin插件中的部分冲突的函数和操作符等，参数开启时这些函数和操作符会执行兼容性逻辑，关闭时则保持openGauss原有的逻辑。

当前影响的操作符有：

LIKE/NOT LIKE
(字符类型异或) ^
(数字类型异或) ^
&&
#

影响的函数有：

其他影响的参数：

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

on表示使用新增兼容性功能。
off表示关闭兼容性功能，使用内核原有功能。

默认值：off