Added: incubator/s2graph/site/docs/api/query/query_options.html URL: http://svn.apache.org/viewvc/incubator/s2graph/site/docs/api/query/query_options.html?rev=1856470&view=auto ============================================================================== --- incubator/s2graph/site/docs/api/query/query_options.html (added) +++ incubator/s2graph/site/docs/api/query/query_options.html Thu Mar 28 11:04:32 2019 @@ -0,0 +1,239 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Query Options — S2Graph 0.0.2 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + <script type="text/javascript" src="../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../_static/css/s2graph_style.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../genindex.html" /> + <link rel="search" title="Search" href="../../search.html" /> + <link rel="next" title="Edge Queries" href="query_edge.html" /> + <link rel="prev" title="Query APIs" href="index.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"> S2Graph + + + + </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"><span class="caption-text">S2Graph Documentation</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../getting_started/index.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../getting_started/your_first_graph.html">Your First S2Graph</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">HTTP API Glossary</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../management/index.html">Management APIs</a></li> +<li class="toctree-l2"><a class="reference internal" href="../mutate/index.html">Mutate APIs</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="index.html">Query APIs</a><ul class="current"> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Query Options</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#query-level-options">Query Level Options</a></li> +<li class="toctree-l4"><a class="reference internal" href="#step-level-option">Step Level Option</a></li> +<li class="toctree-l4"><a class="reference internal" href="#query-param-level-option">Query Param Level Option</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="query_edge.html">Edge Queries</a></li> +<li class="toctree-l3"><a class="reference internal" href="query_vertex.html">Query Vertices</a></li> +</ul> +</li> +</ul> +</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">S2Graph</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">Docs</a> »</li> + + <li><a href="../index.html">HTTP API Glossary</a> »</li> + + <li><a href="index.html">Query APIs</a> »</li> + + <li>Query Options</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/api/query/query_options.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="query-options"> +<h1>Query Options<a class="headerlink" href="#query-options" title="Permalink to this headline">¶</a></h1> +<div class="section" id="query-level-options"> +<h2>Query Level Options<a class="headerlink" href="#query-level-options" title="Permalink to this headline">¶</a></h2> +<p>A typical query contains the source vertex as a starting point, a list of labels to traverse, and optional filters or weights for unwanted results and sorting respectively. Query requests are structured as follows</p> +<p>QUERY LEVEL TABLE HERE</p> +<p><strong>Step</strong></p> +<p>Each step tells S2Graph which labels to traverse in the graph and how to traverse them. Labels in the very first step should be directly connected to the source vertices, labels in the second step should be directly connected to the result vertices of the first step traversal, and so on. A step is specified with a list of <code class="docutils literal notranslate"><span class="pre">query</span> <span class="pre">params</span></code> which we will cover in detail below.</p> +</div> +<div class="section" id="step-level-option"> +<h2>Step Level Option<a class="headerlink" href="#step-level-option" title="Permalink to this headline">¶</a></h2> +<p>STEP LEVEL TABLE HERE</p> +</div> +<div class="section" id="query-param-level-option"> +<h2>Query Param Level Option<a class="headerlink" href="#query-param-level-option" title="Permalink to this headline">¶</a></h2> +<p>Query PARAM LEVEL TABLE HERE</p> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="query_edge.html" class="btn btn-neutral float-right" title="Edge Queries" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="index.html" class="btn btn-neutral float-left" title="Query APIs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, s2graph + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html> \ No newline at end of file
Added: incubator/s2graph/site/docs/api/query/query_vertex.html URL: http://svn.apache.org/viewvc/incubator/s2graph/site/docs/api/query/query_vertex.html?rev=1856470&view=auto ============================================================================== --- incubator/s2graph/site/docs/api/query/query_vertex.html (added) +++ incubator/s2graph/site/docs/api/query/query_vertex.html Thu Mar 28 11:04:32 2019 @@ -0,0 +1,230 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Query Vertices — S2Graph 0.0.2 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + <script type="text/javascript" src="../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../_static/css/s2graph_style.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../genindex.html" /> + <link rel="search" title="Search" href="../../search.html" /> + <link rel="prev" title="Edge Queries" href="query_edge.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"> S2Graph + + + + </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"><span class="caption-text">S2Graph Documentation</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../getting_started/index.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../getting_started/your_first_graph.html">Your First S2Graph</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">HTTP API Glossary</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../management/index.html">Management APIs</a></li> +<li class="toctree-l2"><a class="reference internal" href="../mutate/index.html">Mutate APIs</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="index.html">Query APIs</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="query_options.html">Query Options</a></li> +<li class="toctree-l3"><a class="reference internal" href="query_edge.html">Edge Queries</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Query Vertices</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#post-graphs-getvertices">POST - <code class="docutils literal notranslate"><span class="pre">/graphs/getVertices</span></code></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</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">S2Graph</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">Docs</a> »</li> + + <li><a href="../index.html">HTTP API Glossary</a> »</li> + + <li><a href="index.html">Query APIs</a> »</li> + + <li>Query Vertices</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/api/query/query_vertex.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="query-vertices"> +<h1>Query Vertices<a class="headerlink" href="#query-vertices" title="Permalink to this headline">¶</a></h1> +<div class="section" id="post-graphs-getvertices"> +<h2>POST - <code class="docutils literal notranslate"><span class="pre">/graphs/getVertices</span></code><a class="headerlink" href="#post-graphs-getvertices" title="Permalink to this headline">¶</a></h2> +<p>Selecting all vertices from serviceColumn account_id of a service s2graph.</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XPOST</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">graphs</span><span class="o">/</span><span class="n">getVertices</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Content-Type: Application/json'</span> <span class="o">-</span><span class="n">d</span> <span class="s1">'</span> +<span class="p">[</span> + <span class="p">{</span><span class="s2">"serviceName"</span><span class="p">:</span> <span class="s2">"s2graph"</span><span class="p">,</span> <span class="s2">"columnName"</span><span class="p">:</span> <span class="s2">"account_id"</span><span class="p">,</span> <span class="s2">"ids"</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]},</span> + <span class="p">{</span><span class="s2">"serviceName"</span><span class="p">:</span> <span class="s2">"agit"</span><span class="p">,</span> <span class="s2">"columnName"</span><span class="p">:</span> <span class="s2">"user_id"</span><span class="p">,</span> <span class="s2">"ids"</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]}</span> +<span class="p">]</span><span class="s1">'</span> +</pre></div> +</div> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + + <a href="query_edge.html" class="btn btn-neutral float-left" title="Edge Queries" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, s2graph + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html> \ No newline at end of file Added: incubator/s2graph/site/docs/genindex.html URL: http://svn.apache.org/viewvc/incubator/s2graph/site/docs/genindex.html?rev=1856470&view=auto ============================================================================== --- incubator/s2graph/site/docs/genindex.html (added) +++ incubator/s2graph/site/docs/genindex.html Thu Mar 28 11:04:32 2019 @@ -0,0 +1,196 @@ + + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Index — S2Graph 0.0.2 documentation</title> + + + + + + + + + <script type="text/javascript" src="_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <script type="text/javascript" src="_static/language_data.js"></script> + + <script type="text/javascript" src="_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="_static/css/s2graph_style.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="#" /> + <link rel="search" title="Search" href="search.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"> S2Graph + + + + </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"><span class="caption-text">S2Graph Documentation</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="getting_started/index.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="getting_started/your_first_graph.html">Your First S2Graph</a></li> +<li class="toctree-l1"><a class="reference internal" href="api/index.html">HTTP API Glossary</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">S2Graph</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">Docs</a> »</li> + + <li>Index</li> + + + <li class="wy-breadcrumbs-aside"> + + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + +<h1 id="index">Index</h1> + +<div class="genindex-jumpbox"> + +</div> + + + </div> + + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, s2graph + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html> \ No newline at end of file Added: incubator/s2graph/site/docs/getting_started/index.html URL: http://svn.apache.org/viewvc/incubator/s2graph/site/docs/getting_started/index.html?rev=1856470&view=auto ============================================================================== --- incubator/s2graph/site/docs/getting_started/index.html (added) +++ incubator/s2graph/site/docs/getting_started/index.html Thu Mar 28 11:04:32 2019 @@ -0,0 +1,240 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Getting Started — S2Graph 0.0.2 documentation</title> + + + + + + + + + <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="../_static/language_data.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../_static/css/s2graph_style.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Your First S2Graph" href="your_first_graph.html" /> + <link rel="prev" title="Introduction" href="../index.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"> S2Graph + + + + </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"><span class="caption-text">S2Graph Documentation</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting Started</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#the-directory-layout">The Directory Layout</a></li> +<li class="toctree-l2"><a class="reference internal" href="#launching-s2graph">Launching S2Graph</a></li> +<li class="toctree-l2"><a class="reference internal" href="#building-from-the-source">Building from the Source</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="your_first_graph.html">Your First S2Graph</a></li> +<li class="toctree-l1"><a class="reference internal" href="../api/index.html">HTTP API Glossary</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">S2Graph</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">Docs</a> »</li> + + <li>Getting Started</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/getting_started/index.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="getting-started"> +<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1> +<div class="section" id="the-directory-layout"> +<h2>The Directory Layout<a class="headerlink" href="#the-directory-layout" title="Permalink to this headline">¶</a></h2> +<p>Once extracted the downloaded binary release of S2Graph or built from the source as described below, the following files and directories should be found in the directory.</p> +<div class="code highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">DISCLAIMER</span> +<span class="n">LICENCE</span> <span class="c1"># the Apache License 2.0</span> +<span class="n">NOTICE</span> +<span class="nb">bin</span> <span class="c1"># scripts to manage the lifecycle of S2Graph</span> +<span class="n">conf</span> <span class="c1"># configuration files</span> +<span class="n">lib</span> <span class="c1"># contains the binary</span> +<span class="n">logs</span> <span class="c1"># application logs</span> +<span class="n">var</span> <span class="c1"># application data</span> +</pre></div> +</div> +</div> +<div class="section" id="launching-s2graph"> +<h2>Launching S2Graph<a class="headerlink" href="#launching-s2graph" title="Permalink to this headline">¶</a></h2> +<p>The following will launch S2Graph, using HBase in the standalone mode for data storage and H2 as the metadata storage.</p> +<div class="code highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sh</span> <span class="nb">bin</span><span class="o">/</span><span class="n">start</span><span class="o">-</span><span class="n">s2graph</span><span class="o">.</span><span class="n">sh</span> +</pre></div> +</div> +<p>To connect to a remote HBase cluster or use MySQL as the metastore, refer to the instructions in <code class="docutils literal notranslate"><span class="pre">conf/application.conf</span></code></p> +</div> +<div class="section" id="building-from-the-source"> +<h2>Building from the Source<a class="headerlink" href="#building-from-the-source" title="Permalink to this headline">¶</a></h2> +<p>We use SBT to build the project, which can be installed using Homebrew on MacOS (brew install sbt). For other operating systems, refer to the SBT Tutorial. Once SBT is installed, running the following command on the source root will build the project from the source:</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sbt</span> <span class="n">package</span> +</pre></div> +</div> +<p>Depending on the internet connection, the initial run might take a while downloading the required dependencies. Once the build is complete, the same directory layout as in the top of this document can be found at <code class="docutils literal notranslate"><span class="pre">target/apache-s2graph-$version-bin</span></code>, where <code class="docutils literal notranslate"><span class="pre">$version</span></code> is the current version of the project, e.g. <code class="docutils literal notranslate"><span class="pre">0.1.0-incubating</span></code></p> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="your_first_graph.html" class="btn btn-neutral float-right" title="Your First S2Graph" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../index.html" class="btn btn-neutral float-left" title="Introduction" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, s2graph + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html> \ No newline at end of file Added: incubator/s2graph/site/docs/getting_started/your_first_graph.html URL: http://svn.apache.org/viewvc/incubator/s2graph/site/docs/getting_started/your_first_graph.html?rev=1856470&view=auto ============================================================================== --- incubator/s2graph/site/docs/getting_started/your_first_graph.html (added) +++ incubator/s2graph/site/docs/getting_started/your_first_graph.html Thu Mar 28 11:04:32 2019 @@ -0,0 +1,356 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Your First S2Graph — S2Graph 0.0.2 documentation</title> + + + + + + + + + <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="../_static/language_data.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../_static/css/s2graph_style.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="HTTP API Glossary" href="../api/index.html" /> + <link rel="prev" title="Getting Started" href="index.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"> S2Graph + + + + </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"><span class="caption-text">S2Graph Documentation</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="index.html">Getting Started</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Your First S2Graph</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#first-we-need-a-name-for-the-new-service">First, we need a name for the new service.</a></li> +<li class="toctree-l2"><a class="reference internal" href="#next-we-will-need-some-friends">Next, we will need some friends.</a></li> +<li class="toctree-l2"><a class="reference internal" href="#users-of-kakao-favorites-will-be-able-to-post-urls-of-their-favorite-websites">Users of Kakao Favorites will be able to <code class="docutils literal notranslate"><span class="pre">post</span></code> URLs of their favorite websites.</a></li> +<li class="toctree-l2"><a class="reference internal" href="#so-far-we-have-designed-a-label-schema-for-the-labels-friends-and-post-and-stored-some-edges-to-them">So far, we have designed a label schema for the labels <code class="docutils literal notranslate"><span class="pre">friends</span></code> and <code class="docutils literal notranslate"><span class="pre">post</span></code>, and stored some edges to them.</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../api/index.html">HTTP API Glossary</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">S2Graph</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">Docs</a> »</li> + + <li>Your First S2Graph</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/getting_started/your_first_graph.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="your-first-s2graph"> +<h1>Your First S2Graph<a class="headerlink" href="#your-first-s2graph" title="Permalink to this headline">¶</a></h1> +<p>Once the S2Graph server has been set up, you can now start to send HTTP queries to the server to create a graph and pour data in it. This tutorial goes over a simple toy problem to get a sense of how S2Graphâs API looks like. For the exact definitions of the terminology used here, refer to The Data Model document. +The toy problem is to create a timeline feature for a simple social media, like a simplified version of Facebookâs timeline. Using simple S2Graph queries it is possible to keep track of each userâs friends and their posts.</p> +<div class="section" id="first-we-need-a-name-for-the-new-service"> +<h2>First, we need a name for the new service.<a class="headerlink" href="#first-we-need-a-name-for-the-new-service" title="Permalink to this headline">¶</a></h2> +<p>The following POST query will create a service named <code class="docutils literal notranslate"><span class="pre">KakaoFavorites</span></code></p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XPOST</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">admin</span><span class="o">/</span><span class="n">createService</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Content-Type: Application/json'</span> <span class="o">-</span><span class="n">d</span> <span class="s1">'</span> +<span class="p">{</span> + <span class="s2">"serviceName"</span><span class="p">:</span> <span class="s2">"KakaoFavorites"</span><span class="p">,</span> + <span class="s2">"compressionAlgorithm"</span> <span class="p">:</span> <span class="s2">"gz"</span> +<span class="p">}</span><span class="s1">'</span> +</pre></div> +</div> +<p>To make sure the service is created correctly, check out the following</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XGET</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">admin</span><span class="o">/</span><span class="n">getService</span><span class="o">/</span><span class="n">KakaoFavorites</span> +</pre></div> +</div> +</div> +<div class="section" id="next-we-will-need-some-friends"> +<h2>Next, we will need some friends.<a class="headerlink" href="#next-we-will-need-some-friends" title="Permalink to this headline">¶</a></h2> +<p>In S2Graph, relationships are organized as labels. Create a <code class="docutils literal notranslate"><span class="pre">friends</span></code> label with the following <code class="docutils literal notranslate"><span class="pre">createLabel</span></code> API call:</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XPOST</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">admin</span><span class="o">/</span><span class="n">createLabel</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Content-Type: Application/json'</span> <span class="o">-</span><span class="n">d</span> <span class="s1">'</span> +<span class="p">{</span> + <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"friends"</span><span class="p">,</span> + <span class="s2">"srcServiceName"</span><span class="p">:</span> <span class="s2">"KakaoFavorites"</span><span class="p">,</span> + <span class="s2">"srcColumnName"</span><span class="p">:</span> <span class="s2">"userName"</span><span class="p">,</span> + <span class="s2">"srcColumnType"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span> + <span class="s2">"tgtServiceName"</span><span class="p">:</span> <span class="s2">"KakaoFavorites"</span><span class="p">,</span> + <span class="s2">"tgtColumnName"</span><span class="p">:</span> <span class="s2">"userName"</span><span class="p">,</span> + <span class="s2">"tgtColumnType"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span> + <span class="s2">"isDirected"</span><span class="p">:</span> <span class="s2">"false"</span><span class="p">,</span> + <span class="s2">"indices"</span><span class="p">:</span> <span class="p">[],</span> + <span class="s2">"props"</span><span class="p">:</span> <span class="p">[],</span> + <span class="s2">"consistencyLevel"</span><span class="p">:</span> <span class="s2">"strong"</span> +<span class="p">}</span><span class="s1">'</span> +</pre></div> +</div> +<p>Check if the label has been created correctly:</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XGET</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">admin</span><span class="o">/</span><span class="n">getLabel</span><span class="o">/</span><span class="n">friends</span> +</pre></div> +</div> +<p>Now that the label <code class="docutils literal notranslate"><span class="pre">friends</span></code> is ready, we can store the friendship data. Entries of a label are called edges, and you can add edges with <code class="docutils literal notranslate"><span class="pre">edges/insert</span></code> API:</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XPOST</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">mutate</span><span class="o">/</span><span class="n">edge</span><span class="o">/</span><span class="n">insert</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Content-Type: Application/json'</span> <span class="o">-</span><span class="n">d</span> <span class="s1">'</span> +<span class="p">[</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Elmo"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"Big Bird"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"friends"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152477</span><span class="p">},</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Elmo"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"Ernie"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"friends"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152478</span><span class="p">},</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Elmo"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"Bert"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"friends"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152479</span><span class="p">},</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Cookie Monster"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"Grover"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"friends"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152480</span><span class="p">},</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Cookie Monster"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"Kermit"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"friends"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152481</span><span class="p">},</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Cookie Monster"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"Oscar"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"friends"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152482</span><span class="p">}</span> +<span class="p">]</span><span class="s1">'</span> +</pre></div> +</div> +<p>Query friends of Elmo with <code class="docutils literal notranslate"><span class="pre">getEdges</span></code> API:</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XPOST</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">graphs</span><span class="o">/</span><span class="n">getEdges</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Content-Type: Application/json'</span> <span class="o">-</span><span class="n">d</span> <span class="s1">'</span> +<span class="p">{</span> + <span class="s2">"srcVertices"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"serviceName"</span><span class="p">:</span> <span class="s2">"KakaoFavorites"</span><span class="p">,</span> <span class="s2">"columnName"</span><span class="p">:</span> <span class="s2">"userName"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span><span class="s2">"Elmo"</span><span class="p">}],</span> + <span class="s2">"steps"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span><span class="s2">"step"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"label"</span><span class="p">:</span> <span class="s2">"friends"</span><span class="p">,</span> <span class="s2">"direction"</span><span class="p">:</span> <span class="s2">"out"</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">10</span><span class="p">}]}</span> + <span class="p">]</span> +<span class="p">}</span><span class="s1">'</span> +</pre></div> +</div> +<p>Now query friends of Cookie Monster:</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XPOST</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">graphs</span><span class="o">/</span><span class="n">getEdges</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Content-Type: Application/json'</span> <span class="o">-</span><span class="n">d</span> <span class="s1">'</span> +<span class="p">{</span> + <span class="s2">"srcVertices"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"serviceName"</span><span class="p">:</span> <span class="s2">"KakaoFavorites"</span><span class="p">,</span> <span class="s2">"columnName"</span><span class="p">:</span> <span class="s2">"userName"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span><span class="s2">"Cookie Monster"</span><span class="p">}],</span> + <span class="s2">"steps"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span><span class="s2">"step"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"label"</span><span class="p">:</span> <span class="s2">"friends"</span><span class="p">,</span> <span class="s2">"direction"</span><span class="p">:</span> <span class="s2">"out"</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">10</span><span class="p">}]}</span> + <span class="p">]</span> +<span class="p">}</span><span class="s1">'</span> +</pre></div> +</div> +</div> +<div class="section" id="users-of-kakao-favorites-will-be-able-to-post-urls-of-their-favorite-websites"> +<h2>Users of Kakao Favorites will be able to <code class="docutils literal notranslate"><span class="pre">post</span></code> URLs of their favorite websites.<a class="headerlink" href="#users-of-kakao-favorites-will-be-able-to-post-urls-of-their-favorite-websites" title="Permalink to this headline">¶</a></h2> +<p>We will need a new label <code class="docutils literal notranslate"><span class="pre">post</span></code> for this data:</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XPOST</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">admin</span><span class="o">/</span><span class="n">createLabel</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Content-Type: Application/json'</span> <span class="o">-</span><span class="n">d</span> <span class="s1">'</span> +<span class="p">{</span> + <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"post"</span><span class="p">,</span> + <span class="s2">"srcServiceName"</span><span class="p">:</span> <span class="s2">"KakaoFavorites"</span><span class="p">,</span> + <span class="s2">"srcColumnName"</span><span class="p">:</span> <span class="s2">"userName"</span><span class="p">,</span> + <span class="s2">"srcColumnType"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span> + <span class="s2">"tgtServiceName"</span><span class="p">:</span> <span class="s2">"KakaoFavorites"</span><span class="p">,</span> + <span class="s2">"tgtColumnName"</span><span class="p">:</span> <span class="s2">"url"</span><span class="p">,</span> + <span class="s2">"tgtColumnType"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span> + <span class="s2">"isDirected"</span><span class="p">:</span> <span class="s2">"true"</span><span class="p">,</span> + <span class="s2">"indices"</span><span class="p">:</span> <span class="p">[],</span> + <span class="s2">"props"</span><span class="p">:</span> <span class="p">[],</span> + <span class="s2">"consistencyLevel"</span><span class="p">:</span> <span class="s2">"strong"</span> +<span class="p">}</span><span class="s1">'</span> +</pre></div> +</div> +<p>Now, insert some posts of the users:</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XPOST</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">mutate</span><span class="o">/</span><span class="n">edge</span><span class="o">/</span><span class="n">insert</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Content-Type: Application/json'</span> <span class="o">-</span><span class="n">d</span> <span class="s1">'</span> +<span class="p">[</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Big Bird"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"www.kakaocorp.com/en/main"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"post"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152477</span><span class="p">},</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Big Bird"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"github.com/kakao/s2graph"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"post"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152478</span><span class="p">},</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Ernie"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"groups.google.com/forum/#!forum/s2graph"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"post"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152479</span><span class="p">},</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Grover"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"hbase.apache.org/forum/#!forum/s2graph"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"post"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152480</span><span class="p">},</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Kermit"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"www.playframework.com"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"post"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152481</span><span class="p">},</span> + <span class="p">{</span><span class="s2">"from"</span><span class="p">:</span><span class="s2">"Oscar"</span><span class="p">,</span><span class="s2">"to"</span><span class="p">:</span><span class="s2">"www.scala-lang.org"</span><span class="p">,</span><span class="s2">"label"</span><span class="p">:</span><span class="s2">"post"</span><span class="p">,</span><span class="s2">"props"</span><span class="p">:{},</span><span class="s2">"timestamp"</span><span class="p">:</span><span class="mi">1444360152482</span><span class="p">}</span> +<span class="p">]</span><span class="s1">'</span> +</pre></div> +</div> +<p>Query posts of Big Bird:</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XPOST</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">graphs</span><span class="o">/</span><span class="n">getEdges</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Content-Type: Application/json'</span> <span class="o">-</span><span class="n">d</span> <span class="s1">'</span> +<span class="p">{</span> + <span class="s2">"srcVertices"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"serviceName"</span><span class="p">:</span> <span class="s2">"KakaoFavorites"</span><span class="p">,</span> <span class="s2">"columnName"</span><span class="p">:</span> <span class="s2">"userName"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span><span class="s2">"Big Bird"</span><span class="p">}],</span> + <span class="s2">"steps"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span><span class="s2">"step"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"label"</span><span class="p">:</span> <span class="s2">"post"</span><span class="p">,</span> <span class="s2">"direction"</span><span class="p">:</span> <span class="s2">"out"</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">10</span><span class="p">}]}</span> + <span class="p">]</span> +<span class="p">}</span><span class="s1">'</span> +</pre></div> +</div> +</div> +<div class="section" id="so-far-we-have-designed-a-label-schema-for-the-labels-friends-and-post-and-stored-some-edges-to-them"> +<h2>So far, we have designed a label schema for the labels <code class="docutils literal notranslate"><span class="pre">friends</span></code> and <code class="docutils literal notranslate"><span class="pre">post</span></code>, and stored some edges to them.<a class="headerlink" href="#so-far-we-have-designed-a-label-schema-for-the-labels-friends-and-post-and-stored-some-edges-to-them" title="Permalink to this headline">¶</a></h2> +<p>This should be enough for creating the timeline feature! The following two-step query will return the URLs for Elmoâs timeline, which are the posts of Elmoâs friends:</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XPOST</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">graphs</span><span class="o">/</span><span class="n">getEdges</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Content-Type: Application/json'</span> <span class="o">-</span><span class="n">d</span> <span class="s1">'</span> +<span class="p">{</span> + <span class="s2">"srcVertices"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"serviceName"</span><span class="p">:</span> <span class="s2">"KakaoFavorites"</span><span class="p">,</span> <span class="s2">"columnName"</span><span class="p">:</span> <span class="s2">"userName"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span><span class="s2">"Elmo"</span><span class="p">}],</span> + <span class="s2">"steps"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span><span class="s2">"step"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"label"</span><span class="p">:</span> <span class="s2">"friends"</span><span class="p">,</span> <span class="s2">"direction"</span><span class="p">:</span> <span class="s2">"out"</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">10</span><span class="p">}]},</span> + <span class="p">{</span><span class="s2">"step"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"label"</span><span class="p">:</span> <span class="s2">"post"</span><span class="p">,</span> <span class="s2">"direction"</span><span class="p">:</span> <span class="s2">"out"</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">10</span><span class="p">}]}</span> + <span class="p">]</span> +<span class="p">}</span><span class="s1">'</span> +</pre></div> +</div> +<p>Also try Cookie Monsterâs timeline:</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">XPOST</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">9000</span><span class="o">/</span><span class="n">graphs</span><span class="o">/</span><span class="n">getEdges</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Content-Type: Application/json'</span> <span class="o">-</span><span class="n">d</span> <span class="s1">'</span> +<span class="p">{</span> + <span class="s2">"srcVertices"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"serviceName"</span><span class="p">:</span> <span class="s2">"KakaoFavorites"</span><span class="p">,</span> <span class="s2">"columnName"</span><span class="p">:</span> <span class="s2">"userName"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span><span class="s2">"Cookie Monster"</span><span class="p">}],</span> + <span class="s2">"steps"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span><span class="s2">"step"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"label"</span><span class="p">:</span> <span class="s2">"friends"</span><span class="p">,</span> <span class="s2">"direction"</span><span class="p">:</span> <span class="s2">"out"</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">10</span><span class="p">}]},</span> + <span class="p">{</span><span class="s2">"step"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"label"</span><span class="p">:</span> <span class="s2">"post"</span><span class="p">,</span> <span class="s2">"direction"</span><span class="p">:</span> <span class="s2">"out"</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">10</span><span class="p">}]}</span> + <span class="p">]</span> +<span class="p">}</span><span class="s1">'</span> +</pre></div> +</div> +<p>The example above is by no means a full blown social network timeline, but it gives you an idea of how to represent, store and query graph data with S2Graph.</p> +<p>We also provide a simple script under <code class="docutils literal notranslate"><span class="pre">script/test.sh</span></code> so that you can see if everything is setup correctly.</p> +<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sh</span> <span class="n">script</span><span class="o">/</span><span class="n">test</span><span class="o">.</span><span class="n">sh</span> +</pre></div> +</div> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../api/index.html" class="btn btn-neutral float-right" title="HTTP API Glossary" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="index.html" class="btn btn-neutral float-left" title="Getting Started" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, s2graph + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html> \ No newline at end of file Added: incubator/s2graph/site/docs/index.html URL: http://svn.apache.org/viewvc/incubator/s2graph/site/docs/index.html?rev=1856470&view=auto ============================================================================== --- incubator/s2graph/site/docs/index.html (added) +++ incubator/s2graph/site/docs/index.html Thu Mar 28 11:04:32 2019 @@ -0,0 +1,245 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Introduction — S2Graph 0.0.2 documentation</title> + + + + + + + + + <script type="text/javascript" src="_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <script type="text/javascript" src="_static/language_data.js"></script> + + <script type="text/javascript" src="_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="_static/css/s2graph_style.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="Getting Started" href="getting_started/index.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="#" class="icon icon-home"> S2Graph + + + + </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"><span class="caption-text">S2Graph Documentation</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="getting_started/index.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="getting_started/your_first_graph.html">Your First S2Graph</a></li> +<li class="toctree-l1"><a class="reference internal" href="api/index.html">HTTP API Glossary</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="#">S2Graph</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="#">Docs</a> »</li> + + <li>Introduction</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="introduction"> +<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1> +<p>S2Graph is a graph database designed to handle transactional graph processing at scale. Its REST API allows you to store, manage and query relational information using edge and vertex representations in a fully asynchronous and non-blocking manner. This document covers the basic concepts and terminology of S2Graph to help you get a feel for the S2Graph API.</p> +<p>Mailing Lists +Everyone interested in using and developing S2Graph is welcome to join our mailing lists!</p> +<p><a class="reference external" href="mailto:users%40s2graph.incubator.apache.org";>users<span>@</span>s2graph<span>.</span>incubator<span>.</span>apache<span>.</span>org</a> is for usage questions and announcements. +<a class="reference external" href="mailto:dev%40s2graph.incubator.apache.org";>dev<span>@</span>s2graph<span>.</span>incubator<span>.</span>apache<span>.</span>org</a> is for people who want to contribute to S2Graph.</p> +<div class="toctree-wrapper compound"> +<p class="caption"><span class="caption-text">S2Graph Documentation</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="getting_started/index.html">Getting Started</a><ul> +<li class="toctree-l2"><a class="reference internal" href="getting_started/index.html#the-directory-layout">The Directory Layout</a></li> +<li class="toctree-l2"><a class="reference internal" href="getting_started/index.html#launching-s2graph">Launching S2Graph</a></li> +<li class="toctree-l2"><a class="reference internal" href="getting_started/index.html#building-from-the-source">Building from the Source</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="getting_started/your_first_graph.html">Your First S2Graph</a><ul> +<li class="toctree-l2"><a class="reference internal" href="getting_started/your_first_graph.html#first-we-need-a-name-for-the-new-service">First, we need a name for the new service.</a></li> +<li class="toctree-l2"><a class="reference internal" href="getting_started/your_first_graph.html#next-we-will-need-some-friends">Next, we will need some friends.</a></li> +<li class="toctree-l2"><a class="reference internal" href="getting_started/your_first_graph.html#users-of-kakao-favorites-will-be-able-to-post-urls-of-their-favorite-websites">Users of Kakao Favorites will be able to <code class="docutils literal notranslate"><span class="pre">post</span></code> URLs of their favorite websites.</a></li> +<li class="toctree-l2"><a class="reference internal" href="getting_started/your_first_graph.html#so-far-we-have-designed-a-label-schema-for-the-labels-friends-and-post-and-stored-some-edges-to-them">So far, we have designed a label schema for the labels <code class="docutils literal notranslate"><span class="pre">friends</span></code> and <code class="docutils literal notranslate"><span class="pre">post</span></code>, and stored some edges to them.</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="api/index.html">HTTP API Glossary</a><ul> +<li class="toctree-l2"><a class="reference internal" href="api/management/index.html">Management APIs</a><ul> +<li class="toctree-l3"><a class="reference internal" href="api/management/index.html#create-a-service">Create a Service</a></li> +<li class="toctree-l3"><a class="reference internal" href="api/management/index.html#create-a-label">Create a Label</a></li> +<li class="toctree-l3"><a class="reference internal" href="api/management/index.html#create-a-servicecolumn-optional">Create a ServiceColumn (Optional)</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="api/mutate/index.html">Mutate APIs</a><ul> +<li class="toctree-l3"><a class="reference internal" href="api/mutate/mutate_edge.html">Manage Edges</a></li> +<li class="toctree-l3"><a class="reference internal" href="api/mutate/mutate_vertex.html">Manage Vertices (Optional)</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="api/query/index.html">Query APIs</a><ul> +<li class="toctree-l3"><a class="reference internal" href="api/query/query_options.html">Query Options</a></li> +<li class="toctree-l3"><a class="reference internal" href="api/query/query_edge.html">Edge Queries</a></li> +<li class="toctree-l3"><a class="reference internal" href="api/query/query_vertex.html">Query Vertices</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="getting_started/index.html" class="btn btn-neutral float-right" title="Getting Started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, s2graph + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html> \ No newline at end of file Added: incubator/s2graph/site/docs/objects.inv URL: http://svn.apache.org/viewvc/incubator/s2graph/site/docs/objects.inv?rev=1856470&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/s2graph/site/docs/objects.inv ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: incubator/s2graph/site/docs/search.html URL: http://svn.apache.org/viewvc/incubator/s2graph/site/docs/search.html?rev=1856470&view=auto ============================================================================== --- incubator/s2graph/site/docs/search.html (added) +++ incubator/s2graph/site/docs/search.html Thu Mar 28 11:04:32 2019 @@ -0,0 +1,209 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Search — S2Graph 0.0.2 documentation</title> + + + + + + + + + <script type="text/javascript" src="_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <script type="text/javascript" src="_static/language_data.js"></script> + <script type="text/javascript" src="_static/searchtools.js"></script> + + <script type="text/javascript" src="_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="_static/css/s2graph_style.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="#" /> +</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"> S2Graph + + + + </a> + + + + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="#" 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"><span class="caption-text">S2Graph Documentation</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="getting_started/index.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="getting_started/your_first_graph.html">Your First S2Graph</a></li> +<li class="toctree-l1"><a class="reference internal" href="api/index.html">HTTP API Glossary</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">S2Graph</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">Docs</a> »</li> + + <li>Search</li> + + + <li class="wy-breadcrumbs-aside"> + + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <noscript> + <div id="fallback" class="admonition warning"> + <p class="last"> + Please activate JavaScript to enable the search + functionality. + </p> + </div> + </noscript> + + + <div id="search-results"> + + </div> + + </div> + + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, s2graph + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + <script type="text/javascript"> + jQuery(function() { Search.loadIndex("searchindex.js"); }); + </script> + + <script type="text/javascript" id="searchindexloader"></script> + + + +</body> +</html> \ No newline at end of file
