Browse Source

docs: table import, fields

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
pull/6467/head
Raju Udava 1 year ago
parent
commit
34de4f7b77
  1. 10
      packages/noco-docs/docs/050.tables/010.table-overview.md
  2. 13
      packages/noco-docs/docs/050.tables/020.create-table.md
  3. 38
      packages/noco-docs/docs/050.tables/030.create-table-via-import.md
  4. 26
      packages/noco-docs/docs/050.tables/040.import-data-into-existing-table.md
  5. 21
      packages/noco-docs/docs/050.tables/050.delete-table.md
  6. 47
      packages/noco-docs/docs/050.tables/060.actions-on-table.md
  7. 2
      packages/noco-docs/docs/060.fields/015.primary-key.md
  8. 6
      packages/noco-docs/docs/060.fields/020.display-value.md
  9. 2
      packages/noco-docs/docs/060.fields/030.field-types/040.links-based/010.links.md
  10. 4
      packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/070.specific-db-type.md
  11. 22
      packages/noco-docs/docs/060.fields/050.delete-field.md
  12. 31
      packages/noco-docs/docs/060.fields/060.actions-on-field.md
  13. BIN
      packages/noco-docs/static/img/v2/fields/display-value-in-linked-record.png
  14. BIN
      packages/noco-docs/static/img/v2/fields/display-value.png
  15. BIN
      packages/noco-docs/static/img/v2/fields/linked-record-modal.png
  16. BIN
      packages/noco-docs/static/img/v2/fields/set-as-display-value.png
  17. BIN
      packages/noco-docs/static/img/v2/fields/specific-db-type.png
  18. BIN
      packages/noco-docs/static/img/v2/table/import-csv-url.png
  19. BIN
      packages/noco-docs/static/img/v2/table/import-csv.png
  20. BIN
      packages/noco-docs/static/img/v2/table/import-stage-2.png
  21. BIN
      packages/noco-docs/static/img/v2/table/table-context-menu.png
  22. BIN
      packages/noco-docs/static/img/v2/table/table-create-1.png
  23. BIN
      packages/noco-docs/static/img/v2/table/table-create-2.png
  24. BIN
      packages/noco-docs/static/img/v2/table/table-delete.png
  25. BIN
      packages/noco-docs/static/img/v2/table/table-duplicate.png
  26. BIN
      packages/noco-docs/static/img/v2/table/table-import-1.png
  27. BIN
      packages/noco-docs/static/img/v2/table/table-import-2.png
  28. BIN
      packages/noco-docs/static/img/v2/table/table-rename.png
  29. BIN
      packages/noco-docs/static/img/v2/table/upload-csv-1.png
  30. BIN
      packages/noco-docs/static/img/v2/table/upload-csv-2.png
  31. BIN
      packages/noco-docs/static/img/v2/table/upload-csv-3.png
  32. BIN
      packages/noco-docs/static/img/v2/table/upload-csv-url.png

10
packages/noco-docs/docs/050.tables/010.table-overview.md

@ -13,9 +13,11 @@ Much like traditional spreadsheets, NocoDB tables empower you to carry out tasks
As you delve into this section, you'll gain a deeper understanding of how to leverage NocoDB's tables effectively, equipping you to proficiently organize your own dataset.
## Related articles
- [Create table](/tables/create-table)
- [Import a table using a CSV, Excel or a JSON](/tables/create-table-via-import)
- [Create a new table](/tables/create-table)
- [Create a table using a CSV, Excel or a JSON](/tables/create-table-via-import)
- [Import data from Csv/Xlsx into existing table](/tables/import-data-into-existing-table)
- [Delete table](/tables/delete-table)
- [Table actions](/tables/actions-on-table)
- [Rename a table](/tables/actions-on-table#rename-table)
- [Duplicate a table](/tables/actions-on-table#duplicate-table)
- [Delete a table](/tables/actions-on-table#delete-table)

13
packages/noco-docs/docs/050.tables/020.create-table.md

@ -1,16 +1,17 @@
---
title: 'Create table'
title: 'Create empty table'
description: 'Learn how to create a table in NocoDB.'
tags: ['tables', 'create table']
keywords: ['NocoDB table', 'create table', 'table administration', 'table organization']
---
## New table
## Create new table
1. Click on `+` on the left sidebar next to `base name` OR click on `+ New Table` button on the Base dashboard.
2. Fill table name in the pop-up modal.
3. Click on `Create Table` button.
![image](/img/v2/create-table.png)
![image](/img/v2/create-table-2.png)
![image](/img/v2/table/table-create-1.png)
![image](/img/v2/table/table-create-2.png)
### Related articles

38
packages/noco-docs/docs/050.tables/030.create-table-via-import.md

@ -1,19 +1,21 @@
---
title: 'Create table via import'
description: 'Learn how to create a table in NocoDB via import from CSV, Excel or JSON.'
tags: ['tables', 'import']
keywords: ['NocoDB table', 'create table', 'table administration', 'table organization', 'import table', 'import csv', 'import excel', 'import json']
---
## Import table from CSV / Excel / JSON
### Accessing import modal
There are two ways to access import modal:
#### 1. From the project dashboard
![image](/img/v2/import-csv-1.png)
![image](/img/v2/import-csv-2.png)
#### 1. From the base dashboard
![image](/img/v2/table/table-import-1.png)
![image](/img/v2/table/table-import-2.png)
#### 2. From the table context menu
![image](/img/v2/import-csv-3.png)
#### 2. From the base context menu
![image](/img/v2/base/base-import-sub-menu.png)
### Importing file
There are two ways to upload source file:
@ -23,14 +25,14 @@ There are two ways to upload source file:
2. Click on `file upload` button or drag and drop file to the modal.
3. [Advance Settings](#advance-settings) (optional)
4. Click on `Import` button.
![image](/img/v2/import-csv-4.png)
![image](/img/v2/table/import-csv.png)
#### 2. Upload from URL
1. Select `URL` tab from the Quick import modal.
2. Paste the URL of the file.
3. [Advance Settings](#advance-settings) (optional)
4. Click on `Import` button.
![image](/img/v2/import-csv-5.png)
![image](/img/v2/table/import-csv-url.png)
:::info
- Multiple files can be imported at once.
@ -40,22 +42,22 @@ There are two ways to upload source file:
### Import configurations
1. `Table name` - defaults to the name of the file; double click to edit.
2. `Field configurations` - Optional
1. [**Optional**] `Table name` - defaults to the name of the file; double click to edit.
2. [**Optional**] `Field configurations`
- `Field name` - name of the column as identified from import file header; click to edit.
- `Field type` - inferred from the data in the column; click to edit.
- `Options` - For `Single select` and `Multi select` field types, options identified are listed here; click to edit.
3. Click on `Import` button to start importing the file.
4. `Remove field` - Click on delete icon to exclude a field in source file from being imported.
3. [**Optional**] `Remove field` - Click on delete icon to exclude a field in source file from being imported.
4. Click on `Import` button to start importing the file.
![image](/img/v2/import-csv-6.png)
![image](/img/v2/table/import-stage-2.png)
### Advance settings
- `# of rows to parse to infer datatype` - defaults to 500 rows.
- `Auto select field types` - enabled by default. If checked, field types will be detected. Otherwise, all fields will default to `SingleLineText`.
- `Use first row as headers` - enabled by default. If checked, the first row will be treated as header row & will be used as field names.
- `Import data` - enabled by default. If checked, all data will be imported; otherwise, only table will be created.
### Advanced Settings
- **Number of Rows for Datatype Inference**: Default value is set to 500 rows.
- **Automatic Field Type Detection**: Enabled by default. If selected, the system will automatically detect field types. Otherwise, all fields will default to "SingleLineText."
- **Utilize First Row as Headers**: Enabled by default. If selected, the first row will be treated as the header row and used as field names.
- **Import Data**: Enabled by default. If selected, all data will be imported; otherwise, only the table will be created.
:::info
By default, the first column will be chosen as Display Value and cannot be deleted.

26
packages/noco-docs/docs/050.tables/040.import-data-into-existing-table.md

@ -1,5 +1,8 @@
---
title: 'Import data into an existing table'
description: 'Learn how to import data into an existing table in NocoDB.'
tags: ['tables', 'import']
keywords: ['NocoDB table', 'import data into table', 'import data from csv', 'import data from excel', 'import data from xlsx']
---
@ -10,7 +13,7 @@ title: 'Import data into an existing table'
2. Click on `Upload` button.
3. Select `Upload CSV` / `Upload Excel` option.
![image](/img/v2/upload-csv-1.png)
![image](/img/v2/table/upload-csv-1.png)
### Importing file data
There are two ways to upload source file:
@ -21,7 +24,7 @@ There are two ways to upload source file:
3. [Advance Settings](#advance-settings) (optional)
4. Click on `Import` button.
![image](/img/v2/upload-csv-2.png)
![image](/img/v2/table/upload-csv-2.png)
#### 2. Upload from URL
1. Select `URL` tab from the Quick import modal.
@ -29,13 +32,24 @@ There are two ways to upload source file:
3. [Advance Settings](#advance-settings) (optional)
4. Click on `Import` button.
![image](/img/v2/upload-csv-url.png)
![image](/img/v2/table/upload-csv-url.png)
### Field mapping
1. Existing column names are listed under `Source column`. New columns identified from the import file are listed under `Destination column`. NocoDB auto maps destination column names based on the source column names. One can reconfigure mapping by making use of dropdown that appears on clicking destination column. Checkbox is provided to exclude a column from being imported.
2. Click on `Import` button to start importing the file.
1. **Table Name** (Optional)
- Defaults to the name of the file; double-click to edit.
![image](/img/v2/upload-csv-3.png)
2. **Mapping Columns** (Optional)
- Existing column names are listed under `Source column`, while new columns identified from the import file are listed under `Destination column`.
- NocoDB automatically maps destination column names based on the source column names.
- You can reconfigure the mapping by utilizing the dropdown menu that appears when you click on the destination column.
3. **Exclude Columns** (Optional)
- A checkbox is provided to exclude a column from being imported.
4. **Initiate Import**
- Click on the `Import` button to commence the file import process.
![image](/img/v2/table/upload-csv-3.png)
### Advance settings
- `# of rows to parse to infer datatype` - defaults to 500 rows.

21
packages/noco-docs/docs/050.tables/050.delete-table.md

@ -1,21 +0,0 @@
---
title: 'Delete table'
---
:::danger
**This action cannot be undone.**
:::
1. Open the table context menu by clicking on `...` from the left sidebar.
2. Click on `Delete` option.
![image](/img/v2/table-context-menu.png)
## Related articles
- [Table overview](/tables/table-overview)
- [Create table](/tables/create-table)
- [Create table via import](/tables/create-table-via-import)
- [Import data from Csv/Xlsx into existing table](/tables/import-data-into-existing-table)
- [Table actions](/tables/actions-on-table)

47
packages/noco-docs/docs/050.tables/060.actions-on-table.md

@ -1,27 +1,33 @@
---
title: 'Actions on table'
description: 'Learn how to rename, duplicate, and delete a table in NocoDB.'
tags: ['tables', 'rename', 'duplicate', 'delete']
keywords: ['NocoDB table', 'rename table', 'duplicate table', 'delete table', 'table administration', 'table organization']
---
## Rename table
1. Open the table context menu by clicking on `...` from the left sidebar.
2. Click on `Rename` option.
3. Enter new table name.
4. Click on `Rename` button.
1. Access the contextual menu for the table by clicking on the ellipsis symbol (`...`) located in the left sidebar.
2. Click on the `Rename` option from the context menu.
3. Enter the desired new table name into the provided field.
4. To finalize the renaming process, click on the `Rename` button.
![image](/img/v2/table-context-menu-xcdb.png)
![image](/img/v2/rename-table.png)
![image](/img/v2/table/table-context-menu.png)
![image](/img/v2/table/table-rename.png)
## Duplicate table
1. Open the table context menu by clicking on `...` from the left sidebar.
2. From the dropdown, select `Duplicate` option.
3. Optional configurations
a) `Include data` : You can choose to duplicate the table with or without data.
b) `Include views` : You can choose to duplicate the table with or without views.
4. Click on `Rename Table` button on the confirmation modal.
5. New table will be created with the same schema and data/view as in the original table, based on configurations as specified in step (3).
1. Access the contextual menu for the table by clicking on the ellipsis symbol (`...`) located in the left sidebar.
2. Click on the `Duplicate` option from the context menu.
3. For additional customization (Optional)
a) Under `Include data`, you have the flexibility to choose whether to replicate the table with or without its data.
b) Regarding `Include views` you can select whether to duplicate the table with or without its associated views.
4. Proceed by clicking the `Duplicate Table` button found in the confirmation dialog.
A new table will be generated, mirroring the original table's schema and content, in accordance with the configurations specified in step 3.
![image](/img/v2/table/table-context-menu.png)
![image](/img/v2/table/table-duplicate.png)
:::info
- Duplicate table will be created in the same base as the original table
@ -29,6 +35,19 @@ title: 'Actions on table'
- Duplicate table option is not available for `External DB` projects
:::
## Delete table
:::danger
**This action cannot be undone.**
:::
1. Access the contextual menu for the table by clicking on the ellipsis symbol (`...`) located in the left sidebar.
2. Click on the `Delete` option from the context menu.
3. To finalize the deletion process, click on the `Delete` button in the confirmation dialog.
![image](/img/v2/table/table-context-menu.png)
![image](/img/v2/table/table-delete.png)
## Related articles
- [Table overview](/tables/table-overview)
- [Create table](/tables/create-table)

2
packages/noco-docs/docs/060.fields/015.primary-key.md

@ -10,7 +10,7 @@ A primary key is a special database table column designated to uniquely identify
As it uniquely identifies an individual record of a table, it is used internally by NocoDB for all operations associated with a record
## Primary Key in NocoDB
- Primary Key that gets defined / used in NocoDB depends on how underlying table was created. Summary is captured below
Primary Key that gets defined / used in NocoDB depends on how underlying table was created. Summary is captured below
1. From UI, Create new table / Import from Excel / Import from CSV
1. An `ID` [datatype: Integer] system field created by default during table creation is used as primary key
2. Additional system fields `created-at`, `updated-at` are inserted by default & can be omitted optionally; these fields can be deleted after table creation

6
packages/noco-docs/docs/060.fields/020.display-value.md

@ -13,18 +13,18 @@ The `Display Value`, as its name suggests, serves as the primary or main value w
Example:
Display Value highlighted in Actor table
![display value](https://github.com/nocodb/nocodb/assets/86527202/f3773b9b-cd0e-411c-843f-9e37796a6600)
![display value](/img/v2/fields/display-value.png)
Display Value associated when Links field
The value shown in `Link Records` modal when adding a new link is associated records `Display value`
![display value- links field](https://github.com/nocodb/nocodb/assets/86527202/69eb206f-3796-4587-97cd-0c389053a20a)
![display value- links field](/img/v2/fields/display-value-in-linked-record.png)
## Set Display Value
Click dropdown icon (🔽) in the target column. Click `Set as Display Value`.
![display value set](https://github.com/nocodb/nocodb/assets/86527202/d5f09946-5654-46fe-8ecb-107fc9714219)
![display value set](/img/v2/fields/set-as-display-value.png)
:::info
How is Display Value identified for existing database tables ?

2
packages/noco-docs/docs/060.fields/030.field-types/040.links-based/010.links.md

@ -38,7 +38,7 @@ Clicking on the link-text will open a `Linked Records` modal with the list of li
### List linked records
![image](/img/v2/fields/linked-records-modal.png)
![image](/img/v2/fields/linked-record-modal.png)
A brief note about the modal components:
1. This modal is displaying linked records for `PENELOPE`

4
packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/070.specific-db-type.md

@ -8,4 +8,6 @@ title: 'Specific DB type'
2. [**Optional**] On the dropdown modal, enter the field name.
3. Select the field type as `Specific DB Type` from the dropdown.
4. Provide DB specific data type configurations
5. Click on `Save Column` button.
5. Click on `Save Column` button.
![image](/img/v2/fields/specific-db-type.png)

22
packages/noco-docs/docs/060.fields/050.delete-field.md

@ -1,22 +0,0 @@
---
title: 'Delete field'
---
:::danger
**This action cannot be undone.**
:::
To delete a field, follow the steps below:
1. Open the field context menu by clicking on dropdown icon (🔽) .
2. Click on **Delete**.
3. Confirm the deletion by clicking on **Delete Field** on the confirmation modal.
![Fields context menu](/img/v2/fields/fields-context-menu.png)
![Delete field](/img/v2/fields/detete-field-confirmation.png)
## Related topics
- [Actions on field](actions-on-field)

31
packages/noco-docs/docs/060.fields/060.actions-on-field.md

@ -8,7 +8,7 @@ Fields context menu can be accessed by clicking on the dropdown icon (🔽) next
![Fields context menu](/img/v2/fields/fields-context-menu.png)
### Edit
### Rename field
#### Rename field
1. Open the field context menu
2. Click on `Edit` option.
3. Enter new field name as required in the `Column Name` field.
@ -16,7 +16,7 @@ Fields context menu can be accessed by clicking on the dropdown icon (🔽) next
![Rename field](/img/v2/fields/fields-edit.png)
### Change field type
#### Change field type
1. Open the field context menu
2. Click on `Edit` option.
3. Select new field type from the `Column Type` dropdown.
@ -24,7 +24,7 @@ Fields context menu can be accessed by clicking on the dropdown icon (🔽) next
![Change field type](/img/v2/fields/fields-type-edit.png)
### Change default value
#### Change default value
1. Open the field context menu
2. Click on `Edit` option.
3. Enter new default value in the `Default Value` field. To disable, click on `x` icon.
@ -75,23 +75,12 @@ New field will be created to the right of the original field.
New field will be created to the left of the original field.
### Delete field
1. Open the field context menu
2. Click on `Delete` option.
:::danger
**This action cannot be undone.**
:::
To delete a field, follow the steps below:
1. Open the field context menu by clicking on dropdown icon (🔽) .
2. Click on **Delete**.
3. Confirm the deletion by clicking on **Delete Field** on the confirmation modal.
## Related topics
- [Delete field](delete-field)

BIN
packages/noco-docs/static/img/v2/fields/display-value-in-linked-record.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 164 KiB

BIN
packages/noco-docs/static/img/v2/fields/display-value.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 171 KiB

BIN
packages/noco-docs/static/img/v2/fields/linked-record-modal.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 172 KiB

BIN
packages/noco-docs/static/img/v2/fields/set-as-display-value.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 154 KiB

BIN
packages/noco-docs/static/img/v2/fields/specific-db-type.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 74 KiB

BIN
packages/noco-docs/static/img/v2/table/import-csv-url.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

BIN
packages/noco-docs/static/img/v2/table/import-csv.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 108 KiB

BIN
packages/noco-docs/static/img/v2/table/import-stage-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 135 KiB

BIN
packages/noco-docs/static/img/v2/table/table-context-menu.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 147 KiB

BIN
packages/noco-docs/static/img/v2/table/table-create-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

BIN
packages/noco-docs/static/img/v2/table/table-create-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

BIN
packages/noco-docs/static/img/v2/table/table-delete.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 172 KiB

BIN
packages/noco-docs/static/img/v2/table/table-duplicate.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 173 KiB

BIN
packages/noco-docs/static/img/v2/table/table-import-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB

BIN
packages/noco-docs/static/img/v2/table/table-import-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 KiB

BIN
packages/noco-docs/static/img/v2/table/table-rename.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 173 KiB

BIN
packages/noco-docs/static/img/v2/table/upload-csv-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

BIN
packages/noco-docs/static/img/v2/table/upload-csv-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 147 KiB

BIN
packages/noco-docs/static/img/v2/table/upload-csv-3.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 150 KiB

BIN
packages/noco-docs/static/img/v2/table/upload-csv-url.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 156 KiB

Loading…
Cancel
Save