-
Notifications
You must be signed in to change notification settings - Fork 14.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'apache:master' into srini/add_redirects
- Loading branch information
Showing
258 changed files
with
34,564 additions
and
11,246 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,7 +32,7 @@ superset: | |
| # Create an admin user in your metadata database | ||
| superset fab create-admin \ | ||
| --username admin \ | ||
| --firstname Admin \ | ||
| --firstname "Admin I."\ | ||
| --lastname Strator \ | ||
| --email [email protected] \ | ||
| --password general | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,20 +8,95 @@ version: 1 | |
|
|
||
| ## Trino | ||
|
|
||
| Supported trino version 352 and higher | ||
|
|
||
| The [sqlalchemy-trino](https://pypi.org/project/sqlalchemy-trino/) library is the recommended way to connect to Trino through SQLAlchemy. | ||
|
|
||
| The expected connection string is formatted as follows: | ||
| Superset supports Trino >=352 via SQLAlchemy by using the [sqlalchemy-trino](https://pypi.org/project/sqlalchemy-trino/) library. | ||
|
|
||
| ### Connection String | ||
| The connection string format is as follows: | ||
| ``` | ||
| trino://{username}:{password}@{hostname}:{port}/{catalog} | ||
| ``` | ||
| If you are running trino with docker on local machine please use the following connection URL | ||
|
|
||
| If you are running Trino with docker on local machine, please use the following connection URL | ||
| ``` | ||
| trino://[email protected]:8080 | ||
| ``` | ||
|
|
||
| Reference: | ||
| [Trino-Superset-Podcast](https://trino.io/episodes/12.html) | ||
| ### Authentications | ||
| #### 1. Basic Authentication | ||
| You can provide `username`/`password` in the connection string or in the `Secure Extra` field at `Advanced / Security` | ||
| * In Connection String | ||
| ``` | ||
| trino://{username}:{password}@{hostname}:{port}/{catalog} | ||
| ``` | ||
|
|
||
| * In `Secure Extra` field | ||
| ```json | ||
| { | ||
| "auth_method": "basic", | ||
| "auth_params": { | ||
| "username": "<username>", | ||
| "password": "<password>" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| NOTE: if both are provided, `Secure Extra` always takes higher priority. | ||
|
|
||
| #### 2. Kerberos Authentication | ||
| In `Secure Extra` field, config as following example: | ||
| ```json | ||
| { | ||
| "auth_method": "kerberos", | ||
| "auth_params": { | ||
| "service_name": "superset", | ||
| "config": "/path/to/krb5.config", | ||
| ... | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| All fields in `auth_params` are passed directly to the [`KerberosAuthentication`](https://github.com/trinodb/trino-python-client/blob/0.306.0/trino/auth.py#L40) class. | ||
|
|
||
| #### 3. JWT Authentication | ||
| Config `auth_method` and provide token in `Secure Extra` field | ||
| ```json | ||
| { | ||
| "auth_method": "jwt", | ||
| "auth_params": { | ||
| "token": "<your-jwt-token>" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| #### 4. Custom Authentication | ||
| To use custom authentication, first you need to add it into | ||
| `ALLOWED_EXTRA_AUTHENTICATIONS` allow list in Superset config file: | ||
| ```python | ||
| from your.module import AuthClass | ||
| from another.extra import auth_method | ||
|
|
||
| ALLOWED_EXTRA_AUTHENTICATIONS: Dict[str, Dict[str, Callable[..., Any]]] = { | ||
| "trino": { | ||
| "custom_auth": AuthClass, | ||
| "another_auth_method": auth_method, | ||
| }, | ||
| } | ||
| ``` | ||
|
|
||
| Then in `Secure Extra` field: | ||
| ```json | ||
| { | ||
| "auth_method": "custom_auth", | ||
| "auth_params": { | ||
| ... | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| You can also use custom authentication by providing reference to your `trino.auth.Authentication` class | ||
| or factory function (which returns an `Authentication` instance) to `auth_method`. | ||
|
|
||
| All fields in `auth_params` are passed directly to your class/function. | ||
|
|
||
| **Reference**: | ||
| * [Trino-Superset-Podcast](https://trino.io/episodes/12.html) | ||
140 changes: 140 additions & 0 deletions
140
docs/src/pages/docs/Contributing/creating-viz-plugins.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| --- | ||
| name: Creating Visualization Plugins | ||
| menu: Contributing | ||
| route: /docs/contributing/creating-viz | ||
| index: 9 | ||
| version: 1 | ||
| --- | ||
|
|
||
| ## Creating Visualization Plugins | ||
|
|
||
| Visualizations in Superset are implemented in JavaScript or TypeScript. Superset | ||
| comes preinstalled with several visualizations types (hereafter "viz plugins") that | ||
| can be found under the `superset-frontend/plugins` directory. Viz plugins are added to | ||
| the application in the `superset-frontend/src/visualizations/presets/MainPreset.js`. | ||
| The Superset project is always happy to review proposals for new high quality viz | ||
| plugins. However, for highly custom viz types it is recommended to maintain a fork | ||
| of Superset, and add the custom built viz plugins by hand. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| In order to create a new viz plugin, you need the following: | ||
|
|
||
| - Run MacOS or Linux (Windows is not officially supported, but may work) | ||
| - Node.js 16 | ||
| - npm 7 or 8 | ||
|
|
||
| A general familiarity with [React](https://reactjs.org/) and the npm/Node system is | ||
| also recommended. | ||
|
|
||
| ### Creating a simple Hello World viz plugin | ||
|
|
||
| To get started, you need the Superset Yeoman Generator. It is recommended to use the | ||
| version of the template that ships with the version of Superset you are using. This | ||
| can be installed by doing the following: | ||
|
|
||
| ```bash | ||
| npm i -g yo | ||
| cd superset-frontend/packages/generator-superset | ||
| npm i | ||
| npm link | ||
| ``` | ||
|
|
||
| After this you can proceed to create your viz plugin. Create a new directory for your | ||
| viz plugin with the prefix `superset-plugin-chart` and run the Yeoman generator: | ||
|
|
||
| ```bash | ||
| mkdir /tmp/superset-plugin-chart-hello-world | ||
| cd /tmp/superset-plugin-chart-hello-world | ||
| ``` | ||
|
|
||
| Initialize the viz plugin: | ||
|
|
||
| ```bash | ||
| yo @superset-ui/superset | ||
| ``` | ||
|
|
||
| After that the generator will ask a few questions (the defaults should be fine): | ||
|
|
||
| ``` | ||
| $ yo @superset-ui/superset | ||
| _-----_ ╭──────────────────────────╮ | ||
| | | │ Welcome to the │ | ||
| |--(o)--| │ generator-superset │ | ||
| `---------´ │ generator! │ | ||
| ( _´U`_ ) ╰──────────────────────────╯ | ||
| /___A___\ / | ||
| | ~ | | ||
| __'.___.'__ | ||
| ´ ` |° ´ Y ` | ||
| ? Package name: superset-plugin-chart-hello-world | ||
| ? Plugin name: Hello World | ||
| ? Description: Superset Plugin Chart Hello World | ||
| ? What type of chart would you like? Regular chart | ||
| create package.json | ||
| create .gitignore | ||
| create babel.config.js | ||
| create jest.config.js | ||
| create package-lock.json | ||
| create README.md | ||
| create tsconfig.json | ||
| create src/index.ts | ||
| create src/plugin/buildQuery.ts | ||
| create src/plugin/controlPanel.ts | ||
| create src/plugin/index.ts | ||
| create src/plugin/transformProps.ts | ||
| create src/types.ts | ||
| create src/SupersetPluginChartHelloWorld.tsx | ||
| create test/index.test.ts | ||
| create test/__mocks__/mockExportString.js | ||
| create test/plugin/buildQuery.test.ts | ||
| create test/plugin/transformProps.test.ts | ||
| create types/external.d.ts | ||
| create src/images/thumbnail.png | ||
| ``` | ||
|
|
||
| To build the viz plugin, run the following commands: | ||
|
|
||
| ``` | ||
| npm ci | ||
| npm run build | ||
| ``` | ||
|
|
||
| Alternatively, to run the viz plugin in development mode (=rebuilding whenever changes | ||
| are made), start the dev server with the following command: | ||
|
|
||
| ``` | ||
| npm run dev | ||
| ``` | ||
|
|
||
| To add the package to Superset, go to the `superset-frontend` subdirectory in your | ||
| Superset source folder run | ||
|
|
||
| ```bash | ||
| npm i -S /tmp/superset-plugin-chart-hello-world | ||
| ``` | ||
|
|
||
| If you publish your package to npm, you can naturally install directly from there, too. | ||
| After this edit the `superset-frontend/src/visualizations/presets/MainPreset.js` | ||
| and make the following changes: | ||
|
|
||
| ```js | ||
| import { SupersetPluginChartHelloWorld } from 'superset-plugin-chart-hello-world'; | ||
| ``` | ||
|
|
||
| to import the viz plugin and later add the following to the array that's passed to the | ||
| `plugins` property: | ||
|
|
||
| ```js | ||
| new SupersetPluginChartHelloWorld().configure({ key: 'ext-hello-world' }), | ||
| ``` | ||
|
|
||
| After that the viz plugin should show up when you run Superset, e.g. the development | ||
| server: | ||
|
|
||
| ```bash | ||
| npm run dev-server | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.