mirror of
https://github.com/nocodb/nocodb.git
synced 2026-05-04 18:47:06 +00:00
docs: integrations (#9171)
* 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:
@@ -5,35 +5,42 @@ tags: ['Data sources', 'UI ACL', 'Audit', 'Relations', 'Edit', 'Remove', 'Visibi
|
||||
keywords: ['NocoDB data source', 'UI ACL', 'Audit logs', 'Relations', 'Edit', 'Unlink', 'Visibility']
|
||||
---
|
||||
|
||||
## Edit external database configuration parameters
|
||||
- Access `Data Sources` tab in the `Base Settings`
|
||||
- Click on `Connection Details` tab
|
||||
- Re-configure database credentials as required
|
||||
## Edit Data Source parameters
|
||||
- Open [Data Sources](010.data-source-overview.md#accessing-data-sources) tab in the Base Settings homepage
|
||||
- Click on the data source that you wish to edit
|
||||
- Re-configure data source parameters as required. The following parameters can be edited:
|
||||
1. Data source name
|
||||
2. Database & Schema
|
||||
3. Data source access permissions
|
||||
- Click on `Submit` button to save the changes
|
||||
|
||||
:::info
|
||||
Please make sure database configuration parameters are valid. Any incorrect parameters could lead to schema loss!
|
||||
:::note
|
||||
To change database connection configuration parameters (like host, port, and such) use [Edit connection](/integrations/actions-on-connection#edit) option. Edit connection option is available only for the users with Workspace Creator+ permissions.
|
||||
:::
|
||||
|
||||

|
||||
|
||||
## Remove data source
|
||||
|
||||
- Access `Data Sources` tab in the `Base Settings`
|
||||
- Click on `Delete` icon listed under `Actions` column for the data source that you wish to remove
|
||||
Open [Data Sources](010.data-source-overview.md#accessing-data-sources) tab in the Base Settings homepage
|
||||
1. Click on Actions button (three dots) against the data source that you wish to remove
|
||||
2. Select `Remove` option from the dropdown
|
||||
|
||||

|
||||

|
||||
|
||||

|
||||
|
||||
:::note
|
||||
Unlinking a data source will not delete the external data source. It will only remove the data source from the current project.
|
||||
Removing a data source will not delete the external data source. It will only remove the data source from the current base.
|
||||
:::
|
||||
|
||||
|
||||
## Data source visibility
|
||||
|
||||
- Access `Data Sources` tab in the `Base Settings`
|
||||
- Open [Data Sources](010.data-source-overview.md#accessing-data-sources) tab in the Base Settings homepage
|
||||
- Toggle radio button listed under `Visibility` column for the data source that you wish to hide/un-hide
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
## UI Access Control
|
||||
@@ -42,18 +49,17 @@ Unlinking a data source will not delete the external data source. It will only r
|
||||
UI Access Control is available only in Open-Source version of NocoDB.
|
||||
:::
|
||||
|
||||
Access `Data Sources` tab in the `Base Settings` to manage UI access control for the data source.
|
||||
1. Click on `UI ACL` button listed under `Actions` column for the data source that you wish to manage UI access control for
|
||||
2. On the UI ACL modal, you can see the list of tables available in the data source as rows & roles available as columns. Toggle checkboxes to enable/disable access to tables for specific roles.
|
||||
Open [Data Sources](010.data-source-overview.md#accessing-data-sources) tab in the Base Settings homepage, select the data source that you wish to configure UI ACL for and follow the steps below:
|
||||
1. Select `UI ACL` tab
|
||||
2. You can see the list of views & tables available in the data source as rows & roles available as columns. Toggle checkboxes to enable/disable access to tables for specific roles.
|
||||
3. Click on `Save` button to save the changes
|
||||
|
||||
|
||||

|
||||
|
||||
|
||||
## Audit logs
|
||||
|
||||
Access `Data Sources` tab in the `Base Settings` to access Audit logs for the data source.
|
||||
- Open [Data Sources](010.data-source-overview.md#accessing-data-sources) tab in the Base Settings homepage
|
||||
- Click on `Default` datasource & then
|
||||
- Access `Audit` tab to view the audit logs.
|
||||
|
||||
@@ -64,17 +70,21 @@ Audit logs are not available for external data source connections.
|
||||
:::
|
||||
|
||||
## Relations
|
||||
Access `Data Sources` tab in the `Base Settings` to access Relations view for the data source.
|
||||
- Open [Data Sources](010.data-source-overview.md#accessing-data-sources) tab in the Base Settings homepage
|
||||
- Select the data source that you wish to access ERD (Relations view) for
|
||||
- Click on `ERD` tab
|
||||
- Click on `ERD View` tab
|
||||
|
||||

|
||||
|
||||
### Junction table names within Relations
|
||||
[//]: # (### Junction table names within Relations)
|
||||
|
||||
- Enable `Show M2M Tables` within `Project Settings` menu
|
||||
- Double-click on `Show Fields` to see additional checkboxes get enabled.
|
||||
- Enabling which you should be able to see junction tables and their table names.
|
||||
[//]: # ()
|
||||
[//]: # (- Enable `Show M2M Tables` within `Project Settings` menu)
|
||||
|
||||

|
||||
[//]: # (- Double-click on `Show Fields` to see additional checkboxes get enabled.)
|
||||
|
||||
[//]: # ( - Enabling which you should be able to see junction tables and their table names.)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ()
|
||||
|
||||
|
||||
Reference in New Issue
Block a user