Integrate Hue with Relational Databases

There are two options for integrating Hue with relational databases:

• SQLAlchemy interpreter interface (recommended)
• RDBMS Hue application (legacy)

The Hue UI can be integrated to browse and query the following databases:

• MySQL/MariaDB (supported only with the SQLAlchemy interface)
• Oracle
• PostgreSQL
• SQLite

Here is an example of integrating the Hue UI with MySQL / MariaDB:

[notebook] 
# ... 
[[interpreters]] 
# ... 
[[[mysql]]] 
  name = MySQL 
  interface=sqlalchemy 
  ## https://docs.sqlalchemy.org/en/latest/dialects/mysql.html 
  options='{"url": "mysql+mysqlconnector://root:secret@database:3306/hue"}' 

For information about SQLAlchemy MySQL/MariaDB connector options, see the following article:

[notebook] 
# ... 
[[interpreters]] 
# ... 
[[[oracle]]] 
  name = Oracle 
  interface=sqlalchemy 
  options='{"url": "oracle://hue:hue@host:1521/hue"}' 

Here is an example of integrating the Hue UI with PostgreSQL:

[notebook]
# ...
[[interpreters]]
# ...
[[[postgresql]]]
 name = PostgreSQL
 interface=sqlalchemy
 options='{"url": "postgresql://hue:hue@host:5432/hue"}'

Here's an example of integrating the Hue UI with SQLite:

[notebook] 
# … 
[[interpreters]] 
# … 
[[[sqlite]]] 
  name = SQLite 
  interface=sqlalchemy 
  options='{"url": "sqlite:///relative/path/to/database/file.db"}' 
  # options='{"url": "sqlite:////absolute/path/to/database/file.db"}' 

Beginning with Hue 4.11:

• The following method is obsolete.
• MySQL integration is not supported in the RDBMS Hue application.

To configure access to a relational database server through the Hue RDBMS application, you need to add your database configuration as an entry in the [librdbms][[databases]] section of hue.ini. You also need to add a corresponding entry to the [notebook][[interpreters]] section with the same section name and the interface parameter set to rdbms.

Table 1. Available Parameters for librdbms Entries

Parameter	Used for SQLite?	Value
nice_name	Yes	The nice_name of the current configuration entry.
engine	No	The database back end to use. Available values are: oracle postgresql sqlite
host	No	The IP or hostname of the database server to connect to.
port	No	The ports that the database server is listening to. The default ports are: PostgreSQL:5432 Oracle Express Edition:1521
name	Yes	The database name to connect to. Leave this property empty if you do not want to connect to a specific database on your database server. For SQLite, this is the path to the database file.
user	No	The user name to authenticate with when connecting to the database server.
password	No	The password for the user name that you will authenticate with when connecting to the database server.
password_script	No	As an alternative to specifying the password explicitly in the hue.ini, you can use the password_script parameter to specify the path to the executable file that will be invoked by Hue to read the password.
options	Yes	For additional options to send to the database server when connecting, see this page: https://docs.djangoproject.com/en/1.11/ref/databases/

Here is an example of integrating the Hue UI with Oracle:

[librdbms] 
# ... 
[[databases]] 
# ... 
[[[oracle]]] 
nice_name="Oracle DB" 
name=example_database 
engine=oracle 
host=example.host 
port=1521 
user=example_user 
password=example_password 

# ... 
[notebook] 
# ... 
[[interpreters]] 
# ... 
[[[oracle]]] 
  name = Oracle 
  interface=rdbms 

Here is an example of integrating the Hue UI with PostgreSQL:

[librdbms] 
# ... 
[[databases]] 
# ... 
[[[postgresql]]] 
nice_name="PostgreSQL DB" 
name=mysqldb 
engine=postgresql 
host=example.host 
port=5432 
user=example_user 
password=example_password 
  
# ... 
[notebook] 
# ... 
[[interpreters]] 
# ... 
[[[postgresql]]] 
  name = PostgreSQL 
  interface=rdbms 

Here is an example of integrating the Hue UI with SQLite:

[librdbms] 
# ... 
[[databases]] 
# ... 
[[[sqlite]]] 
nice_name=SQLite 
name=/path/to/sqlite.db 
engine=sqlite 
  
# ... 
[notebook] 
# ... 
[[interpreters]] 
# ... 
[[[sqlite]]] 
  name = sqlite 
  interface=rdbms