Skip to content

Commit

Permalink
[docs] Reference to the Connector API from the config page
Browse files Browse the repository at this point in the history
  • Loading branch information
romainr committed Aug 19, 2021
1 parent fd7095b commit 93525b2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/docs-site/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Hue is a mature SQL Assistant for querying Databases & Data Warehouses.
use Hue to quickly answer questions via self-service querying and are executing 100s of 1000s of queries daily.

Read more on [gethue.com](http://gethue.com) and
- Connect to a [database](/administrator/configuration/connectors/)
- Build your own Editor with the [SQL Scratchpad](/developer/components/scratchpad/)
- connect to a [Database](/administrator/configuration/connectors/)
- build your own Editor with the [SQL Scratchpad](/developer/components/scratchpad/)
- or Query Service by leveraging the [REST API](/developer/api/rest/) and [Kubernetes](/administrator/installation/cloud/#kubernetes)

!["Hue Editor"](https://cdn.gethue.com/uploads/2021/02/hue-4.9.png)
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight: 2

### Config file

Hue connects to any database or warehouse via native or SqlAlchemy connectors that need to be added to the [Hue ini file](/administrator/configuration/). Except [impala] and [beeswax] which have a dedicated section, all the other ones should be appended below the [[interpreters]] of [notebook] e.g.:
Hue connects to any database or warehouse via native Thrift or SqlAlchemy connectors that need to be added to the [Hue ini file](/administrator/configuration/). Except [impala] and [beeswax] which have a dedicated section, all the other ones should be appended below the [[interpreters]] of [notebook] e.g.:

[notebook]
[[interpreters]]
Expand All @@ -30,23 +30,23 @@ Most of the interpreters require to install their SqlAlchemy dialect (e.g. `./bu

Read about [how to build your own parser](/developer/development/#sql-parsers) if you are looking at better autocompletes for your the SQL dialects you use.

### Connectors UI
### Connectors

Admins can configure the connectors via the UI. This feature requires Editor v2 and is functional despite requiring a bit more polishing.
Admins can configure the connectors via the UI or [API](/developer/api/rest/#connectors). This feature requires Editor v2 and is quite functional despite not being offically released and on by default.

[desktop]
enable_connectors=true

[notebook]
enable_notebook_2=true

**NOTE:** After enabling the above flags, if `django.db.utils.OperationalError: (1054, "Unknown column 'useradmin_huepermission.connector_id' in 'field list'")` error comes, then try **changing the DB name** in the hue.ini under `[[database]]` because there is no upgrade path and run the migrate command `./build/env/bin/hue migrate`.
**NOTE:** After enabling the above flags, if a `django.db.utils.OperationalError: (1054, "Unknown column 'useradmin_huepermission.connector_id' in 'field list'")` error comes, then try **changing the DB name** in the hue.ini under `[[database]]` because there is no upgrade path and run the migrate command `./build/env/bin/hue migrate`.

Go to `Administer Server` > `Connectors` > `+ Connector` or can directly navigate to `http://127.0.0.1:8000/hue/desktop/connectors`.
Go to `Administer Server` > `Connectors` > `+ Connector` or directly navigate to the page `http://127.0.0.1:8000/hue/desktop/connectors`.

!["Connectors"](https://cdn.gethue.com/uploads/2020/12/hue-connectors-create.png)

Connectors are also configurable via the public [REST APIs](/developer/api/rest/#connectors).
Connectors are also configurable via the public [REST API](/developer/api/rest/#connectors).

## Databases

Expand Down Expand Up @@ -180,7 +180,7 @@ Then give Hue the information about the database source following the `trino://{
interface=sqlalchemy
options='{"url": "trino://localhost:8080/tpch/default"}'

**Note**: keep `[[[presto]]]` if not using the [connectors](/administrator/configuration/connectors/#connectors-ui).
**Note**: keep `[[[presto]]]` if not using the [connectors](/administrator/configuration/connectors/#connectors).

With impersonation:

Expand Down

0 comments on commit 93525b2

Please sign in to comment.