Skip to content

Commit

Permalink
GITBOOK-131: Add doc: DS connection
Browse files Browse the repository at this point in the history
  • Loading branch information
Openblocks-docs authored and gitbook-bot committed Mar 22, 2023
1 parent 6e5b6b6 commit 232a094
Show file tree
Hide file tree
Showing 23 changed files with 216 additions and 11 deletions.
Binary file added docs/.gitbook/assets/bigquery-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/bigquery-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/clickhouse-1.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/clickhouse-2.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/couchdb-1.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/couchdb-2.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/dynamodb-1.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/dynamodb-2.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/mariadb-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/mariadb-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/oracle-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/oracle-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/snowflake-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/snowflake-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 8 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,19 @@
* [Data source basics](data-sources/data-source-basics.md)
* [Configure IP allowlists](data-sources/configure-ip-allowlists.md)
* [Connect to databases](data-sources/connect-to-databases/README.md)
* [Elasticsearch](data-sources/connect-to-databases/elasticsearch.md)
* [Big Query](data-sources/connect-to-databases/elasticsearch.md)
* [ClickHouse](data-sources/connect-to-databases/elasticsearch-1.md)
* [CouchDB](data-sources/connect-to-databases/elasticsearch-2.md)
* [DynamoDB](data-sources/connect-to-databases/elasticsearch-3.md)
* [Elasticsearch](data-sources/connect-to-databases/elasticsearch-4.md)
* [MariaDB](data-sources/connect-to-databases/elasticsearch-5.md)
* [Microsoft SQL Server](data-sources/connect-to-databases/microsoft-sql-server.md)
* [MongoDB](data-sources/connect-to-databases/mongodb.md)
* [MySQL](data-sources/connect-to-databases/mysql.md)
* [Oracle](data-sources/connect-to-databases/mysql-1.md)
* [PostgreSQL](data-sources/connect-to-databases/postgresql.md)
* [Redis](data-sources/connect-to-databases/redis.md)
* [Snowflake](data-sources/connect-to-databases/redis-1.md)
* [Connect to APIs](data-sources/connect-to-databases-1/README.md)
* [REST API](data-sources/connect-to-databases-1/rest-apis.md)
* [GraphQL](data-sources/connect-to-databases-1/graphql.md)
Expand Down
28 changes: 28 additions & 0 deletions docs/data-sources/connect-to-databases/elasticsearch-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# ClickHouse

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.

## Prerequisites

* Get ClickHouse database connection parameters from the database owner.
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).

## Connect to ClickHouse data source

Follow the steps below:

1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**. 

<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
2. Select **Database** > **ClickHouse** as the data source type.&#x20;

<figure><img src="../../.gitbook/assets/clickhouse-1.PNG" alt=""><figcaption></figcaption></figure>
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;

<figure><img src="../../.gitbook/assets/clickhouse-2.PNG" alt=""><figcaption></figcaption></figure>
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
5. Click **Save**, and it will be saved to your data source library.
28 changes: 28 additions & 0 deletions docs/data-sources/connect-to-databases/elasticsearch-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# CouchDB

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.

## Prerequisites

* Get CouchDB database connection parameters from the database owner.
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).

## Connect to CouchDB data source

Follow the steps below:

1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
2. Select **Database** > **CouchDB** as the data source type.&#x20;

<figure><img src="../../.gitbook/assets/couchdb-1.PNG" alt=""><figcaption></figcaption></figure>
3. Set its name and configure the server URL. You can also set the user name and a password.&#x20;

<figure><img src="../../.gitbook/assets/couchdb-2.PNG" alt=""><figcaption></figcaption></figure>
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
5. Click **Save**, and it will be saved to your data source library.
28 changes: 28 additions & 0 deletions docs/data-sources/connect-to-databases/elasticsearch-3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# DynamoDB

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.

## Prerequisites

* Get DynamoDB database connection parameters from the database owner.
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).

## Connect to DynamoDB data source

Follow the steps below:

1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
2. Select **Database** > **DynamoDB** as the data source type.&#x20;

<figure><img src="../../.gitbook/assets/dynamodb-1.PNG" alt=""><figcaption></figcaption></figure>
3. Set its name and configure general settings, including access key ID, secret key. You can also set endpoint URL and region.

<figure><img src="../../.gitbook/assets/dynamodb-2.PNG" alt=""><figcaption></figcaption></figure>
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
5. Click **Save**, and it will be saved to your data source library.
30 changes: 30 additions & 0 deletions docs/data-sources/connect-to-databases/elasticsearch-4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Elasticsearch

Elasticsearch is a highly scalable and distributed search and analytics engine designed to perform fast and complex searches on large volumes of data.



## Prerequisites

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

## Connect to Elasticsearch data source

Follow the steps below:

1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;

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

<figure><img src="../../.gitbook/assets/elasticsearch-1.PNG" alt=""><figcaption></figcaption></figure>
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;

<figure><img src="../../.gitbook/assets/elasticsearch-2.PNG" alt=""><figcaption></figcaption></figure>
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
5. Click **Save**, and it will be saved to your data source library.
28 changes: 28 additions & 0 deletions docs/data-sources/connect-to-databases/elasticsearch-5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# MariaDB

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.

## Prerequisites

* Get MariaDB database connection parameters from the database owner.
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).

## Connect to MariaDB data source

Follow the steps below:

1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
2. Select **Database** > **MariaDB** as the data source type.&#x20;

<figure><img src="../../.gitbook/assets/mariadb-1.png" alt=""><figcaption></figcaption></figure>
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;

<figure><img src="../../.gitbook/assets/mariadb-2.png" alt=""><figcaption></figcaption></figure>
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
5. Click **Save**, and it will be saved to your data source library.
18 changes: 8 additions & 10 deletions docs/data-sources/connect-to-databases/elasticsearch.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
# Elasticsearch

Elasticsearch is a highly scalable and distributed search and analytics engine designed to perform fast and complex searches on large volumes of data.

# Big Query

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.

## Prerequisites

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

## Connect to Elasticsearch data source
## Connect to Big Query data source

Follow the steps below:

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

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

<figure><img src="../../.gitbook/assets/elasticsearch-1.PNG" alt=""><figcaption></figcaption></figure>
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;
<figure><img src="../../.gitbook/assets/bigquery-1.png" alt=""><figcaption></figcaption></figure>
3. Set its name and service account.

<figure><img src="../../.gitbook/assets/elasticsearch-2.PNG" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/bigquery-2.png" alt=""><figcaption></figcaption></figure>
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
5. Click **Save**, and it will be saved to your data source library.
28 changes: 28 additions & 0 deletions docs/data-sources/connect-to-databases/mysql-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Oracle

Oracle is a leading provider of enterprise software and database management systems, offering a wide range of solutions for businesses of all sizes.

## Prerequisites

* Get Oracle database connection parameters from the database owner.
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).

## Connect to Oracle data source

Follow the steps below:

1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
2. Select **Database** > **Oracle** as the data source type. &#x20;

<figure><img src="../../.gitbook/assets/oracle-1.png" alt=""><figcaption></figcaption></figure>
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;

<figure><img src="../../.gitbook/assets/oracle-2.png" alt=""><figcaption></figcaption></figure>
4. (Optional) Click **Test connection** to check whether the new data source is successfully connected.
5. Click **Save**, and it will be saved to your data source library.
30 changes: 30 additions & 0 deletions docs/data-sources/connect-to-databases/redis-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Snowflake

Snowflake is a cloud-based data warehousing platform that provides scalable and flexible solutions for storing, processing, and analyzing large volumes of data.

## Prerequisites

* Get Snowflake database connection parameters from the database owner.
* Refer to [IP allowlist](../configure-ip-allowlists.md) to add IP addresses of Openblocks to your allowlist (if needed).

## Connect to Snowflake data source

Follow the steps below:

1. Create a new data source in two ways. Note that this permission is restricted to workspace admins and developers.
* Navigate to the **Data Sources** tab on [Openblocks Homepage](https://openblocks.dev) and click **New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-1.PNG" alt=""><figcaption></figcaption></figure>
* When creating a new query in the app editor, click **+ New** > **+ New data source**.&#x20;

<figure><img src="../../.gitbook/assets/db-2.PNG" alt=""><figcaption></figcaption></figure>
2. Select **Database** > **Snowflake** as the data source type.&#x20;

<figure><img src="../../.gitbook/assets/snowflake-1.png" alt=""><figcaption></figcaption></figure>
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;



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

0 comments on commit 232a094

Please sign in to comment.