Skip to content

Commit 93f6b4a

Browse files
Merge pull request #192 from nocodb/docs/0731-cleanup
2 parents 54973cd + 03d567d commit 93f6b4a

File tree

10 files changed

+135
-89
lines changed

10 files changed

+135
-89
lines changed

content/docs/fields/actions-on-field.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,4 @@ Field description can be added by clicking on the `Add Description` button on th
102102
Description for a field will be visible as a tooltip when hovering over the `info` icon next to the field name.
103103

104104
![Field description](/img/v2/fields/fields-description.png)
105+
Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,52 @@
11
---
2-
title: "Display value"
3-
description: 'This article explains how to set display value for a table & its use.'
2+
3+
title: "Display Value"
4+
description: "This article explains how to set the display value for a table and its significance."
45
tags: ['Fields', 'Display Value']
5-
keywords : ['display value', 'display value in nocoDB', 'display value in nocoDB']
6+
keywords: ['display value', 'display value in NocoDB']
67
---
78

8-
# Display Value
9+
The **Display Value** serves as the primary visual identifier for a record within a table. It helps users quickly recognize and associate records across views and linked tables. While it is often recommended to set a display value based on a field with unique identifiers (like a primary key), uniqueness is not enforced at the database level.
910

10-
The `Display Value`, as its name suggests, serves as the primary or main value within a record of a table, and it is typically the attribute by which we identify or associate that specific record. While it is advisable for the display value to be linked to a field with unique identifiers, such as a primary key, it's important to note that this uniqueness is not always enforced at the database level.
11+
<div style={{ textAlign: 'center' }}>
12+
<iframe width="560" height="315" src="https://www.youtube.com/embed/GAPAec6zXQ8?start=13" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen></iframe>
13+
</div>
1114

12-
<center>
13-
<iframe width="560" height="315" src="https://www.youtube.com/embed/GAPAec6zXQ8?si=G_61hrI3gV_xYTrt?&start=13" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen ></iframe>
14-
</center>
15+
---
1516

1617
## Use of Display Value
17-
- Within a spreadsheet, `Display Value` are always highlighted so that it is easier to recognise what record we are working with.
18-
- And when `Links` are created between two tables - it is the Display Value that appears in `Linked records` modal.
1918

20-
Example:
21-
Display Value highlighted in Actor table
19+
* In the spreadsheet view, the display value is visually emphasized to make it easier to identify the record you’re working with.
20+
* When creating **Links** between tables, the display value is shown in the **Linked Records** modal, making cross-table relationships more readable and intuitive.
2221

22+
**Example: Display Value highlighted in the Actor table**
2323
![display value](/img/v2/fields/display-value.png)
2424

25-
Display Value associated when Links field
26-
The value shown in `Link Records` modal when adding a new link is associated records `Display value`
27-
25+
**Example: Display Value shown in a Links field.**
26+
The value shown in the **Link Records** modal is pulled from the related table's display value.
2827
![display value- links field](/img/v2/fields/display-value-in-linked-record.png)
2928

29+
---
3030

3131
## Set Display Value
32-
Click dropdown icon (🔽) in the target field. Click `Set as Display Value`.
33-
34-
![display value set](/img/v2/fields/set-as-display-value.png)
3532

36-
<Callout type="info">
37-
How is Display Value identified for existing database tables ?
38-
- It is usually the first field after the primary key which is not a number.
39-
- If there is no field which is not a number then the field adjacent to primary key is chosen.
33+
To set a field as the display value:
34+
35+
1. Click the dropdown icon (🔽) next to the desired field.
36+
2. Select **Set as display value** from the menu.
37+
38+
<div style={{ textAlign: 'center' }}>
39+
<img src="/img/v2/fields/set-as-display-value.png" alt="Set as display value" style={{ width: '80%', maxWidth: '480px' }} />
40+
</div>
4041

41-
Can I change the Display Value to another field within tables ?
42-
- Yes, you can use the same way mentioned above to set Display Value.
43-
</Callout>
42+
---
43+
44+
## FAQ
45+
46+
**How is the Display Value determined for existing database tables?**
47+
For tables connected from external databases, NocoDB automatically selects the display value based on the table structure. By default, it picks the first non-numeric field after the primary key. If no non-numeric field is found, it selects the next field after the primary key.
4448

49+
**Can I change the Display Value later?**
50+
Yes. You can change the display value at any time by using the context menu on the target field. [Learn more →](/docs/product-docs/fields/display-value#set-display-value)
51+
52+
---

content/docs/fields/index.mdx

Lines changed: 88 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,57 +2,96 @@
22
title: 'Fields'
33
description: 'This article discusses various field types that NocoDB offers.'
44
tags: ['Fields', 'Overview']
5-
keywords : ['NocoDB fields', 'fields overview', 'field administration', 'field organization']
5+
keywords: ['NocoDB fields', 'fields overview', 'field administration', 'field organization']
66
icon: "type"
77
---
88

9+
Fields define the structure and type of data stored in each record of a table. They are the building blocks of your database, determining how information is entered, displayed, and interpreted. Whether you're capturing names, numbers, dates, selections, or calculated values—fields provide the necessary flexibility to model your data accurately.
910

10-
- [Primary Key](/docs/product-docs/fields/primary-key)
11-
- [Display Value](/docs/product-docs/fields/display-value)
12-
13-
### Text based
14-
- [Single line text](/docs/product-docs/fields/field-types/text-based/single-line-text)
15-
- [Long text](/docs/product-docs/fields/field-types/text-based/long-text)
16-
- [Email](/docs/product-docs/fields/field-types/text-based/email)
17-
- [Phone](/docs/product-docs/fields/field-types/text-based/phonenumber)
18-
- [URL](/docs/product-docs/fields/field-types/text-based/url)
19-
20-
### Numerical
21-
- [Number](/docs/product-docs/fields/field-types/numerical/number)
22-
- [Decimal](/docs/product-docs/fields/field-types/numerical/decimal)
23-
- [Percentage](/docs/product-docs/fields/field-types/numerical/percent)
24-
- [Currency](/docs/product-docs/fields/field-types/numerical/currency)
25-
26-
### Date and time
27-
- [Date](/docs/product-docs/fields/field-types/date-time-based/date)
28-
- [Time](/docs/product-docs/fields/field-types/date-time-based/time)
29-
- [Date and time](/docs/product-docs/fields/field-types/date-time-based/date-time)
30-
- [Duration](/docs/product-docs/fields/field-types/date-time-based/duration)
31-
32-
### Select based
33-
- [Single select](/docs/product-docs/fields/field-types/select-based/single-select)
34-
- [Multi select](/docs/product-docs/fields/field-types/select-based/multi-select)
35-
36-
### Link based
37-
- [Links](/docs/product-docs/fields/field-types/links-based/links)
38-
- [Lookup](/docs/product-docs/fields/field-types/links-based/lookup)
39-
- [Rollup](/docs/product-docs/fields/field-types/links-based/rollup)
40-
41-
### Custom types
42-
- [Attachment](/docs/product-docs/fields/field-types/custom-types/attachment)
43-
- [Barcode](/docs/product-docs/fields/field-types/custom-types/barcode)
44-
- [QR-code](/docs/product-docs/fields/field-types/custom-types/QR-code)
45-
- [Geometry](/docs/product-docs/fields/field-types/custom-types/geometry)
46-
- [Specific DB type](/docs/product-docs/fields/field-types/custom-types/specific-db-type)
47-
- [JSON](/docs/product-docs/fields/field-types/custom-types/json)
48-
- [Checkbox](/docs/product-docs/fields/field-types/custom-types/checkbox)
49-
- [Rating](/docs/product-docs/fields/field-types/custom-types/rating)
50-
51-
### Formula
52-
- [Formula](/docs/product-docs/fields/field-types/formula/formula)
53-
- [Operators](/docs/product-docs/fields/field-types/formula/operators)
54-
- [Numeric Functions](/docs/product-docs/fields/field-types/formula/numeric-functions)
55-
- [String Functions](/docs/product-docs/fields/field-types/formula/string-functions)
56-
- [Date Functions](/docs/product-docs/fields/field-types/formula/date-functions)
57-
- [Conditional Expressions](/docs/product-docs/fields/field-types/formula/conditional-expressions)
11+
This section will guide you through the different types of fields available, their configurations, and best practices for choosing the right field type based on your use case. By understanding how fields work, you can design more effective tables and ensure consistent, meaningful data across your workspace.
12+
13+
![image](/img/v2/fields/fields-intro.png)
14+
15+
Among all fields in a table, two hold special significance: the **[primary key](/docs/product-docs/fields/primary-key)** and the **[display value](/docs/product-docs/fields/display-value)**. The **primary key** is a technical identifier that uniquely distinguishes each record and is essential for backend operations like updates, deletions, and maintaining data integrity. It is always unique and typically hidden from end users. On the other hand, the **display value** is a human-readable label—such as a name or title—used in the interface to help users quickly identify and associate records. While it’s recommended to use a field with unique values as the display value, strict uniqueness is not enforced. In essence, the primary key ensures consistent record management, while the display value improves usability and context.
16+
17+
18+
## Create a Field
19+
20+
To add a new field to your table:
21+
22+
1. Click on the ➕ icon in the table header where you'd like to insert the new field.
23+
2. In the **New Field** panel:
24+
* Enter the field name (optional at first).
25+
* Select the appropriate **field type** from the list (e.g., Single line text, Number, Lookup, etc.).
26+
3. Configure additional settings such as default value and description as needed.
27+
4. Click **Save Field** to finalize the creation.
28+
29+
<div style={{ textAlign: 'center' }}>
30+
<img src="/img/v2/fields/create-field-1.png" alt="Create new field - select type" style={{ width: '90%', maxWidth: '800px' }} />
31+
</div>
32+
33+
<div style={{ textAlign: 'center', marginTop: '1rem' }}>
34+
<img src="/img/v2/fields/create-field-2.png" alt="Configure field details" style={{ width: '90%', maxWidth: '400px' }} />
35+
</div>
36+
37+
<Callout type="note">You can edit the field name, type, default value, or description anytime using the field’s context menu.</Callout>
38+
39+
Depending on the field type selected, additional options or configurations may be required—such as allowed values, precision, formulas, or linked table settings. Refer to the documentation for each field type for detailed guidance.
40+
41+
## Field Types
42+
43+
NocoDB offers a wide range of field types to help you structure your data effectively. From basic text and numeric fields to more advanced options like linked records, formulas, and custom types, each field serves a specific purpose. The table below provides an overview of all available field types along with brief descriptions to help you choose the right one for your use case.
44+
45+
46+
| Field Type | Name | Description |
47+
|------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
48+
| **Text based** | [Single line text](https://nocodb.com/docs/product-docs/fields/field-types/text-based/single-line-text) | For short text entries like names or titles. |
49+
| | [Long text](https://nocodb.com/docs/product-docs/fields/field-types/text-based/long-text) | Suitable for paragraphs or detailed notes. |
50+
| | [Email](https://nocodb.com/docs/product-docs/fields/field-types/text-based/email) | Stores and validates email addresses. |
51+
| | [Phone](https://nocodb.com/docs/product-docs/fields/field-types/text-based/phonenumber) | For storing phone numbers. |
52+
| | [URL](https://nocodb.com/docs/product-docs/fields/field-types/text-based/url) | Stores website or web resource links. |
53+
| **Numerical** | [Number](https://nocodb.com/docs/product-docs/fields/field-types/numerical/number) | Whole numbers, positive or negative. |
54+
| | [Decimal](https://nocodb.com/docs/product-docs/fields/field-types/numerical/decimal) | Numbers with decimal precision. |
55+
| | [Percentage](https://nocodb.com/docs/product-docs/fields/field-types/numerical/percent) | Represents numeric values as percentages. |
56+
| | [Currency](https://nocodb.com/docs/product-docs/fields/field-types/numerical/currency) | Stores monetary values with currency symbol. |
57+
| **Date & Time** | [Date](https://nocodb.com/docs/product-docs/fields/field-types/date-time-based/date) | Captures calendar dates. |
58+
| | [Time](https://nocodb.com/docs/product-docs/fields/field-types/date-time-based/time) | Stores time of day. |
59+
| | [Date and time](https://nocodb.com/docs/product-docs/fields/field-types/date-time-based/date-time) | Stores both date and time in one field. |
60+
| | [Duration](https://nocodb.com/docs/product-docs/fields/field-types/date-time-based/duration) | Measures length of time (e.g., hours or days). |
61+
| **Select based** | [Single select](https://nocodb.com/docs/product-docs/fields/field-types/select-based/single-select) | Allows choosing one option from a list. |
62+
| | [Multi select](https://nocodb.com/docs/product-docs/fields/field-types/select-based/multi-select) | Allows selecting multiple options from a list. |
63+
| **Link based** | [Links](https://nocodb.com/docs/product-docs/fields/field-types/links-based/links) | Creates relationships between tables. |
64+
| | [Lookup](https://nocodb.com/docs/product-docs/fields/field-types/links-based/lookup) | Pulls data from linked records. |
65+
| | [Rollup](https://nocodb.com/docs/product-docs/fields/field-types/links-based/rollup) | Aggregates values from related records. |
66+
| **Custom types** | [Attachment](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/attachment) | Upload and store files or images. |
67+
| | [Barcode](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/barcode) | Stores and displays barcodes. |
68+
| | [QR-code](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/QR-code) | Stores and displays QR codes. |
69+
| | [Geometry](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/geometry) | For geographic or spatial data. |
70+
| | [Specific DB type](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/specific-db-type) | Maps directly to native DB field types. |
71+
| | [JSON](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/json) | Stores structured data in JSON format. |
72+
| | [Checkbox](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/checkbox) | Boolean toggle for true/false values. |
73+
| | [Rating](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/rating) | Displays star-based or numeric rating. |
74+
| **Formula** | [Formula](https://nocodb.com/docs/product-docs/fields/field-types/formula/formula) | Computes values using expressions based on other fields. |
75+
76+
---
77+
78+
## Field Actions
79+
80+
Beyond selecting the right field type, you can also perform various actions to customize how fields behave and appear in your tables. These actions are accessible from the field’s context menu & toolbar menu and include:
81+
82+
* [Rename a field](/docs/product-docs/fields/actions-on-field#rename-field)
83+
* [Change field type](/docs/product-docs/fields/actions-on-field#change-field-type)
84+
* [Set default value](/docs/product-docs/fields/actions-on-field#change-default-value)
85+
* [Adjust field width](/docs/product-docs/fields/actions-on-field#change-field-width)
86+
* [Hide or unhide fields](/docs/product-docs/fields/actions-on-field#hide-field)
87+
* [Set as display value](/docs/product-docs/fields/actions-on-field#set-as-display-value)
88+
* [Sort by field (ascending/descending)](/docs/product-docs/fields/actions-on-field#sort-ascending)
89+
* [Duplicate a field](/docs/product-docs/fields/actions-on-field#duplicate-field)
90+
* [Insert new field before or after](/docs/product-docs/fields/actions-on-field#insert-before-a-field)
91+
* [Delete a field](/docs/product-docs/fields/actions-on-field#delete-field)
92+
* [Add or edit field description](/docs/product-docs/fields/actions-on-field#add--edit-field-description)
93+
94+
For step-by-step instructions and visuals, refer to the full guide on [Actions on Field](/docs/product-docs/fields/actions-on-field).
95+
96+
---
5897

0 commit comments

Comments
 (0)