mirror of https://github.com/nocodb/nocodb
Raju Udava
1 year ago
22 changed files with 599 additions and 13 deletions
@ -0,0 +1,92 @@ |
|||||||
|
--- |
||||||
|
title: "Share Base" |
||||||
|
description: "Procedures to share a base & generating embedded iframe" |
||||||
|
--- |
||||||
|
|
||||||
|
## Generate Share base |
||||||
|
|
||||||
|
- Open Project |
||||||
|
- Click on `Share` button to the top right in the top navigation bar |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
- Under `Shared base` section and toggle `Enable public access` to enable shared base |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
- Share base link generated is displayed over & can be used to share this project to others. Click `Copy Link` to copy URL |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
|
||||||
|
## Modify Share base |
||||||
|
|
||||||
|
Modifying `Share base` will invalidate the `Share base` link generated previously and will generate a new link. |
||||||
|
|
||||||
|
- Open Project base |
||||||
|
- Click on 'Share' button on top right tool bar |
||||||
|
- Toggle ``Enable public access`` to disable base share |
||||||
|
- Toggle ``Enable public access`` to re-enable base share & generate a new link |
||||||
|
|
||||||
|
|
||||||
|
## Disable Share base |
||||||
|
|
||||||
|
Disabling `Share base` will invalidate the generated `Share base` link |
||||||
|
|
||||||
|
- Open Project base |
||||||
|
- Click on 'Share' button on top right tool bar |
||||||
|
- Toggle ``Enable public access`` to disable base share |
||||||
|
|
||||||
|
## Share base Access Permissions |
||||||
|
|
||||||
|
Shared base can be configured as |
||||||
|
|
||||||
|
- Viewer - User with the link will get **READ ONLY** access to the project data. |
||||||
|
- Editor - User with the link will get **READ & WRITE** access to the project data. |
||||||
|
|
||||||
|
Toggle `Enable Editor Access` button to configure permissions as desired |
||||||
|
|
||||||
|
## Embeddable Frame |
||||||
|
|
||||||
|
NocoDB interface can be embedded into existing applications easily by making use of [HTML IFRAME](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe)) attribute. |
||||||
|
|
||||||
|
### Generate embeddable HTML code |
||||||
|
|
||||||
|
- Open Project base |
||||||
|
- Click on 'Share' button on top right tool bar |
||||||
|
- Under 'Shared base link' tab |
||||||
|
- Click on button to copy 'Embeddable HTML code' |
||||||
|
|
||||||
|
Example: |
||||||
|
|
||||||
|
```html |
||||||
|
<iframe |
||||||
|
class="nc-embed" |
||||||
|
src="https://nocodb-nocodb-rsyir.ondigitalocean.app/dashboard/#/nc/base/e3bba9df-4fc1-4d11-b7ce-41c4a3ad6810?embed" |
||||||
|
frameBorder="0" |
||||||
|
width="100%" |
||||||
|
height="700" |
||||||
|
style="background: transparent; border: 1px solid #ddd" |
||||||
|
> |
||||||
|
</iframe> |
||||||
|
``` |
||||||
|
|
||||||
|
### Embed into application's HTML Body |
||||||
|
|
||||||
|
Sample code with embedded iframe generated above |
||||||
|
|
||||||
|
```html |
||||||
|
<!DOCTYPE html> |
||||||
|
<html> |
||||||
|
<body> |
||||||
|
<iframe |
||||||
|
class="nc-embed" |
||||||
|
src="http://localhost:3000/#/nc/base/7d4b551c-b5e0-41c9-a87b-f3984c21d2c7?embed" |
||||||
|
frameBorder="0" |
||||||
|
width="100%" |
||||||
|
height="700" |
||||||
|
style="background: transparent; " |
||||||
|
></iframe> |
||||||
|
</body> |
||||||
|
</html> |
||||||
|
``` |
||||||
@ -0,0 +1,41 @@ |
|||||||
|
--- |
||||||
|
title: "Primary Key" |
||||||
|
description: "Understanding Primary Key in NocoDB!" |
||||||
|
--- |
||||||
|
|
||||||
|
# Primary Key |
||||||
|
A primary key is a special database table column designated to uniquely identify each table record. |
||||||
|
|
||||||
|
## Use of Primary Key |
||||||
|
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 |
||||||
|
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 |
||||||
|
2. Connect to existing external database |
||||||
|
1. Existing `primary key` field defined for a table is retained as is; NocoDB doesn't insert a new ID field |
||||||
|
2. Additional system fields `created-at`, `updated-at` are not inserted by default |
||||||
|
3. Import from Airtable |
||||||
|
1. Airtable record ID is marked as primary key for imported records, and is mapped to field `ncRecordId` [datatype: varchar] |
||||||
|
2. If a new record is inserted after migration & if ncRecordId field was omitted during record insertion - auto generated string will be inserted by NocoDB |
||||||
|
3. Computed hash value for the entire record is stored in system field `ncRecordHash` |
||||||
|
4. Additional system fields `created-at`, `updated-at` are not inserted by default |
||||||
|
4. Create new table using SDK / API |
||||||
|
1. No default primary key field is introduced by NocoDB. It has to be explicitly specified during table creation (using attribute `pk: true`) |
||||||
|
|
||||||
|
:::info |
||||||
|
**What if Primary Key was missing?** |
||||||
|
|
||||||
|
It is possible to have a table without any primary key. |
||||||
|
- External database table can be created without primary key configuration. |
||||||
|
- New table can be created using SDK / API without primary key |
||||||
|
|
||||||
|
In such scenario's, new records can be created in NocoDB for this table, but records can't be updated or deleted as there is no way for NocoDB to uniquely identify these records |
||||||
|
::: |
||||||
|
|
||||||
|
:::info |
||||||
|
**Can I change the Primary Key to another column within tables?** |
||||||
|
- You can't update Primary Key from NocoDB UI. You can reconfigure it at database level directly & trigger `meta sync` explicitly. |
||||||
|
::: |
||||||
@ -0,0 +1,36 @@ |
|||||||
|
--- |
||||||
|
title: "Display Value" |
||||||
|
description: "Understanding Display Value in NocoDB!" |
||||||
|
--- |
||||||
|
|
||||||
|
# Display Value |
||||||
|
|
||||||
|
The `Display Value`, as its name suggests, serves as the primary or main value within a row of a table, and it is typically the attribute by which we identify or associate that specific row. While it is advisable for the display value to be linked to a column with unique identifiers, such as a primary key, it's important to note that this uniqueness is not always enforced at the database level. |
||||||
|
|
||||||
|
## Use of Display Value |
||||||
|
- Within a spreadsheet, `Display Value` are always highlighted so that it is easier to recognise what row we are in. |
||||||
|
- And when `Links` are created between two tables - it is the Display Value that appears in `Linked records` modal. |
||||||
|
|
||||||
|
Example: |
||||||
|
Display Value highlighted in Actor table |
||||||
|
 |
||||||
|
|
||||||
|
Display Value associated when Links field |
||||||
|
The value shown in `Link Records` modal when adding a new link is associated records `Display value` |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
|
||||||
|
## Set Display Value |
||||||
|
Click dropdown icon (🔽) in the target column. Click `Set as Display Value`. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
:::info |
||||||
|
How is Display Value identified for existing database tables ? |
||||||
|
- 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. |
||||||
|
|
||||||
|
Can I change the Display Value to another column within tables ? |
||||||
|
- Yes, you can use the same way mentioned above to set Display Value. |
||||||
|
::: |
||||||
@ -0,0 +1,34 @@ |
|||||||
|
--- |
||||||
|
title: 'Expanded form' |
||||||
|
description: 'NocoDB provides Expanded Form to let you edit your data easily' |
||||||
|
--- |
||||||
|
|
||||||
|
## Overview |
||||||
|
|
||||||
|
Expanded Form allows you to edit a row data in a form. Apart from record information, it also consists of the activity feed such as user comments or revision history. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
## Expanding a Record |
||||||
|
|
||||||
|
To expand a record in a grid view, click on double arrow icon that appears on the first column on hover over a record. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
Alternatively, we can click on a cell and press the space bar. The expanded form for the corresponding record will be opened. |
||||||
|
|
||||||
|
## Activity Feed |
||||||
|
|
||||||
|
In an expanded form comment section, disable `Comments only` checkbox to show the activity feed. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
## Copy Record URL |
||||||
|
|
||||||
|
In an expanded form, click `Copy Record URL` to share the record form to other authorized users. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
## Comment on Record |
||||||
|
|
||||||
|
In an expanded form comment section, feed in the comment in the input box provided and press `Enter` key |
||||||
@ -0,0 +1,17 @@ |
|||||||
|
--- |
||||||
|
title: 'Delete record' |
||||||
|
--- |
||||||
|
import Tabs from '@theme/Tabs'; |
||||||
|
import TabItem from '@theme/TabItem'; |
||||||
|
|
||||||
|
### Delete Record (Single) |
||||||
|
|
||||||
|
Right-click on the row and then from the cell context menu, select `Delete Row` option. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
|
||||||
|
### Delete Record (Bulk) |
||||||
|
|
||||||
|
Select multiple rows by using the checkbox in first column and then `Delete Selected Rows` options from the right click context menu. |
||||||
|
 |
||||||
@ -1,5 +0,0 @@ |
|||||||
--- |
|
||||||
title: 'Comments on record' |
|
||||||
--- |
|
||||||
import Tabs from '@theme/Tabs'; |
|
||||||
import TabItem from '@theme/TabItem'; |
|
||||||
@ -1,5 +1,53 @@ |
|||||||
--- |
--- |
||||||
title: 'View overview' |
title: 'Views' |
||||||
|
description: 'Understanding Views in NocoDB!' |
||||||
--- |
--- |
||||||
import Tabs from '@theme/Tabs'; |
|
||||||
import TabItem from '@theme/TabItem'; |
`View` often represents a way to display your data. NocoDB provides different types of views to display your data in different ways. You can also Sort or Filter records within a View. Each View is independent, which means the configuration applying to View 1 will not apply to View 2. |
||||||
|
|
||||||
|
## View Types |
||||||
|
|
||||||
|
### Grid View |
||||||
|
|
||||||
|
Grid View, as a default type of view, allows you to display your data in a spreadsheet-like interface. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
### Form View |
||||||
|
|
||||||
|
Form View allows you to arrange fields in a form to input data. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
You can drag-drop columns from the form to form-field-menu-bar as required. |
||||||
|
|
||||||
|
### Gallery View |
||||||
|
|
||||||
|
Gallery View allows you to display images as thumbnails with other fields just like a gallery. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
### Kanban View |
||||||
|
|
||||||
|
Kanban View allows you to visualise your data using cards at various stacks. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
## View Permission Types |
||||||
|
|
||||||
|
We can apply permission to each View. By default, Collaborative Views will be used. To see or change the view type, expand `view-tool-bar-menu` as shown below. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
### Collaborative Views (default) |
||||||
|
- Collaborators with edit permissions or higher can change the view configurations |
||||||
|
|
||||||
|
### Locked Views |
||||||
|
- No one can edit view configurations until it is Unlocked |
||||||
|
- All collaborators can only READ data from such views |
||||||
|
|
||||||
|
### Personal Views |
||||||
|
- Only you can edit the view configuration. |
||||||
|
- Your personal views are hidden for other collaborators |
||||||
|
- Are not available currently; will be enabled in future release |
||||||
|
|
||||||
|
|||||||
@ -0,0 +1,31 @@ |
|||||||
|
--- |
||||||
|
title: "Share View" |
||||||
|
description: "Procedures to share a view" |
||||||
|
--- |
||||||
|
|
||||||
|
|
||||||
|
## Generate Share View |
||||||
|
|
||||||
|
- Open a table or a view |
||||||
|
|
||||||
|
- Click `Share` button on the top right of the toolbar |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
- Toggle `Enable public viewing` to create shared view link |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
- You can enable `Restrict access with a password` if you want a password-protected view |
||||||
|
- Or you can toggle `Allow Download` button to enable or disable download CSV/XLSX options in the shared view link |
||||||
|
|
||||||
|
|
||||||
|
## Access Share View |
||||||
|
|
||||||
|
- Access the link. If it is password-protected, enter the password to unlock. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
- Otherwise, you should see the share view. |
||||||
|
|
||||||
|
 |
||||||
@ -0,0 +1,67 @@ |
|||||||
|
--- |
||||||
|
title: 'Data Sources' |
||||||
|
description: 'NocoDB Data-Source sync, access control & re-config' |
||||||
|
--- |
||||||
|
|
||||||
|
## Overview |
||||||
|
|
||||||
|
`Data Sources` tab includes following functionalities |
||||||
|
- Connect/manage external data source |
||||||
|
- UI Access Control |
||||||
|
- Relations |
||||||
|
|
||||||
|
Note that, currently only one external data source can be added per project. |
||||||
|
|
||||||
|
## Accessing Data Sources |
||||||
|
|
||||||
|
Click `Data Sources` tab in `Project dashboard` |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
## Sync Metadata |
||||||
|
|
||||||
|
Go to `Data Sources`, click ``Sync Metadata``, you can see your metadata sync status. If it is out of sync, you can sync the schema. See [Sync Schema](/setup-and-usages/sync-schema) for more. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
## UI Access Control |
||||||
|
|
||||||
|
Go to `Data Sources`, click ``UI ACL``, you can control the access to each table by roles. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
|
||||||
|
## Relations |
||||||
|
|
||||||
|
Go to `Data Sources`, click ``Relations``, you can see the ERD of your database. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
|
||||||
|
### Junction table names within Relations |
||||||
|
|
||||||
|
- Enable `Show M2M Tables` within `Project Settings` menu |
||||||
|
- Double click on `Show Columns` to see additional checkboxes get enabled. |
||||||
|
- Enabling which you should be able to see junction tables and their table names. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
## Edit external database configuration parameters |
||||||
|
|
||||||
|
Go to `Data Sources`, click ``Edit`` icon, you can re-configure database credentials. |
||||||
|
Please make sure database configuration parameters are valid. Any incorrect parameters could lead to schema loss! |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
## Unlink data source |
||||||
|
|
||||||
|
Go to `Data Sources`, click ``Delete`` against the data source that you wish to un-link. |
||||||
|
|
||||||
|
 |
||||||
|
|
||||||
|
|
||||||
|
## Data source visibility |
||||||
|
|
||||||
|
Go to `Data Sources`, toggle ``Radio-button`` against the data source that you wish to hide/un-hide. |
||||||
|
|
||||||
|
 |
||||||
@ -0,0 +1,5 @@ |
|||||||
|
{ |
||||||
|
"label": "Data Source", |
||||||
|
"collapsible": true, |
||||||
|
"collapsed": true |
||||||
|
} |
||||||
|
After Width: | Height: | Size: 86 KiB |
|
After Width: | Height: | Size: 133 KiB |
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 144 KiB |
|
After Width: | Height: | Size: 132 KiB |
Loading…
Reference in new issue