Browse Source

[doc] Change datasource doc (#10660)

3.1.0-release
sneh-wha 3 years ago committed by GitHub
parent
commit
7898f41dc0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 21
      docs/docs/en/guide/datasource/clickhouse.md
  2. 21
      docs/docs/en/guide/datasource/db2.md
  3. 22
      docs/docs/en/guide/datasource/hive.md
  4. 5
      docs/docs/en/guide/datasource/introduction.md
  5. 22
      docs/docs/en/guide/datasource/mysql.md
  6. 20
      docs/docs/en/guide/datasource/oracle.md
  7. 22
      docs/docs/en/guide/datasource/postgresql.md
  8. 22
      docs/docs/en/guide/datasource/presto.md
  9. 20
      docs/docs/en/guide/datasource/redshift.md
  10. 22
      docs/docs/en/guide/datasource/spark.md
  11. 22
      docs/docs/en/guide/datasource/sql-server.md
  12. BIN
      docs/img/new_ui/dev/datasource/ClickHouse.png
  13. BIN
      docs/img/new_ui/dev/datasource/DB2.png
  14. BIN
      docs/img/new_ui/dev/datasource/oracle.png
  15. BIN
      docs/img/new_ui/dev/datasource/presto.png
  16. BIN
      docs/img/new_ui/dev/datasource/redshift.png
  17. BIN
      docs/img/new_ui/dev/datasource/sql_server.png

21
docs/docs/en/guide/datasource/clickhouse.md

@ -0,0 +1,21 @@
# ClickHouse
![ClickHouse Datasource](../../../../img/new_ui/dev/datasource/ClickHouse.png)
## Datasource Parameters
| **Datasource** | **Description** |
| --- | --- |
| Datasource | Select CLICKHOUSE. |
| Datasource Name | Enter the name of the datasource. |
| Description | Enter a description of the datasource. |
| IP/Host Name | Enter the CLICKHOUSE service IP. |
| Port | Enter the CLICKHOUSE service port. |
| Username | Set the username for CLICKHOUSE connection. |
| Password | Set the password for CLICKHOUSE connection. |
| Database Name | Enter the database name of the CLICKHOUSE connection. |
| jdbc connect parameters | Parameter settings for CLICKHOUSE connection, in JSON format. |
## Native Supported
Yes, could use this datasource by default.

21
docs/docs/en/guide/datasource/db2.md

@ -0,0 +1,21 @@
# DB2
![DB2 Datasource](../../../../img/new_ui/dev/datasource/DB2.png)
## Datasource Parameters
| **Datasource** | **Description** |
| --- | --- |
| Datasource | Select DB2. |
| Datasource Name | Enter the name of the datasource. |
| Description | Enter a description of the datasource. |
| IP/Host Name | Enter the DB2 service IP. |
| Port | Enter the DB2 service port. |
| Username | Set the username for DB2 connection. |
| Password | Set the password for DB2 connection. |
| Database Name | Enter the database name of the DB2 connection. |
| jdbc connect parameters | Parameter settings for DB2 connection, in JSON format. |
## Native Supported
Yes, could use this datasource by default.

22
docs/docs/en/guide/datasource/hive.md

@ -4,15 +4,19 @@
![hive](../../../../img/new_ui/dev/datasource/hive.png)
- Datasource: select `HIVE`
- Datasource name: enter the name of the DataSource
- Description: enter a description of the DataSource
- IP/Host Name: enter the HIVE service IP
- Port: enter the HIVE service port
- Username: set the username for HIVE connection
- Password: set the password for HIVE connection
- Database name: enter the database name of the HIVE connection
- Jdbc connection parameters: parameter settings for HIVE connection, in JSON format
## Datasource Parameters
| **Datasource** | **Description** |
| --- | --- |
| Datasource | Select HIVE. |
| Datasource name | Enter the name of the DataSource. |
| Description | Enter a description of the DataSource. |
| IP/Host Name | Enter the HIVE service IP. |
| Port | Enter the HIVE service port. |
| Username | Set the username for HIVE connection. |
| Password | Set the password for HIVE connection. |
| Database name | Enter the database name of the HIVE connection. |
| Jdbc connection parameters | Parameter settings for HIVE connection, in JSON format. |
> NOTICE: If you wish to execute multiple HIVE SQL in the same session, you could set `support.hive.oneSession = true` in `common.properties`.
> It is helpful when you try to set env variables before running HIVE SQL. Default value of `support.hive.oneSession` is `false` and multi-SQLs run in different sessions.

5
docs/docs/en/guide/datasource/introduction.md

@ -2,9 +2,8 @@
DataSource supports MySQL, PostgreSQL, Hive/Impala, Spark, ClickHouse, Oracle, SQL Server and other DataSources.
- Click bottom "Data Source Center -> Create Data Source" to create a new datasource.
- Click "Test Connection" to test whether the DataSource can connect successfully(datasource can be saved only if passed the
connection test).
- Click bottom `Data Source Center -> Create Data Source` to create a new datasource.
- Click `Test Connection` to test whether the DataSource can connect successfully (datasource can be saved only if it passes the connection test).
## Using datasource incompatible to Apache LICENSE V2 LICENSE

22
docs/docs/en/guide/datasource/mysql.md

@ -2,15 +2,19 @@
![mysql](../../../../img/new_ui/dev/datasource/mysql.png)
- Datasource: select MYSQL
- Datasource name: enter the name of the DataSource
- Description: enter a description of the DataSource
- IP/Host Name: enter the MYSQL service IP
- Port: enter the MYSQL service port
- Username: set the username for MYSQL connection
- Password: set the password for MYSQL connection
- Database name: enter the database name of the MYSQL connection
- Jdbc connection parameters: parameter settings for MYSQL connection, in JSON format
## Datasource Parameters
| **Datasource** | **Description** |
| --- | --- |
| Datasource | Select MYSQL. |
| Datasource name | Enter the name of the DataSource. |
| Description | Enter a description of the DataSource. |
| IP/Host Name | Enter the MYSQL service IP. |
| Port | Enter the MYSQL service port. |
| Username | Set the username for MYSQL connection. |
| Password | Set the password for MYSQL connection. |
| Database name | Enter the database name of the MYSQL connection. |
| Jdbc connection parameters | Parameter settings for MYSQL connection, in JSON format. |
## Native Supported

20
docs/docs/en/guide/datasource/oracle.md

@ -0,0 +1,20 @@
# Oracle
![oracle](../../../../img/new_ui/dev/datasource/oracle.png)
## Datasource Parameters
| **Datasource** | **Description** |
| --- | --- |
| Datasource | Select Oracle. |
| Datasource Name | Enter the name of the datasource. |
| Description | Enter a description of the datasource. |
| IP/Host Name | Enter the Oracle service IP. |
| Port | Enter the Oracle service port. |
| Username | Set the username for Oracle connection. |
| Password | Set the password for Oracle connection. |
| Database Name | Enter the database name of the Oracle connection. |
| jdbc connect parameters | Parameter settings for Oracle connection, in JSON format. |
## Native Supported
Yes, could use this datasource by default.

22
docs/docs/en/guide/datasource/postgresql.md

@ -2,15 +2,19 @@
![postgresql](../../../../img/new_ui/dev/datasource/postgresql.png)
- Datasource: select POSTGRESQL
- Datasource name: enter the name of the DataSource
- Description: enter a description of the DataSource
- IP/Host Name: enter the PostgreSQL service IP
- Port: enter the PostgreSQL service port
- Username: set the username for PostgreSQL connection
- Password: set the password for PostgreSQL connection
- Database name: enter the database name of the PostgreSQL connection
- Jdbc connection parameters: parameter settings for PostgreSQL connection, in JSON format
## Datasource Parameters
| **Datasource** | **Description** |
| --- | --- |
| Datasource | Select POSTGRESQL. |
| Datasource name | Enter the name of the DataSource. |
| Description | Enter a description of the DataSource. |
| IP/Host Name | Enter the PostgreSQL service IP. |
| Port | Enter the PostgreSQL service port. |
| Username | Set the username for PostgreSQL connection. |
| Password | Set the password for PostgreSQL connection. |
| Database name | Enter the database name of the PostgreSQL connection. |
| Jdbc connection parameters | Parameter settings for PostgreSQL connection, in JSON format. |
## Native Supported

22
docs/docs/en/guide/datasource/presto.md

@ -0,0 +1,22 @@
# Presto
![Presto Datasource](../../../../img/new_ui/dev/datasource/presto.png)
## Datasource Parameters
| **Datasource** | **Description** |
| --- | --- |
| Datasource | Select Presto. |
| Datasource Name | Enter the name of the datasource. |
| Description | Enter a description of the datasource. |
| IP/Host Name | Enter the Presto service IP. |
| Port | Enter the Presto service port. |
| Username | Set the username for Presto connection. |
| Password | Set the password for Presto connection. |
| Database Name | Enter the database name of the Presto connection. |
| jdbc connect parameters | Parameter settings for Presto connection, in JSON format. |
## Native Supported
Yes, could use this datasource by default.

20
docs/docs/en/guide/datasource/redshift.md

@ -0,0 +1,20 @@
# Amazon Redshift
![Redshift datasource](../../../../img/new_ui/dev/datasource/redshift.png)
## Datasource Parameters
| **Datasource** | **Description** |
| --- | --- |
| Datasource | Select Redshift. |
| Datasource Name | Enter the name of the datasource. |
| Description | Enter a description of the datasource. |
| IP/Host Name | Enter the Redshift service IP. |
| Port | Enter the Redshift service port. |
| Username | Set the username for Redshift connection. |
| Password | Set the password for Redshift connection. |
| Database Name | Enter the database name of the Redshift connection. |
| jdbc connect parameters | Parameter settings for Redshift connection, in JSON format. |
## Native Supported
Yes, could use this datasource by default.

22
docs/docs/en/guide/datasource/spark.md

@ -2,15 +2,19 @@
![sparksql](../../../../img/new_ui/dev/datasource/sparksql.png)
- Datasource: select Spark
- Datasource name: enter the name of the DataSource
- Description: enter a description of the DataSource
- IP/Host Name: enter the Spark service IP
- Port: enter the Spark service port
- Username: set the username for Spark connection
- Password: set the password for Spark connection
- Database name: enter the database name of the Spark connection
- Jdbc connection parameters: parameter settings for Spark connection, in JSON format
## Datasource Parameters
| **Datasource** | **Description** |
| --- | --- |
| Datasource | Select Spark. |
| Datasource name | Enter the name of the DataSource. |
| Description | Enter a description of the DataSource. |
| IP/Host Name | Enter the Spark service IP. |
| Port | Enter the Spark service port. |
| Username | Set the username for Spark connection. |
| Password | Set the password for Spark connection. |
| Database name | Enter the database name of the Spark connection. |
| Jdbc connection parameters | Parameter settings for Spark connection, in JSON format. |
## Native Supported

22
docs/docs/en/guide/datasource/sql-server.md

@ -0,0 +1,22 @@
# SQL Server
![SQL Server](../../../../img/new_ui/dev/datasource/sql_server.png)
## Datasource Parameters
| **Datasource** | **Description** |
| --- | --- |
| Datasource | Select SQLSERVER. |
| Datasource Name | Enter the name of the datasource. |
| Description | Enter a description of the datasource. |
| IP/Host Name | Enter the SQLSERVER service IP. |
| Port | Enter the SQLSERVER service port. |
| Username | Set the username for SQLSERVER connection. |
| Password | Set the password for SQLSERVER connection. |
| Database Name | Enter the database name of the SQLSERVER connection. |
| jdbc connect parameters | Parameter settings for SQLSERVER connection, in JSON format. |
## Native Supported
Yes, could use this datasource by default.

BIN
docs/img/new_ui/dev/datasource/ClickHouse.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

BIN
docs/img/new_ui/dev/datasource/DB2.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

BIN
docs/img/new_ui/dev/datasource/oracle.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

BIN
docs/img/new_ui/dev/datasource/presto.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

BIN
docs/img/new_ui/dev/datasource/redshift.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

BIN
docs/img/new_ui/dev/datasource/sql_server.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

Loading…
Cancel
Save