Skip to content

Commit ac006be

Browse files
Openblocks-docsgitbook-bot
Openblocks-docs
authored and
gitbook-bot
committed
GITBOOK-124: Add 6 docs under DS connection
1 parent 82d8c2a commit ac006be

29 files changed

+196
-5
lines changed

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

97.6 KB
Loading

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

84.5 KB
Loading

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

133 KB
Loading

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

44.2 KB
Loading

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

133 KB
Loading

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

50.4 KB
Loading

‎docs/.gitbook/assets/mongodb-3.PNG

25.9 KB
Loading

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

133 KB
Loading

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

64.8 KB
Loading

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

132 KB
Loading

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

59.1 KB
Loading

‎docs/.gitbook/assets/mysql-3.PNG

128 KB
Loading

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

132 KB
Loading

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

62 KB
Loading

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

132 KB
Loading

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

39.8 KB
Loading

‎docs/.gitbook/assets/redis-3.PNG

32.3 KB
Loading

‎docs/SUMMARY.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,17 @@
1313

1414
* [Data source basics](data-sources/data-source-basics.md)
1515
* [Configure IP allowlists](data-sources/configure-ip-allowlists.md)
16-
* [Connect to APIs](data-sources/connect-to-databases/README.md)
17-
* [REST APIs](data-sources/connect-to-databases/rest-apis.md)
18-
* [GraphQL](data-sources/connect-to-databases/graphql.md)
19-
* [Google Sheets](data-sources/connect-to-databases/google-sheets.md)
16+
* [Connect to databases](data-sources/connect-to-databases/README.md)
17+
* [MySQL](data-sources/connect-to-databases/mysql.md)
18+
* [MongoDB](data-sources/connect-to-databases/mongodb.md)
19+
* [PostgreSQL](data-sources/connect-to-databases/postgresql.md)
20+
* [Microsoft SQL Server](data-sources/connect-to-databases/microsoft-sql-server.md)
21+
* [Elasticsearch](data-sources/connect-to-databases/elasticsearch.md)
22+
* [Redis](data-sources/connect-to-databases/redis.md)
23+
* [Connect to APIs](data-sources/connect-to-databases-1/README.md)
24+
* [REST APIs](data-sources/connect-to-databases-1/rest-apis.md)
25+
* [GraphQL](data-sources/connect-to-databases-1/graphql.md)
26+
* [Google Sheets](data-sources/connect-to-databases-1/google-sheets.md)
2027

2128
## Queries
2229

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Connect to databases
2+

‎docs/data-sources/connect-to-databases/google-sheets.md renamed to ‎docs/data-sources/connect-to-databases-1/google-sheets.md

File renamed without changes.

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

File renamed without changes.

‎docs/data-sources/connect-to-databases/rest-apis.md renamed to ‎docs/data-sources/connect-to-databases-1/rest-apis.md

File renamed without changes.

‎docs/data-sources/connect-to-databases/elasticsearch.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**. 
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/microsoft-sql-server.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Microsoft SQL Server
2+
3+
Microsoft SQL Server is a relational database management system (RDBMS), offering a comprehensive platform for storing, managing, and retrieving data from various sources.
4+
5+
## Prerequisites
6+
7+
* Get Microsoft SQL Server 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 Microsoft SQL Server 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** > **Microsoft SQL Server** as the data source type.&#x20;
22+
23+
<figure><img src="../../.gitbook/assets/mssql-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/mssql-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/mongodb.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# MongoDB
2+
3+
MongoDB is a broadly used NoSQL database system that stores data in JSON-like documents with dynamic schemas and handles both unstructured and semi-structured data. By offering high performance, scalability, and ease of use, MongoDB is a versatile and robust solution for a wide range of use cases.
4+
5+
## Prerequisites
6+
7+
* Get MongoDB 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 MongoDB 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** > **MongoDB** as the data source type.&#x20;
22+
23+
<figure><img src="../../.gitbook/assets/mongodb-1.PNG" alt=""><figcaption></figcaption></figure>
24+
3. Set its name and configure the parameters according to your **Connection Type**:
25+
* **Regular**: Host, port, database name (required); user name, password (optional)&#x20;
26+
27+
<figure><img src="../../.gitbook/assets/mongodb-2.PNG" alt=""><figcaption></figcaption></figure>
28+
* **URI**: URI&#x20;
29+
30+
<figure><img src="../../.gitbook/assets/mongodb-3.PNG" alt=""><figcaption></figcaption></figure>
31+
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
32+
5. Click **Save**, and it will be saved to your data source library.

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# MySQL
2+
3+
MySQL is a popular relational database management system (RDBMS) and is widely used in various industries due to its scalability, flexibility, and ease of use.
4+
5+
## Prerequisites
6+
7+
* Get MySQL 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 MySQL 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** > **MySQL** as the data source type.&#x20;
22+
23+
<figure><img src="../../.gitbook/assets/mysql-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/mysql-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.
29+
30+
## Query a MySQL data source
31+
32+
Create `query1` and select the recently created data source. Insert a query and then click ▶ **Run**.
33+
34+
<figure><img src="../../.gitbook/assets/mysql-3.PNG" alt=""><figcaption></figcaption></figure>

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# PostgreSQL
2+
3+
PostgreSQL is a powerful open-source relational database management system (RDBMS), renowned for stability, scalability, and robustness. It is an ideal choice for applications that require data consistency and reliability.
4+
5+
## Prerequisites
6+
7+
* Get PostgreSQL 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 PostgreSQL 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** > **PostgreSQL** as the data source type.&#x20;
22+
23+
<figure><img src="../../.gitbook/assets/postgresql-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/postgresql-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.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Redis
2+
3+
Redis (Remote Dictionary Server) is an open-source in-memory data structure store. Due to the nature of being fast, scalable, and highly available, Redis is a popular choice for applications that require real-time data processing, high throughput, and low latency.
4+
5+
## Prerequisites
6+
7+
* Get Redis 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 Redis 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** > **Redis** as the data source type.&#x20;
22+
23+
<figure><img src="../../.gitbook/assets/redis-1.PNG" alt=""><figcaption></figcaption></figure>
24+
3. Set its name and configure the parameters according to your **Connection Type**:
25+
* **Regular**: Host, port, database name (required); user name, password (optional)&#x20;
26+
27+
<figure><img src="../../.gitbook/assets/redis-2.PNG" alt=""><figcaption></figcaption></figure>
28+
* **URI**: URI ![](../../.gitbook/assets/redis-3.PNG)
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/data-source-basics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Follow the steps below:
1919
3. Select the database or API type you need to connect.&#x20;
2020

2121
<figure><img src="../.gitbook/assets/data source basics-2.png" alt=""><figcaption></figcaption></figure>
22-
4. Fill out data source connection fields. See docs in [Connect to databases](broken-reference) and [Connect to APIs](connect-to-databases/) for detailed tutorials.
22+
4. Fill out data source connection fields. See docs in [Connect to databases](broken-reference) and [Connect to APIs](connect-to-databases-1/) for detailed tutorials.
2323
5. Click **Test connection** to check whether you can make a successful connection to data source based on current settings.
2424
6. Click **Save**.
2525

0 commit comments

Comments
 (0)