Skip to content

faq: document database engine for caravel backend options #1470

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
xrmx wants to merge 1 commit into from
Closed

faq: document database engine for caravel backend options #1470

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,27 @@ for dealing with the time boundary filtering mentioned above.
But what happens with filtering when dealing with slices coming from
different tables or databases? If the column name is shared, the filter will
be applied, it's as simple as that.


On which database server can I install Caravel?
-----------------------------------------------

To clarify, the *database backend* is an OLTP database used by Caravel to store its
internal information like your list of users, slices and dashboard definitions.

Caravel is tested using Mysql, Postgresql and Sqlite for its backend. It's recommended
you install Caravel on one of these database server for production.

Using a column-store, non-OLTP databases like Vertica, Redshift or Presto as a database
backend simply won't work as these databases are not designed for this type of workload.
Installation on Oracle, Microsoft SQL Server, or other OLTP databases may work but isn't
tested.

Please note that pretty much any databases that have a SqlAlchemy integration
should work perfectly fine as a datasource for Caravel, just not as the OLTP backend.

Caravel is tested on Mysql, Postgresql and Sqlite. It's recommended you
install Caravel on one of these database server on production.

Installation may work on other databases though, at time of writing it does
not work on Oracle or Redshift.
Copy link
Member

@mistercrunch mistercrunch Oct 28, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some clarifications:

What database engine can I use as a backend for Caravel?
 --------------------------------------------------------

To clarify, the *database backend* is an OLTP database used by Caravel to store its internal
information like your list of users, slices and dashboard definitions.

 Caravel is tested using Mysql, Postgresql and Sqlite for its backend. It's recommended you
 install Caravel on one of these database server for production.

Using a column-store, non-OLTP databases like Vertica, Redshift or Presto as a database backend simply won't work as these databases are not designed for this type of workload. Installation on Oracle, Microsoft SQL Server, or other OLTP databases may work but isn't tested.

Please note that pretty much any databases that have a SqlAlchemy integration should work perfectly fine as a datasource for Caravel, just not as the OLTP backend.