diff --git a/packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md b/packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md index 82fc5f9188..170226c44c 100644 --- a/packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md +++ b/packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md @@ -40,8 +40,6 @@ To connect to an external data source, follow the steps below: - 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) @@ -49,3 +47,38 @@ To connect to an external data source, follow the steps below: ![data source-3](/img/v2/data-source/ds-connect-3.png) ![data source-4](/img/v2/data-source/ds-connect-4.png) + + + +## Configuring Permissions +When connecting NocoDB to external data sources such as PostgreSQL, it is crucial to configure the appropriate permissions to ensure data integrity and security. This section explains the options available for schema and data editing, allowing you to tailor the access levels according to your requirements. + +![data source-1](/img/v2/data-source/data-source-permissions.png) + +NocoDB provides the following options for schema and data permissions: + + +### Schema Permissions +This option enables users to modify the structure of the database schema. When enabled, users can create, modify, and delete tables, fields and relationships (links) within the connected datasource from NocoDB UI. This provides flexibility to adjust the database design as needed from UI but should be used with caution. + +Toggle `Allow Schema Edit` to enable or disable schema editing for the connected datasource. By default, schema editing is disabled. + +Even when schema editing is disabled, users can still + +- add (augment) virtual columns such as Lookup, Rollup and Formula. These virtual columns do not alter the underlying schema of the connected data source. +- create views to customize the data presentation without modifying the original tables. +- create webhooks to trigger external actions based on specific events within the connected datasource. +- collaborate with other users by explicitly inviting them to the base or by sharing views. + + + +### Data Permissions +This option enables users to modify the data (records) within the connected datasource. When enabled, users can insert, update, and delete records from the tables. This provides the flexibility to manage the data directly from the NocoDB UI but should be used with caution to avoid unintentional changes to the records in the external data source. + +Toggle `Allow Data Edit` to enable or disable data editing for the connected datasource. By default, data editing is enabled. + +When data editing is disabled, users can still view the data and perform read-only operations such as filtering, sorting, and grouping. This ensures that users can access the data for analysis and reporting purposes without the risk of modifying the records. + +:::note +Data editing can only be disabled when schema editing is also disabled +::: diff --git a/packages/noco-docs/static/img/v2/data-source/data-source-permissions.png b/packages/noco-docs/static/img/v2/data-source/data-source-permissions.png new file mode 100644 index 0000000000..784335e9cd Binary files /dev/null and b/packages/noco-docs/static/img/v2/data-source/data-source-permissions.png differ