You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by su...@apache.org on 2014/10/22 18:47:14 UTC
svn commit: r1633650 [11/14] - in
/incubator/usergrid/site/publish/documents: ./ _sources/ _sources/concepts/
_sources/presentations-and-videos/ _static/ _static/css/ _static/fonts/
_static/js/ concepts/ presentations-and-videos/
Added: incubator/usergrid/site/publish/documents/concepts/query-language.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/documents/concepts/query-language.html?rev=1633650&view=auto
==============================================================================
--- incubator/usergrid/site/publish/documents/concepts/query-language.html (added)
+++ incubator/usergrid/site/publish/documents/concepts/query-language.html Wed Oct 22 16:47:12 2014
@@ -0,0 +1,664 @@
+
+
+<!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 Language — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="up" title="Organizations & Admins" href="../organizations-admins.html"/>
+ <link rel="next" title="Users & Devices" href="users-devices.html"/>
+ <link rel="prev" title="Collections" href="collections.html"/>
+
+
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+ <a href="../index.html" class="fa fa-home"> Apache Usergrid</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">
+
+
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../deploy-local.html">Deploying to local Tomcat & Cassandra</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#example-usergrid-deployment-properties-file">Example usergrid-deployment.properties file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-up-and-running-locally.html">Getting Up & Running Locally</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1 current"><a class="reference internal" href="../organizations-admins.html">Organizations & Admins</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="applications.html">Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="events-and-counters.html">Events and counters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="roles-and-permissions.html">Roles & Permissions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="relationships.html">Relationships</a></li>
+<li class="toctree-l2"><a class="reference internal" href="collections.html">Collections</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Query Language</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users-devices.html">Users & Devices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="groups.html">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="activity.html">Activity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="assets.html">Assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../presentations-and-videos.html">Presentations & Videos</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/presentations.html">Presentations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/videos.html">Videos</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading from Previous Versions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contribute-code.html">How to Contribute Code & Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#code-contributions">Code Contributions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#website-and-documentation-contributions">Website and Documentation Contributions</a></li>
+</ul>
+</li>
+</ul>
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</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="../organizations-admins.html">Organizations & Admins</a> »</li>
+
+ <li>Query Language</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/concepts/query-language.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document">
+
+ <div class="section" id="query-language">
+<h1>Query Language<a class="headerlink" href="#query-language" title="Permalink to this headline">¶</a></h1>
+<blockquote>
+<div>Query examples in this content are shown unencoded to make them
+easier to read. Keep in mind that you might need to encode query
+strings if you’re sending them as part of URLs, such as when you’re
+executing them with the cURL tool.</div></blockquote>
+<p>The following example retrieves a list of restaurants (from a
+restaurants collection) whose name property contains the value “diner”,
+sorting the list in ascending order by name:</p>
+<div class="highlight-python"><div class="highlight"><pre>/restaurants?ql=select * where name contains 'diner' order by name asc
+</pre></div>
+</div>
+<div class="section" id="basic-syntax">
+<h2>Basic syntax<a class="headerlink" href="#basic-syntax" title="Permalink to this headline">¶</a></h2>
+<p>Queries of Apigee data for Apache Usergrid are made up of two kinds of
+statements: the path to the collection you want to query, followed by
+the query language statement containing your query. These two statements
+are separated by ”?ql=” to indicate where the query language statement
+starts.</p>
+<p>To retrieve items from a collection, you would use a syntax such as the
+following:</p>
+<div class="highlight-python"><div class="highlight"><pre>/<collection>?ql=<query_statement>
+</pre></div>
+</div>
+<p>In the following example, the query is retrieving all users whose name
+is Gladys Kravitz.</p>
+<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where name = 'Gladys Kravitz'
+</pre></div>
+</div>
+<p>The following example selects all items except those that have an a
+property value of 5:</p>
+<div class="highlight-python"><div class="highlight"><pre>/items?ql=select * where NOT a = 5
+</pre></div>
+</div>
+<p>Note that there is a shortcut available when your query selects all
+items matching certain criteria – in other words, where you use a
+statement that starts “select * where”. In this case, you can omit the
+first part of the statement and abbreviate it this way:</p>
+<div class="highlight-python"><div class="highlight"><pre>/items?ql=NOT a = 5
+</pre></div>
+</div>
+<p>You query your Apache Usergrid data by using a query syntax that’s like
+Structured Query Language (SQL), the query language for relational
+databases. Unlike a relational database, where you specify tables and
+columns containing the data you want to query, in your Apache Usergrid
+queries you specify collections and entities.</p>
+<p>The syntax of Apache Usergrid queries only <em>resembles</em> SQL to make
+queries familiar and easier to write. However, the language isn’t SQL.
+Only the syntax items documented here are supported.</p>
+</div>
+<div class="section" id="supported-operators">
+<h2>Supported operators<a class="headerlink" href="#supported-operators" title="Permalink to this headline">¶</a></h2>
+<p>Comparisons</p>
+<ul class="simple">
+<li>Less than <code class="docutils literal"><span class="pre"><</span></code> or <code class="docutils literal"><span class="pre">lt</span></code></li>
+<li>Less than or equal <code class="docutils literal"><span class="pre"><=</span></code> or <code class="docutils literal"><span class="pre">lte</span></code></li>
+<li>Equal <code class="docutils literal"><span class="pre">=</span></code> or <code class="docutils literal"><span class="pre">eq</span></code></li>
+<li>Greater than or equal <code class="docutils literal"><span class="pre">>=</span></code> or <code class="docutils literal"><span class="pre">gte</span></code></li>
+<li>Greater than <code class="docutils literal"><span class="pre">></span></code> or <code class="docutils literal"><span class="pre">gt</span></code></li>
+<li>Not equal <code class="docutils literal"><span class="pre">NOT</span></code></li>
+</ul>
+<p>Logical operations</p>
+<ul class="simple">
+<li>Intersection of results <code class="docutils literal"><span class="pre">and</span></code></li>
+<li>Union of results <code class="docutils literal"><span class="pre">or</span></code></li>
+<li>Subtraction of results <code class="docutils literal"><span class="pre">not</span></code></li>
+</ul>
+</div>
+<div class="section" id="query-response-format">
+<h2>Query Response Format<a class="headerlink" href="#query-response-format" title="Permalink to this headline">¶</a></h2>
+<p>the queryâs response is formatted in JavaScript Object Notation (JSON).
+This is a common format used for parameter and return values in REST web
+services.</p>
+<p>So for the following query:</p>
+<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where name = âGladys Kravitzâ
+</pre></div>
+</div>
+<p>...you would get a response such as the the one below. The JSON format
+arranges the data in name/value pairs. Many of the values correspond to
+specifics of the request, including the requestâs HTTP action (GET), the
+applicationâs UUID, the requestâs parameters (the query string you
+sent), and so on.</p>
+<p>Here, the query is asking for whole entities in the users collection.
+Data corresponding to the response is captured in the responseâs
+<code class="docutils literal"><span class="pre">entities</span></code> array. The array has one member here, corresponding to the
+one user found by the query (another kind of query might have found more
+users). That one member gives the UUID of the entity (user), the entity
+type, and values for properties such as name, username, email, and so
+on.</p>
+<div class="code json highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"get"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"8272c9b0-d86a-11e2-92e2-cdf1ce04c1c0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"ql"</span> <span class="p">:</span> <span class="p">[</span> <span class="s">"select * where name = 'Gladys Kravitz'"</span> <span class="p">]</span>
+ <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/users"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"http://api.usergrid.com/myorg/myapp/users"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"d0d7d0ba-e97b-11e2-8cef-411c466c4f2c"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"user"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"Gladys Kravitz"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1373472876859</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1373472876859</span><span class="p">,</span>
+ <span class="s">"username"</span> <span class="p">:</span> <span class="s">"gladys"</span><span class="p">,</span>
+ <span class="s">"email"</span> <span class="p">:</span> <span class="s">"gladys@example.com"</span><span class="p">,</span>
+ <span class="s">"activated"</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"picture"</span> <span class="p">:</span> <span class="s">"http://www.gravatar.com/avatar/20c57d4f41cf51f2db44165eb058b3b2"</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c"</span><span class="p">,</span>
+ <span class="s">"sets"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"rolenames"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c/rolenames"</span><span class="p">,</span>
+ <span class="s">"permissions"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c/permissions"</span>
+ <span class="p">},</span>
+ <span class="s">"connections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"firstname"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c/firstname"</span><span class="p">,</span>
+ <span class="s">"lastname"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c/lastname"</span>
+ <span class="p">},</span>
+ <span class="s">"collections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"activities"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c/activities"</span><span class="p">,</span>
+ <span class="s">"devices"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c/devices"</span><span class="p">,</span>
+ <span class="s">"feed"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c/feed"</span><span class="p">,</span>
+ <span class="s">"groups"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c/groups"</span><span class="p">,</span>
+ <span class="s">"roles"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c/roles"</span><span class="p">,</span>
+ <span class="s">"following"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c/following"</span><span class="p">,</span>
+ <span class="s">"followers"</span> <span class="p">:</span> <span class="s">"/users/d0d7d0ba-e97b-11e2-8cef-411c466c4f2c/followers"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1374694196061</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">48</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"myorg"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"myapp"</span><span class="p">,</span>
+ <span class="s">"count"</span> <span class="p">:</span> <span class="mi">1</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>Compare the preceding example with the following for another kind of
+query. Imagine the following request string, where the query string is
+asking for only the values of two of the entityâs properties (username
+and name):</p>
+<div class="highlight-python"><div class="highlight"><pre>/users?ql=select username,name where name=âGladys Kravitzâ
+</pre></div>
+</div>
+<p>In the response JSON from this query, the return value is specified as
+the property of the <code class="docutils literal"><span class="pre">list</span></code> item – here, an array containing only the
+values of the properties the query asked for, in the order they were
+requested (username first, then name).</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"get"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"8272c9b0-d86a-11e2-92e2-cdf1ce04c1c0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"ql"</span> <span class="p">:</span> <span class="p">[</span> <span class="s">"select username,name where name='Gladys Kravitz'"</span> <span class="p">]</span>
+ <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/users"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"http://api.usergrid.com/myorg/myapp/users"</span><span class="p">,</span>
+ <span class="s">"list"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">[</span> <span class="s">"gladys"</span><span class="p">,</span> <span class="s">"Gladys Kravitz"</span> <span class="p">]</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1374697463190</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">25</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"myorg"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"myapp"</span><span class="p">,</span>
+ <span class="s">"count"</span> <span class="p">:</span> <span class="mi">1</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="data-types-supported-in-queries">
+<h2>Data types supported in queries<a class="headerlink" href="#data-types-supported-in-queries" title="Permalink to this headline">¶</a></h2>
+<p>As you develop queries for your Apache Usergrid data, remember that
+entity properties each conform to a particular data type (whether the
+entity is included by default or an entity you defined). Your queries
+must acknowledge this, testing with values that conform to each
+property’s data type. (You can view the list of property data types for
+the default entities at <a class="reference external" href="/default-data-entities">Default Data
+Entities</a>.)</p>
+<p>For example, in the default entity <code class="docutils literal"><span class="pre">User</span></code>, the <code class="docutils literal"><span class="pre">name</span></code> property is
+stored as a <code class="docutils literal"><span class="pre">string</span></code>, the created date as a <code class="docutils literal"><span class="pre">long</span></code>, and metadata is
+stored as a JSON object. Your queries must be data type-aware so that
+you can be sure that query results are as you expect them to be.</p>
+<p>So imagine you define an entity with a <code class="docutils literal"><span class="pre">price</span></code> property whose value
+might be <code class="docutils literal"><span class="pre">100.00</span></code>. Querying for <code class="docutils literal"><span class="pre">100</span></code> will return no results even if
+there are occurrences of <code class="docutils literal"><span class="pre">100.00</span></code> as <code class="docutils literal"><span class="pre">price</span></code> values in your data
+set. That’s because the database expected a decimal-delimited <code class="docutils literal"><span class="pre">float</span></code>
+value in your query.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="6%" />
+<col width="22%" />
+<col width="73%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Data Type</th>
+<th class="head">Examples</th>
+<th class="head">Notes</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">string</span></code></td>
+<td><code class="docutils literal"><span class="pre">'value'</span></code>, <code class="docutils literal"><span class="pre">unicode</span> <span class="pre">'\uFFFF'</span></code>, <code class="docutils literal"><span class="pre">octal</span> <span class="pre">'\0707'</span></code></td>
+<td>true | false</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">long</span></code></td>
+<td>1357412326021</td>
+<td>Timestamps are typically stored as <code class="docutils literal"><span class="pre">long</span></code> values.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">float</span></code></td>
+<td>10.1, -10.1, 10e10, 10e-10, 10E10, 10e-10</td>
+<td>Your query must be specific about the value you’re looking for, down to the value (if any) after the decimal point.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">boolean</span></code></td>
+<td>true | false</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">UUID</span></code></td>
+<td>ee912c4b-5769-11e2-924d-02e81ac5a17b</td>
+<td>UUID types are typically used for the unique IDs of entities. The value must conform to the following format (do not enclose with quotation marks): xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</td>
+</tr>
+</tbody>
+</table>
+<p><code class="docutils literal"><span class="pre">object</span></code> For a JSON object like this one:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"items"</span><span class="p">:[</span>
+ <span class="p">{</span><span class="s">"name"</span><span class="p">:</span><span class="s">"rocks"</span><span class="p">},</span>
+ <span class="p">{</span><span class="s">"name"</span><span class="p">:</span><span class="s">"boats"</span><span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>you can use dot notation to reach property values in the object:
+/mycollection/thing?ql=”select * where items.name = ‘rocks’” Objects
+are often used to contain entity metadata, such as the activities
+associated with a user, the users associated with a role, and so on.</p>
+</div>
+<div class="section" id="retrieving-values-for-multiple-properties">
+<h2>Retrieving values for multiple properties<a class="headerlink" href="#retrieving-values-for-multiple-properties" title="Permalink to this headline">¶</a></h2>
+<p>Your query can return multiple kinds of values – such as the values of
+multiple properties – by specifying the property names in your select
+statement as a comma-separated list.</p>
+<p>For example, the following request returns the address and phone number
+of users whose name is Gladys Kravitz:</p>
+<div class="highlight-python"><div class="highlight"><pre>/users?ql=select address,phone_number where name = 'Gladys Kravitz'
+</pre></div>
+</div>
+</div>
+<div class="section" id="querying-for-the-contents-of-text">
+<h2>Querying for the contents of text<a class="headerlink" href="#querying-for-the-contents-of-text" title="Permalink to this headline">¶</a></h2>
+<p>Your query can search the text of entity values of the string data type.
+For example, you can search a postal code field for values that start
+with a specific three numbers.</p>
+<p>For example, the following query selects all restaurants with the word
+<code class="docutils literal"><span class="pre">diner</span></code> in the name:</p>
+<div class="highlight-python"><div class="highlight"><pre>/restaurants?ql=select * where name contains 'diner'
+</pre></div>
+</div>
+<p><strong>Note:</strong> Not all string properties of the default entities are indexed
+for searching. This includes the <code class="docutils literal"><span class="pre">User</span></code> entity’s <code class="docutils literal"><span class="pre">username</span></code>
+property.</p>
+<p>This will return all users whose name property contains the word
+‘Kravitz’</p>
+<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where name contains 'Kravitz'
+</pre></div>
+</div>
+<p>This will return all users whose name property contains a word beginning
+with ‘Krav’</p>
+<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where name contains 'Krav*'
+</pre></div>
+</div>
+<p>This will return all users whose name is exactly ‘Gladys Kravitz’</p>
+<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where name = 'Gladys Kravitz'
+</pre></div>
+</div>
+</div>
+<div class="section" id="sorting-results">
+<h2>Sorting results<a class="headerlink" href="#sorting-results" title="Permalink to this headline">¶</a></h2>
+<p>You can return query results that are sorted in the order you specify.
+Use the <code class="docutils literal"><span class="pre">order</span> <span class="pre">by</span></code> clause to specify the property to sort by, along
+with the order in which results should be sorted. The syntax for the
+clause is as follows <code class="docutils literal"><span class="pre">order</span> <span class="pre">by</span> <span class="pre"><property_name></span> <span class="pre">asc</span> <span class="pre">|</span> <span class="pre">desc</span></code></p>
+<p>The following table includes a few examples:</p>
+<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where lastname = 'Smith' order by firstname asc
+
+
+/users?ql=select * where lastname = 'Smith' order by firstname desc
+
+
+/users?ql=select * where lastname contains 'Sm*' order by lastname asc, firstname asc
+</pre></div>
+</div>
+</div>
+<div class="section" id="geoqueries">
+<h2>Geoqueries<a class="headerlink" href="#geoqueries" title="Permalink to this headline">¶</a></h2>
+<p>Many of today’s apps are enhanced by the use of <em>geolocation</em>, wireless
+detection of the physical location of a remote device. These apps are
+said to be <em>geolocation-aware</em> in that they query the device to
+determine the user’s position and then use this data to further enhance
+the user’s experience. For example, apps can capture the exact location
+where a picture was taken or a message was created.</p>
+<p>App services support geolocation on any entity, both built in (e.g.,
+users, groups) and user defined.</p>
+<p>To add a location to any entity, include the following member to the
+JSON in a POST or PUT call:</p>
+<div class="highlight-python"><div class="highlight"><pre>"location": {
+ "latitude": 37.779632,
+ "longitude": -122.395131
+}
+</pre></div>
+</div>
+<p>For example, to store a listing of restaurants and their locations,
+start by creating a collection called restaurants:</p>
+<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/org_name/app_name/restaurants
+</pre></div>
+</div>
+<p>Next, add a new entity to the collection:</p>
+<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/org_name/app_name/restaurants
+{
+ "name": "Rockadero",
+ "address": "21 Slate Street, Bedrock, CA",
+ "location": {
+ "latitude": 37.779632,
+ "longitude": -122.395131
+ }
+}
+</pre></div>
+</div>
+<p>This creates a new restaurant entity called “Rockadero” with the
+longitude and latitude included as part of the object.</p>
+<p>When a location is added to an entity, it is easy to make queries
+against that data. For example, to see all restaurants within a 10 mile
+radius of the user’s location, make a GET call against that entity, and
+include a search query in the following format:</p>
+<div class="highlight-python"><div class="highlight"><pre>location within <distance in meters> of <latitude>, <longitude>
+</pre></div>
+</div>
+<p>If we use the location of our user Fred, we first need to convert miles
+to meters. 1 mile is equivalent to 1609.344 meters, so 10 miles is about
+16093 meters. Thus, the API call looks like this:</p>
+<div class="highlight-python"><div class="highlight"><pre>GET https://api.usergrid.com/org_name/app_name/restaurants?ql=location within 16093 of 37.776753, -122.407846
+</pre></div>
+</div>
+</div>
+<div class="section" id="managing-large-sets-of-results">
+<h2>Managing large sets of results<a class="headerlink" href="#managing-large-sets-of-results" title="Permalink to this headline">¶</a></h2>
+<p>When your query might return more results than you want to display to
+the user at once, you can use the limit parameter with cursors or API
+methods to manage the display of results. By default, query results are
+limited to 10 at a time. You can adjust this by setting the limit
+parameter to a value you prefer.</p>
+<p>For example, you might execute a query that could potentially return
+hundreds of results, but you want to display 20 of those at a time to
+users. To do this, your code sets the limit parameter to 20 when
+querying for data, then provides a way for the user to request more of
+the results when they’re ready.</p>
+<p>You would use the following parameters in your query:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="33%" />
+<col width="33%" />
+<col width="33%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">limit</span></code></td>
+<td>integer</td>
+<td><p class="first">Number of results to
+return. The maximum
+number of results is
+1,000. Specifying a
+limit greater than
+1,000 will result in a
+limit of 1,000.</p>
+<p>Limit is applied to the
+collection, not the
+query string. For
+example, the following
+query will find the
+first 100 entities in
+the books collection,
+then from that set
+return the ones with
+author=’Hemingway’:</p>
+<div class="highlight-python"><div class="highlight"><pre>/books?ql=author =
+</pre></div>
+</div>
+<p>‘Hemingway’&limit=100</p>
+<p>You can also use the
+limit parameter on a
+request without a query
+string. The following
+example is shorthand
+for selecting all books
+and limiting by 100 at
+a time:</p>
+<div class="highlight-python"><div class="highlight"><pre>/books?limit=100
+</pre></div>
+</div>
+<p>Using a limit on a
+DELETE can help you
+manage the amount of
+time it takes to delete
+data. For example you
+can delete all of the
+books, 1000 at a time,
+with the following:</p>
+<div class="highlight-python"><div class="highlight"><pre>DELETE /books?limit
+</pre></div>
+</div>
+<p>=1000</p>
+<p class="last">Keep in mind that
+DELETE operations can
+take longer to execute.
+Yet even though the
+DELETE query call might
+time out (such as with
+a very large limit),
+the operation will
+continue on the server
+even if the client
+stops waiting for the
+result.</p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cursor</span></code></td>
+<td>string</td>
+<td>An encoded
+representation of the
+query position pointing
+to a set of results. To
+retrieve the next set
+of results, pass the
+cursor with your next
+call for most results.</td>
+</tr>
+</tbody>
+</table>
+<p>For example:</p>
+<p>Select all users whose name starts with fred, and returns the first 50
+results:</p>
+<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where name = 'fred*'&limit=50
+</pre></div>
+</div>
+<p>Retrieve the next batch of users whose name is “fred”, passing the
+cursor received from the last request to specify where the next set of
+results should begin:</p>
+<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where name = 'fred*'&limit=50&cursor=LTIxNDg0NDUxNDpnR2tBQVFFQWdITUFDWFJ2YlM1emJXbDBhQUNBZFFBUUQyMVZneExfRWVLRlV3TG9Hc1doZXdDQWRRQVFIYVdjb0JwREVlS1VCd0xvR3NWT0JRQQ
+</pre></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="users-devices.html" class="btn btn-neutral float-right" title="Users & Devices">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="collections.html" class="btn btn-neutral" title="Collections"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2014, Apache Usergrid.
+ </p>
+ </div>
+
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </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/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/documents/concepts/relationships.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/documents/concepts/relationships.html?rev=1633650&view=auto
==============================================================================
--- incubator/usergrid/site/publish/documents/concepts/relationships.html (added)
+++ incubator/usergrid/site/publish/documents/concepts/relationships.html Wed Oct 22 16:47:12 2014
@@ -0,0 +1,313 @@
+
+
+<!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>Relationships — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="up" title="Organizations & Admins" href="../organizations-admins.html"/>
+ <link rel="next" title="Collections" href="collections.html"/>
+ <link rel="prev" title="Roles & Permissions" href="roles-and-permissions.html"/>
+
+
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+ <a href="../index.html" class="fa fa-home"> Apache Usergrid</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">
+
+
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../deploy-local.html">Deploying to local Tomcat & Cassandra</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#example-usergrid-deployment-properties-file">Example usergrid-deployment.properties file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-up-and-running-locally.html">Getting Up & Running Locally</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1 current"><a class="reference internal" href="../organizations-admins.html">Organizations & Admins</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="applications.html">Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="events-and-counters.html">Events and counters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="roles-and-permissions.html">Roles & Permissions</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Relationships</a></li>
+<li class="toctree-l2"><a class="reference internal" href="collections.html">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="query-language.html">Query Language</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users-devices.html">Users & Devices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="groups.html">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="activity.html">Activity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="assets.html">Assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../presentations-and-videos.html">Presentations & Videos</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/presentations.html">Presentations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/videos.html">Videos</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading from Previous Versions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contribute-code.html">How to Contribute Code & Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#code-contributions">Code Contributions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#website-and-documentation-contributions">Website and Documentation Contributions</a></li>
+</ul>
+</li>
+</ul>
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</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="../organizations-admins.html">Organizations & Admins</a> »</li>
+
+ <li>Relationships</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/concepts/relationships.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document">
+
+ <div class="section" id="relationships">
+<h1>Relationships<a class="headerlink" href="#relationships" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="creating-connections-between-entities">
+<h2>Creating connections between entities<a class="headerlink" href="#creating-connections-between-entities" title="Permalink to this headline">¶</a></h2>
+<p>One of the most useful features of App services is the ability to create
+connections between entities. A simple example of this is the
+Twitter-like use of <em>following</em>, where one user forms a connection with
+another by subscribing to any tweets they post. <a class="reference external" href="/messagee-example">Messagee
+Example</a> walks you through an example of following
+other users in our sample app, <em>Messagee</em>. Here is the basic format:</p>
+<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/my-org/my-app/users/fred/following/users/barney
+</pre></div>
+</div>
+<p>This API call results in two users, Fred and Barney, linked with a
+connection where Fred is following Barney.</p>
+<p>If you create a <em>following</em> connection between two users, Apache
+Usergrid automatically creates a virtual connection called <em>followers</em>
+that mirrors the <em>following</em> connection. In other words, if you create a
+connection where Fred is following Barney, Apache Usergrid automatically
+creates a virtual connection where Fred is a follower of Barney.</p>
+<p>Note that there is no mirror connection established. Apache Usergrid
+only creates a mirror connection when you create a <em>following</em>
+connection. It does not create a mirror connection for other verbs such
+as likes.</p>
+<p>You can see all the users that Fred is following, in this case only
+Barney, by making the following API call:</p>
+<div class="highlight-python"><div class="highlight"><pre>GET https://api.usergrid.com/my-org/my-app/users/fred/following
+</pre></div>
+</div>
+<p>You can see all of barneyâs followers, in this case only Fred, by making
+the following API call:</p>
+<div class="highlight-python"><div class="highlight"><pre>GET https://api.usergrid.com/my-org/my-app/users/barney/followers
+</pre></div>
+</div>
+<p>The <em>followers</em> connection is a virtual connection because you canât use
+it to link two entities. In other words, you canât make fred a follower
+of barney by using a <em>followers</em> connection. <strong>This is wrong:</strong></p>
+<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/my-org/my-app/users/barney/followers/users/fred
+</pre></div>
+</div>
+<p>To create a <em>following</em> connection with the users switched, so that
+Barney is following Fred, do this:</p>
+<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/my-org/my-app/users/barney/following/users/fred
+</pre></div>
+</div>
+<p>You can now see Fredâs followers (only Barney) by making the following
+call:</p>
+<div class="highlight-python"><div class="highlight"><pre>GET https://api.usergrid.com/my-org/my-app/users/fred/followers
+</pre></div>
+</div>
+</div>
+<div class="section" id="creating-other-connections">
+<h2>Creating other connections<a class="headerlink" href="#creating-other-connections" title="Permalink to this headline">¶</a></h2>
+<p>You can extend this connection structure to create connections using any
+“verb” that can link two entities. For example, you could use likes to
+denote a connection between a user and his dog. First, create a dogs
+collection:</p>
+<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/my-org/my-app/dogs
+</pre></div>
+</div>
+<p>Then populate this collection with a new dog named Dino:</p>
+<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/my-org/my-app/dogs {"name" : "dino"}
+</pre></div>
+</div>
+<p>Then create a likes connection between Fred and his dog Dino:</p>
+<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/my-org/my-app/users/fred/likes/dogs/dino
+</pre></div>
+</div>
+</div>
+<div class="section" id="getting-connections">
+<h2>Getting connections<a class="headerlink" href="#getting-connections" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="get-all-connections-for-an-entity">
+<h3>Get all connections for an entity<a class="headerlink" href="#get-all-connections-for-an-entity" title="Permalink to this headline">¶</a></h3>
+<p>To get a list that only contains the connections, do a GET on the
+connections sub-property of the entity:</p>
+<div class="highlight-python"><div class="highlight"><pre>GET https://api.usergrid.com/my-org/my-app/users/fred/connections
+</pre></div>
+</div>
+</div>
+<div class="section" id="get-information-on-a-specific-connection-type">
+<h3>Get information on a specific connection type<a class="headerlink" href="#get-information-on-a-specific-connection-type" title="Permalink to this headline">¶</a></h3>
+<p>To get a list of users who like Fred:</p>
+<div class="highlight-python"><div class="highlight"><pre>GET https://api.usergrid.com/my-org/my-app/users/fred/connecting/likes
+</pre></div>
+</div>
+<p>To get a list of all dogs that Fred likes:</p>
+<div class="highlight-python"><div class="highlight"><pre>GET https://api.usergrid.com/my-org/my-app/users/fred/likes/dog
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="deleting-a-connection">
+<h2>Deleting a connection<a class="headerlink" href="#deleting-a-connection" title="Permalink to this headline">¶</a></h2>
+<p>You can delete a connection in a way similar to creating one. Just
+replace the POST method with the DELETE method. For example, you can
+delete the connection between fred and barney with the following API
+call:</p>
+<div class="highlight-python"><div class="highlight"><pre>DELETE https://api.usergrid.com/my-org/my-app/users/fred/following/barney
+</pre></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="collections.html" class="btn btn-neutral float-right" title="Collections">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="roles-and-permissions.html" class="btn btn-neutral" title="Roles & Permissions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2014, Apache Usergrid.
+ </p>
+ </div>
+
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </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/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/documents/concepts/roles-and-permissions.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/documents/concepts/roles-and-permissions.html?rev=1633650&view=auto
==============================================================================
--- incubator/usergrid/site/publish/documents/concepts/roles-and-permissions.html (added)
+++ incubator/usergrid/site/publish/documents/concepts/roles-and-permissions.html Wed Oct 22 16:47:12 2014
@@ -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>Roles & Permissions — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="up" title="Organizations & Admins" href="../organizations-admins.html"/>
+ <link rel="next" title="Relationships" href="relationships.html"/>
+ <link rel="prev" title="Events and counters" href="events-and-counters.html"/>
+
+
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+ <a href="../index.html" class="fa fa-home"> Apache Usergrid</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">
+
+
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../deploy-local.html">Deploying to local Tomcat & Cassandra</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#example-usergrid-deployment-properties-file">Example usergrid-deployment.properties file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-up-and-running-locally.html">Getting Up & Running Locally</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1 current"><a class="reference internal" href="../organizations-admins.html">Organizations & Admins</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="applications.html">Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="events-and-counters.html">Events and counters</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Roles & Permissions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="relationships.html">Relationships</a></li>
+<li class="toctree-l2"><a class="reference internal" href="collections.html">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="query-language.html">Query Language</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users-devices.html">Users & Devices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="groups.html">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="activity.html">Activity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="assets.html">Assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../presentations-and-videos.html">Presentations & Videos</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/presentations.html">Presentations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/videos.html">Videos</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading from Previous Versions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contribute-code.html">How to Contribute Code & Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#code-contributions">Code Contributions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#website-and-documentation-contributions">Website and Documentation Contributions</a></li>
+</ul>
+</li>
+</ul>
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</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="../organizations-admins.html">Organizations & Admins</a> »</li>
+
+ <li>Roles & Permissions</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/concepts/roles-and-permissions.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document">
+
+ <div class="section" id="roles-permissions">
+<h1>Roles & Permissions<a class="headerlink" href="#roles-permissions" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="roles">
+<h2>Roles<a class="headerlink" href="#roles" title="Permalink to this headline">¶</a></h2>
+<p>A role represents a set of permissions that enable certain operations to
+be performed on a specific endpoint. You can assign a user to a role,
+and in this way give the user the permissions associated with that role.</p>
+<p><strong>Note:</strong> The /rolenames endpoint is no longer valid. If your code
+currently makes calls to /rolenames, you need to change the calls to use
+/roles.</p>
+</div>
+<div class="section" id="permissions">
+<h2>Permissions<a class="headerlink" href="#permissions" title="Permalink to this headline">¶</a></h2>
+<p>Each role contains multiple permissions. Permissions work by
+whitelisting by default, meaning any permission that is not explicitely
+granted is denied by default. Permission is an HTTP verb (GET to allow
+reads, POST to allow creation, PUT to allow edits and DELETE to allow
+deletes) combined with a path, with optional wildcards. For example the
+permission put:/users/* allows editing any user.</p>
+<p>Permissions can be added to roles, groups or to users directly, and a
+userâs permission is the combination of its personal permissions and the
+permissions of any role heâs been assigned, and the permissions of any
+group heâs a member of.</p>
+<p>Permissions are only valid within the scope of a single application, so
+the permission paths do not need to be prefixed with
+/org_name_or_uuid/app_name_or_uuid.</p>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="relationships.html" class="btn btn-neutral float-right" title="Relationships">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="events-and-counters.html" class="btn btn-neutral" title="Events and counters"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2014, Apache Usergrid.
+ </p>
+ </div>
+
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </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/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/documents/concepts/users-devices.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/documents/concepts/users-devices.html?rev=1633650&view=auto
==============================================================================
--- incubator/usergrid/site/publish/documents/concepts/users-devices.html (added)
+++ incubator/usergrid/site/publish/documents/concepts/users-devices.html Wed Oct 22 16:47:12 2014
@@ -0,0 +1,471 @@
+
+
+<!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>Users & Devices — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="up" title="Organizations & Admins" href="../organizations-admins.html"/>
+ <link rel="next" title="Groups" href="groups.html"/>
+ <link rel="prev" title="Query Language" href="query-language.html"/>
+
+
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+ <a href="../index.html" class="fa fa-home"> Apache Usergrid</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">
+
+
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../deploy-local.html">Deploying to local Tomcat & Cassandra</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#example-usergrid-deployment-properties-file">Example usergrid-deployment.properties file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-up-and-running-locally.html">Getting Up & Running Locally</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1 current"><a class="reference internal" href="../organizations-admins.html">Organizations & Admins</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="applications.html">Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="events-and-counters.html">Events and counters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="roles-and-permissions.html">Roles & Permissions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="relationships.html">Relationships</a></li>
+<li class="toctree-l2"><a class="reference internal" href="collections.html">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="query-language.html">Query Language</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Users & Devices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="groups.html">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="activity.html">Activity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="assets.html">Assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../presentations-and-videos.html">Presentations & Videos</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/presentations.html">Presentations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/videos.html">Videos</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading from Previous Versions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contribute-code.html">How to Contribute Code & Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#code-contributions">Code Contributions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#website-and-documentation-contributions">Website and Documentation Contributions</a></li>
+</ul>
+</li>
+</ul>
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</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="../organizations-admins.html">Organizations & Admins</a> »</li>
+
+ <li>Users & Devices</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/concepts/users-devices.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document">
+
+ <div class="section" id="users-devices">
+<h1>Users & Devices<a class="headerlink" href="#users-devices" title="Permalink to this headline">¶</a></h1>
+<p>Users and Devices are the primary ways to identify access to the system.
+Devices are great to track anonymous access, while Users allow you to
+model signing up, signing in, etc.</p>
+<div class="section" id="users">
+<h2>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="properties">
+<h3>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h3>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="10%" />
+<col width="77%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Property</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>uuid</td>
+<td>UUID</td>
+<td>Userâs unique entity ID</td>
+</tr>
+<tr class="row-odd"><td>type</td>
+<td>string</td>
+<td>Type of entity, in this case âuserâ</td>
+</tr>
+<tr class="row-even"><td>created</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity creation</td>
+</tr>
+<tr class="row-odd"><td>modified</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity modification</td>
+</tr>
+<tr class="row-even"><td>username</td>
+<td>string</td>
+<td>Valid and unique string username (mandatory)</td>
+</tr>
+<tr class="row-odd"><td>password</td>
+<td>string</td>
+<td>User password</td>
+</tr>
+<tr class="row-even"><td>email</td>
+<td>string</td>
+<td>Valid and unique email address</td>
+</tr>
+<tr class="row-odd"><td>name</td>
+<td>string</td>
+<td>User display name</td>
+</tr>
+<tr class="row-even"><td>activated</td>
+<td>boolean</td>
+<td>Whether the user account is activated</td>
+</tr>
+<tr class="row-odd"><td>disabled</td>
+<td>boolean</td>
+<td>Whether the user account is administratively disabled</td>
+</tr>
+<tr class="row-even"><td>firstname</td>
+<td>string</td>
+<td>User first name</td>
+</tr>
+<tr class="row-odd"><td>middlename</td>
+<td>string</td>
+<td>User middle name</td>
+</tr>
+<tr class="row-even"><td>lastname</td>
+<td>string</td>
+<td>User last name</td>
+</tr>
+<tr class="row-odd"><td>picture</td>
+<td>string</td>
+<td>User picture</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="sets">
+<h3>Sets<a class="headerlink" href="#sets" title="Permalink to this headline">¶</a></h3>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Set</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>connections</td>
+<td>string</td>
+<td>Set of connection types (e.g., likes)</td>
+</tr>
+<tr class="row-odd"><td>rolenames</td>
+<td>string</td>
+<td>Set of roles assigned to a user</td>
+</tr>
+<tr class="row-even"><td>permissions</td>
+<td>string</td>
+<td>Set of user permissions</td>
+</tr>
+<tr class="row-odd"><td>credentials</td>
+<td>string</td>
+<td>Set of user credentials</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="relationshops">
+<h3>Relationshops<a class="headerlink" href="#relationshops" title="Permalink to this headline">¶</a></h3>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Collection</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>groups</td>
+<td>group</td>
+<td>Collection of groups to which a user belongs</td>
+</tr>
+<tr class="row-odd"><td>devices</td>
+<td>device</td>
+<td>Collection of devices in the service</td>
+</tr>
+<tr class="row-even"><td>activities</td>
+<td>activity</td>
+<td>Collection of activities a user has performed</td>
+</tr>
+<tr class="row-odd"><td>feed</td>
+<td>activity</td>
+<td>Inbox of activity notifications a user has received</td>
+</tr>
+<tr class="row-even"><td>roles</td>
+<td>role</td>
+<td>Set of roles assigned to a user</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="facebook-sign-in">
+<h3>Facebook Sign-in<a class="headerlink" href="#facebook-sign-in" title="Permalink to this headline">¶</a></h3>
+<p>You can authenticate your Apache Usergrid requests by logging into
+Facebook. To access Apache Usergrid resources, you need to provide an
+access token with each request (unless you use the sandbox app). You can
+get an access token by connecting to an appropriate web service endpoint
+and providing the correct client credentials â this is further described
+in <a class="reference external" href="/authenticating-users-and-application-clients">Authenticating users and application
+clients</a>. However, you
+can also obtain an access token by logging into Facebook.</p>
+<p>To enable authentication to Apache Usergrid through Facebook, do the
+following in your app:</p>
+<ol class="arabic">
+<li><p class="first">Make a login call to the Facebook API (do this using the <a class="reference external" href="https://developers.facebook.com/docs/sdks/">Facebook
+SDK</a> or
+<a class="reference external" href="https://developers.facebook.com/docs/facebook-login/">API</a>). If
+the login succeeds, a Facebook access token is returned.</p>
+</li>
+<li><p class="first">Send the Facebook access token to Apache Usergrid. If the Facebook
+access token is valid and the user does not already exist in App
+Services, Apache Usergrid provisions a new Apache Usergrid user. It
+also returns an Apache Usergrid access token, which you can use for
+subsequent Apache Usergrid API calls. Behind the scenes, Apache
+Usergrid uses the Facebook access token to retrieve the user’s
+profile information from Facebook.</p>
+<p>If the Facebook access token is invalid, Facebook returns an OAuth
+authentication error, and the login does not succeed.</p>
+</li>
+</ol>
+<p>The request to authenticate to Apache Usergrid using a Facebook access
+token is:</p>
+<div class="highlight-python"><div class="highlight"><pre>GET https://api.usergrid.com/{my_org}/{my_app}/auth/facebook?fb_access_token={fb_access_token}
+</pre></div>
+</div>
+<p>where:</p>
+<ul class="simple">
+<li>{my_org} is the organization UUID or organization name.</li>
+<li>{my_app} is the application UUID or application name.</li>
+<li>{fb_access_token} is the Facebook access token.</li>
+</ul>
+</div>
+</div>
+<div class="section" id="devices">
+<h2>Devices<a class="headerlink" href="#devices" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="id1">
+<h3>Properties<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="9%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Property</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>uuid</td>
+<td>UUID</td>
+<td>Entity unique ID</td>
+</tr>
+<tr class="row-odd"><td>type</td>
+<td>string</td>
+<td>Entity type (e.g., device)</td>
+</tr>
+<tr class="row-even"><td>created</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity creation</td>
+</tr>
+<tr class="row-odd"><td>modified</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity modification</td>
+</tr>
+<tr class="row-even"><td>name</td>
+<td>string</td>
+<td>Device name (mandatory)</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="relationships">
+<h3>Relationships<a class="headerlink" href="#relationships" title="Permalink to this headline">¶</a></h3>
+<p>Devices have the following associated collection.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="11%" />
+<col width="69%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Collection</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>users</td>
+<td>user</td>
+<td>Collection of users to which a device belongs</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="groups.html" class="btn btn-neutral float-right" title="Groups">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="query-language.html" class="btn btn-neutral" title="Query Language"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2014, Apache Usergrid.
+ </p>
+ </div>
+
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </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/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file