Latest docs

_sources/faq.txt

@@ -32,3 +32,14 @@ It can be gigantic! As mentioned above, the main criteria is whether your
 database can execute queries and return results in a time frame that is
 acceptable to your users. Many distributed databases out there can execute
 queries that scan through terabytes in an interactive fashion.
+
+
+How do I create my own visualization?
+-------------------------------------
+
+We are planning on making it easier to add new visualizations to the
+framework, in the meantime, we've tagged a few pull requests as
+``example`` to give people examples of how to contribute new
+visualizations.
+
+https://github.com/airbnb/caravel/issues?q=label%3Aexample+is%3Aclosed

_sources/gallery.txt

@@ -76,3 +76,8 @@ Gallery
 .. image:: _static/img/viz_thumbnails/horizon.png
    :scale: 25 %
 
+.. image:: _static/img/viz_thumbnails/mapbox.png
+   :scale: 25 %
+
+.. image:: _static/img/viz_thumbnails/separator.png
+   :scale: 25 %

_sources/installation.txt

@@ -68,8 +68,11 @@ Follow these few simple steps to install Caravel.::
     # Load some data to play with
     caravel load_examples
 
-    # Start the development web server
-    caravel runserver -d
+    # Start the web server on port 8088
+    caravel runserver -p 8088
+
+    # To start a development web server, use the -d switch
+    # caravel runserver -d
 
 
 After installation, you should be able to point your browser to the right
@@ -79,6 +82,15 @@ the credential you entered while creating the admin account, and navigate to
 your datasources for Caravel to be aware of, and they should show up in
 `Menu -> Datasources`, from where you can start playing with your data!
 
+Configuration behind a load balancer
+------------------------------------
+
+If you are running caravel behind a load balancer or reverse proxy (e.g. NGINX
+or ELB on AWS), you may need to utilise a healthcheck endpoint so that your
+load balancer knows if your caravel instance is running. This is provided
+at ``/health`` which will return a 200 response containing "OK" if the
+webserver is running.
+
 
 Configuration
 -------------
@@ -146,6 +158,8 @@ Here's a list of some of the recommended packages.
 +---------------+-------------------------------------+-------------------------------------------------+
 |  MSSQL        | ``pip install pymssql``             | ``mssql://``                                    |
 +---------------+-------------------------------------+-------------------------------------------------+
+|  Impala       | ``pip install impyla``              | ``impala://``                                   |
++---------------+-------------------------------------+-------------------------------------------------+
 
 Note that many other database are supported, the main criteria being the
 existence of a functional SqlAlchemy dialect and Python driver. Googling

faq.html

@@ -90,6 +90,7 @@
 <li><a class="reference internal" href="#">FAQ</a><ul>
 <li><a class="reference internal" href="#can-i-query-join-multiple-tables-at-one-time">Can I query/join multiple tables at one time?</a></li>
 <li><a class="reference internal" href="#how-big-can-my-data-source-be">How BIG can my data source be?</a></li>
+<li><a class="reference internal" href="#how-do-i-create-my-own-visualization">How do I create my own visualization?</a></li>
 </ul>
 </li>
 </ul>
@@ -150,6 +151,14 @@ database can execute queries and return results in a time frame that is
 acceptable to your users. Many distributed databases out there can execute
 queries that scan through terabytes in an interactive fashion.</p>
 </div>
+<div class="section" id="how-do-i-create-my-own-visualization">
+<h2>How do I create my own visualization?<a class="headerlink" href="#how-do-i-create-my-own-visualization" title="Permalink to this headline">¶</a></h2>
+<p>We are planning on making it easier to add new visualizations to the
+framework, in the meantime, we&#8217;ve tagged a few pull requests as
+<code class="docutils literal"><span class="pre">example</span></code> to give people examples of how to contribute new
+visualizations.</p>
+<p><a class="reference external" href="https://github.com/airbnb/caravel/issues?q=label%3Aexample+is%3Aclosed">https://github.com/airbnb/caravel/issues?q=label%3Aexample+is%3Aclosed</a></p>
+</div>
 </div>
 
 

gallery.html

@@ -146,6 +146,8 @@
 <a class="reference internal image-reference" href="_images/treemap.png"><img alt="_images/treemap.png" src="_images/treemap.png" style="width: 256.0px; height: 256.0px;" /></a>
 <a class="reference internal image-reference" href="_images/cal_heatmap.png"><img alt="_images/cal_heatmap.png" src="_images/cal_heatmap.png" style="width: 187.75px; height: 187.75px;" /></a>
 <a class="reference internal image-reference" href="_images/horizon.png"><img alt="_images/horizon.png" src="_images/horizon.png" style="width: 199.5px; height: 174.0px;" /></a>
+<a class="reference internal image-reference" href="_static/img/viz_thumbnails/mapbox.png"><img alt="_static/img/viz_thumbnails/mapbox.png" src="_static/img/viz_thumbnails/mapbox.png" /></a>
+<a class="reference internal image-reference" href="_static/img/viz_thumbnails/separator.png"><img alt="_static/img/viz_thumbnails/separator.png" src="_static/img/viz_thumbnails/separator.png" /></a>
 </div>
 
 

index.html

@@ -242,6 +242,7 @@ to the user</li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#getting-started">Getting Started</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#os-dependencies">OS dependencies</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#caravel-installation-and-initialization">Caravel installation and initialization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#configuration-behind-a-load-balancer">Configuration behind a load balancer</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#configuration">Configuration</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#database-dependencies">Database dependencies</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#caching">Caching</a></li>
@@ -280,6 +281,7 @@ to the user</li>
 <li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="faq.html#can-i-query-join-multiple-tables-at-one-time">Can I query/join multiple tables at one time?</a></li>
 <li class="toctree-l2"><a class="reference internal" href="faq.html#how-big-can-my-data-source-be">How BIG can my data source be?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-create-my-own-visualization">How do I create my own visualization?</a></li>
 </ul>
 </li>
 </ul>

installation.html

@@ -92,6 +92,7 @@
 <li><a class="reference internal" href="#getting-started">Getting Started</a></li>
 <li><a class="reference internal" href="#os-dependencies">OS dependencies</a></li>
 <li><a class="reference internal" href="#caravel-installation-and-initialization">Caravel installation and initialization</a></li>
+<li><a class="reference internal" href="#configuration-behind-a-load-balancer">Configuration behind a load balancer</a></li>
 <li><a class="reference internal" href="#configuration">Configuration</a></li>
 <li><a class="reference internal" href="#database-dependencies">Database dependencies</a></li>
 <li><a class="reference internal" href="#caching">Caching</a></li>
@@ -195,8 +196,11 @@ attempt it, download <a class="reference external" href="https://bootstrap.pypa.
 <span class="c1"># Load some data to play with</span>
 <span class="n">caravel</span> <span class="n">load_examples</span>
 
-<span class="c1"># Start the development web server</span>
-<span class="n">caravel</span> <span class="n">runserver</span> <span class="o">-</span><span class="n">d</span>
+<span class="c1"># Start the web server on port 8088</span>
+<span class="n">caravel</span> <span class="n">runserver</span> <span class="o">-</span><span class="n">p</span> <span class="mi">8088</span>
+
+<span class="c1"># To start a development web server, use the -d switch</span>
+<span class="c1"># caravel runserver -d</span>
 </pre></div>
 </div>
 <p>After installation, you should be able to point your browser to the right
@@ -206,6 +210,14 @@ the credential you entered while creating the admin account, and navigate to
 your datasources for Caravel to be aware of, and they should show up in
 <cite>Menu -&gt; Datasources</cite>, from where you can start playing with your data!</p>
 </div>
+<div class="section" id="configuration-behind-a-load-balancer">
+<h2>Configuration behind a load balancer<a class="headerlink" href="#configuration-behind-a-load-balancer" title="Permalink to this headline">¶</a></h2>
+<p>If you are running caravel behind a load balancer or reverse proxy (e.g. NGINX
+or ELB on AWS), you may need to utilise a healthcheck endpoint so that your
+load balancer knows if your caravel instance is running. This is provided
+at <code class="docutils literal"><span class="pre">/health</span></code> which will return a 200 response containing &#8220;OK&#8221; if the
+webserver is running.</p>
+</div>
 <div class="section" id="configuration">
 <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
 <p>To configure your application, you need to create a file (module)
@@ -291,6 +303,10 @@ connect to the databases you want to access through Caravel.</p>
 <td><code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">pymssql</span></code></td>
 <td><code class="docutils literal"><span class="pre">mssql://</span></code></td>
 </tr>
+<tr class="row-odd"><td>Impala</td>
+<td><code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">impyla</span></code></td>
+<td><code class="docutils literal"><span class="pre">impala://</span></code></td>
+</tr>
 </tbody>
 </table>
 <p>Note that many other database are supported, the main criteria being the