clone/nocodb
1
0
Fork 0
mirror of https://github.com/nocodb/nocodb.git synced 2026-05-05 02:36:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: integrations (#9171)

Browse Source 
* 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 comments
This commit is contained in:
Raju Udava
2024-08-07 22:07:15 +05:30
committed by GitHub
parent a5d0ad7dbd
commit 4bb8911171
37 changed files with 301 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md
View File

@@ -5,50 +5,27 @@ tags: ['Data Sources', 'Connect', 'External', 'PG', 'MySQL', 'mtls', 'tls', 'ssl
keywords: ['NocoDB data source', 'connect data source', 'external data source', 'PG data source', 'MySQL data source']
---
To connect to an external data source, follow the steps below:
1. Access the Base context menu by clicking on the `...` in the left sidebar against the base name
2. Click on `Settings` tab
3. In the popup modal, click on `Data Sources` tab
4. Click on `+ New Data Source` button
5. On the input modal, provide the following details:
| Field Name | Description |
|---------------|--------------------------------------------------------------------------------------|
| Source Name | Name for this data source for display on NocoDB UI |
| Database Type | Type of the data source. Currently, NocoDB supports PostgreSQL & MySQL data sources. |
| Host Address | Hostname of the data source |
| Port Number | Port number of the data source |
| Username | Username to connect to the database |
| Password | Password to connect to the database |
| Database | Name of the database to connect to |
| Schema name | Name of the schema to connect to |
5a. Optionally, if the connection required is TLS/MTLS for MITM protection, follow these additional steps below:
- Click on `SSL & Advanced Parameters`
- Select `SSL Mode` and upload the client certificate, client key, and Root CA files by clicking on the file.
\
Note: The entire connection parameters can be viewed in json form by clicking on the "Edit connection JSON" and edited as required by database server type.\
\
Example: In PostgreSQL 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).
6. Click on the `Test Database Connection` button to verify the connection
7. Wait for the connection to be verified.
- After test is successful, `Counnect to Data Source` button will be enabled.
- Click on `Connect to Data Source` button to save the data source.
![data source-1](/img/v2/data-source/ds-connect-1.png)
![data source-2](/img/v2/data-source/ds-connect-2.png)
![data source-3](/img/v2/data-source/ds-connect-3.png)
![data source-4](/img/v2/data-source/ds-connect-4.png)
To connect an external Database as a new Data Source for NocoDB, follow the steps below:
1. Click on the Base name in the left sidebar to access the **Base homepage**
2. Click **Connect External Data** button
3. Provide a name to the data source
4. Select connection to pick credentials for the database
(a) Select connection from the list of available connections in the dropdown
(b) Click on `+ New connection` button to create a new connection instead
5. Configure / Change database & schema details as required. If default database & schema details were provided during connection creation, these details will be pre-filled.
6. [Configure permissions](#configuring-permissions) for the data source
7. Click on `Test Database Connection` button to verify the connection
8. Click on `Add Source` button to save the data source
![data source](/img/v2/data-source/data-source-1.png)
![data source](/img/v2/data-source/data-source-2.png)
![data source](/img/v2/data-source/data-source-3.png)
:::info
Option (4b) to create a new connection is available only if the user has the required permissions to create new connection (Workspace Creator+).
:::
## Configuring Permissions
This section covers the settings available when configuring data source permissions. These settings determine the level of access and modifications allowed on the connected database.