vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/dev/dws_06_0320.html
Lu, Huayi e6fa411af0 DWS DEV 830.201 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2024-05-16 07:24:04 +00:00

235 lines
22 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001444168116"></a><a name="EN-US_TOPIC_0000001444168116"></a>
<h1 class="topictitle1">Text Search Functions</h1>
<div id="body0000001444168116"><div class="section" id="EN-US_TOPIC_0000001444168116__section15255191916227"><h4 class="sectiontitle">get_current_ts_config()</h4><p id="EN-US_TOPIC_0000001444168116__p124616193226">Description: Gets default text search configuration.</p>
<p id="EN-US_TOPIC_0000001444168116__p14246151912213">Return type: regconfig</p>
<p id="EN-US_TOPIC_0000001444168116__p20246171922211">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen7247131972217"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">get_current_ts_config</span><span class="p">();</span>
<span class="w"> </span><span class="n">get_current_ts_config</span><span class="w"> </span>
<span class="c1">-----------------------</span>
<span class="w"> </span><span class="n">english</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section132061225142216"><h4 class="sectiontitle">length(tsvector)</h4><p id="EN-US_TOPIC_0000001444168116__p1620022532212">Description: Number of lexemes in a <strong id="EN-US_TOPIC_0000001444168116__b73539904793543">tsvector</strong>-typed word.</p>
<p id="EN-US_TOPIC_0000001444168116__p7200102582217">Return type: integer</p>
<p id="EN-US_TOPIC_0000001444168116__p1820032510229">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen102007257221"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="k">length</span><span class="p">(</span><span class="s1">'fat:2,4 cat:3 rat:5A'</span><span class="p">::</span><span class="n">tsvector</span><span class="p">);</span>
<span class="w"> </span><span class="k">length</span><span class="w"> </span>
<span class="c1">--------</span>
<span class="w"> </span><span class="mi">3</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section1534818588222"><h4 class="sectiontitle">numnode(tsquery)</h4><p id="EN-US_TOPIC_0000001444168116__p133427584225">Description: Number of lexemes plus <strong id="EN-US_TOPIC_0000001444168116__b61971711593543">tsquery</strong> operators</p>
<p id="EN-US_TOPIC_0000001444168116__p183431158162218">Return type: integer</p>
<p id="EN-US_TOPIC_0000001444168116__p1134313582222">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen834335815222"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">numnode</span><span class="p">(</span><span class="s1">'(fat &amp; rat) | cat'</span><span class="p">::</span><span class="n">tsquery</span><span class="p">);</span>
<span class="w"> </span><span class="n">numnode</span><span class="w"> </span>
<span class="c1">---------</span>
<span class="w"> </span><span class="mi">5</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section171813154230"><h4 class="sectiontitle">plainto_tsquery([ config regconfig , ] query text)</h4><p id="EN-US_TOPIC_0000001444168116__p1918018152236">Description: Generates <strong id="EN-US_TOPIC_0000001444168116__b197799172393543">tsquery</strong> lexemes without punctuation.</p>
<p id="EN-US_TOPIC_0000001444168116__p16180121514237">Return type: tsquery</p>
<p id="EN-US_TOPIC_0000001444168116__p9181815132319">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen141811415102317"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">plainto_tsquery</span><span class="p">(</span><span class="s1">'english'</span><span class="p">,</span><span class="w"> </span><span class="s1">'The Fat Rats'</span><span class="p">);</span>
<span class="w"> </span><span class="n">plainto_tsquery</span><span class="w"> </span>
<span class="c1">-----------------</span>
<span class="w"> </span><span class="s1">'fat'</span><span class="w"> </span><span class="o">&amp;</span><span class="w"> </span><span class="s1">'rat'</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section1660721192314"><h4 class="sectiontitle">querytree(query tsquery)</h4><p id="EN-US_TOPIC_0000001444168116__p8598131113236">Description: Gets indexable part of a <strong id="EN-US_TOPIC_0000001444168116__b207222114893543">tsquery</strong>.</p>
<p id="EN-US_TOPIC_0000001444168116__p12598411152310">Return type: text</p>
<p id="EN-US_TOPIC_0000001444168116__p759811162317">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen959916119233"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">querytree</span><span class="p">(</span><span class="s1">'foo &amp; ! bar'</span><span class="p">::</span><span class="n">tsquery</span><span class="p">);</span>
<span class="w"> </span><span class="n">querytree</span><span class="w"> </span>
<span class="c1">-----------</span>
<span class="w"> </span><span class="s1">'foo'</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section163221921102319"><h4 class="sectiontitle">setweight(tsvector, "char")</h4><p id="EN-US_TOPIC_0000001444168116__p1317421152311">Description: Assigns weight to each element of <strong id="EN-US_TOPIC_0000001444168116__b96458671093543">tsvector</strong>.</p>
<p id="EN-US_TOPIC_0000001444168116__p1931732182319">Return type: tsvector</p>
<p id="EN-US_TOPIC_0000001444168116__p10317152114237">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen1031822117230"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">setweight</span><span class="p">(</span><span class="s1">'fat:2,4 cat:3 rat:5B'</span><span class="p">::</span><span class="n">tsvector</span><span class="p">,</span><span class="w"> </span><span class="s1">'A'</span><span class="p">);</span>
<span class="w"> </span><span class="n">setweight</span><span class="w"> </span>
<span class="c1">-------------------------------</span>
<span class="w"> </span><span class="s1">'cat'</span><span class="p">:</span><span class="mi">3</span><span class="n">A</span><span class="w"> </span><span class="s1">'fat'</span><span class="p">:</span><span class="mi">2</span><span class="n">A</span><span class="p">,</span><span class="mi">4</span><span class="n">A</span><span class="w"> </span><span class="s1">'rat'</span><span class="p">:</span><span class="mi">5</span><span class="n">A</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section46931024192319"><h4 class="sectiontitle">strip(tsvector)</h4><p id="EN-US_TOPIC_0000001444168116__p4690182482318">Description: Removes positions and weights from <strong id="EN-US_TOPIC_0000001444168116__b13584070593543">tsvector</strong>.</p>
<p id="EN-US_TOPIC_0000001444168116__p1669014245232">Return type: tsvector</p>
<p id="EN-US_TOPIC_0000001444168116__p17690724132314">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen1969122410234"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">strip</span><span class="p">(</span><span class="s1">'fat:2,4 cat:3 rat:5A'</span><span class="p">::</span><span class="n">tsvector</span><span class="p">);</span>
<span class="w"> </span><span class="n">strip</span><span class="w"> </span>
<span class="c1">-------------------</span>
<span class="w"> </span><span class="s1">'cat'</span><span class="w"> </span><span class="s1">'fat'</span><span class="w"> </span><span class="s1">'rat'</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section14892162772313"><h4 class="sectiontitle">to_tsquery([ config regconfig , ] query text)</h4><p id="EN-US_TOPIC_0000001444168116__p8889142782318">Description: Normalizes words and converts them to <strong id="EN-US_TOPIC_0000001444168116__b46117829393543">tsquery</strong>.</p>
<p id="EN-US_TOPIC_0000001444168116__p1388992732313">Return type: tsquery</p>
<p id="EN-US_TOPIC_0000001444168116__p158891527192315">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen6890327202318"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">to_tsquery</span><span class="p">(</span><span class="s1">'english'</span><span class="p">,</span><span class="w"> </span><span class="s1">'The &amp; Fat &amp; Rats'</span><span class="p">);</span>
<span class="w"> </span><span class="n">to_tsquery</span><span class="w"> </span>
<span class="c1">---------------</span>
<span class="w"> </span><span class="s1">'fat'</span><span class="w"> </span><span class="o">&amp;</span><span class="w"> </span><span class="s1">'rat'</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section1718873119238"><h4 class="sectiontitle">to_tsvector([ config regconfig , ] document text)</h4><p id="EN-US_TOPIC_0000001444168116__p918516318238">Description: Reduces document text to <strong id="EN-US_TOPIC_0000001444168116__b109442938593543">tsvector</strong>.</p>
<p id="EN-US_TOPIC_0000001444168116__p1318583112318">Return type: tsvector</p>
<p id="EN-US_TOPIC_0000001444168116__p1518553111237">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen12186183132316"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">to_tsvector</span><span class="p">(</span><span class="s1">'english'</span><span class="p">,</span><span class="w"> </span><span class="s1">'The Fat Rats'</span><span class="p">);</span>
<span class="w"> </span><span class="n">to_tsvector</span><span class="w"> </span>
<span class="c1">-----------------</span>
<span class="w"> </span><span class="s1">'fat'</span><span class="p">:</span><span class="mi">2</span><span class="w"> </span><span class="s1">'rat'</span><span class="p">:</span><span class="mi">3</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section460745202419"><h4 class="sectiontitle">ts_headline([ config regconfig, ] document text, query tsquery [, options text ])</h4><p id="EN-US_TOPIC_0000001444168116__p14604757249">Description: Highlights a query match.</p>
<p id="EN-US_TOPIC_0000001444168116__p1560414502415">Return type: text</p>
<p id="EN-US_TOPIC_0000001444168116__p1860518510245">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen176051053241"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">ts_headline</span><span class="p">(</span><span class="s1">'x y z'</span><span class="p">,</span><span class="w"> </span><span class="s1">'z'</span><span class="p">::</span><span class="n">tsquery</span><span class="p">);</span>
<span class="w"> </span><span class="n">ts_headline</span><span class="w"> </span>
<span class="c1">--------------</span>
<span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="o">&lt;</span><span class="n">b</span><span class="o">&gt;</span><span class="n">z</span><span class="o">&lt;/</span><span class="n">b</span><span class="o">&gt;</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section381613910247"><h4 class="sectiontitle">ts_rank([ weights float4[], ] vector tsvector, query tsquery [, normalization integer ])</h4><p id="EN-US_TOPIC_0000001444168116__p18148913247">Description: Ranks document for query.</p>
<p id="EN-US_TOPIC_0000001444168116__p2814139182415">Return type: float4</p>
<p id="EN-US_TOPIC_0000001444168116__p1881469112419">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen18145914245"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">ts_rank</span><span class="p">(</span><span class="s1">'hello world'</span><span class="p">::</span><span class="n">tsvector</span><span class="p">,</span><span class="w"> </span><span class="s1">'world'</span><span class="p">::</span><span class="n">tsquery</span><span class="p">);</span>
<span class="w"> </span><span class="n">ts_rank</span><span class="w"> </span>
<span class="c1">----------</span>
<span class="w"> </span><span class="p">.</span><span class="mi">0607927</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section1531391342413"><h4 class="sectiontitle">ts_rank_cd([ weights float4[], ] vector tsvector, query tsquery [, normalization integer ])</h4><p id="EN-US_TOPIC_0000001444168116__p2031271313240">Description: Ranks document for query using cover density.</p>
<p id="EN-US_TOPIC_0000001444168116__p9312191314244">Return type: float4</p>
<p id="EN-US_TOPIC_0000001444168116__p1031221302413">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen20312121362410"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">ts_rank_cd</span><span class="p">(</span><span class="s1">'hello world'</span><span class="p">::</span><span class="n">tsvector</span><span class="p">,</span><span class="w"> </span><span class="s1">'world'</span><span class="p">::</span><span class="n">tsquery</span><span class="p">);</span>
<span class="w"> </span><span class="n">ts_rank_cd</span><span class="w"> </span>
<span class="c1">------------</span>
<span class="w"> </span><span class="mi">0</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section1045371616243"><h4 class="sectiontitle">ts_rewrite(query tsquery, target tsquery, substitute tsquery)</h4><p id="EN-US_TOPIC_0000001444168116__p64522166248">Description: Replaces <strong id="EN-US_TOPIC_0000001444168116__b207316597693543">tsquery</strong>-typed word.</p>
<p id="EN-US_TOPIC_0000001444168116__p174521216152414">Return type: tsquery</p>
<p id="EN-US_TOPIC_0000001444168116__p174521416162414">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen154531165246"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">ts_rewrite</span><span class="p">(</span><span class="s1">'a &amp; b'</span><span class="p">::</span><span class="n">tsquery</span><span class="p">,</span><span class="w"> </span><span class="s1">'a'</span><span class="p">::</span><span class="n">tsquery</span><span class="p">,</span><span class="w"> </span><span class="s1">'foo|bar'</span><span class="p">::</span><span class="n">tsquery</span><span class="p">);</span>
<span class="w"> </span><span class="n">ts_rewrite</span><span class="w"> </span>
<span class="c1">-------------------------</span>
<span class="w"> </span><span class="s1">'b'</span><span class="w"> </span><span class="o">&amp;</span><span class="w"> </span><span class="p">(</span><span class="w"> </span><span class="s1">'foo'</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="s1">'bar'</span><span class="w"> </span><span class="p">)</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001444168116__section4527919172419"><h4 class="sectiontitle">ts_rewrite(query tsquery, select text)</h4><p id="EN-US_TOPIC_0000001444168116__p14526219182414">Description: Replaces <strong id="EN-US_TOPIC_0000001444168116__b76433986693543">tsquery</strong> data in the target with the result of a <strong id="EN-US_TOPIC_0000001444168116__b48198723493543">SELECT</strong> command.</p>
<p id="EN-US_TOPIC_0000001444168116__p65262198249">Return type: tsquery</p>
<p id="EN-US_TOPIC_0000001444168116__p35261619142418">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001444168116__screen11527121922417"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">ts_rewrite</span><span class="p">(</span><span class="s1">'world'</span><span class="p">::</span><span class="n">tsquery</span><span class="p">,</span><span class="w"> </span><span class="s1">'select ''world''::tsquery, ''hello''::tsquery'</span><span class="p">);</span>
<span class="w"> </span><span class="n">ts_rewrite</span><span class="w"> </span>
<span class="c1">------------</span>
<span class="w"> </span><span class="s1">'hello'</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_06_0039.html">Text Search Functions and Operators</a></div>
</div>
</div>
View Git Blame Copy Permalink