Skip to content

Commit d39afc3

Browse files
committed
Turn readme into markdown format.
1 parent 4079cc5 commit d39afc3

File tree

2 files changed

+63
-57
lines changed

2 files changed

+63
-57
lines changed

README.hstore_ops

Lines changed: 0 additions & 57 deletions
This file was deleted.

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
hstore_ops - better operator class for hstore
2+
=============================================
3+
4+
hstore_ops extension provides another implementation of GIN index (opclass)
5+
for hstore. It provides smaller index and faster @> operator queries than
6+
default GIN opclass. However, queries containing ?, ?|, ?& operators could
7+
become a little slower.
8+
9+
Idea of this opclass is to use composite GIN key which consists of hashes
10+
of hstore key and value. Thus, search for @> operator is possible as simple
11+
match for each queried key-value pair. Search for @>, ?, ?|, ?& is possible
12+
as partial match for each queried hstore key. Recheck is essential for
13+
every kind of search, because of possible hash collision. Hashing provides
14+
small size of index, mixing key and value into same GIN key provides high
15+
performance for @> search operator.
16+
17+
Authors
18+
-------
19+
20+
* Alexander Korotkov <aekorotkov@gmail.com>, Intaro Soft Ltd., Moscow, Russia
21+
* Oleg Bartunov <oleg@sai.msu.su>, Moscow University, Moscow, Russia
22+
23+
License
24+
-------
25+
26+
Development version, available on github, released under the
27+
GNU General Public License, version 2 (June 1991).
28+
29+
Downloads
30+
---------
31+
32+
Stable version of hstore_ops is available from
33+
https://github.com/akorotkov/hstore_ops
34+
35+
Installation
36+
------------
37+
38+
hstore_ops is regular PostgreSQL extension depending on hstore contrib.
39+
To build and install it you should ensure in following:
40+
41+
* You have development package of PostgreSQL installed or you built
42+
PostgreSQL from source.
43+
* Your PATH variable configured so that pg_config command available.
44+
* You did "CREATE EXTENSION hstore;" before "CREATE EXTENSION hstore_ops;".
45+
46+
Typical installation procedure may look like this:
47+
48+
$ git clone https://github.com/akorotkov/hstore_ops.git
49+
$ cd hstore_ops
50+
$ make USE_PGXS=1
51+
$ sudo make USE_PGXS=1 install
52+
$ make USE_PGXS=1 installcheck
53+
$ psql DB -c "CREATE EXTENSION hstore_ops;"
54+
55+
Usage
56+
-----
57+
58+
Just create index on hstore column using following command.
59+
60+
CREATE INDEX index_name ON table_name USING GIN (column_name gin_hstore_hash_ops);
61+
62+
Index will be automatically used for search on @>, ?, ?|, ?& operators on this
63+
column.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy