2024年11月21日: PostgreSQL 17.2, 16.6, 15.10, 14.15, 13.18 和 12.22 发布！
支持的版本: 当前 (17) / 16 / 15 / 14 / 13
开发版本: devel
不支持的版本: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3
F.17. hstore — hstore 键/值数据类型
上一个  上 附录 F. 附加提供的模块和扩展 首页  下一个

F.17. hstore — hstore 键/值数据类型 #

F.17.1. hstore 外部表示
F.17.2. hstore 操作符和函数
F.17.3. 索引
F.17.4. 示例
F.17.5. 统计信息
F.17.6. 兼容性
F.17.7. 转换
F.17.8. 作者

此模块实现 hstore 数据类型，用于在单个 PostgreSQL 值中存储键/值对的集合。这在各种场景中非常有用，例如具有很少检查的许多属性的行，或半结构化数据。键和值只是文本字符串。

此模块被认为是“受信任的”，也就是说，拥有当前数据库的 CREATE 权限的非超级用户可以安装它。

F.17.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.17.2. hstore 操作符和函数 #

hstore 模块提供的操作符显示在 表 F.6 中，函数显示在 表 F.7 中。

表 F.6. hstore 操作符

操作符

描述

示例

hstore -> text → text

返回与给定键关联的值，如果不存在则返回 NULL。

'a=>x, b=>y'::hstore -> 'a' → x

hstore -> text[] → text[]

返回与给定键关联的值，如果不存在则返回 NULL。

'a=>x, b=>y, c=>z'::hstore -> ARRAY['c','a'] → {"z","x"}

hstore || hstore → hstore

连接两个 hstore。

'a=>b, c=>d'::hstore || 'c=>x, d=>q'::hstore → "a"=>"b", "c"=>"x", "d"=>"q"

hstore ? text → boolean

hstore 是否包含键？

'a=>1'::hstore ? 'a' → t

hstore ?& text[] → boolean

hstore 是否包含所有指定的键？

'a=>1,b=>2'::hstore ?& ARRAY['a','b'] → t

hstore ?| text[] → boolean

hstore 是否包含任何指定的键？

'a=>1,b=>2'::hstore ?| ARRAY['b','c'] → t

hstore @> hstore → boolean

左操作数是否包含右操作数？

'a=>b, b=>1, c=>NULL'::hstore @> 'b=>1' → t

hstore <@ hstore → boolean

左操作数是否包含在右操作数中？

'a=>c'::hstore <@ 'a=>b, b=>1, c=>NULL' → f

hstore - text → hstore

从左操作数中删除键。

'a=>1, b=>2, c=>3'::hstore - 'b'::text → "a"=>"1", "c"=>"3"

hstore - text[] → hstore

从左操作数中删除键。

'a=>1, b=>2, c=>3'::hstore - ARRAY['a','b'] → "c"=>"3"

hstore - hstore → hstore

从左操作数中删除与右操作数中的对匹配的对。

'a=>1, b=>2, c=>3'::hstore - 'a=>4, b=>2'::hstore → "a"=>"1", "c"=>"3"

anyelement #= hstore → anyelement

使用 hstore 中的匹配值替换左操作数中的字段（必须是复合类型）。

ROW(1,3) #= 'f1=>11'::hstore → (11,3)

%% hstore → text[]

将 hstore 转换为交替键和值的数组。

%% 'a=>foo, b=>bar'::hstore → {a,foo,b,bar}

%# hstore → text[]

将 hstore 转换为二维键/值数组。

%# 'a=>foo, b=>bar'::hstore → {{a,foo},{b,bar}}

表 F.7. hstore 函数

函数

描述

示例

hstore ( record ) → hstore

从记录或行构造 hstore。

hstore(ROW(1,2)) → "f1"=>"1", "f2"=>"2"

hstore ( text[] ) → hstore

从数组构造 hstore，该数组可以是键/值数组，也可以是二维数组。

hstore(ARRAY['a','1','b','2']) → "a"=>"1", "b"=>"2"

hstore(ARRAY[['c','3'],['d','4']]) → "c"=>"3", "d"=>"4"

hstore ( text[], text[] ) → hstore

从单独的键和值数组构造 hstore。

hstore(ARRAY['a','b'], ARRAY['1','2']) → "a"=>"1", "b"=>"2"

hstore ( text, text ) → hstore

创建单项 hstore。

hstore('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 值被强制转换为 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 值被强制转换为 jsonb 时，会隐式使用此函数。

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 record ( key text, value text )

将 hstore 的键和值提取为一组记录。

select * from each('a=>1,b=>2') →

 key | value
-----+-------
 a   | 1
 b   | 2

exist ( hstore, text ) → boolean

hstore 是否包含键？

exist('a=>1', 'a') → t

defined ( hstore, text ) → boolean

hstore 是否包含键的非 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 ( anyelement, hstore ) → anyelement

使用 hstore 中的匹配值替换左操作数中的字段（必须是复合类型）。

populate_record(ROW(1,2), 'f1=>42'::hstore) → (42,2)

除了这些运算符和函数之外，hstore 类型的值还可以使用下标，使其像关联数组一样工作。只能指定一个 text 类型的下标；它被解释为一个键，并获取或存储相应的值。例如，

CREATE TABLE mytable (h hstore);
INSERT INTO mytable VALUES ('a=>b, c=>d');
SELECT h['a'] FROM mytable;
 h
---
 b
(1 row)

UPDATE mytable SET h['c'] = 'new';
SELECT h FROM mytable;
          h
----------------------
 "a"=>"b", "c"=>"new"
(1 row)

如果下标为 NULL 或该键不存在于 hstore 中，则下标提取返回 NULL。（因此，下标提取与 -> 运算符没有太大区别。）如果下标为 NULL，则下标更新会失败；否则，它将替换该键的值，如果该键尚不存在，则向 hstore 添加一个条目。

F.17.3. 索引 #

hstore 为 @>、?、?& 和 ?| 运算符提供了 GiST 和 GIN 索引支持。例如

CREATE INDEX hidx ON testhstore USING GIST (h);

CREATE INDEX hidx ON testhstore USING GIN (h);

gist_hstore_ops GiST 操作类将一组键/值对近似为位图签名。它的可选整数参数 siglen 确定签名的字节长度。默认长度为 16 字节。签名的有效长度值在 1 到 2024 字节之间。更长的签名会导致更精确的搜索（扫描索引的一小部分和更少的堆页面），但代价是索引更大。

以下是创建签名长度为 32 字节的此类索引的示例

CREATE INDEX hidx ON testhstore USING GIST (h gist_hstore_ops(siglen=32));

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.17.4. 示例 #

添加一个键，或使用新值更新现有键

UPDATE tab SET h['c'] = '3';

另一种执行相同操作的方法是

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

如果要在一次操作中添加或更改多个键，则连接方法比下标更有效

UPDATE tab SET h = h || hstore(array['q', 'w'], array['11', '12']);

删除键

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.17.5. 统计信息 #

由于其固有的自由性，hstore 类型可能包含许多不同的键。检查有效键是应用程序的任务。以下示例演示了几种用于检查键和获取统计信息的技术。

简单示例

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

使用表

CREATE TABLE stat AS SELECT (each(h)).key, (each(h)).value 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.17.6. 兼容性 #

从 PostgreSQL 9.0 开始，hstore 使用与以前版本不同的内部表示。由于文本表示（在转储中使用）未更改，因此这对转储/还原升级没有障碍。

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

UPDATE tablename SET hstorecol = hstorecol || '';

另一种方法是

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

ALTER TABLE 方法需要在表上获得 ACCESS EXCLUSIVE 锁，但不会导致旧行版本使表膨胀。

F.17.7. 转换 #

可以使用其他扩展来实现 PL/Perl 和 PL/Python 语言的 hstore 类型的转换。PL/Perl 的扩展名为 hstore_plperl 和 hstore_plperlu，分别用于受信任和不受信任的 PL/Perl。如果您安装这些转换并在创建函数时指定它们，则 hstore 值将映射到 Perl 哈希。PL/Python 的扩展名为 hstore_plpython3u。如果您使用它，则 hstore 值将映射到 Python 字典。

注意

强烈建议将转换扩展安装在与 hstore 相同的模式中。否则，如果转换扩展的模式包含由恶意用户定义的对象，则存在安装时的安全风险。

F.17.8. 作者 #

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

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

Andrew Gierth 的其他增强功能, 英国

上一个  上  下一个
F.16. fuzzystrmatch — 确定字符串相似度和距离  首页  F.18. intagg — 整数聚合器和枚举器

提交更正

如果您在文档中发现任何不正确、与特定功能的体验不符或需要进一步澄清的地方，请使用此表单报告文档问题。