You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ma...@apache.org on 2019/03/12 05:54:22 UTC
[incubator-superset-site] branch asf-site updated: Latest docs
This is an automated email from the ASF dual-hosted git repository.
maximebeauchemin pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-superset-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 62a8192 Latest docs
62a8192 is described below
commit 62a81920d0db4cd6914c7ead1721d1107e46ee4a
Author: Maxime Beauchemin <ma...@gmail.com>
AuthorDate: Mon Mar 11 22:54:04 2019 -0700
Latest docs
---
.buildinfo | 4 ++--
_sources/installation.rst.txt | 35 +++++++++++++++++++++++++++++++----
_sources/tutorial.rst.txt | 2 +-
index.html | 1 +
installation.html | 37 ++++++++++++++++++++++++++++++++++---
searchindex.js | 2 +-
tutorial.html | 2 +-
7 files changed, 71 insertions(+), 12 deletions(-)
diff --git a/.buildinfo b/.buildinfo
index 0885fbe..c0f5130 100644
--- a/.buildinfo
+++ b/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config:
-tags:
+config: aef1dd98ccac6c00170d15d9ca65cf37
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/installation.rst.txt b/_sources/installation.rst.txt
index f1a6d76..732342e 100644
--- a/_sources/installation.rst.txt
+++ b/_sources/installation.rst.txt
@@ -56,7 +56,14 @@ as needed.
Start with Docker
-----------------
-If you know docker, then you're lucky, we have shortcut road for you to
+.. note ::
+ The Docker-related files and documentation has been
+ community-contributed and
+ is not actively maintained and managed by the core committers working on
+ the project. Some issues have been reported as of 2019-01.
+ Help and contributions around Docker are welcomed!
+
+If you know docker, then you're lucky, we have shortcut road for you to
initialize development environment: ::
git clone https://github.com/apache/incubator-superset/
@@ -73,7 +80,7 @@ From there, the container server will reload on modification of the superset pyt
and javascript source code.
Don't forget to reload the page to take the new frontend into account though.
-See also `CONTRIBUTING.md <https://github.com/apache/incubator-superset/blob/master/CONTRIBUTING.md#webpack-dev-server>`_,
+See also `CONTRIBUTING.md#building <https://github.com/apache/incubator-superset/blob/master/CONTRIBUTING.md#building>`_,
for alternative way of serving the frontend.
It is also possible to run Superset in non-development mode: in the `docker-compose.yml` file remove
@@ -382,6 +389,9 @@ Here's a list of some of the recommended packages.
+---------------+-------------------------------------+-------------------------------------------------+
| Teradata | ``pip install sqlalchemy-teradata`` | ``teradata://`` |
+---------------+-------------------------------------+-------------------------------------------------+
+| Pinot | ``pip install pinotdb`` | ``pinot+http://controller:5436/`` |
+| | | ``query?server=http://controller:5983/`` |
++---------------+-------------------------------------+-------------------------------------------------+
Note that many other databases are supported, the main criteria being the
existence of a functional SqlAlchemy dialect and Python driver. Googling
@@ -405,6 +415,11 @@ You can also use `PyAthena` library(no java required) like this ::
See `PyAthena <https://github.com/laughingman7743/PyAthena#sqlalchemy>`_.
+MSSQL
+-----
+
+Full Unicode support requires SQLAlchemy 1.3 or later.
+
Snowflake
---------
@@ -581,7 +596,7 @@ next available socket. PR (`#5039 <https://github.com/apache/incubator-superset/
and this feature will be enabled by configuration only (by default Superset
doesn't allow cross-domain request).
-*``SUPERSET_WEBSERVER_DOMAINS``: list of allowed hostnames for domain sharding feature. default `None`
+* ``SUPERSET_WEBSERVER_DOMAINS``: list of allowed hostnames for domain sharding feature. default `None`
MIDDLEWARE
@@ -616,6 +631,18 @@ Upgrading should be as straightforward as running::
superset db upgrade
superset init
+We recommend to follow standard best practices when upgrading Superset, such
+as taking a database backup prior to the upgrade, upgrading a staging
+environment prior to upgrading production, and upgrading production while less
+users are active on the platform.
+
+.. note ::
+ Some upgrades may contain backward-incompatible changes, or require
+ scheduling downtime, when that is the case, contributors attach notes in
+ ``UPDATING.md`` in the repository. It's recommended to review this
+ file prior to running an upgrade.
+
+
Celery Tasks
------------
On large analytic databases, it's common to run background jobs, reports
@@ -791,7 +818,7 @@ Building from source
More advanced users may want to build Superset from sources. That
would be the case if you fork the project to add features specific to
-your environment. See `CONTRIBUTING.md <https://github.com/apache/incubator-superset/blob/master/CONTRIBUTING.md#local-development>`_.
+your environment. See `CONTRIBUTING.md#setup-local-environment-for-development <https://github.com/apache/incubator-superset/blob/master/CONTRIBUTING.md#setup-local-environment-for-development>`_.
Blueprints
----------
diff --git a/_sources/tutorial.rst.txt b/_sources/tutorial.rst.txt
index 9aa0c01..8273398 100644
--- a/_sources/tutorial.rst.txt
+++ b/_sources/tutorial.rst.txt
@@ -61,7 +61,7 @@ this walkthrough, you’ll only need to do **two things**:
This example shows the connection string for our test weather database.
As noted in the text below the URI, you should refer to the SQLAlchemy
documentation on
-`creating new connection URIs <http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html#database-urls>`_
+`creating new connection URIs <https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#database-urls>`_
for your target database.
Click the **Test Connection** button to confirm things work end to end.
diff --git a/index.html b/index.html
index 38ee5b9..dcdcab0 100644
--- a/index.html
+++ b/index.html
@@ -249,6 +249,7 @@ to the user</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#aws-athena">(AWS) Athena</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#mssql">MSSQL</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#snowflake">Snowflake</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#teradata">Teradata</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#caching">Caching</a></li>
diff --git a/installation.html b/installation.html
index cd58b11..221ed39 100644
--- a/installation.html
+++ b/installation.html
@@ -94,6 +94,7 @@
<li class="toctree-l2"><a class="reference internal" href="#configuration">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="#database-dependencies">Database dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="#aws-athena">(AWS) Athena</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#mssql">MSSQL</a></li>
<li class="toctree-l2"><a class="reference internal" href="#snowflake">Snowflake</a></li>
<li class="toctree-l2"><a class="reference internal" href="#teradata">Teradata</a></li>
<li class="toctree-l2"><a class="reference internal" href="#caching">Caching</a></li>
@@ -221,6 +222,14 @@ as needed.</p>
</div>
<div class="section" id="start-with-docker">
<h2>Start with Docker<a class="headerlink" href="#start-with-docker" title="Permalink to this headline">¶</a></h2>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The Docker-related files and documentation has been
+community-contributed and
+is not actively maintained and managed by the core committers working on
+the project. Some issues have been reported as of 2019-01.
+Help and contributions around Docker are welcomed!</p>
+</div>
<p>If you know docker, then you’re lucky, we have shortcut road for you to
initialize development environment:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">apache</span><span class="o">/</span><span class="n">incubator</span><span class="o">-</span><span class="n">superset</span><span class="o">/</span>
@@ -236,7 +245,7 @@ a browser and view <cite>http://localhost:8088</cite> to start your journey.</p>
<p>From there, the container server will reload on modification of the superset python
and javascript source code.
Don’t forget to reload the page to take the new frontend into account though.</p>
-<p>See also <a class="reference external" href="https://github.com/apache/incubator-superset/blob/master/CONTRIBUTING.md#webpack-dev-server">CONTRIBUTING.md</a>,
+<p>See also <a class="reference external" href="https://github.com/apache/incubator-superset/blob/master/CONTRIBUTING.md#building">CONTRIBUTING.md#building</a>,
for alternative way of serving the frontend.</p>
<p>It is also possible to run Superset in non-development mode: in the <cite>docker-compose.yml</cite> file remove
the volumes needed for development and change the variable <cite>SUPERSET_ENV</cite> to <cite>production</cite>.</p>
@@ -568,6 +577,11 @@ connect to the databases you want to access through Superset.</p>
<td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">sqlalchemy-teradata</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">teradata://</span></code></td>
</tr>
+<tr class="row-odd"><td>Pinot</td>
+<td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">pinotdb</span></code></td>
+<td><code class="docutils literal notranslate"><span class="pre">pinot+http://controller:5436/</span></code>
+<code class="docutils literal notranslate"><span class="pre">query?server=http://controller:5983/</span></code></td>
+</tr>
</tbody>
</table>
<p>Note that many other databases are supported, the main criteria being the
@@ -591,6 +605,10 @@ database you want to connect to should get you to the right place.</p>
</div>
<p>See <a class="reference external" href="https://github.com/laughingman7743/PyAthena#sqlalchemy">PyAthena</a>.</p>
</div>
+<div class="section" id="mssql">
+<h2>MSSQL<a class="headerlink" href="#mssql" title="Permalink to this headline">¶</a></h2>
+<p>Full Unicode support requires SQLAlchemy 1.3 or later.</p>
+</div>
<div class="section" id="snowflake">
<h2>Snowflake<a class="headerlink" href="#snowflake" title="Permalink to this headline">¶</a></h2>
<p>The connection string for Snowflake looks like this</p>
@@ -740,7 +758,9 @@ than 6 slices in dashboard, a lot of time fetch requests are queued up and wait
next available socket. PR (<cite>#5039 <https://github.com/apache/incubator-superset/pull/5039></cite>) adds domain sharding to Superset,
and this feature will be enabled by configuration only (by default Superset
doesn’t allow cross-domain request).</p>
-<p><a href="#id1"><span class="problematic" id="id2">*</span></a><code class="docutils literal notranslate"><span class="pre">SUPERSET_WEBSERVER_DOMAINS</span></code>: list of allowed hostnames for domain sharding feature. default <cite>None</cite></p>
+<ul class="simple">
+<li><code class="docutils literal notranslate"><span class="pre">SUPERSET_WEBSERVER_DOMAINS</span></code>: list of allowed hostnames for domain sharding feature. default <cite>None</cite></li>
+</ul>
</div>
<div class="section" id="middleware">
<h2>MIDDLEWARE<a class="headerlink" href="#middleware" title="Permalink to this headline">¶</a></h2>
@@ -770,6 +790,17 @@ environment variable:</p>
<span class="n">superset</span> <span class="n">init</span>
</pre></div>
</div>
+<p>We recommend to follow standard best practices when upgrading Superset, such
+as taking a database backup prior to the upgrade, upgrading a staging
+environment prior to upgrading production, and upgrading production while less
+users are active on the platform.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Some upgrades may contain backward-incompatible changes, or require
+scheduling downtime, when that is the case, contributors attach notes in
+<code class="docutils literal notranslate"><span class="pre">UPDATING.md</span></code> in the repository. It’s recommended to review this
+file prior to running an upgrade.</p>
+</div>
</div>
<div class="section" id="celery-tasks">
<h2>Celery Tasks<a class="headerlink" href="#celery-tasks" title="Permalink to this headline">¶</a></h2>
@@ -947,7 +978,7 @@ install from pip:</p>
<h2>Building from source<a class="headerlink" href="#building-from-source" title="Permalink to this headline">¶</a></h2>
<p>More advanced users may want to build Superset from sources. That
would be the case if you fork the project to add features specific to
-your environment. See <a class="reference external" href="https://github.com/apache/incubator-superset/blob/master/CONTRIBUTING.md#local-development">CONTRIBUTING.md</a>.</p>
+your environment. See <a class="reference external" href="https://github.com/apache/incubator-superset/blob/master/CONTRIBUTING.md#setup-local-environment-for-development">CONTRIBUTING.md#setup-local-environment-for-development</a>.</p>
</div>
<div class="section" id="blueprints">
<h2>Blueprints<a class="headerlink" href="#blueprints" title="Permalink to this headline">¶</a></h2>
diff --git a/searchindex.js b/searchindex.js
index 41f6ba4..9eda96a 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["druid","faq","gallery","import_export_datasources","index","installation","misc","security","sqllab","tutorial","videos","visualization"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":1,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["druid.rst","faq.rst","gallery.rst","import_export_datasources.rst"," [...]
\ No newline at end of file
+Search.setIndex({docnames:["druid","faq","gallery","import_export_datasources","index","installation","misc","security","sqllab","tutorial","videos","visualization"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":1,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["druid.rst","faq.rst","gallery.rst","import_export_datasources.rst"," [...]
\ No newline at end of file
diff --git a/tutorial.html b/tutorial.html
index ff6f2b4..130c818 100644
--- a/tutorial.html
+++ b/tutorial.html
@@ -189,7 +189,7 @@ this walkthrough, you’ll only need to do <strong>two things</strong>:</p>
<p>This example shows the connection string for our test weather database.
As noted in the text below the URI, you should refer to the SQLAlchemy
documentation on
-<a class="reference external" href="http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html#database-urls">creating new connection URIs</a>
+<a class="reference external" href="https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#database-urls">creating new connection URIs</a>
for your target database.</p>
<p>Click the <strong>Test Connection</strong> button to confirm things work end to end.
Once Superset can successfully connect and authenticate, you should see