begriffs open source - ai-pg/blob - full-docs/html/dict-int.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>F.12. dict_int — example full-text search dictionary for integers</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="contrib-dblink-build-sql-update.html" title="dblink_build_sql_update" /><link rel="next" href="dict-xsyn.html" title="F.13. dict_xsyn — example synonym full-text search dictionary" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">F.12. dict_int —
   3    example full-text search dictionary for integers</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="contrib-dblink-build-sql-update.html" title="dblink_build_sql_update">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="contrib.html" title="Appendix F. Additional Supplied Modules and Extensions">Up</a></td><th width="60%" align="center">Appendix F. Additional Supplied Modules and Extensions</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="dict-xsyn.html" title="F.13. dict_xsyn — example synonym full-text search dictionary">Next</a></td></tr></table><hr /></div><div class="sect1" id="DICT-INT"><div class="titlepage"><div><div><h2 class="title" style="clear: both">F.12. dict_int —
   4    example full-text search dictionary for integers <a href="#DICT-INT" class="id_link">#</a></h2></div></div></div><div class="toc"><dl class="toc"><dt><span class="sect2"><a href="dict-int.html#DICT-INT-CONFIG">F.12.1. Configuration</a></span></dt><dt><span class="sect2"><a href="dict-int.html#DICT-INT-USAGE">F.12.2. Usage</a></span></dt></dl></div><a id="id-1.11.7.22.2" class="indexterm"></a><p>
   5   <code class="filename">dict_int</code> is an example of an add-on dictionary template
   6   for full-text search.  The motivation for this example dictionary is to
   7   control the indexing of integers (signed and unsigned), allowing such
   8   numbers to be indexed while preventing excessive growth in the number of
   9   unique words, which greatly affects the performance of searching.
  10  </p><p>
  11   This module is considered <span class="quote">“<span class="quote">trusted</span>”</span>, that is, it can be
  12   installed by non-superusers who have <code class="literal">CREATE</code> privilege
  13   on the current database.
  14  </p><div class="sect2" id="DICT-INT-CONFIG"><div class="titlepage"><div><div><h3 class="title">F.12.1. Configuration <a href="#DICT-INT-CONFIG" class="id_link">#</a></h3></div></div></div><p>
  15    The dictionary accepts three options:
  16   </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
  17      The <code class="literal">maxlen</code> parameter specifies the maximum number of
  18      digits allowed in an integer word.  The default value is 6.
  19     </p></li><li class="listitem"><p>
  20      The <code class="literal">rejectlong</code> parameter specifies whether an overlength
  21      integer should be truncated or ignored.  If <code class="literal">rejectlong</code> is
  22      <code class="literal">false</code> (the default), the dictionary returns the first
  23      <code class="literal">maxlen</code> digits of the integer. If <code class="literal">rejectlong</code> is
  24      <code class="literal">true</code>, the dictionary treats an overlength integer as a stop
  25      word, so that it will not be indexed.  Note that this also means that
  26      such an integer cannot be searched for.
  27     </p></li><li class="listitem"><p>
  28      The <code class="literal">absval</code> parameter specifies whether leading
  29      <span class="quote">“<span class="quote"><code class="literal">+</code></span>”</span> or <span class="quote">“<span class="quote"><code class="literal">-</code></span>”</span>
  30      signs should be removed from integer words.  The default
  31      is <code class="literal">false</code>.  When <code class="literal">true</code>, the sign is
  32      removed before <code class="literal">maxlen</code> is applied.
  33     </p></li></ul></div></div><div class="sect2" id="DICT-INT-USAGE"><div class="titlepage"><div><div><h3 class="title">F.12.2. Usage <a href="#DICT-INT-USAGE" class="id_link">#</a></h3></div></div></div><p>
  34    Installing the <code class="literal">dict_int</code> extension creates a text search
  35    template <code class="literal">intdict_template</code> and a dictionary <code class="literal">intdict</code>
  36    based on it, with the default parameters.  You can alter the
  37    parameters, for example
  38
  39 </p><pre class="programlisting">
  40 mydb# ALTER TEXT SEARCH DICTIONARY intdict (MAXLEN = 4, REJECTLONG = true);
  41 ALTER TEXT SEARCH DICTIONARY
  42 </pre><p>
  43
  44    or create new dictionaries based on the template.
  45   </p><p>
  46    To test the dictionary, you can try
  47
  48 </p><pre class="programlisting">
  49 mydb# select ts_lexize('intdict', '12345678');
  50  ts_lexize
  51 -----------
  52  {123456}
  53 </pre><p>
  54
  55    but real-world usage will involve including it in a text search
  56    configuration as described in <a class="xref" href="textsearch.html" title="Chapter 12. Full Text Search">Chapter 12</a>.
  57    That might look like this:
  58
  59 </p><pre class="programlisting">
  60 ALTER TEXT SEARCH CONFIGURATION english
  61     ALTER MAPPING FOR int, uint WITH intdict;
  62 </pre><p>
  63
  64   </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="contrib-dblink-build-sql-update.html" title="dblink_build_sql_update">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="contrib.html" title="Appendix F. Additional Supplied Modules and Extensions">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="dict-xsyn.html" title="F.13. dict_xsyn — example synonym full-text search dictionary">Next</a></td></tr><tr><td width="40%" align="left" valign="top">dblink_build_sql_update </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="40%" align="right" valign="top"> F.13. dict_xsyn — example synonym full-text search dictionary</td></tr></table></div></body></html>