Google Git
Sign in
apache/age-website/refs/heads/asf-site/./age-manual/master/functions/string_functions.html
blob: 539aeb23960e937983d9a4d90e0ceca0fde200fd [file]
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>String Functions &mdash; Apache AGE master documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Aggregation Functions" href="aggregate_functions.html" />
<link rel="prev" title="Trigonometric Functions" href="trigonometric_functions.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home"> Apache AGE
<img src="../_static/logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../intro/overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intro/setup.html">Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intro/graphs.html">Graphs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intro/cypher.html">The AGE Cypher Query Format</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intro/types.html">Data Types - An Introduction to agtype</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intro/comparability.html">Comparability, Equality, Orderability and Equivalence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intro/operators.html">Operators</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intro/precedence.html">Operator Precedence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intro/aggregation.html">Aggregation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intro/agload.html">Importing Graph from Files</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Clauses</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../clauses/match.html">MATCH</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clauses/with.html">WITH</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clauses/return.html">RETURN</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clauses/order_by.html">ORDER BY</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clauses/skip.html">SKIP</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clauses/limit.html">LIMIT</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clauses/create.html">CREATE</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clauses/delete.html">DELETE</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clauses/set.html">SET</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clauses/remove.html">REMOVE</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clauses/merge.html">MERGE</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clauses/unwind.html">UNWIND</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Functions</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="predicate_functions.html">Predicate Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="scalar_functions.html">Scalar Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="list_functions.html">List Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="numeric_functions.html">Numeric Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="logarithmic_functions.html">Logarithmic Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="trigonometric_functions.html">Trigonometric Functions</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">String Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#replace">replace</a></li>
<li class="toctree-l2"><a class="reference internal" href="#split">split</a></li>
<li class="toctree-l2"><a class="reference internal" href="#left">left</a></li>
<li class="toctree-l2"><a class="reference internal" href="#right">right</a></li>
<li class="toctree-l2"><a class="reference internal" href="#substring">substring</a></li>
<li class="toctree-l2"><a class="reference internal" href="#rtrim">rTrim</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ltrim">lTrim</a></li>
<li class="toctree-l2"><a class="reference internal" href="#trim">trim</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tolower">toLower</a></li>
<li class="toctree-l2"><a class="reference internal" href="#toupper">toUpper</a></li>
<li class="toctree-l2"><a class="reference internal" href="#reverse">reverse</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tostring">toString</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="aggregate_functions.html">Aggregation Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="map_functions.html">Map Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_functions.html">User Defined Functions</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">AGE Beyond Cypher</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../advanced/advanced_overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/advanced.html">Using Cypher in a CTE Expression</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/advanced.html#using-cypher-in-a-join-expression">Using Cypher in a Join expression</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/advanced.html#cypher-in-sql-expressions">Cypher in SQL expressions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/prepared_statements.html">Prepared Statements</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/plpgsql.html">PL/pgSQL Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/sql_in_cypher.html">SQL In Cypher</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Contributing</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../contributing/run_tests.html">Run the test suite</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Apache AGE</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li>String Functions</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/apache/age-website/blob/master/docs/functions/string_functions.md" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="string-functions">
<h1>String Functions<a class="headerlink" href="#string-functions" title="Permalink to this heading"></a></h1>
<section id="replace">
<h2>replace<a class="headerlink" href="#replace" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">replace()</span></code> returns a string in which all occurrences of a specified string in the original string have been replaced by another (specified) string.</p>
<p>Syntax: <code>replace(original, search, replace)</code></strong></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">An</span> <span class="n">agtype</span> <span class="n">string</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>original
</td>
<td>An expression that returns a string.
</td>
</tr>
<tr>
<td>search
</td>
<td>An expression that specifies the string to be replaced in original.
</td>
</tr>
<tr>
<td>replace
</td>
<td>An expression that specifies the replacementstring.
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p>If any argument is <code class="docutils literal notranslate"><span class="pre">null</span></code>, <code class="docutils literal notranslate"><span class="pre">null</span></code> will be returned.</p></li>
<li><p>If search is not found in <code class="docutils literal notranslate"><span class="pre">original</span></code>, <code class="docutils literal notranslate"><span class="pre">original</span></code> will be returned.</p></li>
</ul>
<table>
<tr>
</tr>
</table>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN replace(&#39;hello&#39;, &#39;l&#39;, &#39;w&#39;)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">str_array</span><span class="w"> </span><span class="n">agtype</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td>new_str
</td>
</tr>
<tr>
<td>“Hewwo”
</td>
</tr>
<tr>
<td>1 row(s) returned
</td>
</tr>
</table>
</section>
<section id="split">
<h2>split<a class="headerlink" href="#split" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">split()</span></code> returns a list of strings resulting from the splitting of the original string around matches of the given delimiter.</p>
<p>Syntax: <code class="docutils literal notranslate"><span class="pre">split(original,</span> <span class="pre">split_delimiter)</span></code></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">An</span> <span class="n">agtype</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">agtype</span> <span class="n">strings</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>original
</td>
<td>An expression that returns a string.
</td>
</tr>
<tr>
<td>split_delimiter
</td>
<td>The string with which to split original.
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">split(null,</span> <span class="pre">splitDelimiter)</span></code> and <code class="docutils literal notranslate"><span class="pre">split(original,</span> <span class="pre">null)</span></code> both return <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
</ul>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN split(&#39;one,two&#39;, &#39;,&#39;)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">split_list</span><span class="w"> </span><span class="n">agtype</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td><strong>split_list</strong>
</td>
</tr>
<tr>
<td>[“one”,”two”]
</td>
</tr>
<tr>
<td>1 row(s) returned
</td>
</tr>
</table>
</section>
<section id="left">
<h2>left<a class="headerlink" href="#left" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">left()</span></code> returns a string containing the specified number of leftmost characters of the original string.</p>
<p>Syntax: <code class="docutils literal notranslate"><span class="pre">left(original,</span> <span class="pre">length)</span></code></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">An</span> <span class="n">agtype</span> <span class="n">string</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>original
</td>
<td>An expression that returns a string.
</td>
</tr>
<tr>
<td>n
</td>
<td>An expression that returns a positive integer.
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">left(null,</span> <span class="pre">length)</span></code> and <code class="docutils literal notranslate"><span class="pre">left(null,</span> <span class="pre">null)</span></code> both return <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">left(original,</span> <span class="pre">null)</span></code> will raise an error.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">length</span></code> is not a positive integer, an error is raised.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">length</span></code> exceeds the size of <code class="docutils literal notranslate"><span class="pre">original</span></code>, <code class="docutils literal notranslate"><span class="pre">original</span></code> is returned.</p></li>
</ul>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN left(&#39;Hello&#39;, 3)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">new_str</span><span class="w"> </span><span class="n">agtype</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td>new_str
</td>
</tr>
<tr>
<td>“Hel”
</td>
</tr>
<tr>
<td>1 row(s) returned
</td>
</tr>
</table>
</section>
<section id="right">
<h2>right<a class="headerlink" href="#right" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">right()</span></code> returns a string containing the specified number of rightmost characters of the original string.</p>
<p>Syntax: <code class="docutils literal notranslate"><span class="pre">right(original,</span> <span class="pre">length)</span></code></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">An</span> <span class="n">agtype</span> <span class="n">string</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>original
</td>
<td>An expression that returns a string.
</td>
</tr>
<tr>
<td>n
</td>
<td>An expression that returns a positive integer.
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">right(null,</span> <span class="pre">length)</span></code> and <code class="docutils literal notranslate"><span class="pre">right(null,</span> <span class="pre">null)</span></code> both return <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">right(original,</span> <span class="pre">null)</span></code> will raise an error.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">length</span></code> is not a positive integer, an error is raised.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">length</span></code> exceeds the size of <code class="docutils literal notranslate"><span class="pre">original</span></code>, <code class="docutils literal notranslate"><span class="pre">original</span></code> is returned.</p></li>
</ul>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN right(&#39;hello&#39;, 3)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">new_str</span><span class="w"> </span><span class="n">agtype</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td>new_str
</td>
</tr>
<tr>
<td>“llo”
</td>
</tr>
<tr>
<td>1 row(s) returned
</td>
</tr>
</table>
</section>
<section id="substring">
<h2>substring<a class="headerlink" href="#substring" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">substring()</span></code> returns a substring of the original string, beginning with a 0-based index start and length.</p>
<p>Syntax: <code>substring(original, <strong>start</strong> [, <strong>length</strong>])</code></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">An</span> <span class="n">agtype</span> <span class="n">string</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>original
</td>
<td>An expression that returns a string.
</td>
</tr>
<tr>
<td>start
</td>
<td>An expression denoting the position at which the substring will begin.
</td>
</tr>
<tr>
<td>length
</td>
<td>An optional expression that returns a positive integer, denoting how many characters of the original expression will be returned.
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> uses a zero-based index.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">length</span></code> is omitted, the function returns the substring starting at the position given by <code class="docutils literal notranslate"><span class="pre">start</span></code> and extending to the end of <code class="docutils literal notranslate"><span class="pre">original</span></code>.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">original</span></code> is <code class="docutils literal notranslate"><span class="pre">null</span></code>, <code class="docutils literal notranslate"><span class="pre">null</span></code> is returned.</p></li>
<li><p>If either <code class="docutils literal notranslate"><span class="pre">start</span></code> or <code class="docutils literal notranslate"><span class="pre">length</span></code> is <code class="docutils literal notranslate"><span class="pre">null</span></code> or a negative integer, an error is raised.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">start</span></code> is 0, the substring will start at the beginning of <code class="docutils literal notranslate"><span class="pre">original</span></code>.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">length</span></code> is 0, the empty string will be returned.</p></li>
</ul>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN substring(&#39;hello&#39;, 1, 3), substring(&#39;hello&#39;, 2)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">sub_str1</span><span class="w"> </span><span class="n">agtype</span><span class="p">,</span><span class="w"> </span><span class="n">sub_str2</span><span class="w"> </span><span class="n">agtype</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td>sub_str1
</td>
<td>sub_str2
</td>
</tr>
<tr>
<td>‘ell’
</td>
<td>‘llo’
</td>
</tr>
<tr>
<td colspan="2" >1 row(s) returned
</td>
</tr>
</table>
</section>
<section id="rtrim">
<h2>rTrim<a class="headerlink" href="#rtrim" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">rTrim()</span></code> returns the original string with trailing whitespace removed.</p>
<p>Syntax: <code class="docutils literal notranslate"><span class="pre">rTrim(original)</span></code></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">An</span> <span class="n">agtype</span> <span class="n">string</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>original
</td>
<td>An expression that returns a string
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">rTrim(null)</span></code> returns <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
</ul>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN rTrim(&#39; hello &#39;)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">right_trimmed_str</span><span class="w"> </span><span class="n">agtype</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td>right_trimmed_str
</td>
</tr>
<tr>
<td>" hello"
</td>
</tr>
<tr>
<td>1 row(s) returned
</td>
</tr>
</table>
</section>
<section id="ltrim">
<h2>lTrim<a class="headerlink" href="#ltrim" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">lTrim()</span></code> returns the original string with leading whitespace removed.</p>
<p>Syntax: <code class="docutils literal notranslate"><span class="pre">lTrim(original)</span></code></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">An</span> <span class="n">agtype</span> <span class="n">string</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>original
</td>
<td>An expression that returns a string
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">lTrim(null)</span></code> returns <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
</ul>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN lTrim(&#39; hello &#39;)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">left_trimmed_str</span><span class="w"> </span><span class="n">agtype</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td>left_trimmed_str
</td>
</tr>
<tr>
<td>“hello ”
</td>
</tr>
<tr>
<td>1 row(s) returned
</td>
</tr>
</table>
</section>
<section id="trim">
<h2>trim<a class="headerlink" href="#trim" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">trim()</span></code> returns the original string with leading and trailing whitespace removed.</p>
<p>Syntax: <code class="docutils literal notranslate"><span class="pre">trim(original)</span></code></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">An</span> <span class="n">agtype</span> <span class="n">string</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>original
</td>
<td>An expression that returns a string
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">trim(null)</span></code> returns <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
</ul>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN trim(&#39; hello &#39;)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">trimmed_str</span><span class="w"> </span><span class="n">agtype</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td>trimmed_str
</td>
</tr>
<tr>
<td>“hello”
</td>
</tr>
<tr>
<td>1 row(s) returned
</td>
</tr>
</table>
</section>
<section id="tolower">
<h2>toLower<a class="headerlink" href="#tolower" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">toLower()</span></code> returns the original string in lowercase.</p>
<p>Syntax: <code class="docutils literal notranslate"><span class="pre">toLower(original)</span></code></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">An</span> <span class="n">agtype</span> <span class="n">string</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>original
</td>
<td>An expression that returns a string
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">toLower(null)</span></code> returns <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
</ul>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN toLower(&#39;HELLO&#39;)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">lower_str</span><span class="w"> </span><span class="n">agtype</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td>lower_str
</td>
</tr>
<tr>
<td>“hello”
</td>
</tr>
<tr>
<td>1 row(s) returned
</td>
</tr>
</table>
</section>
<section id="toupper">
<h2>toUpper<a class="headerlink" href="#toupper" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">toUpper()</span> </code>returns the original string in uppercase.</p>
<p>Syntax: <code class="docutils literal notranslate"><span class="pre">toUpper(original)</span></code></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">An</span> <span class="n">agtype</span> <span class="n">string</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>original
</td>
<td>An expression that returns a string
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">toUpper(null)</span></code> returns <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
</ul>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN toUpper(&#39;hello&#39;)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">upper_str</span><span class="w"> </span><span class="n">agtype</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td><code>upper_str</code>
</td>
</tr>
<tr>
<td>“HELLO”
</td>
</tr>
<tr>
<td>1 row(s) returned
</td>
</tr>
</table>
</section>
<section id="reverse">
<h2>reverse<a class="headerlink" href="#reverse" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">reverse()</span></code> returns a string in which the order of all characters in the original string have been reversed.</p>
<p>Syntax: <code class="docutils literal notranslate"><span class="pre">reverse(original)</span></code></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">An</span> <span class="n">agtype</span> <span class="n">string</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>original
</td>
<td>An expression that returns a string
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">reverse(null)</span></code> returns <code class="docutils literal notranslate"><span class="pre">null</span></code>.</p></li>
</ul>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN reverse(&quot;hello&quot;)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">reverse_str</span><span class="w"> </span><span class="n">agtype</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td>reverse_str
</td>
</tr>
<tr>
<td>“olleh”
</td>
</tr>
<tr>
<td>1 row(s) returned
</td>
</tr>
</table>
</section>
<section id="tostring">
<h2>toString<a class="headerlink" href="#tostring" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">toString()</span></code> converts an integer, float or boolean value to a string.</p>
<p>Syntax: <code class="docutils literal notranslate"><span class="pre">toString(expression)</span></code></p>
<p>Returns:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">A</span> <span class="n">string</span><span class="o">.</span>
</pre></div>
</div>
<p>Arguments:</p>
<table>
<tr>
<td>Name
</td>
<td>Description
</td>
</tr>
<tr>
<td>expression
</td>
<td>An expression that returns a number, a boolean, or a string.
</td>
</tr>
</table>
<p>Considerations:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">toString(null)</span></code> returns <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p>If expression is a string, it will be returned unchanged.</p></li>
</ul>
<p>Query:</p>
<div class="highlight-postgresql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span>
<span class="k">FROM</span><span class="w"> </span><span class="n">cypher</span><span class="p">(</span><span class="s1">&#39;graph_name&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">$$</span>
<span class="s"> RETURN toString(11.5),toString(&#39;a string&#39;), toString(true)</span>
<span class="s">$$</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="p">(</span><span class="n">float_to_str</span><span class="w"> </span><span class="n">agtype</span><span class="p">,</span><span class="w"> </span><span class="n">str_to_str</span><span class="w"> </span><span class="n">agtype</span><span class="p">,</span><span class="w"> </span><span class="n">bool_to_string</span><span class="p">);</span>
</pre></div>
</div>
<p>Result:</p>
<table>
<tr>
<td>float_to_str
</td>
<td>str_to_str
</td>
<td>bool_to_str
</td>
</tr>
<tr>
<td>"11.5"
</td>
<td>"a string"
</td>
<td>"true"
</td>
</tr>
<tr>
<td colspan="3" >1 row(s) returned
</td>
</tr>
</table>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="trigonometric_functions.html" class="btn btn-neutral float-left" title="Trigonometric Functions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="aggregate_functions.html" class="btn btn-neutral float-right" title="Aggregation Functions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Apache AGE.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Other Versions</span>
v: master
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="string_functions.html">master</a></dd>
<dd><a href="../../v0.6.0/index.html">v0.6.0</a></dd>
</dl>
</div>
</div><script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>