Skip to content

Commit 8195764

Browse files
author
Zakirov Artur
committed
Fix README
1 parent 80101ab commit 8195764

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,14 @@ Typical installation procedure may look like this:
6161

6262
## Operator classes
6363

64-
**rum** provides next operator classes
64+
**rum** provides next operator classes.
6565

6666
### rum_tsvector_ops
6767

6868
For type: `tsvector`
6969

7070
This operator class stores `tsvector` lexemes with positional information. Supports
71-
ordering by `<=>` operator and prefix search. There is the example.
71+
ordering by `<=>` operator and prefix search. There is the example.
7272

7373
Let us assume we have the table:
7474

@@ -99,7 +99,7 @@ CREATE INDEX rumidx ON test_rum USING rum (a rum_tsvector_ops);
9999
And we can execute the following queries:
100100

101101
```sql
102-
=# SELECT t, a <=> to_tsquery('english', 'beautiful | place') AS rank
102+
SELECT t, a <=> to_tsquery('english', 'beautiful | place') AS rank
103103
FROM test_rum
104104
WHERE a @@ to_tsquery('english', 'beautiful | place')
105105
ORDER BY a <=> to_tsquery('english', 'beautiful | place');
@@ -110,7 +110,7 @@ And we can execute the following queries:
110110
It looks like a beautiful place | 0.0607927
111111
(3 rows)
112112

113-
=# SELECT t, a <=> to_tsquery('english', 'place | situation') AS rank
113+
SELECT t, a <=> to_tsquery('english', 'place | situation') AS rank
114114
FROM test_rum
115115
WHERE a @@ to_tsquery('english', 'place | situation')
116116
ORDER BY a <=> to_tsquery('english', 'place | situation');
@@ -126,29 +126,29 @@ And we can execute the following queries:
126126
For type: `tsvector`
127127

128128
This operator class stores hash of `tsvector` lexemes with positional information.
129-
Supports ordering by `&lt;=&gt;` operator. But **doesn't** support prefix search.
129+
Supports ordering by `<=>` operator. But **doesn't** support prefix search.
130130

131131
### rum_timestamp_ops
132132

133133
For type: `timestamp`
134134

135135
Operator class provides fast search and ordering by timestamp fields. Supports
136-
ordering by `&lt;=&gt;`, `&lt;=&#124;` and `&#124;=&gt;` operators. Can be used
137-
with `rum_tsvector_timestamp_ops` operator class.
136+
ordering by `<=>`, `<=|` and `|=>` operators. Can be used with
137+
`rum_tsvector_timestamp_ops` operator class.
138138

139139
### rum_timestamptz_ops
140140

141141
For type: `timestamptz`
142142

143143
Operator class provides fast search and ordering by timestamptz fields. Supports
144-
ordering by `&lt;=&gt;`, `&lt;=&#124;` and `&#124;=&gt;` operators. Can be used
145-
with `rum_tsvector_timestamptz_ops` operator class.
144+
ordering by `<=>`, `<=|` and `|=>` operators. Can be used with
145+
`rum_tsvector_timestamptz_ops` operator class.
146146

147147
### rum_tsvector_timestamp_ops
148148

149149
For type: `tsvector`
150150

151-
This operator class stores `tsvector` lexems with timestamp field. There is the example:
151+
This operator class stores `tsvector` lexems with timestamp field. There is the example.
152152

153153
Let us assume we have the table:
154154
```sql
@@ -163,7 +163,7 @@ CREATE INDEX tsts_idx ON tsts USING rum (t rum_tsvector_timestamp_ops, d)
163163
Now we can execute the following queries:
164164
```sql
165165
EXPLAIN (costs off)
166-
SELECT id, d, d <=> '2016-05-16 14:21:25' FROM tsts WHERE t @@ 'wr&qh' ORDER BY d <=> '2016-05-16 14:21:25' LIMIT 5;
166+
SELECT id, d, d <=> '2016-05-16 14:21:25' FROM tsts WHERE t @@ 'wr&qh' ORDER BY d <=> '2016-05-16 14:21:25' LIMIT 5;
167167
QUERY PLAN
168168
-----------------------------------------------------------------------------------
169169
Limit
@@ -223,7 +223,7 @@ CREATE INDEX query_idx ON query USING rum(q);
223223
Now we can execute the following fast query:
224224
```sql
225225
SELECT * FROM query
226-
WHERE to_tsvector('black holes never exists before we think about them') @@ q;
226+
WHERE to_tsvector('black holes never exists before we think about them') @@ q;
227227
q | tag
228228
------------------+-------
229229
'black' | color

0 commit comments

Comments
 (0)