| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" > |
| <head> |
| <meta charset="utf-8" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| |
| <title>List Functions — Apache AGE master documentation</title> |
| |
| |
| |
| <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
| <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 type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> |
| <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/doctools.js"></script> |
| |
| <script type="text/javascript" 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="Numeric Functions" href="numeric_functions.html" /> |
| <link rel="prev" title="Scalar Functions" href="scalar_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="main navigation"> |
| |
| |
| |
| |
| |
| |
| <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/aggregation.html">Aggregation</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/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/delete.html">DELETE</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 current"><a class="current reference internal" href="#">List Functions</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#data-setup">Data Setup</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#keys">keys</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#range">range</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#labels">labels</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#relationships">relationships</a></li> |
| </ul> |
| </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"><a class="reference internal" href="string_functions.html">String Functions</a></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="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> |
| |
| |
| |
| </div> |
| |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <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="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../index.html" class="icon icon-home"></a> »</li> |
| |
| <li>List Functions</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| |
| <a href="https://github.com/apache/incubator-age-website/blob/master/docs/functions/list_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"> |
| |
| <div class="tex2jax_ignore mathjax_ignore section" id="list-functions"> |
| <h1>List Functions<a class="headerlink" href="#list-functions" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="data-setup"> |
| <h2>Data Setup<a class="headerlink" href="#data-setup" title="Permalink to this headline">¶</a></h2> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>SELECT * from cypher('graph_name', $$ |
| CREATE (A:Person {name: 'Alice', age: 38, eyes: 'brown'}), |
| (B:Person {name: 'Bob', age: 25, eyes: 'blue'}), |
| (C:Person {name: 'Charlie', age: 53, eyes: 'green'}), |
| (D:Person {name: 'Daniel', age: 54, eyes: 'brown'}), |
| (E:Person {name: 'Eskil', age: 41, eyes: 'blue', array: ['one', 'two', 'three']}), |
| (A)-[:KNOWS]->(B), |
| (A)-[:KNOWS]->(C), |
| (B)-[:KNOWS]->(D), |
| (C)-[:KNOWS]->(D), |
| (B)-[:KNOWS]->(E) |
| $$) as (result agtype); |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="keys"> |
| <h2>keys<a class="headerlink" href="#keys" title="Permalink to this headline">¶</a></h2> |
| <p>keys returns a list containing the string representations for all the property names of a vertex, edge, or map.</p> |
| <p>Syntax:<code class="docutils literal notranslate"><span class="pre">keys(expression)</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">containing</span> <span class="n">string</span> <span class="n">agtype</span> <span class="n">elements</span> |
| </pre></div> |
| </div> |
| <p>Arguments:</p> |
| <table> |
| <tr> |
| <td>Name |
| </td> |
| <td>Description |
| </td> |
| </tr> |
| <tr> |
| <td>path |
| </td> |
| <td>An expression that returns a vertex, edge, or map. |
| </td> |
| </tr> |
| </table> |
| <p>Considerations:</p> |
| <ul class="simple"> |
| <li><p>keys(null) returns null.</p></li> |
| </ul> |
| <p>Query:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>SELECT * from cypher('graph_name', $$ |
| MATCH (a) |
| WHERE a.name = 'Alice' |
| RETURN keys(a) |
| $$) as (result agtype); |
| </pre></div> |
| </div> |
| <p>A list containing the names of all the properties on the vertex bound to a is returned.</p> |
| <p>Result:</p> |
| <table> |
| <tr> |
| <td>keys |
| </td> |
| </tr> |
| <tr> |
| <td>["age", "eyes", "name"]</td> |
| </tr> |
| <tr> |
| <td colspan="1" >1 rows |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="section" id="range"> |
| <h2>range<a class="headerlink" href="#range" title="Permalink to this headline">¶</a></h2> |
| <p>range() returns a list comprising all integer values within a range bounded by a start value start and end value end, where the difference step between any two consecutive values is constant; i.e. an arithmetic progression. The range is inclusive, and the arithmetic progression will therefore always contain start and—depending on the values of start, step and end—end.</p> |
| <p>Syntax:<code class="docutils literal notranslate"><span class="pre">range(start,</span> <span class="pre">end</span> <span class="pre">[,</span> <span class="pre">step])</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">containing</span> <span class="n">edge</span> <span class="n">entities</span> |
| </pre></div> |
| </div> |
| <p>Arguments:</p> |
| <table> |
| <tr> |
| <td>Name |
| </td> |
| <td>Description |
| </td> |
| </tr> |
| <tr> |
| <td>start |
| </td> |
| <td>An expression that returns an integer value. |
| </td> |
| </tr> |
| <tr> |
| <td>end |
| </td> |
| <td>An expression that returns an integer value. |
| </td> |
| </tr> |
| <tr> |
| <td>step |
| </td> |
| <td>A numeric expression defining the differencebetween any two consecutive values, with adefault of 1. |
| </td> |
| </tr> |
| </table> |
| <p>Query:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>SELECT * |
| FROM cypher('graph_name', $$ |
| RETURN range(0, 10), range(2, 18, 3) |
| $$) as (no_step agtype, step agtype); |
| </pre></div> |
| </div> |
| <p>Two lists of numbers in the given ranges are returned.</p> |
| <p>Result:</p> |
| <table> |
| <tr> |
| <td>no_step |
| </td> |
| <td>step |
| </td> |
| </tr> |
| <tr> |
| <td>[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]</td> |
| <td>[2, 5, 8, 11, 14, 17]</td> |
| </tr> |
| <tr> |
| <td colspan="1" >1 row |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="section" id="labels"> |
| <h2>labels<a class="headerlink" href="#labels" title="Permalink to this headline">¶</a></h2> |
| <p>labels returns a list containing the string representations for all the labels of a node.</p> |
| <p>Syntax:<code class="docutils literal notranslate"><span class="pre">labels(vertex)</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">containing</span> <span class="n">String</span> <span class="n">elements</span> |
| </pre></div> |
| </div> |
| <p>Arguments:</p> |
| <table> |
| <tr> |
| <td>Name |
| </td> |
| <td>Description |
| </td> |
| </tr> |
| <tr> |
| <td>vertex |
| </td> |
| <td>An expression that returns a single vertex. |
| </td> |
| </tr> |
| </table> |
| <p>Considerations:</p> |
| <ul class="simple"> |
| <li><p>labels(null) returns null.</p></li> |
| </ul> |
| <p>Query:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>SELECT * |
| FROM cypher('graph_name', $$ |
| MATCH (a) |
| WHERE a.name = 'Alice' |
| RETURN labels(a) |
| $$) as (edges agtype); |
| </pre></div> |
| </div> |
| <p>A list containing all the labels of the node bound to a is returned.</p> |
| <p>Result:</p> |
| <table> |
| <tr> |
| <td>edges |
| </td> |
| </tr> |
| <tr> |
| <td>["Person"] |
| </td> |
| </tr> |
| <tr> |
| <td colspan="3" >1 row |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="section" id="relationships"> |
| <h2>relationships<a class="headerlink" href="#relationships" title="Permalink to this headline">¶</a></h2> |
| <p>relationships() returns a list containing all the relationships in a path.</p> |
| <p>Syntax:<code class="docutils literal notranslate"><span class="pre">relationships(path)</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">containing</span> <span class="n">edge</span> <span class="n">entities</span> |
| </pre></div> |
| </div> |
| <p>Arguments:</p> |
| <table> |
| <tr> |
| <td>Name |
| </td> |
| <td>Description |
| </td> |
| </tr> |
| <tr> |
| <td>path |
| </td> |
| <td>An expression that returns an Agtype path. |
| </td> |
| </tr> |
| </table> |
| <p>Considerations:</p> |
| <ul class="simple"> |
| <li><p>relationships(null) returns null.</p></li> |
| </ul> |
| <p>Query:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>SELECT * |
| FROM cypher('graph_name', $$ |
| MATCH p = (a)-[]->(b)-[]->(c) |
| WHERE a.name = 'Alice' AND c.name = 'Eskil' |
| RETURN relationships(p) |
| $$) as (edges agtype); |
| </pre></div> |
| </div> |
| <p>A list containing all the edges in the path p is returned.</p> |
| <p>Result:</p> |
| <table> |
| <tr> |
| <td>edges |
| </td> |
| </tr> |
| <tr> |
| <td>[{"id": 1125899906842640, "label": "KNOWS", "end_id": 844424930131989, "start_id": 844424930131988, "properties": {}}::edge, {"id": 1125899906842644, "label": "KNOWS", "end_id": 844424930131992, "start_id": 844424930131989, "properties": {}}::edge] |
| </td> |
| </tr> |
| <tr> |
| <td colspan="3" >1 row |
| </td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| <a href="numeric_functions.html" class="btn btn-neutral float-right" title="Numeric Functions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| <a href="scalar_functions.html" class="btn btn-neutral float-left" title="Scalar Functions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © 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: v0.6.0 |
| <span class="fa fa-caret-down"></span> |
| </span> |
| <div class="rst-other-versions"> |
| <dl> |
| <dt>Versions</dt> |
| <dd><a href="../../master/index.html">master</a></dd> |
| <dd><a href="list_functions.html">v0.6.0</a></dd> |
| </dl> |
| </div> |
| </div> |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
