* docs: integrations framework * docs: integrations (wip) * docs: wip * docs: integrations & connections * docs: remove database folder * docs: warning about access permissions * docs: add new data source * docs: meta sync * docs: actions on data soruce * docs: update links * misc: data => Data * docs: fix review commentspull/9174/head
Raju Udava
5 months ago
committed by
GitHub
@ -0,0 +1,29 @@
|
||||
--- |
||||
title: 'Overview' |
||||
description: 'Overview of the integrations available in NocoDB' |
||||
tags: ['Integrations', 'Overview'] |
||||
keywords: ['Integrations overview', 'Integrations sync', 'Integrations access control', 'Integrations re-config'] |
||||
--- |
||||
|
||||
**Integrations** enable seamless connectivity between NocoDB and external platforms. This helps consolidate your data scattered across multiple silos into one common platform. |
||||
|
||||
You can add multiple instances of an integration within a single workspace, with each instance referred to as a **Connection**. Once established, these connections allow you to utilize data from the integrated platforms in your NocoDB base. If applicable, changes made in NocoDB can also be synchronized back to the external platforms. |
||||
|
||||
Currently, NocoDB supports integrations with databases such as _MySQL_ and _PostgreSQL_, with additional integrations planned for the future. If you have a specific integration in mind, please let us know by submitting your request using "**Request Integration**" option in the `Integrations` menu. |
||||
|
||||
:::info |
||||
- In Cloud hosted solutions, Integrations menu will be accessible for Workspace Owners & Workspace Creators. |
||||
- In Self-hosted solutions (OSS), Integrations menu will be accessible for Organization Admins & Organization Creators. |
||||
::: |
||||
|
||||
All activities related to integrations and their connections can be efficiently managed from the `Integrations` menu, conveniently located in the left sidebar. |
||||
|
||||
 |
||||
|
||||
Learn more about working with integrations in the following sections: |
||||
- [Create a new connection](/integrations/create-connection) |
||||
- [Edit connection](/integrations/edit-connection) |
||||
- [Remove connection](/integrations/remove-connection) |
||||
|
||||
|
||||
|
||||
@ -0,0 +1,101 @@
|
||||
--- |
||||
title: 'Connect to an Integration' |
||||
description: 'Learn how to create a new connection in NocoDB.' |
||||
tags: ['Integrations', 'Create', 'Connection', 'External', 'PG', 'MySQL'] |
||||
keywords: ['NocoDB create connection', 'create connection', 'external connection', 'PG connection', 'MySQL connection'] |
||||
--- |
||||
|
||||
Users with Workspace Owner or Workspace Creator roles can create a new connection in NocoDB. To create a new connection, follow the steps below: |
||||
|
||||
 |
||||
|
||||
1. Click on the `Integrations` menu in the left sidebar. |
||||
2. From the list, click on the integration you want to connect to |
||||
3. In the subsequent modal, provide required details. Please refer to the integration-specific documentation for more details. |
||||
- [PostgreSQL](#postgresql) |
||||
- [MySQL](#mysql) |
||||
|
||||
Connection to an integration thus created will be listed in the `Connections` tab under the `Integrations` menu. |
||||
|
||||
:::info |
||||
Note that, there is no ownership concept for connections in NocoDB. All the connections created in a workspace are accessible to all eligible users in that workspace. |
||||
- Users with **Workspace Creator+** permissions can create, edit, duplicate, and delete connections |
||||
- Users with **Base Creator+** permissions can create data sources using database connections |
||||
::: |
||||
|
||||
## Database Integrations |
||||
|
||||
### PostgreSQL |
||||
This section covers the details required to create a new PostgreSQL connection in NocoDB. |
||||
|
||||
 |
||||
|
||||
1. **Connection Name**: Name for this connection for display on NocoDB UI |
||||
2. Key in following database connection configuration details |
||||
- **Host Address**: Hostname of the PostgreSQL server |
||||
- **Port Number**: Port number of the PostgreSQL server, default is 5432 |
||||
- **Username**: Username to connect to the PostgreSQL server, default is "postgres" |
||||
- **Password**: Password to connect to the PostgreSQL server |
||||
- [Optional] **Database**: Name of the PostgreSQL database to connect to |
||||
- [Optional] **Schema Name**: Name of the schema to connect to |
||||
:::info |
||||
Note, Database name & Schema name are optional fields when creating a connection. If provided, these details will be filled in by default when creating a new data source using this connection. |
||||
::: |
||||
3. **Connection parameters**: required if any, can be added as Key-Value pairs |
||||
4. **SSL Mode**: This step is required if the connection required is TLS/MTLS for MITM protection. Toggle to enable SSL for the connection & select the SSL mode |
||||
- **Client Certificate**: Upload the client certificate file |
||||
- **Client Key**: Upload the client key file |
||||
- **Root CA**: Upload the Root CA file |
||||
5. **Test Database Connection**: Click to verify the connection |
||||
6. **Create Connection**: Click to save the data source |
||||
|
||||
The connection thus created will be listed in the `Connections` tab under the `Integrations` menu. |
||||
|
||||
:::note |
||||
You can autofill the connection details if you have a connection URL. |
||||
|
||||
 |
||||
::: |
||||
|
||||
:::note |
||||
The entire connection parameters can be viewed in JSON form by clicking on the **Advanced Options** and edited as required by database server type. |
||||
|
||||
**Example**: When SSL mode set to "Required-Identity," if the server certificate's common name (cname) differs from the actual DNS/IP used for connection, the connection will fail. To resolve, add "servername" property with same cname value under the SSL section. Additional details are available at [knex configuration options](https://knexjs.org/guide/#configuration-options). |
||||
::: |
||||
|
||||
### MySQL |
||||
This section covers the details required to create a new MySQL connection in NocoDB. |
||||
|
||||
 |
||||
|
||||
1. **Connection Name**: Name for this connection for display on NocoDB UI |
||||
2. Key in following database connection configuration details |
||||
- **Host Address**: Hostname of the MySQL server |
||||
- **Port Number**: Port number of the MySQL server, default is 3306 |
||||
- **Username**: Username to connect to the MySQL server, default is "root" |
||||
- **Password**: Password to connect to the MySQL server |
||||
- [Optional] **Database**: Name of the MySQL database to connect to |
||||
:::info |
||||
Note, Database name is optional when creating a connection. If provided, it will be filled in by default when creating a new data source using this connection. |
||||
::: |
||||
3. **Connection parameters**: required if any, can be added as Key-Value pairs |
||||
4. **SSL Mode**: This step is required if the connection required is TLS/MTLS for MITM protection. Toggle to enable SSL for the connection & select the SSL mode |
||||
- **Client Certificate**: Upload the client certificate file |
||||
- **Client Key**: Upload the client key file |
||||
- **Root CA**: Upload the Root CA file |
||||
5. **Test Database Connection**: Click to verify the connection |
||||
6. **Create Connection**: Click to save the data source |
||||
|
||||
The connection thus created will be listed in the `Connections` tab under the `Integrations` menu. |
||||
|
||||
:::note |
||||
You can autofill the connection details if you have a connection URL. |
||||
|
||||
 |
||||
::: |
||||
|
||||
:::note |
||||
The entire connection parameters can be viewed in JSON form by clicking on the **Advanced Options** and edited as required by database server type. |
||||
|
||||
**Example**: When SSL mode set to "Required-Identity," if the server certificate's common name (cname) differs from the actual DNS/IP used for connection, the connection will fail. To resolve, add "servername" property with same cname value under the SSL section. Additional details are available at [knex configuration options](https://knexjs.org/guide/#configuration-options). |
||||
::: |
||||
@ -0,0 +1,61 @@
|
||||
--- |
||||
title: 'Actions on connection' |
||||
description: 'Learn how to perform actions (edit, duplicate, delete) on a connection in NocoDB.' |
||||
tags: ['Integrations', 'Actions', 'Connection', 'Edit', 'Duplicate', 'Delete'] |
||||
keywords: ['NocoDB connection', 'edit connection', 'duplicate connection', 'delete connection'] |
||||
--- |
||||
|
||||
## List |
||||
To list all the connections in NocoDB, follow the steps below: |
||||
1. Select the **Integrations** menu in the left sidebar. |
||||
2. Click on the **Connections** tab |
||||
|
||||
 |
||||
|
||||
Connections list provides a consolidated view of all the connections in this workspace. The details include |
||||
- Connection name, as specified during creation |
||||
- Connection type, i.e., the integration type [Example: PG, MySQL] |
||||
- Date added, specifies the date when this connection was created |
||||
- Added by, specifies the user who created this connection |
||||
- Usage, depends on the type of the integration |
||||
- for database type integrations, this would specify the number of data sources using this connection |
||||
|
||||
:::info |
||||
Note that, there is no ownership concept for connections in NocoDB. All the connections created in a workspace are accessible to all eligible users in that workspace. |
||||
- Users with Workspace Creator+ permissions can create, edit, duplicate, and delete connections |
||||
- Users with Base Creator+ permissions can create data sources using these connections |
||||
::: |
||||
|
||||
|
||||
## Edit |
||||
To edit a connection in NocoDB, Open the [Connections list](#list) and follow the steps below: |
||||
- Click on the Connection you want to edit |
||||
- Modify the required details in the subsequent modal |
||||
- **Test connection** if applicable |
||||
- Applicable if you have updated the connection details for a database integration |
||||
- Click on the **Update connection** button to save the changes |
||||
|
||||
## Duplicate |
||||
|
||||
To duplicate a connection in NocoDB, Open the [Connections list](#list) and follow the steps below: |
||||
1. Click on the Action menu (three dots) against the Connection you want to duplicate |
||||
2. Select the **Duplicate** option from the dropdown |
||||
|
||||
Duplicated base will be created with the same connection details as the original connection - with connection name for the duplicated entry suffixed with **_copy**. |
||||
|
||||
 |
||||
|
||||
## Delete |
||||
|
||||
To delete a connection in NocoDB, Open the [Connections list](#list) and follow the steps below: |
||||
1. Click on the Action menu (three dots) against the Connection you want to delete |
||||
2. Select the **Delete** option from the dropdown |
||||
3. Click on the **Delete** button in the subsequent modal to confirm deletion |
||||
|
||||
 |
||||
|
||||
 |
||||
|
||||
:::warning |
||||
Note that, deleting a database connection **will remove all the associated data sources using this connection** from all the bases in this workspace. |
||||
::: |
||||
@ -0,0 +1,8 @@
|
||||
{ |
||||
"label": "Integrations", |
||||
"collapsible": true, |
||||
"collapsed": true, |
||||
"link": { |
||||
"type": "generated-index" |
||||
} |
||||
} |
||||
|
Before Width: | Height: | Size: 195 KiB After Width: | Height: | Size: 205 KiB |
|
Before Width: | Height: | Size: 128 KiB After Width: | Height: | Size: 237 KiB |
|
Before Width: | Height: | Size: 175 KiB After Width: | Height: | Size: 316 KiB |
|
Before Width: | Height: | Size: 323 KiB After Width: | Height: | Size: 307 KiB |
|
Before Width: | Height: | Size: 278 KiB After Width: | Height: | Size: 371 KiB |
|
Before Width: | Height: | Size: 403 KiB After Width: | Height: | Size: 492 KiB |
|
After Width: | Height: | Size: 193 KiB |
|
Before Width: | Height: | Size: 118 KiB After Width: | Height: | Size: 272 KiB |
|
Before Width: | Height: | Size: 267 KiB After Width: | Height: | Size: 265 KiB |
|
Before Width: | Height: | Size: 292 KiB After Width: | Height: | Size: 307 KiB |
|
After Width: | Height: | Size: 178 KiB |
|
Before Width: | Height: | Size: 138 KiB After Width: | Height: | Size: 166 KiB |
|
Before Width: | Height: | Size: 330 KiB After Width: | Height: | Size: 242 KiB |
|
Before Width: | Height: | Size: 176 KiB After Width: | Height: | Size: 163 KiB |
|
After Width: | Height: | Size: 263 KiB |
|
After Width: | Height: | Size: 93 KiB |
|
After Width: | Height: | Size: 309 KiB |
|
After Width: | Height: | Size: 239 KiB |
|
After Width: | Height: | Size: 264 KiB |
|
After Width: | Height: | Size: 292 KiB |
|
After Width: | Height: | Size: 295 KiB |
|
After Width: | Height: | Size: 295 KiB |
|
After Width: | Height: | Size: 302 KiB |