sharpetronics/PostgreSQL
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-05-28 00:03:23 -04:00
Code Issues Projects Releases Wiki Activity

Documentation improvement for pg_trgm

Browse Source 
Documentation of word_similarity() and strict_word_similarity() functions
contains some vague wordings which could confuse users.  This patch makes
those wordings more clear.  word_similarity() was introduced in PostgreSQL 9.6,
and corresponding part of documentation needs to be backpatched.

Author: Bruce Momjian, Alexander Korotkov
Discussion: https://postgr.es/m/20180526165648.GB12510%40momjian.us
Backpatch: 9.6, where word_similarity() was introduced
This commit is contained in:
Alexander Korotkov 2018-06-13 18:23:00 +03:00
parent e3eb8be77e
commit e146e4d02d
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/src/sgml/pgtrgm.sgml
View File

@ -113,7 +113,10 @@
<entry><type>real</type></entry>
<entry>
Same as <function>word_similarity(text, text)</function>, but forces
extent boundaries to match word boundaries.
extent boundaries to match word boundaries. Since we don't have
cross-word trigrams, this function actually returns greatest similarity
between first string and any continuous extent of words of the second
string.
</entry>
</row>
<row>
@ -164,16 +167,16 @@
This function returns a value that can be approximately understood as the
greatest similarity between the first string and any substring of the second
string. However, this function does not add padding to the boundaries of
the extent. Thus, a whole word match gets a higher score than a match with
a part of the word.
the extent. Thus, the number of additional characters present in the
second string is not considered, except for the mismatched word boundry.
</para>
<para>
At the same time, <function>strict_word_similarity(text, text)</function>
has to select an extent that matches word boundaries. In the example above,
selects extent of words in the second string. In the example above,
<function>strict_word_similarity(text, text)</function> would select the
extent <literal>{" w"," wo","wor","ord","rds","ds "}</literal>, which
corresponds to the whole word <literal>'words'</literal>.
extent of single word <literal>'words'</literal>, whose set of trigrams is
<literal>{" w"," wo","wor","ord","rds","ds "}</literal>
<programlisting>
# SELECT strict_word_similarity('word', 'two words'), similarity('word', 'words');
@ -186,9 +189,9 @@
<para>
Thus, the <function>strict_word_similarity(text, text)</function> function
is useful for finding similar subsets of whole words, while
is useful for finding the similarity to whole words, while
<function>word_similarity(text, text)</function> is more suitable for
searching similar parts of words.
finding the similarity for parts of words.
</para>
<table id="pgtrgm-op-table">