Skip to content

Commit cc67320

Browse files
author
Vitaly Davydov
committed
Fix found problems in the doc after review
1 parent a956a08 commit cc67320

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

Diff for: README.pg_sphere

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ It provides:
99
* Object rotation by Euler angles
1010
* Indexing of spherical data types
1111

12-
This is an R-Tree implementation using GiST for spherical objects like
12+
This is an R-tree implementation using GiST for spherical objects like
1313
spherical points and spherical circles with useful functions and operators.
14-
It also support the Block Range INdexing (BRIN) for large datasets.
14+
It also supports the Block Range INdexing (BRIN) for large datasets.
1515

1616
NOTICE:
1717
This version will work only with PostgreSQL version 10 and above.

Diff for: doc/indices.sgm

+14-13
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@
1010
<application>pgSphere</application> uses <literal>GiST</literal>
1111
and Block Range INdexing (<literal>BRIN</literal>) algorithms to create
1212
spherical indices.
13-
<literal>GiST</literal> index represents the R-Tree implementation for
14-
spherical objects, while <literal>BRINs</literal> are based on "summarization"
13+
<literal>GiST</literal> indexes utilize an R-tree implementation for
14+
spherical objects, while <literal>BRIN</literal> indexes are based on the "summarization"
1515
of data blocks (<literal>pages</literal>) on physical storage in order to
1616
organize data searches on ranges of summarized data that can be easily skipped
1717
on the base of search filters (see <ulink
18-
url="https://www.postgresql.org/docs/9.5/static/brin-intro.html"><citetitle>
19-
PostgreSQL documentation</citetitle></ulink> for further details on BRINs).
20-
As a consequence, BRINs result to be really small indexes (up to 1000 times
21-
than GiST ones), generally with lower a performance compared with a GiST one,
18+
url="https://www.postgresql.org/docs/current/brin-intro.html"><citetitle>
19+
PostgreSQL documentation</citetitle></ulink> for further details on BRIN indexes).
20+
As a consequence, BRIN indexes are small (up to 1000 times smaller
21+
than GiST ones), generally with lower performance compared with a GiST one,
2222
but up to 100 times faster than a full sequential scan of a table performed
23-
without any index. So BRINs are particularly suitable in a big data context.
23+
without any index. So BRIN indexes are particularly suitable in a big data context.
2424
An index speeds up the execution time of searches based on operators <link
2525
linkend="op.over"><literal>&lt;@</literal></link>, <link
2626
linkend="op.over"><literal>@</literal></link>, <link
@@ -84,17 +84,18 @@
8484
<![CDATA[VACUUM ANALYZE test;]]>
8585
</programlisting>
8686
<para>
87-
BRINs can be created through the following syntax:
87+
BRIN index can be created through the following syntax:
8888
</para>
8989
<programlisting>
9090
<![CDATA[CREATE INDEX test_pos_idx USING BRIN ON test (pos);]]>
9191
</programlisting>
9292
<para>
93-
By default, BRINs summarize block of 128 pages. The lower numbers
94-
of pages are specified, the higher granularity is reached during
95-
the searches, and performance's gap between GiST indexes and BRINs
96-
is lower (consider that BRINs size increases as well). Different
97-
summarizations can be used with the following command:
93+
By default, BRIN indexes summarize blocks of 128 pages. The smaller the
94+
number of pages specified, the higher the granularity in searches,
95+
and the gap in performance between GiST indexes and BRIN indexes will be
96+
decreased. Note that the size of the BRIN indexes increases as well.
97+
Different summarizations can be specified with the following
98+
command:
9899
</para>
99100
<programlisting>
100101
<![CDATA[CREATE INDEX test_pos_idx USING BRIN ON test (pos) WITH (pages_per_range = 16);]]>

0 commit comments

Comments
 (0)