Modified: tajo/site/docs/current/functions/json_func.html URL: http://svn.apache.org/viewvc/tajo/site/docs/current/functions/json_func.html?rev=1710762&r1=1710761&r2=1710762&view=diff ============================================================================== --- tajo/site/docs/current/functions/json_func.html (original) +++ tajo/site/docs/current/functions/json_func.html Tue Oct 27 10:40:08 2015 @@ -30,7 +30,7 @@ <link rel="top" title="Apache Tajo 0.11.0 documentation" href="../index.html"/> <link rel="up" title="Functions" href="../functions.html"/> - <link rel="next" title="Table Management" href="../table_management.html"/> + <link rel="next" title="Aggregation Functions" href="agg_func.html"/> <link rel="prev" title="Network Functions and Operators" href="network_func_and_operators.html"/> @@ -95,7 +95,9 @@ <li class="toctree-l2"><a class="reference internal" href="../sql_language/data_model.html">Data Model</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/ddl.html">Data Definition Language</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/insert.html">INSERT (OVERWRITE) INTO</a></li> +<li class="toctree-l2"><a class="reference internal" href="../sql_language/alter_table.html">ALTER TABLE</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/queries.html">Queries</a></li> +<li class="toctree-l2"><a class="reference internal" href="../sql_language/joins.html">Joins</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/sql_expression.html">SQL Expressions</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/predicates.html">Predicates</a></li> </ul> @@ -109,15 +111,15 @@ </ul> </li> <li class="toctree-l1 current"><a class="reference internal" href="../functions.html">Functions</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="math_func_and_operators.html">Math Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="string_func_and_operators.html">String Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="datetime_func_and_operators.html">DateTime Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="network_func_and_operators.html">Network Functions and Operators</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">JSON Functions</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../functions.html#built-in-scalar-functions">Built-in Scalar Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#built-in-aggregation-functions">Built-in Aggregation Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#built-in-window-functions">Built-in Window Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#user-defined-functions">User-defined Functions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../table_management.html">Table Management</a><ul> <li class="toctree-l2"><a class="reference internal" href="../table_management/table_overview.html">Overview of Tajo Tables</a></li> +<li class="toctree-l2"><a class="reference internal" href="../table_management/tablespaces.html">Tablespaces</a></li> <li class="toctree-l2"><a class="reference internal" href="../table_management/file_formats.html">File Formats</a></li> <li class="toctree-l2"><a class="reference internal" href="../table_management/compression.html">Compression</a></li> </ul> @@ -129,6 +131,11 @@ <li class="toctree-l2"><a class="reference internal" href="../partitioning/hash_partitioning.html">Hash Partitioning</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="../storage_plugins.html">Storage Plugin</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../storage_plugins/overview.html">Storage Plugin Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="../storage_plugins/postgresql.html">PostgreSQL Storage Handler</a></li> +</ul> +</li> <li class="toctree-l1"><a class="reference internal" href="../index_overview.html">Index (Experimental Feature)</a><ul> <li class="toctree-l2"><a class="reference internal" href="../index/types.html">Index Types</a></li> <li class="toctree-l2"><a class="reference internal" href="../index/how_to_use.html">How to use index?</a></li> @@ -139,7 +146,7 @@ <li class="toctree-l2"><a class="reference internal" href="../backup_and_restore/catalog.html">Backup and Restore Catalog</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../hcatalog_integration.html">HCatalog Integration</a></li> +<li class="toctree-l1"><a class="reference internal" href="../hive_integration.html">Hive Integration</a></li> <li class="toctree-l1"><a class="reference internal" href="../hbase_integration.html">HBase Integration</a><ul> <li class="toctree-l2"><a class="reference internal" href="../hbase_integration.html#create-table">CREATE TABLE</a></li> <li class="toctree-l2"><a class="reference internal" href="../hbase_integration.html#drop-table">DROP TABLE</a></li> @@ -157,6 +164,8 @@ <li class="toctree-l1"><a class="reference internal" href="../jdbc_driver.html">Tajo JDBC Driver</a><ul> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#how-to-get-jdbc-driver">How to get JDBC driver</a></li> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#setting-the-classpath">Setting the CLASSPATH</a></li> +<li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#connecting-to-the-tajo-cluster-instance">Connecting to the Tajo cluster instance</a></li> +<li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#connection-parameters">Connection Parameters</a></li> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#an-example-jdbc-client">An Example JDBC Client</a></li> </ul> </li> @@ -202,16 +211,16 @@ <h1>JSON Functions<a class="headerlink" href="#json-functions" title="Permalink to this headline">¶</a></h1> <dl class="function"> <dt id="json_extract_path_text"> -<code class="descname">json_extract_path_text</code><span class="sig-paren">(</span><em>string json</em>, <em>string xpath</em><span class="sig-paren">)</span><a class="headerlink" href="#json_extract_path_text" title="Permalink to this definition">¶</a></dt> -<dt> -<code class="descname">Extracts JSON string from a JSON string based on json path specified and returns JSON string pointed to by xPath</code></dt> -<dd><table class="docutils field-list" frame="void" rules="none"> +<code class="descname">json_extract_path_text</code><span class="sig-paren">(</span><em>json text</em>, <em>json_path text</em><span class="sig-paren">)</span><a class="headerlink" href="#json_extract_path_text" title="Permalink to this definition">¶</a></dt> +<dd><p>Extracts JSON string from a JSON string based on json path specified and returns JSON string pointed to by JSONPath. +Returns null if either argument is null.</p> +<table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>string</strong> – </li> -<li><strong>string</strong> – </li> +<li><strong>json</strong> – JSON string</li> +<li><strong>json_path</strong> – JSONpath</li> </ul> </td> </tr> @@ -222,12 +231,91 @@ </tr> </tbody> </table> -<div class="highlight-sql"><div class="highlight"><pre><span class="n">json_extract_path_text</span><span class="p">(</span><span class="s1">'{"test" : {"key" : "tajo"}}'</span><span class="p">,</span><span class="s1">'$.test.key'</span><span class="p">);</span> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">json_extract_path_text</span><span class="p">(</span><span class="s1">'{"test" : {"key" : "tajo"}}'</span><span class="p">,</span><span class="s1">'$.test.key'</span><span class="p">);</span> <span class="o">></span> <span class="n">tajo</span> </pre></div> </div> </dd></dl> +<dl class="function"> +<dt id="json_array_get"> +<code class="descname">json_array_get</code><span class="sig-paren">(</span><em>json_array text</em>, <em>index int4</em><span class="sig-paren">)</span><a class="headerlink" href="#json_array_get" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the element at the specified index into the JSON array. This function returns an element indexed from the end of an array with a negative index, and null if the element at the specified index doesnât exist.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>json_array</strong> – String of a JSON array</li> +<li><strong>index</strong> – index</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">json_array_get</span><span class="p">(</span><span class="s1">'[100, 200, 300]'</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span> +<span class="o">></span> <span class="mi">100</span> + +<span class="k">select</span> <span class="n">json_array_get</span><span class="p">(</span><span class="s1">'[100, 200, 300]'</span><span class="p">,</span> <span class="o">-</span><span class="mi">2</span><span class="p">);</span> +<span class="o">></span> <span class="mi">200</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="json_array_contains"> +<code class="descname">json_array_contains</code><span class="sig-paren">(</span><em>json_array text</em>, <em>value any</em><span class="sig-paren">)</span><a class="headerlink" href="#json_array_contains" title="Permalink to this definition">¶</a></dt> +<dd><p>Determine if the given value exists in the JSON array.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>json_array</strong> – String of a JSON array</li> +<li><strong>value</strong> – value of any type</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">json_array_contains</span><span class="p">(</span><span class="s1">'[100, 200, 300]'</span><span class="p">,</span> <span class="mi">100</span><span class="p">);</span> +<span class="o">></span> <span class="n">t</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="json_array_length"> +<code class="descname">json_array_length</code><span class="sig-paren">(</span><em>json_array text</em><span class="sig-paren">)</span><a class="headerlink" href="#json_array_length" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the length of json array.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>json_array</strong> – String of a JSON array</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int8</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">json_array_length</span><span class="p">(</span><span class="s1">'[100, 200, 300]'</span><span class="p">);</span> +<span class="o">></span> <span class="mi">3</span> +</pre></div> +</div> +</dd></dl> + </div> @@ -236,7 +324,7 @@ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="../table_management.html" class="btn btn-neutral float-right" title="Table Management"/>Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="agg_func.html" class="btn btn-neutral float-right" title="Aggregation Functions"/>Next <span class="fa fa-arrow-circle-right"></span></a> <a href="network_func_and_operators.html" class="btn btn-neutral" title="Network Functions and Operators"><span class="fa fa-arrow-circle-left"></span> Previous</a>
Modified: tajo/site/docs/current/functions/math_func_and_operators.html URL: http://svn.apache.org/viewvc/tajo/site/docs/current/functions/math_func_and_operators.html?rev=1710762&r1=1710761&r2=1710762&view=diff ============================================================================== --- tajo/site/docs/current/functions/math_func_and_operators.html (original) +++ tajo/site/docs/current/functions/math_func_and_operators.html Tue Oct 27 10:40:08 2015 @@ -31,7 +31,7 @@ <link rel="top" title="Apache Tajo 0.11.0 documentation" href="../index.html"/> <link rel="up" title="Functions" href="../functions.html"/> <link rel="next" title="String Functions and Operators" href="string_func_and_operators.html"/> - <link rel="prev" title="Functions" href="../functions.html"/> + <link rel="prev" title="Data Type Functions and Operators" href="data_type_func_and_operators.html"/> <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js";></script> @@ -95,7 +95,9 @@ <li class="toctree-l2"><a class="reference internal" href="../sql_language/data_model.html">Data Model</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/ddl.html">Data Definition Language</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/insert.html">INSERT (OVERWRITE) INTO</a></li> +<li class="toctree-l2"><a class="reference internal" href="../sql_language/alter_table.html">ALTER TABLE</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/queries.html">Queries</a></li> +<li class="toctree-l2"><a class="reference internal" href="../sql_language/joins.html">Joins</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/sql_expression.html">SQL Expressions</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/predicates.html">Predicates</a></li> </ul> @@ -109,15 +111,15 @@ </ul> </li> <li class="toctree-l1 current"><a class="reference internal" href="../functions.html">Functions</a><ul class="current"> -<li class="toctree-l2 current"><a class="current reference internal" href="">Math Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="string_func_and_operators.html">String Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="datetime_func_and_operators.html">DateTime Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="network_func_and_operators.html">Network Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="json_func.html">JSON Functions</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../functions.html#built-in-scalar-functions">Built-in Scalar Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#built-in-aggregation-functions">Built-in Aggregation Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#built-in-window-functions">Built-in Window Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#user-defined-functions">User-defined Functions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../table_management.html">Table Management</a><ul> <li class="toctree-l2"><a class="reference internal" href="../table_management/table_overview.html">Overview of Tajo Tables</a></li> +<li class="toctree-l2"><a class="reference internal" href="../table_management/tablespaces.html">Tablespaces</a></li> <li class="toctree-l2"><a class="reference internal" href="../table_management/file_formats.html">File Formats</a></li> <li class="toctree-l2"><a class="reference internal" href="../table_management/compression.html">Compression</a></li> </ul> @@ -129,6 +131,11 @@ <li class="toctree-l2"><a class="reference internal" href="../partitioning/hash_partitioning.html">Hash Partitioning</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="../storage_plugins.html">Storage Plugin</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../storage_plugins/overview.html">Storage Plugin Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="../storage_plugins/postgresql.html">PostgreSQL Storage Handler</a></li> +</ul> +</li> <li class="toctree-l1"><a class="reference internal" href="../index_overview.html">Index (Experimental Feature)</a><ul> <li class="toctree-l2"><a class="reference internal" href="../index/types.html">Index Types</a></li> <li class="toctree-l2"><a class="reference internal" href="../index/how_to_use.html">How to use index?</a></li> @@ -139,7 +146,7 @@ <li class="toctree-l2"><a class="reference internal" href="../backup_and_restore/catalog.html">Backup and Restore Catalog</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../hcatalog_integration.html">HCatalog Integration</a></li> +<li class="toctree-l1"><a class="reference internal" href="../hive_integration.html">Hive Integration</a></li> <li class="toctree-l1"><a class="reference internal" href="../hbase_integration.html">HBase Integration</a><ul> <li class="toctree-l2"><a class="reference internal" href="../hbase_integration.html#create-table">CREATE TABLE</a></li> <li class="toctree-l2"><a class="reference internal" href="../hbase_integration.html#drop-table">DROP TABLE</a></li> @@ -157,6 +164,8 @@ <li class="toctree-l1"><a class="reference internal" href="../jdbc_driver.html">Tajo JDBC Driver</a><ul> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#how-to-get-jdbc-driver">How to get JDBC driver</a></li> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#setting-the-classpath">Setting the CLASSPATH</a></li> +<li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#connecting-to-the-tajo-cluster-instance">Connecting to the Tajo cluster instance</a></li> +<li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#connection-parameters">Connection Parameters</a></li> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#an-example-jdbc-client">An Example JDBC Client</a></li> </ul> </li> @@ -349,7 +358,9 @@ </tr> <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int8</td> </tr> -<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +<tr class="field-odd field"><th class="field-name">Alias:</th><td class="field-body">ceiling</td> +</tr> +<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"></td> </tr> </tbody> </table> @@ -571,6 +582,28 @@ </dd></dl> <dl class="function"> +<dt id="random"> +<code class="descname">random</code><span class="sig-paren">(</span><em>number int4</em><span class="sig-paren">)</span><a class="headerlink" href="#random" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns a pseudorandom number.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>number</strong> – range restriction</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int4</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">random</span><span class="p">(</span><span class="mi">10</span><span class="p">);</span> +<span class="o">></span> <span class="mi">4</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> <dt id="round"> <code class="descname">round</code><span class="sig-paren">(</span><em>number int|float</em><span class="sig-paren">)</span><a class="headerlink" href="#round" title="Permalink to this definition">¶</a></dt> <dd><p>Rounds to nearest integer</p> @@ -691,7 +724,7 @@ <a href="string_func_and_operators.html" class="btn btn-neutral float-right" title="String Functions and Operators"/>Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="../functions.html" class="btn btn-neutral" title="Functions"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="data_type_func_and_operators.html" class="btn btn-neutral" title="Data Type Functions and Operators"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> Modified: tajo/site/docs/current/functions/network_func_and_operators.html URL: http://svn.apache.org/viewvc/tajo/site/docs/current/functions/network_func_and_operators.html?rev=1710762&r1=1710761&r2=1710762&view=diff ============================================================================== --- tajo/site/docs/current/functions/network_func_and_operators.html (original) +++ tajo/site/docs/current/functions/network_func_and_operators.html Tue Oct 27 10:40:08 2015 @@ -95,7 +95,9 @@ <li class="toctree-l2"><a class="reference internal" href="../sql_language/data_model.html">Data Model</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/ddl.html">Data Definition Language</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/insert.html">INSERT (OVERWRITE) INTO</a></li> +<li class="toctree-l2"><a class="reference internal" href="../sql_language/alter_table.html">ALTER TABLE</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/queries.html">Queries</a></li> +<li class="toctree-l2"><a class="reference internal" href="../sql_language/joins.html">Joins</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/sql_expression.html">SQL Expressions</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/predicates.html">Predicates</a></li> </ul> @@ -109,15 +111,15 @@ </ul> </li> <li class="toctree-l1 current"><a class="reference internal" href="../functions.html">Functions</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="math_func_and_operators.html">Math Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="string_func_and_operators.html">String Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="datetime_func_and_operators.html">DateTime Functions and Operators</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Network Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="json_func.html">JSON Functions</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../functions.html#built-in-scalar-functions">Built-in Scalar Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#built-in-aggregation-functions">Built-in Aggregation Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#built-in-window-functions">Built-in Window Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#user-defined-functions">User-defined Functions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../table_management.html">Table Management</a><ul> <li class="toctree-l2"><a class="reference internal" href="../table_management/table_overview.html">Overview of Tajo Tables</a></li> +<li class="toctree-l2"><a class="reference internal" href="../table_management/tablespaces.html">Tablespaces</a></li> <li class="toctree-l2"><a class="reference internal" href="../table_management/file_formats.html">File Formats</a></li> <li class="toctree-l2"><a class="reference internal" href="../table_management/compression.html">Compression</a></li> </ul> @@ -129,6 +131,11 @@ <li class="toctree-l2"><a class="reference internal" href="../partitioning/hash_partitioning.html">Hash Partitioning</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="../storage_plugins.html">Storage Plugin</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../storage_plugins/overview.html">Storage Plugin Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="../storage_plugins/postgresql.html">PostgreSQL Storage Handler</a></li> +</ul> +</li> <li class="toctree-l1"><a class="reference internal" href="../index_overview.html">Index (Experimental Feature)</a><ul> <li class="toctree-l2"><a class="reference internal" href="../index/types.html">Index Types</a></li> <li class="toctree-l2"><a class="reference internal" href="../index/how_to_use.html">How to use index?</a></li> @@ -139,7 +146,7 @@ <li class="toctree-l2"><a class="reference internal" href="../backup_and_restore/catalog.html">Backup and Restore Catalog</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../hcatalog_integration.html">HCatalog Integration</a></li> +<li class="toctree-l1"><a class="reference internal" href="../hive_integration.html">Hive Integration</a></li> <li class="toctree-l1"><a class="reference internal" href="../hbase_integration.html">HBase Integration</a><ul> <li class="toctree-l2"><a class="reference internal" href="../hbase_integration.html#create-table">CREATE TABLE</a></li> <li class="toctree-l2"><a class="reference internal" href="../hbase_integration.html#drop-table">DROP TABLE</a></li> @@ -157,6 +164,8 @@ <li class="toctree-l1"><a class="reference internal" href="../jdbc_driver.html">Tajo JDBC Driver</a><ul> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#how-to-get-jdbc-driver">How to get JDBC driver</a></li> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#setting-the-classpath">Setting the CLASSPATH</a></li> +<li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#connecting-to-the-tajo-cluster-instance">Connecting to the Tajo cluster instance</a></li> +<li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#connection-parameters">Connection Parameters</a></li> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#an-example-jdbc-client">An Example JDBC Client</a></li> </ul> </li> @@ -219,7 +228,7 @@ as follows.</p> <h2>Supported Functions<a class="headerlink" href="#supported-functions" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="geoip_country_code"> -<code class="descname">geoip_country_code</code><span class="sig-paren">(</span><em>string addr</em><span class="sig-paren">)</span><a class="headerlink" href="#geoip_country_code" title="Permalink to this definition">¶</a></dt> +<code class="descname">geoip_country_code</code><span class="sig-paren">(</span><em>addr text</em><span class="sig-paren">)</span><a class="headerlink" href="#geoip_country_code" title="Permalink to this definition">¶</a></dt> <dd><p>Convert an ipv4 address string to a geoip country code.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> @@ -241,7 +250,7 @@ as follows.</p> <dl class="function"> <dt> -<code class="descname">geoip_country_code</code><span class="sig-paren">(</span><em>inet4 addr</em><span class="sig-paren">)</span></dt> +<code class="descname">geoip_country_code</code><span class="sig-paren">(</span><em>addr inet4</em><span class="sig-paren">)</span></dt> <dd><p>Convert an ipv4 address to a geoip country code.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> @@ -263,7 +272,7 @@ as follows.</p> <dl class="function"> <dt id="geoip_in_country"> -<code class="descname">geoip_in_country</code><span class="sig-paren">(</span><em>string addr</em>, <em>string code</em><span class="sig-paren">)</span><a class="headerlink" href="#geoip_in_country" title="Permalink to this definition">¶</a></dt> +<code class="descname">geoip_in_country</code><span class="sig-paren">(</span><em>addr text</em>, <em>code text</em><span class="sig-paren">)</span><a class="headerlink" href="#geoip_in_country" title="Permalink to this definition">¶</a></dt> <dd><p>If the given country code is same with the country code of the given address, it returns true. Otherwise, returns false.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> @@ -290,7 +299,7 @@ as follows.</p> <dl class="function"> <dt> -<code class="descname">geoip_in_country</code><span class="sig-paren">(</span><em>inet4 addr</em>, <em>string code</em><span class="sig-paren">)</span></dt> +<code class="descname">geoip_in_country</code><span class="sig-paren">(</span><em>addr inet4</em>, <em>code text</em><span class="sig-paren">)</span></dt> <dd><p>If the given country code is same with the country code of the given address, it returns true. Otherwise, returns false.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> Modified: tajo/site/docs/current/functions/string_func_and_operators.html URL: http://svn.apache.org/viewvc/tajo/site/docs/current/functions/string_func_and_operators.html?rev=1710762&r1=1710761&r2=1710762&view=diff ============================================================================== --- tajo/site/docs/current/functions/string_func_and_operators.html (original) +++ tajo/site/docs/current/functions/string_func_and_operators.html Tue Oct 27 10:40:08 2015 @@ -95,7 +95,9 @@ <li class="toctree-l2"><a class="reference internal" href="../sql_language/data_model.html">Data Model</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/ddl.html">Data Definition Language</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/insert.html">INSERT (OVERWRITE) INTO</a></li> +<li class="toctree-l2"><a class="reference internal" href="../sql_language/alter_table.html">ALTER TABLE</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/queries.html">Queries</a></li> +<li class="toctree-l2"><a class="reference internal" href="../sql_language/joins.html">Joins</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/sql_expression.html">SQL Expressions</a></li> <li class="toctree-l2"><a class="reference internal" href="../sql_language/predicates.html">Predicates</a></li> </ul> @@ -109,15 +111,15 @@ </ul> </li> <li class="toctree-l1 current"><a class="reference internal" href="../functions.html">Functions</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="math_func_and_operators.html">Math Functions and Operators</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">String Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="datetime_func_and_operators.html">DateTime Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="network_func_and_operators.html">Network Functions and Operators</a></li> -<li class="toctree-l2"><a class="reference internal" href="json_func.html">JSON Functions</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../functions.html#built-in-scalar-functions">Built-in Scalar Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#built-in-aggregation-functions">Built-in Aggregation Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#built-in-window-functions">Built-in Window Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../functions.html#user-defined-functions">User-defined Functions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../table_management.html">Table Management</a><ul> <li class="toctree-l2"><a class="reference internal" href="../table_management/table_overview.html">Overview of Tajo Tables</a></li> +<li class="toctree-l2"><a class="reference internal" href="../table_management/tablespaces.html">Tablespaces</a></li> <li class="toctree-l2"><a class="reference internal" href="../table_management/file_formats.html">File Formats</a></li> <li class="toctree-l2"><a class="reference internal" href="../table_management/compression.html">Compression</a></li> </ul> @@ -129,6 +131,11 @@ <li class="toctree-l2"><a class="reference internal" href="../partitioning/hash_partitioning.html">Hash Partitioning</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="../storage_plugins.html">Storage Plugin</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../storage_plugins/overview.html">Storage Plugin Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="../storage_plugins/postgresql.html">PostgreSQL Storage Handler</a></li> +</ul> +</li> <li class="toctree-l1"><a class="reference internal" href="../index_overview.html">Index (Experimental Feature)</a><ul> <li class="toctree-l2"><a class="reference internal" href="../index/types.html">Index Types</a></li> <li class="toctree-l2"><a class="reference internal" href="../index/how_to_use.html">How to use index?</a></li> @@ -139,7 +146,7 @@ <li class="toctree-l2"><a class="reference internal" href="../backup_and_restore/catalog.html">Backup and Restore Catalog</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../hcatalog_integration.html">HCatalog Integration</a></li> +<li class="toctree-l1"><a class="reference internal" href="../hive_integration.html">Hive Integration</a></li> <li class="toctree-l1"><a class="reference internal" href="../hbase_integration.html">HBase Integration</a><ul> <li class="toctree-l2"><a class="reference internal" href="../hbase_integration.html#create-table">CREATE TABLE</a></li> <li class="toctree-l2"><a class="reference internal" href="../hbase_integration.html#drop-table">DROP TABLE</a></li> @@ -157,6 +164,8 @@ <li class="toctree-l1"><a class="reference internal" href="../jdbc_driver.html">Tajo JDBC Driver</a><ul> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#how-to-get-jdbc-driver">How to get JDBC driver</a></li> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#setting-the-classpath">Setting the CLASSPATH</a></li> +<li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#connecting-to-the-tajo-cluster-instance">Connecting to the Tajo cluster instance</a></li> +<li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#connection-parameters">Connection Parameters</a></li> <li class="toctree-l2"><a class="reference internal" href="../jdbc_driver.html#an-example-jdbc-client">An Example JDBC Client</a></li> </ul> </li> @@ -221,8 +230,54 @@ </tr> </tbody> </table> -<div class="highlight-sql"><div class="highlight"><pre>select âTaâ || âjoâ; -> 'Tajo' +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="s1">'Ta'</span> <span class="o">||</span> <span class="s1">'jo'</span><span class="p">;</span> +<span class="o">></span> <span class="s1">'Tajo'</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="ascii"> +<code class="descname">ascii</code><span class="sig-paren">(</span><em>string text</em><span class="sig-paren">)</span><a class="headerlink" href="#ascii" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the ASCII code of the first character of the text. +For UTF-8, this function returns the Unicode code point of the character. +For other multibyte encodings, the argument must be an ASCII character.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – input string</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int4</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">ascii</span><span class="p">(</span><span class="s1">'x'</span><span class="p">);</span> +<span class="o">></span> <span class="mi">120</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="bit_length"> +<code class="descname">bit_length</code><span class="sig-paren">(</span><em>string text</em><span class="sig-paren">)</span><a class="headerlink" href="#bit_length" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the number of bits in string.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – input string</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int4</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="k">bit_length</span><span class="p">(</span><span class="s1">'jose'</span><span class="p">);</span> +<span class="o">></span> <span class="mi">32</span> </pre></div> </div> </dd></dl> @@ -230,7 +285,7 @@ <dl class="function"> <dt id="char_length"> <code class="descname">char_length</code><span class="sig-paren">(</span><em>string text</em><span class="sig-paren">)</span><a class="headerlink" href="#char_length" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns Number of characters in string</p> +<dd><p>Returns the number of characters in string.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> @@ -239,29 +294,338 @@ </tr> <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int4</td> </tr> -<tr class="field-odd field"><th class="field-name">Alias:</th><td class="field-body">character_length</td> +<tr class="field-odd field"><th class="field-name">Alias:</th><td class="field-body">character_length, length</td> +</tr> +<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="k">char_length</span><span class="p">(</span><span class="s1">'Tajo'</span><span class="p">);</span> +<span class="o">></span> <span class="mi">4</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="octet_length"> +<code class="descname">octet_length</code><span class="sig-paren">(</span><em>string text</em><span class="sig-paren">)</span><a class="headerlink" href="#octet_length" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the number of bytes in string.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – input string</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int4</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="k">octet_length</span><span class="p">(</span><span class="s1">'jose'</span><span class="p">);</span> +<span class="o">></span> <span class="mi">4</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="chr"> +<code class="descname">chr</code><span class="sig-paren">(</span><em>code int4</em><span class="sig-paren">)</span><a class="headerlink" href="#chr" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns a character with the given code.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>code</strong> – input character code</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">char</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">chr</span><span class="p">(</span><span class="mi">65</span><span class="p">);</span> +<span class="o">></span> <span class="n">A</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="decode"> +<code class="descname">decode</code><span class="sig-paren">(</span><em>binary text</em>, <em>format text</em><span class="sig-paren">)</span><a class="headerlink" href="#decode" title="Permalink to this definition">¶</a></dt> +<dd><p>Decode binary data from textual representation in string.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>binary</strong> – encoded value</li> +<li><strong>format</strong> – decode format. base64, hex, escape. escape converts zero bytes and high-bit-set bytes to octal sequences (nnn) and doubles backslashes.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre>select decode('MTIzXDAwMFwwMDE=', 'base64'); +> 123\\000\\001 +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="digest"> +<code class="descname">digest</code><span class="sig-paren">(</span><em>input text</em>, <em>method text</em><span class="sig-paren">)</span><a class="headerlink" href="#digest" title="Permalink to this definition">¶</a></dt> +<dd><p>Calculates the Digest hash of string.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>input</strong> – input string</li> +<li><strong>method</strong> – hash method</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">digest</span><span class="p">(</span><span class="s1">'tajo'</span><span class="p">,</span> <span class="s1">'sha1'</span><span class="p">);</span> +<span class="o">></span> <span class="mi">02</span><span class="n">b0e20540b89f0b735092bbac8093eb2e3804cf</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="encode"> +<code class="descname">encode</code><span class="sig-paren">(</span><em>binary text</em>, <em>format text</em><span class="sig-paren">)</span><a class="headerlink" href="#encode" title="Permalink to this definition">¶</a></dt> +<dd><p>Encode binary data into a textual representation.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>binary</strong> – decoded value</li> +<li><strong>format</strong> – encode format. base64, hex, escape. escape converts zero bytes and high-bit-set bytes to octal sequences (nnn) and doubles backslashes.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">encode</span><span class="p">(</span><span class="s1">'123\\000\\001'</span><span class="p">,</span> <span class="s1">'base64'</span><span class="p">);</span> +<span class="o">></span> <span class="n">MTIzXDAwMFwwMDE</span><span class="o">=</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="initcap"> +<code class="descname">initcap</code><span class="sig-paren">(</span><em>string text</em><span class="sig-paren">)</span><a class="headerlink" href="#initcap" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert the first letter of each word to upper case and the rest to lower case.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – input string</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">text</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">initcap</span><span class="p">(</span><span class="s1">'hi THOMAS'</span><span class="p">);</span> +<span class="o">></span> <span class="n">Hi</span> <span class="n">Thomas</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="md5"> +<code class="descname">md5</code><span class="sig-paren">(</span><em>string text</em><span class="sig-paren">)</span><a class="headerlink" href="#md5" title="Permalink to this definition">¶</a></dt> +<dd><p>Calculates the MD5 hash of string.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – input string</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">text</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">md5</span><span class="p">(</span><span class="s1">'abc'</span><span class="p">);</span> +<span class="o">></span> <span class="mi">900150983</span><span class="n">cd24fb0d6963f7d28e17f72</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="left"> +<code class="descname">left</code><span class="sig-paren">(</span><em>string text</em>, <em>number int4</em><span class="sig-paren">)</span><a class="headerlink" href="#left" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the first n characters in the string.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>string</strong> – input string</li> +<li><strong>number</strong> – number of characters retrieved</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="k">left</span><span class="p">(</span><span class="s1">'ABC'</span><span class="p">,</span> <span class="mi">2</span><span class="p">);</span> +<span class="o">></span> <span class="n">AB</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="right"> +<code class="descname">right</code><span class="sig-paren">(</span><em>string text</em>, <em>number int4</em><span class="sig-paren">)</span><a class="headerlink" href="#right" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the last n characters in the string.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>string</strong> – input string</li> +<li><strong>number</strong> – number of characters retrieved</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="k">right</span><span class="p">(</span><span class="s1">'ABC'</span><span class="p">,</span> <span class="mi">2</span><span class="p">);</span> +<span class="o">></span> <span class="n">BC</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="locate"> +<code class="descname">locate</code><span class="sig-paren">(</span><em>source text</em>, <em>target text</em><span class="optional">[</span>, <em>start_index int4</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#locate" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the location of specified substring.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>source</strong> – source string</li> +<li><strong>target</strong> – target substring</li> +<li><strong>start_index</strong> – the index where the search is started</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">int4</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Alias:</th><td class="field-body"><p class="first">strpos</p> +</td> </tr> <tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"></td> </tr> </tbody> </table> -<div class="highlight-sql"><div class="highlight"><pre>select char_length(âTajoâ); -> 4 +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">locate</span><span class="p">(</span><span class="s1">'high'</span><span class="p">,</span> <span class="s1">'ig'</span><span class="p">,</span> <span class="mi">1</span><span class="p">);</span> +<span class="o">></span> <span class="mi">2</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="strposb"> +<code class="descname">strposb</code><span class="sig-paren">(</span><em>source text</em>, <em>target text</em><span class="sig-paren">)</span><a class="headerlink" href="#strposb" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the binary location of specified substring.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>source</strong> – source string</li> +<li><strong>target</strong> – target substring</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">int4</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">strpos</span><span class="p">(</span><span class="s1">'tajo'</span><span class="p">,</span> <span class="s1">'aj'</span><span class="p">);</span> +<span class="o">></span> <span class="mi">2</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="substr"> +<code class="descname">substr</code><span class="sig-paren">(</span><em>source text</em>, <em>start int4</em>, <em>length int4</em><span class="sig-paren">)</span><a class="headerlink" href="#substr" title="Permalink to this definition">¶</a></dt> +<dd><p>Extract substring.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>source</strong> – source string</li> +<li><strong>start</strong> – start index</li> +<li><strong>length</strong> – length of substring</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">substr</span><span class="p">(</span><span class="s1">'alphabet'</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">);</span> +<span class="o">></span> <span class="n">ph</span> </pre></div> </div> </dd></dl> <dl class="function"> <dt id="trim"> -<code class="descname">trim</code><span class="sig-paren">(</span><em>[leading | trailing | both] [characters] from string</em><span class="sig-paren">)</span><a class="headerlink" href="#trim" title="Permalink to this definition">¶</a></dt> -<dd><p>Removes the characters (a space by default) from the start/end/both ends of the string</p> +<code class="descname">trim</code><span class="sig-paren">(</span><em>string text</em><span class="optional">[</span>, <em>characters text</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#trim" title="Permalink to this definition">¶</a></dt> +<dd><p>Removes the characters (a space by default) from the start/end/both ends of the string.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>string</strong> – </li> -<li><strong>characters</strong> – </li> +<li><strong>string</strong> – input string</li> +<li><strong>characters</strong> – characters which will be removed</li> </ul> </td> </tr> @@ -272,8 +636,35 @@ </tr> </tbody> </table> -<div class="highlight-sql"><div class="highlight"><pre>select trim(both âxâ from âxTajoxxâ); -> Tajo +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="k">trim</span><span class="p">(</span><span class="s1">'xTajoxx'</span><span class="p">,</span> <span class="s1">'x'</span><span class="p">);</span> +<span class="o">></span> <span class="n">Tajo</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt> +<code class="descname">trim</code><span class="sig-paren">(</span><em>[leading | trailing | both] [characters text] FROM string text</em><span class="sig-paren">)</span></dt> +<dd><p>Removes the characters (a space by default) from the start/end/both ends of the string.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>string</strong> – input string</li> +<li><strong>characters</strong> – characters which will be removed</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="k">trim</span><span class="p">(</span><span class="k">both</span> <span class="s1">'x'</span> <span class="k">from</span> <span class="s1">'xTajoxx'</span><span class="p">);</span> +<span class="o">></span> <span class="n">Tajo</span> </pre></div> </div> </dd></dl> @@ -281,14 +672,14 @@ <dl class="function"> <dt id="btrim"> <code class="descname">btrim</code><span class="sig-paren">(</span><em>string text</em><span class="optional">[</span>, <em>characters text</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#btrim" title="Permalink to this definition">¶</a></dt> -<dd><p>Removes the characters (a space by default) from the both ends of the string</p> +<dd><p>Removes the characters (a space by default) from the both ends of the string.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>string</strong> – </li> -<li><strong>characters</strong> – </li> +<li><strong>string</strong> – input string</li> +<li><strong>characters</strong> – characters which will be removed</li> </ul> </td> </tr> @@ -302,8 +693,8 @@ </tr> </tbody> </table> -<div class="highlight-sql"><div class="highlight"><pre>select btrim(âxTajoxxâ, âxâ); -> Tajo +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">btrim</span><span class="p">(</span><span class="s1">'xTajoxx'</span><span class="p">,</span> <span class="s1">'x'</span><span class="p">);</span> +<span class="o">></span> <span class="n">Tajo</span> </pre></div> </div> </dd></dl> @@ -311,14 +702,14 @@ <dl class="function"> <dt id="ltrim"> <code class="descname">ltrim</code><span class="sig-paren">(</span><em>string text</em><span class="optional">[</span>, <em>characters text</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#ltrim" title="Permalink to this definition">¶</a></dt> -<dd><p>Removes the characters (a space by default) from the start ends of the string</p> +<dd><p>Removes the characters (a space by default) from the start ends of the string.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>string</strong> – </li> -<li><strong>characters</strong> – </li> +<li><strong>string</strong> – input string</li> +<li><strong>characters</strong> – characters which will be removed</li> </ul> </td> </tr> @@ -329,8 +720,8 @@ </tr> </tbody> </table> -<div class="highlight-sql"><div class="highlight"><pre>select ltrim(âxxTajoâ, âxâ); -> Tajo +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">ltrim</span><span class="p">(</span><span class="s1">'xxTajo'</span><span class="p">,</span> <span class="s1">'x'</span><span class="p">);</span> +<span class="o">></span> <span class="n">Tajo</span> </pre></div> </div> </dd></dl> @@ -338,14 +729,14 @@ <dl class="function"> <dt id="rtrim"> <code class="descname">rtrim</code><span class="sig-paren">(</span><em>string text</em><span class="optional">[</span>, <em>characters text</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#rtrim" title="Permalink to this definition">¶</a></dt> -<dd><p>Removes the characters (a space by default) from the end ends of the string</p> +<dd><p>Removes the characters (a space by default) from the end ends of the string.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>string</strong> – </li> -<li><strong>characters</strong> – </li> +<li><strong>string</strong> – input string</li> +<li><strong>characters</strong> – characters which will be removed</li> </ul> </td> </tr> @@ -365,15 +756,15 @@ <dl class="function"> <dt id="split_part"> <code class="descname">split_part</code><span class="sig-paren">(</span><em>string text</em>, <em>delimiter text</em>, <em>field int</em><span class="sig-paren">)</span><a class="headerlink" href="#split_part" title="Permalink to this definition">¶</a></dt> -<dd><p>Splits a string on delimiter and return the given field (counting from one)</p> +<dd><p>Splits a string on delimiter and return the given field (counting from one).</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>string</strong> – </li> -<li><strong>delimiter</strong> – </li> -<li><strong>field</strong> – </li> +<li><strong>string</strong> – input string</li> +<li><strong>delimiter</strong> – delimiter</li> +<li><strong>field</strong> – index to field</li> </ul> </td> </tr> @@ -384,8 +775,8 @@ </tr> </tbody> </table> -<div class="highlight-sql"><div class="highlight"><pre>select split_part(âab_bc_cdâ,â_â,2); -> bc +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">split_part</span><span class="p">(</span><span class="s1">'ab_bc_cd'</span><span class="p">,</span><span class="s1">'_'</span><span class="p">,</span><span class="mi">2</span><span class="p">);</span> +<span class="o">></span> <span class="n">bc</span> </pre></div> </div> </dd></dl> @@ -393,15 +784,15 @@ <dl class="function"> <dt id="regexp_replace"> <code class="descname">regexp_replace</code><span class="sig-paren">(</span><em>string text</em>, <em>pattern text</em>, <em>replacement text</em><span class="sig-paren">)</span><a class="headerlink" href="#regexp_replace" title="Permalink to this definition">¶</a></dt> -<dd><p>Replaces substrings matched to a given regular expression pattern</p> +<dd><p>Replaces substrings matched to a given regular expression pattern.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>string</strong> – </li> -<li><strong>pattern</strong> – </li> -<li><strong>replacement</strong> – </li> +<li><strong>string</strong> – input string</li> +<li><strong>pattern</strong> – pattern</li> +<li><strong>replacement</strong> – string substituted for the matching substring</li> </ul> </td> </tr> @@ -412,7 +803,7 @@ </tr> </tbody> </table> -<div class="highlight-sql"><div class="highlight"><pre>select regexp_replace(âabcdefâ, â(Ëab|ef$)â, âââ); +<div class="highlight-sql"><div class="highlight"><pre>select regexp_replace('abcdef', '(Ëab|ef$)', 'â'); > âcdâ </pre></div> </div> @@ -421,12 +812,12 @@ <dl class="function"> <dt id="upper"> <code class="descname">upper</code><span class="sig-paren">(</span><em>string text</em><span class="sig-paren">)</span><a class="headerlink" href="#upper" title="Permalink to this definition">¶</a></dt> -<dd><p>makes an input text to be upper case</p> +<dd><p>Makes an input text to be upper case.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – </td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – input string</td> </tr> <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">text</td> </tr> @@ -443,12 +834,12 @@ <dl class="function"> <dt id="lower"> <code class="descname">lower</code><span class="sig-paren">(</span><em>string text</em><span class="sig-paren">)</span><a class="headerlink" href="#lower" title="Permalink to this definition">¶</a></dt> -<dd><p>makes an input text to be lower case</p> +<dd><p>Makes an input text to be lower case.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – </td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – input string</td> </tr> <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">text</td> </tr> @@ -461,6 +852,133 @@ </pre></div> </div> </dd></dl> + +<dl class="function"> +<dt id="lpad"> +<code class="descname">lpad</code><span class="sig-paren">(</span><em>source text</em>, <em>number int4</em>, <em>pad text</em><span class="sig-paren">)</span><a class="headerlink" href="#lpad" title="Permalink to this definition">¶</a></dt> +<dd><p>Fill up the string to length by prepending the characters fill (a space by default). If the string is already longer than length then it is truncated (on the right).</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>source</strong> – source string</li> +<li><strong>number</strong> – padding length</li> +<li><strong>pad</strong> – padding string</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">lpad</span><span class="p">(</span><span class="s1">'hi'</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="s1">'xy'</span><span class="p">);</span> +<span class="o">></span> <span class="n">xyxhi</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="rpad"> +<code class="descname">rpad</code><span class="sig-paren">(</span><em>source text</em>, <em>number int4</em>, <em>pad text</em><span class="sig-paren">)</span><a class="headerlink" href="#rpad" title="Permalink to this definition">¶</a></dt> +<dd><p>Fill up the string to length length by appending the characters fill (a space by default). If the string is already longer than length then it is truncated.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>source</strong> – source string</li> +<li><strong>number</strong> – padding length</li> +<li><strong>pad</strong> – padding string</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">rpad</span><span class="p">(</span><span class="s1">'hi'</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="s1">'xy'</span><span class="p">);</span> +<span class="o">></span> <span class="n">hixyx</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="quote_ident"> +<code class="descname">quote_ident</code><span class="sig-paren">(</span><em>string text</em><span class="sig-paren">)</span><a class="headerlink" href="#quote_ident" title="Permalink to this definition">¶</a></dt> +<dd><p>Return the given string suitably quoted to be used as an identifier in an SQL statement string. Quotes are added only if necessary (i.e., if the string contains non-identifier characters or would be case-folded). Embedded quotes are properly doubled.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – input string</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">text</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">quote_ident</span><span class="p">(</span><span class="s1">'Foo bar'</span><span class="p">);</span> +<span class="o">></span> <span class="ss">"Foo bar"</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="repeat"> +<code class="descname">repeat</code><span class="sig-paren">(</span><em>string text</em>, <em>number int4</em><span class="sig-paren">)</span><a class="headerlink" href="#repeat" title="Permalink to this definition">¶</a></dt> +<dd><p>Repeat string the specified number of times.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>string</strong> – input string</li> +<li><strong>number</strong> – repetition number</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">text</p> +</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">repeat</span><span class="p">(</span><span class="s1">'Pg'</span><span class="p">,</span> <span class="mi">4</span><span class="p">);</span> +<span class="o">></span> <span class="n">PgPgPgPg</span> +</pre></div> +</div> +</dd></dl> + +<dl class="function"> +<dt id="reverse"> +<code class="descname">reverse</code><span class="sig-paren">(</span><em>string text</em><span class="sig-paren">)</span><a class="headerlink" href="#reverse" title="Permalink to this definition">¶</a></dt> +<dd><p>Reverse string.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> – input string</td> +</tr> +<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">text</td> +</tr> +<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<div class="highlight-sql"><div class="highlight"><pre><span class="k">select</span> <span class="n">reverse</span><span class="p">(</span><span class="s1">'TAJO'</span><span class="p">);</span> +<span class="o">></span> <span class="n">OJAT</span> +</pre></div> +</div> +</dd></dl> </div>
