Skip to content

Commit 232a094

Browse files
Openblocks-docsgitbook-bot
Openblocks-docs
authored and
gitbook-bot
committed
GITBOOK-131: Add doc: DS connection
1 parent 6e5b6b6 commit 232a094

23 files changed

+216
-11
lines changed

‎docs/.gitbook/assets/bigquery-1.png

133 KB
Loading

‎docs/.gitbook/assets/bigquery-2.png

32.4 KB
Loading

‎docs/.gitbook/assets/clickhouse-1.PNG

133 KB
Loading

‎docs/.gitbook/assets/clickhouse-2.PNG

60.2 KB
Loading

‎docs/.gitbook/assets/couchdb-1.PNG

133 KB
Loading

‎docs/.gitbook/assets/couchdb-2.PNG

51.4 KB
Loading

‎docs/.gitbook/assets/dynamodb-1.PNG

133 KB
Loading

‎docs/.gitbook/assets/dynamodb-2.PNG

41.1 KB
Loading

‎docs/.gitbook/assets/mariadb-1.png

133 KB
Loading

‎docs/.gitbook/assets/mariadb-2.png

58.8 KB
Loading

‎docs/.gitbook/assets/oracle-1.png

132 KB
Loading

‎docs/.gitbook/assets/oracle-2.png

60.7 KB
Loading

‎docs/.gitbook/assets/snowflake-1.png

132 KB
Loading

‎docs/.gitbook/assets/snowflake-2.png

71.1 KB
Loading

‎docs/SUMMARY.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,19 @@
1414
* [Data source basics](data-sources/data-source-basics.md)
1515
* [Configure IP allowlists](data-sources/configure-ip-allowlists.md)
1616
* [Connect to databases](data-sources/connect-to-databases/README.md)
17-
* [Elasticsearch](data-sources/connect-to-databases/elasticsearch.md)
17+
* [Big Query](data-sources/connect-to-databases/elasticsearch.md)
18+
* [ClickHouse](data-sources/connect-to-databases/elasticsearch-1.md)
19+
* [CouchDB](data-sources/connect-to-databases/elasticsearch-2.md)
20+
* [DynamoDB](data-sources/connect-to-databases/elasticsearch-3.md)
21+
* [Elasticsearch](data-sources/connect-to-databases/elasticsearch-4.md)
22+
* [MariaDB](data-sources/connect-to-databases/elasticsearch-5.md)
1823
* [Microsoft SQL Server](data-sources/connect-to-databases/microsoft-sql-server.md)
1924
* [MongoDB](data-sources/connect-to-databases/mongodb.md)
2025
* [MySQL](data-sources/connect-to-databases/mysql.md)
26+
* [Oracle](data-sources/connect-to-databases/mysql-1.md)
2127
* [PostgreSQL](data-sources/connect-to-databases/postgresql.md)
2228
* [Redis](data-sources/connect-to-databases/redis.md)
29+
* [Snowflake](data-sources/connect-to-databases/redis-1.md)
2330
* [Connect to APIs](data-sources/connect-to-databases-1/README.md)
2431
* [REST API](data-sources/connect-to-databases-1/rest-apis.md)
2532
* [GraphQL](data-sources/connect-to-databases-1/graphql.md)

‎docs/data-sources/connect-to-databases/elasticsearch-1.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# ClickHouse
2+
3+
ClickHouse is an open-source column-oriented database management system designed for high-speed online analytical processing (OLAP) and data warehousing, capable of processing petabytes of data in real-time.
4+
5+
## Prerequisites
6+
7+
* Get ClickHouse database connection parameters from the database owner.
8+
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).
9+
10+
## Connect to ClickHouse data source
11+
12+
Follow the steps below:
13+
14+
1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
15+
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**. 
16+
17+
<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
18+
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;
19+
20+
<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
21+
2. Select **Database** > **ClickHouse** as the data source type.&#x20;
22+
23+
<figure><img src="../../.gitbook/assets/clickhouse-1.PNG" alt=""><figcaption></figcaption></figure>
24+
3. Set its name and configure general settings, including host, port, and database name. You can also set the user name and a password.&#x20;
25+
26+
<figure><img src="../../.gitbook/assets/clickhouse-2.PNG" alt=""><figcaption></figcaption></figure>
27+
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
28+
5. Click **Save**, and it will be saved to your data source library.

‎docs/data-sources/connect-to-databases/elasticsearch-2.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# CouchDB
2+
3+
CouchDB is an open-source NoSQL document-oriented database management system that provides easy-to-use web-based interfaces for data storage, retrieval, and indexing, as well as built-in synchronization and replication capabilities.
4+
5+
## Prerequisites
6+
7+
* Get CouchDB database connection parameters from the database owner.
8+
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).
9+
10+
## Connect to CouchDB data source
11+
12+
Follow the steps below:
13+
14+
1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
15+
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;
16+
17+
<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
18+
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;
19+
20+
<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
21+
2. Select **Database** > **CouchDB** as the data source type.&#x20;
22+
23+
<figure><img src="../../.gitbook/assets/couchdb-1.PNG" alt=""><figcaption></figcaption></figure>
24+
3. Set its name and configure the server URL. You can also set the user name and a password.&#x20;
25+
26+
<figure><img src="../../.gitbook/assets/couchdb-2.PNG" alt=""><figcaption></figcaption></figure>
27+
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
28+
5. Click **Save**, and it will be saved to your data source library.

‎docs/data-sources/connect-to-databases/elasticsearch-3.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# DynamoDB
2+
3+
DynamoDB is a fully managed NoSQL database service offered by Amazon Web Services (AWS) that provides fast and predictable performance with seamless scalability, making it ideal for applications with high scalability requirements.
4+
5+
## Prerequisites
6+
7+
* Get DynamoDB database connection parameters from the database owner.
8+
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).
9+
10+
## Connect to DynamoDB data source
11+
12+
Follow the steps below:
13+
14+
1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
15+
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;
16+
17+
<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
18+
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;
19+
20+
<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
21+
2. Select **Database** > **DynamoDB** as the data source type.&#x20;
22+
23+
<figure><img src="../../.gitbook/assets/dynamodb-1.PNG" alt=""><figcaption></figcaption></figure>
24+
3. Set its name and configure general settings, including access key ID, secret key. You can also set endpoint URL and region.
25+
26+
<figure><img src="../../.gitbook/assets/dynamodb-2.PNG" alt=""><figcaption></figcaption></figure>
27+
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
28+
5. Click **Save**, and it will be saved to your data source library.

‎docs/data-sources/connect-to-databases/elasticsearch-4.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Elasticsearch
2+
3+
Elasticsearch is a highly scalable and distributed search and analytics engine designed to perform fast and complex searches on large volumes of data.
4+
5+
6+
7+
## Prerequisites
8+
9+
* Get Microsoft SQL Server database connection parameters from the database owner.
10+
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).
11+
12+
## Connect to Elasticsearch data source
13+
14+
Follow the steps below:
15+
16+
1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
17+
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;
18+
19+
<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
20+
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;
21+
22+
<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
23+
2. Select **Database** > **Elasticsearch** as the data source type.&#x20;
24+
25+
<figure><img src="../../.gitbook/assets/elasticsearch-1.PNG" alt=""><figcaption></figcaption></figure>
26+
3. Set its name and configure general settings, including host, port, and database name. You can also set the user name and a password.&#x20;
27+
28+
<figure><img src="../../.gitbook/assets/elasticsearch-2.PNG" alt=""><figcaption></figcaption></figure>
29+
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
30+
5. Click **Save**, and it will be saved to your data source library.

‎docs/data-sources/connect-to-databases/elasticsearch-5.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# MariaDB
2+
3+
MariaDB is a popular open-source relational database management system that offers high performance, scalability, and security features for businesses and organizations of all sizes.
4+
5+
## Prerequisites
6+
7+
* Get MariaDB database connection parameters from the database owner.
8+
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).
9+
10+
## Connect to MariaDB data source
11+
12+
Follow the steps below:
13+
14+
1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
15+
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;
16+
17+
<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
18+
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;
19+
20+
<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
21+
2. Select **Database** > **MariaDB** as the data source type.&#x20;
22+
23+
<figure><img src="../../.gitbook/assets/mariadb-1.png" alt=""><figcaption></figcaption></figure>
24+
3. Set its name and configure general settings, including host, port, and database name. You can also set the user name and a password.&#x20;
25+
26+
<figure><img src="../../.gitbook/assets/mariadb-2.png" alt=""><figcaption></figcaption></figure>
27+
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
28+
5. Click **Save**, and it will be saved to your data source library.

‎docs/data-sources/connect-to-databases/elasticsearch.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
1-
# Elasticsearch
2-
3-
Elasticsearch is a highly scalable and distributed search and analytics engine designed to perform fast and complex searches on large volumes of data.
4-
1+
# Big Query
52

3+
Big Query is a fully managed cloud-based data warehouse offered by Google Cloud Platform that provides high-speed querying and interactive analysis of large datasets using SQL-like queries.
64

75
## Prerequisites
86

9-
* Get Microsoft SQL Server database connection parameters from the database owner.
7+
* Get Big Query database connection parameters from the database owner.
108
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).
119

12-
## Connect to Elasticsearch data source
10+
## Connect to Big Query data source
1311

1412
Follow the steps below:
1513

@@ -20,11 +18,11 @@ Follow the steps below:
2018
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;
2119

2220
<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
23-
2. Select **Database** > **Elasticsearch** as the data source type.&#x20;
21+
2. Select **Database** > **Big Query** as the data source type.&#x20;
2422

25-
<figure><img src="../../.gitbook/assets/elasticsearch-1.PNG" alt=""><figcaption></figcaption></figure>
26-
3. Set its name and configure general settings, including host, port, and database name. You can also set the user name and a password.&#x20;
23+
<figure><img src="../../.gitbook/assets/bigquery-1.png" alt=""><figcaption></figcaption></figure>
24+
3. Set its name and service account.
2725

28-
<figure><img src="../../.gitbook/assets/elasticsearch-2.PNG" alt=""><figcaption></figcaption></figure>
26+
<figure><img src="../../.gitbook/assets/bigquery-2.png" alt=""><figcaption></figcaption></figure>
2927
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
3028
5. Click **Save**, and it will be saved to your data source library.

‎docs/data-sources/connect-to-databases/mysql-1.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Oracle
2+
3+
Oracle is a leading provider of enterprise software and database management systems, offering a wide range of solutions for businesses of all sizes.
4+
5+
## Prerequisites
6+
7+
* Get Oracle database connection parameters from the database owner.
8+
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).
9+
10+
## Connect to Oracle data source
11+
12+
Follow the steps below:
13+
14+
1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
15+
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;
16+
17+
<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
18+
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;
19+
20+
<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
21+
2. Select **Database** > **Oracle** as the data source type. &#x20;
22+
23+
<figure><img src="../../.gitbook/assets/oracle-1.png" alt=""><figcaption></figcaption></figure>
24+
3. Set its name and configure general settings, including host, port, and service name. You can also set the user name and a password.&#x20;
25+
26+
<figure><img src="../../.gitbook/assets/oracle-2.png" alt=""><figcaption></figcaption></figure>
27+
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
28+
5. Click **Save**, and it will be saved to your data source library.

‎docs/data-sources/connect-to-databases/redis-1.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Snowflake
2+
3+
Snowflake is a cloud-based data warehousing platform that provides scalable and flexible solutions for storing, processing, and analyzing large volumes of data.
4+
5+
## Prerequisites
6+
7+
* Get Snowflake database connection parameters from the database owner.
8+
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).
9+
10+
## Connect to Snowflake data source
11+
12+
Follow the steps below:
13+
14+
1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
15+
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;
16+
17+
<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
18+
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;
19+
20+
<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
21+
2. Select **Database** > **Snowflake** as the data source type.&#x20;
22+
23+
<figure><img src="../../.gitbook/assets/snowflake-1.png" alt=""><figcaption></figcaption></figure>
24+
3. Set its name and configure general settings, including account identifier, and database. You can also set schema, warehouse, user name, password, and so on.&#x20;
25+
26+
27+
28+
<figure><img src="../../.gitbook/assets/snowflake-2.png" alt=""><figcaption></figcaption></figure>
29+
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
30+
5. Click **Save**, and it will be saved to your data source library.

0 commit comments

Comments
 (0)