↑↓ 选择↵ 打开⌫ 切换范围完整搜索

PG.CENTER 连接 PostgreSQL 文档、百科与生态知识。由 Pigsty 维护。

支持中的版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发中的版本: 19 / 20devel
已结束支持的版本: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3
历史版本。 PostgreSQL 9.5 已结束支持。 2021-02-11. 请参阅 当前版本手册.

F.15. hstore #

此模块实现了hstore数据类型,用于在单个 PostgreSQL值中存储一组键/值对。这在多种场景中都很有用,例如属性很多但很少查看的行,或者半结构化数据。键和值都只是文本字符串。

F.15.1. hstore 外部表示

用于输入和输出的hstore文本表示包含零个或多个以逗号分隔的 key => value 对。一些示例:

k => v
foo => bar, baz => whatever
"1-a" => "anything at all"

键/值对的顺序并不重要(而且在输出时可能不会按原样重现)。键/值对之间或 => 号周围的空白会被忽略。包含空白、逗号、= 或 > 的键和值必须用双引号括起来。要在键或值中包含双引号或反斜线,请用反斜线转义。

每个hstore中的键都是唯一的。如果声明的hstore 带有重复键,则在该hstore中只会存储其中一个,而且无法保证保留的是哪一个:

SELECT 'a=>1,a=>2'::hstore;
  hstore
----------
 "a"=>"1"

值(但键不能)可以是 SQL NULL。例如:

key => NULL

NULL关键字不区分大小写。若要将NULL 视为普通字符串“NULL”,请用双引号括起来。

注意

请注意,当hstore文本格式用于输入时,它会在任何必需的加引号或转义之前应用。如果通过参数传递一个 hstore字面量,则不需要额外处理。但如果将其作为带引号的字面量常量传递,那么其中的单引号字符以及(取决于 standard_conforming_strings配置参数的设置)反斜线字符都需要被正确转义。关于字符串常量的处理,见第 4.1.2.1 节。

在输出时,即使严格来说并非必需,键和值也总是带有双引号。

F.15.2. hstore 操作符和函数

hstore模块提供的操作符见表 F.8,函数见表 F.9。

表 F.8. hstore 操作符

操作符 描述 示例结果
hstore -> text获取键对应的值(如果不存在则为NULL)'a=>x, b=>y'::hstore -> 'a' x
hstore -> text[]获取各键对应的值(如果不存在则为NULL)'a=>x, b=>y, c=>z'::hstore -> ARRAY['c','a']{"z","x"}
hstore || hstore连接hstore值'a=>b, c=>d'::hstore || 'c=>x, d=>q'::hstore"a"=>"b", "c"=>"x", "d"=>"q"
hstore ? texthstore是否包含该键?'a=>1'::hstore ? 'a't
hstore ?& text[]hstore是否包含所有指定的键?'a=>1,b=>2'::hstore ?& ARRAY['a','b']t
hstore ?| text[]hstore是否包含指定键中的任意一个?'a=>1,b=>2'::hstore ?| ARRAY['b','c']t
hstore @> hstore左操作数是否包含右操作数?'a=>b, b=>1, c=>NULL'::hstore @> 'b=>1't
hstore <@ hstore左操作数是否被包含在右操作数中?'a=>c'::hstore <@ 'a=>b, b=>1, c=>NULL'f
hstore - text从左操作数中删除键'a=>1, b=>2, c=>3'::hstore - 'b'::text"a"=>"1", "c"=>"3"
hstore - text[]从左操作数中删除键'a=>1, b=>2, c=>3'::hstore - ARRAY['a','b']"c"=>"3"
hstore - hstore从左操作数中删除匹配的键值对'a=>1, b=>2, c=>3'::hstore - 'a=>4, b=>2'::hstore"a"=>"1", "c"=>"3"
record #= hstore用hstore中匹配的值替换record中的字段参见示例部分 
%% hstore将hstore转换为交替排列的键和值数组%% 'a=>foo, b=>bar'::hstore{a,foo,b,bar}
%# hstore将hstore转换为二维键/值数组%# 'a=>foo, b=>bar'::hstore{{a,foo},{b,bar}}

注意

在 PostgreSQL 8.2 之前,包含操作符 @> 和 <@ 分别称为 @ 和 ~。这些名称仍然可用,但已弃用,最终将被删除。请注意,旧名称与核心几何数据类型以前采用的约定正好相反!

表 F.9. hstore 函数

函数返回类型 描述 示例结果
hstore(record)hstore从记录或行构造hstorehstore(ROW(1,2))f1=>1,f2=>2
hstore(text[])hstore从数组构造hstore,数组可以是键/值数组,也可以是二维数组hstore(ARRAY['a','1','b','2']) || hstore(ARRAY[['c','3'],['d','4']])a=>1, b=>2, c=>3, d=>4
hstore(text[], text[])hstore从分开的键数组和值数组构造hstorehstore(ARRAY['a','b'], ARRAY['1','2'])"a"=>"1","b"=>"2"
hstore(text, text)hstore生成只含一个项的hstorehstore('a', 'b')"a"=>"b"
akeys(hstore)text[]将hstore的键作为数组获取akeys('a=>1,b=>2'){a,b}
skeys(hstore)setof text将hstore的键作为集合获取skeys('a=>1,b=>2')
a
b
avals(hstore)text[]将hstore的值作为数组获取avals('a=>1,b=>2'){1,2}
svals(hstore)setof text将hstore的值作为集合获取svals('a=>1,b=>2')
1
2
hstore_to_array(hstore)text[]将hstore的键和值作为交替排列的键和值数组获取hstore_to_array('a=>1,b=>2'){a,1,b,2}
hstore_to_matrix(hstore)text[]将hstore的键和值作为二维数组获取hstore_to_matrix('a=>1,b=>2'){{a,1},{b,2}}
hstore_to_json(hstore)json将hstore作为json值获取,把所有非空值转换为 JSON 字符串hstore_to_json('"a key"=>1, b=>t, c=>null, d=>12345, e=>012345, f=>1.234, g=>2.345e+4'){"a key": "1", "b": "t", "c": null, "d": "12345", "e": "012345", "f": "1.234", "g": "2.345e+4"}
hstore_to_jsonb(hstore)jsonb将hstore作为jsonb值获取,把所有非空值转换为 JSON 字符串hstore_to_jsonb('"a key"=>1, b=>t, c=>null, d=>12345, e=>012345, f=>1.234, g=>2.345e+4'){"a key": "1", "b": "t", "c": null, "d": "12345", "e": "012345", "f": "1.234", "g": "2.345e+4"}
hstore_to_json_loose(hstore)json将hstore作为json值获取,但尝试区分数值和布尔值,使它们在 JSON 中不带引号hstore_to_json_loose('"a key"=>1, b=>t, c=>null, d=>12345, e=>012345, f=>1.234, g=>2.345e+4'){"a key": 1, "b": true, "c": null, "d": 12345, "e": "012345", "f": 1.234, "g": 2.345e+4}
hstore_to_jsonb_loose(hstore)jsonb将hstore作为jsonb值获取,但尝试区分数值和布尔值,使它们在 JSON 中不带引号hstore_to_jsonb_loose('"a key"=>1, b=>t, c=>null, d=>12345, e=>012345, f=>1.234, g=>2.345e+4'){"a key": 1, "b": true, "c": null, "d": 12345, "e": "012345", "f": 1.234, "g": 2.345e+4}
slice(hstore, text[])hstore提取hstore的子集slice('a=>1,b=>2,c=>3'::hstore, ARRAY['b','c','x'])"b"=>"2", "c"=>"3"
each(hstore)setof(key text, value text)将hstore的键和值作为集合获取select * from each('a=>1,b=>2')
 key | value
-----+-------
 a   | 1
 b   | 2
exist(hstore,text)booleanhstore是否包含该键?exist('a=>1','a')t
defined(hstore,text)booleanhstore是否包含该键的非NULL值?defined('a=>NULL','a')f
delete(hstore,text)hstore删除键匹配的键值对delete('a=>1,b=>2','b')"a"=>"1"
delete(hstore,text[])hstore删除键匹配的键值对delete('a=>1,b=>2,c=>3',ARRAY['a','b'])"c"=>"3"
delete(hstore,hstore)hstore删除与第二个参数中的键值对匹配的键值对delete('a=>1,b=>2','a=>4,b=>2'::hstore)"a"=>"1"
populate_record(record,hstore)record用hstore中匹配的值替换record中的字段参见示例部分 

注意

将hstore值转换为json时使用函数hstore_to_json。同样,将hstore值转换为jsonb时使用hstore_to_jsonb。

注意

populate_record函数的第一个参数实际声明为anyelement,而不是record,但它会在运行时出错并拒绝非记录类型。

F.15.3. 索引

hstore支持针对@>、?、?&和?|操作符的 GiST 和 GIN 索引。例如:

CREATE INDEX hidx ON testhstore USING GIST (h);

CREATE INDEX hidx ON testhstore USING GIN (h);

hstore也支持用于=操作符的 btree或hash索引。这允许hstore列被声明为 UNIQUE,或者用于GROUP BY、ORDER BY或DISTINCT表达式。hstore值的排序顺序本身并没有特别实用的意义,但这些索引可能适合用于等值查找。可按如下方式为=比较创建索引:

CREATE INDEX hidx ON testhstore USING BTREE (h);

CREATE INDEX hidx ON testhstore USING HASH (h);

F.15.4. 示例

添加一个键,或用新值更新现有键:

UPDATE tab SET h = h || hstore('c', '3');

删除一个键:

UPDATE tab SET h = delete(h, 'k1');

将record转换为hstore:

CREATE TABLE test (col1 integer, col2 text, col3 text);
INSERT INTO test VALUES (123, 'foo', 'bar');

SELECT hstore(t) FROM test AS t;
                   hstore
---------------------------------------------
 "col1"=>"123", "col2"=>"foo", "col3"=>"bar"
(1 row)

将hstore转换为预定义的record类型:

CREATE TABLE test (col1 integer, col2 text, col3 text);

SELECT * FROM populate_record(null::test,
                              '"col1"=>"456", "col2"=>"zzz"');
 col1 | col2 | col3
------+------+------
  456 | zzz  |
(1 row)

使用hstore中的值修改现有记录:

CREATE TABLE test (col1 integer, col2 text, col3 text);
INSERT INTO test VALUES (123, 'foo', 'bar');

SELECT (r).* FROM (SELECT t #= '"col3"=>"baz"' AS r FROM test t) s;
 col1 | col2 | col3
------+------+------
  123 | foo  | baz
(1 row)

F.15.5. 统计信息

由于hstore类型本身比较宽松,它可能包含大量不同的键。检查键是否合法是应用程序的任务。下面的示例展示了检查键并获取统计信息的几种技术。

简单示例:

SELECT * FROM each('aaa=>bq, b=>NULL, ""=>1');

使用表:

SELECT (each(h)).key, (each(h)).value INTO stat FROM testhstore;

在线统计信息:

SELECT key, count(*) FROM
  (SELECT (each(h)).key FROM testhstore) AS stat
  GROUP BY key
  ORDER BY count DESC, key;
    key    | count
-----------+-------
 line      |   883
 query     |   207
 pos       |   203
 node      |   202
 space     |   197
 status    |   195
 public    |   194
 title     |   190
 org       |   189
...................

F.15.6. 兼容性

自 PostgreSQL 9.0 起,hstore使用了与更早版本不同的内部表示。这不会妨碍转储/恢复升级,因为文本表示(即转储中使用的表示)没有改变。

在进行二进制升级时,通过让新代码识别旧格式数据,维持了向上兼容性。这会在处理尚未被新代码修改过的数据时带来轻微的性能损失。可以通过执行如下 UPDATE语句,强制升级表列中的所有值:

UPDATE tablename SET hstorecol = hstorecol || '';

另一种方式是:

ALTER TABLE tablename ALTER hstorecol TYPE hstore USING hstorecol || '';

使用ALTER TABLE方法需要对表加独占锁,但不会因旧行版本而导致表膨胀。

F.15.7. 转换

另外还有一些扩展可用,它们为 PL/Perl 和 PL/Python 语言中的 hstore类型实现了转换。PL/Perl 的扩展分别名为 hstore_plperl和hstore_plperlu,对应受信任的和不受信任的 PL/Perl。如果安装这些转换并在创建函数时指定它们,则hstore值会映射为 Perl 哈希。PL/Python 的扩展分别名为hstore_plpythonu、hstore_plpython2u和hstore_plpython3u(关于 PL/Python 的命名约定请见第 43.1 节)。如果使用它们,hstore值会映射为 Python 字典。

小心

强烈建议将转换扩展安装在与 hstore 相同的模式中。否则,如果转换扩展所在的模式包含由恶意用户定义的对象,就会在安装时产生安全隐患。

F.15.8. 作者

Oleg Bartunov ,俄罗斯莫斯科,莫斯科大学

Teodor Sigaev ,俄罗斯莫斯科,Delta-Soft Ltd.

Andrew Gierth ,英国,对本模块作了额外增强

报告文档问题

阅读 上游文档. 反馈更正前请先核对 当前版本手册.