F.17. hstore — hstore 键/值数据类型 #
此模块实现了 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 字面量,则不需要额外处理。但如果将其作为带引号的字面量常量传递,那么其中的单引号字符需要被正确转义。关于字符串常量的处理,见第 4.1.2.1 节。
在输出时,即使严格来说并非必需,键和值也总是带有双引号。
F.17.2. hstore 操作符和函数 #
hstore 模块提供的操作符见表 F.6,函数见表 F.7。
表 F.6. hstore 操作符
操作符 描述 示例 |
|---|
返回与给定键关联的值,如果该键不存在则返回
|
返回与给定各键关联的值;若某个键不存在,则对应位置返回
|
串接两个
|
|
|
|
左操作数是否包含右操作数?
|
左操作数是否被右操作数包含?
|
从左操作数中删除该键。
|
从左操作数中删除这些键。
|
从左操作数中删除与右操作数中的键/值对相匹配的键/值对。
|
用
|
将
|
将
|
表 F.7. hstore 函数
除了这些操作符和函数之外,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 hash。PL/Python 的扩展名为
hstore_plpython3u。如果使用它,hstore
值会映射为 Python 字典。
F.17.8. 作者 #
Oleg Bartunov <oleg@sai.msu.su>,俄罗斯莫斯科,莫斯科大学
Teodor Sigaev <teodor@sigaev.ru>,俄罗斯莫斯科,Delta-Soft Ltd.
Andrew Gierth <andrew@tao11.riddles.org.uk>,英国,对本模块作了额外增强