Browse Source

docs: minor update on content

Signed-off-by: Wing-Kam Wong <wingkwong.code@gmail.com>
pull/1685/head
Wing-Kam Wong 3 years ago
parent
commit
9c7e7bf9c9
  1. 4
      packages/noco-docs/content/en/engineering/architecture.md
  2. 14
      packages/noco-docs/content/en/setup-and-usages/primary-value.md
  3. 4
      packages/noco-docs/content/en/setup-and-usages/share-view.md

4
packages/noco-docs/content/en/engineering/architecture.md

@ -5,7 +5,9 @@ position: 4000
category: "Engineering" category: "Engineering"
menuTitle: "NocoDB Architecture" menuTitle: "NocoDB Architecture"
--- ---
<!-- TODO: add some text -->
By default, if `NC_DB` is not specified, then SQLite will be used to store your meta data. We suggest users to separate the meta data and user data in different databases.
<!-- TODO: update diagram --> <!-- TODO: update diagram -->
<img src="../architecture.png" style="background: white;border-radius:4px;padding :10px"> <img src="../architecture.png" style="background: white;border-radius:4px;padding :10px">

14
packages/noco-docs/content/en/setup-and-usages/primary-value.md

@ -6,27 +6,27 @@ category: "Product"
menuTitle: "Primary value" menuTitle: "Primary value"
--- ---
## What is a `Primary Value` ? ## What is a Primary Value ?
- Primary value as the name stands is the primary or main value within a row of a table that you generally associate that row with. - Primary value as the name stands is the primary or main value within a row of a table that you generally associate that row with.
- It should be usually associated with a column which is uniquely identifiable. However, this uniqueness is not enforced at the database level. - It should be usually associated with a column which is uniquely identifiable. However, this uniqueness is not enforced at the database level.
## What is the use of `Primary Value` ? ## What is the use of Primary Value ?
- Within a spreadsheet, primary value are always highlighted so that it is easier to recognise what row we are in. - Within a spreadsheet, primary value are always highlighted so that it is easier to recognise what row we are in.
- And when LinkToAnotherRecord is created between two tables - it is the primary value that appears in LinkToAnotheRecord column. - And when LinkToAnotherRecord is created between two tables - it is the primary value that appears in LinkToAnotheRecord column.
#### Example : ```Primary value```highlighted in actor table #### Example : Primary Value highlighted in actor table
<img width="547" alt="actor" src="https://user-images.githubusercontent.com/5435402/152645708-92b83985-4a0a-42b2-9d01-d26be70fd3aa.png"> <img width="547" alt="actor" src="https://user-images.githubusercontent.com/5435402/152645708-92b83985-4a0a-42b2-9d01-d26be70fd3aa.png">
#### Example : ```Primary value``` highlighted in film table #### Example : Primary Value highlighted in film table
<img width="1406" alt="film-table" src="https://user-images.githubusercontent.com/5435402/152645713-b4df99b2-4eb7-4fea-85f9-0baf47470ef3.png"> <img width="1406" alt="film-table" src="https://user-images.githubusercontent.com/5435402/152645713-b4df99b2-4eb7-4fea-85f9-0baf47470ef3.png">
#### Example : ```Primary value``` associated when ```LinkToAnotherRecord``` is created #### Example : Primary Value associated when LinkToAnotherRecord is created
<img width="753" alt="actor-film" src="https://user-images.githubusercontent.com/5435402/152645714-4061c94a-4cfb-44e5-b112-63cf4ed869fe.png"> <img width="753" alt="actor-film" src="https://user-images.githubusercontent.com/5435402/152645714-4061c94a-4cfb-44e5-b112-63cf4ed869fe.png">
## How is ```Primary value``` identfied for existing database tables ? ## How is Primary Value identfied for existing database tables ?
- It is usually the first column after the primary key which is not a number. - It is usually the first column after the primary key which is not a number.
- If there is no column which is not a number then the column adjacent to primary key is chosen. - If there is no column which is not a number then the column adjacent to primary key is chosen.
## Can I change the ```Primary Value``` to another column within tables ? ## Can I change the Primary Value to another column within tables ?
- Yes, you can. Hover over column which you want as primary column and click ```Set as Primary Value``` - Yes, you can. Hover over column which you want as primary column and click ```Set as Primary Value```

4
packages/noco-docs/content/en/setup-and-usages/share-view.md

@ -6,7 +6,7 @@ category: "Product"
menuTitle: "Share View" menuTitle: "Share View"
--- ---
## Generate `Share View` ## Generate Share View
- Open a table or a view - Open a table or a view
@ -22,7 +22,7 @@ menuTitle: "Share View"
![image](https://user-images.githubusercontent.com/35857179/161970131-0fa83989-0673-493d-968f-76913a09cc06.png) ![image](https://user-images.githubusercontent.com/35857179/161970131-0fa83989-0673-493d-968f-76913a09cc06.png)
## Access `Share View` ## Access Share View
- Access the link. If it is password-protected, enter the password to unlock. - Access the link. If it is password-protected, enter the password to unlock.

Loading…
Cancel
Save