Browse Source

docs: update

pull/8510/head
Raju Udava 6 months ago
parent
commit
529d7c0885
  1. 8
      packages/noco-docs/docs/100.data-sources/010.data-source-overview.md
  2. 29
      packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md
  3. 18
      packages/noco-docs/docs/100.data-sources/030.sync-with-data-source.md
  4. BIN
      packages/noco-docs/static/img/v2/data-source/data-source-1.png
  5. BIN
      packages/noco-docs/static/img/v2/data-source/data-source-2.png
  6. BIN
      packages/noco-docs/static/img/v2/data-source/data-source-meta-sync-1.png
  7. BIN
      packages/noco-docs/static/img/v2/data-source/data-source-meta-sync-2.png
  8. BIN
      packages/noco-docs/static/img/v2/data-source/ds-connect-1.png
  9. BIN
      packages/noco-docs/static/img/v2/data-source/ds-connect-2.png
  10. BIN
      packages/noco-docs/static/img/v2/data-source/ds-connect-3.png
  11. BIN
      packages/noco-docs/static/img/v2/data-source/ds-connect-4.png

8
packages/noco-docs/docs/100.data-sources/010.data-source-overview.md

@ -21,10 +21,12 @@ Currently only one external data source can be added per project.
## Accessing `Data Sources`
1. Access Base context menu by clicking on the `Base` name in the left sidebar
2. Click on `Data Sources` tab
1. Access 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
![data source](/img/v2/data-source/data-source.png)
![data source](/img/v2/data-source/data-source-1.png)
![data source](/img/v2/data-source/data-source-2.png)
Learn more about working with Data sources in the following sections:

29
packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md

@ -7,10 +7,11 @@ keywords: ['NocoDB data source', 'connect data source', 'external data source',
To connect to an external data source, follow the steps below:
1. Access Base context menu by clicking on the `Base` name in the left sidebar
2. Select `Data Sources` tab
3. Click on `+ New Data Source` button
4. On the pop-up modal, provide the following details:
1. Access 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 |
|---------------|--------------------------------------------------------------------------------------|
@ -23,7 +24,7 @@ To connect to an external data source, follow the steps below:
| Database | Name of the database to connect to |
| Schema name | Name of the schema to connect to |
4a. Optionally, if the connection required is TLS/MTLS for MITM protection, follow these additional steps below:
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.
@ -33,16 +34,18 @@ To connect to an external data source, follow the steps below:
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).
5. Click on `Test Database Connection` button to verify the connection
6. Wait for the connection to be verified.
- After connection is successful, `Submit` button will be enabled.
- Click on `Submit` button to save the data source.
6. Click on `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 `Counnect to Data Source` button to save the data source.
![data source-1](/img/v2/data-source/data-source-connect-1.png)
![data source-2](/img/v2/data-source/data-source-connect-2.png)
![data source-3](/img/v2/data-source/data-source-connect-3.png)
![data source-1](/img/v2/data-source/ds-connect-1.png)
![data source-4](/img/v2/data-source/data-source-connect-4a.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)

18
packages/noco-docs/docs/100.data-sources/030.sync-with-data-source.md

@ -5,17 +5,15 @@ tags: ['Data Sources', 'Sync', 'External', 'PG', 'MySQL']
keywords: ['NocoDB data source', 'connect data source', 'external data source', 'PG data source', 'MySQL data source']
---
1. Access Base context menu by clicking on the `Base` name in the left sidebar
2. Select `Data Sources` tab
3. Click on `Sync Metadata` button listed under `Actions` column for the data source that you wish to sync metadata for
4. Click on `Reload` button to refresh Sync state (Optional)
5. Any changes to the metadata identified will be listed in the `Sync State` column
6. Click on `Sync Now` button to sync the metadata changes
Access `Data Sources` tab in the `Base Settings` to sync changes done in the external data source with NocoDB.
1. Select the data source that you wish to sync metadata for
2. Click on `Meta Sync` button listed under `Actions` column for the data source that you wish to sync metadata for
3. Click on `Reload` button to refresh Sync state (Optional)
4. Any changes to the metadata identified will be listed in the `Sync State` column
5. Click on `Sync Now` button to sync the metadata changes
![sync metadata](/img/v2/data-source/data-source-2.png)
![sync metadata](/img/v2/data-source/data-source-meta-sync.png)
![sync metadata](/img/v2/data-source/data-source-meta-sync-1.png)
![sync metadata](/img/v2/data-source/data-source-meta-sync-2.png)
After the sync is complete, you can see the updated state in the `Sync State` column.
Sync modal also marks `Tables metadata is in Sync` in the header.

BIN
packages/noco-docs/static/img/v2/data-source/data-source-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 195 KiB

BIN
packages/noco-docs/static/img/v2/data-source/data-source-2.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 175 KiB

After

Width:  |  Height:  |  Size: 128 KiB

BIN
packages/noco-docs/static/img/v2/data-source/data-source-meta-sync-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 118 KiB

BIN
packages/noco-docs/static/img/v2/data-source/data-source-meta-sync-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 267 KiB

BIN
packages/noco-docs/static/img/v2/data-source/ds-connect-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 195 KiB

BIN
packages/noco-docs/static/img/v2/data-source/ds-connect-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

BIN
packages/noco-docs/static/img/v2/data-source/ds-connect-3.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 268 KiB

BIN
packages/noco-docs/static/img/v2/data-source/ds-connect-4.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 148 KiB

Loading…
Cancel
Save