diff --git a/content/docs/fields/actions-on-field.mdx b/content/docs/fields/actions-on-field.mdx index e3b816c6..a98742d9 100644 --- a/content/docs/fields/actions-on-field.mdx +++ b/content/docs/fields/actions-on-field.mdx @@ -102,3 +102,4 @@ Field description can be added by clicking on the `Add Description` button on th Description for a field will be visible as a tooltip when hovering over the `info` icon next to the field name. ![Field description](/img/v2/fields/fields-description.png) + diff --git a/content/docs/fields/display-value.mdx b/content/docs/fields/display-value.mdx index 551deff7..25deddba 100644 --- a/content/docs/fields/display-value.mdx +++ b/content/docs/fields/display-value.mdx @@ -1,44 +1,52 @@ --- -title: "Display value" -description: 'This article explains how to set display value for a table & its use.' + +title: "Display Value" +description: "This article explains how to set the display value for a table and its significance." tags: ['Fields', 'Display Value'] -keywords : ['display value', 'display value in nocoDB', 'display value in nocoDB'] +keywords: ['display value', 'display value in NocoDB'] --- -# Display Value +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. -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. +
+ +
-
- -
+--- ## Use of Display Value -- Within a spreadsheet, `Display Value` are always highlighted so that it is easier to recognise what record we are working with. -- 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 +* In the spreadsheet view, the display value is visually emphasized to make it easier to identify the record you’re working with. +* When creating **Links** between tables, the display value is shown in the **Linked Records** modal, making cross-table relationships more readable and intuitive. +**Example: Display Value highlighted in the Actor table** ![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` - +**Example: Display Value shown in a Links field.** +The value shown in the **Link Records** modal is pulled from the related table's display value. ![display value- links field](/img/v2/fields/display-value-in-linked-record.png) +--- ## Set Display Value -Click dropdown icon (🔽) in the target field. Click `Set as Display Value`. - -![display value set](/img/v2/fields/set-as-display-value.png) - - How is Display Value identified for existing database tables ? -- It is usually the first field after the primary key which is not a number. -- If there is no field which is not a number then the field adjacent to primary key is chosen. +To set a field as the display value: + +1. Click the dropdown icon (🔽) next to the desired field. +2. Select **Set as display value** from the menu. + +
+ Set as display value +
-Can I change the Display Value to another field within tables ? -- Yes, you can use the same way mentioned above to set Display Value. - +--- + +## FAQ + +**How is the Display Value determined for existing database tables?** +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. +**Can I change the Display Value later?** +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) + +--- diff --git a/content/docs/fields/index.mdx b/content/docs/fields/index.mdx index dc821ea8..913106e2 100644 --- a/content/docs/fields/index.mdx +++ b/content/docs/fields/index.mdx @@ -2,57 +2,96 @@ title: 'Fields' description: 'This article discusses various field types that NocoDB offers.' tags: ['Fields', 'Overview'] -keywords : ['NocoDB fields', 'fields overview', 'field administration', 'field organization'] +keywords: ['NocoDB fields', 'fields overview', 'field administration', 'field organization'] icon: "type" --- +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. -- [Primary Key](/docs/product-docs/fields/primary-key) -- [Display Value](/docs/product-docs/fields/display-value) - -### Text based -- [Single line text](/docs/product-docs/fields/field-types/text-based/single-line-text) -- [Long text](/docs/product-docs/fields/field-types/text-based/long-text) -- [Email](/docs/product-docs/fields/field-types/text-based/email) -- [Phone](/docs/product-docs/fields/field-types/text-based/phonenumber) -- [URL](/docs/product-docs/fields/field-types/text-based/url) - -### Numerical -- [Number](/docs/product-docs/fields/field-types/numerical/number) -- [Decimal](/docs/product-docs/fields/field-types/numerical/decimal) -- [Percentage](/docs/product-docs/fields/field-types/numerical/percent) -- [Currency](/docs/product-docs/fields/field-types/numerical/currency) - -### Date and time -- [Date](/docs/product-docs/fields/field-types/date-time-based/date) -- [Time](/docs/product-docs/fields/field-types/date-time-based/time) -- [Date and time](/docs/product-docs/fields/field-types/date-time-based/date-time) -- [Duration](/docs/product-docs/fields/field-types/date-time-based/duration) - -### Select based -- [Single select](/docs/product-docs/fields/field-types/select-based/single-select) -- [Multi select](/docs/product-docs/fields/field-types/select-based/multi-select) - -### Link based -- [Links](/docs/product-docs/fields/field-types/links-based/links) -- [Lookup](/docs/product-docs/fields/field-types/links-based/lookup) -- [Rollup](/docs/product-docs/fields/field-types/links-based/rollup) - -### Custom types -- [Attachment](/docs/product-docs/fields/field-types/custom-types/attachment) -- [Barcode](/docs/product-docs/fields/field-types/custom-types/barcode) -- [QR-code](/docs/product-docs/fields/field-types/custom-types/QR-code) -- [Geometry](/docs/product-docs/fields/field-types/custom-types/geometry) -- [Specific DB type](/docs/product-docs/fields/field-types/custom-types/specific-db-type) -- [JSON](/docs/product-docs/fields/field-types/custom-types/json) -- [Checkbox](/docs/product-docs/fields/field-types/custom-types/checkbox) -- [Rating](/docs/product-docs/fields/field-types/custom-types/rating) - -### Formula -- [Formula](/docs/product-docs/fields/field-types/formula/formula) - - [Operators](/docs/product-docs/fields/field-types/formula/operators) - - [Numeric Functions](/docs/product-docs/fields/field-types/formula/numeric-functions) - - [String Functions](/docs/product-docs/fields/field-types/formula/string-functions) - - [Date Functions](/docs/product-docs/fields/field-types/formula/date-functions) - - [Conditional Expressions](/docs/product-docs/fields/field-types/formula/conditional-expressions) +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. + +![image](/img/v2/fields/fields-intro.png) + +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. + + +## Create a Field + +To add a new field to your table: + +1. Click on the ➕ icon in the table header where you'd like to insert the new field. +2. In the **New Field** panel: + * Enter the field name (optional at first). + * Select the appropriate **field type** from the list (e.g., Single line text, Number, Lookup, etc.). +3. Configure additional settings such as default value and description as needed. +4. Click **Save Field** to finalize the creation. + +
+ Create new field - select type +
+ +
+ Configure field details +
+ +You can edit the field name, type, default value, or description anytime using the field’s context menu. + +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. + +## Field Types + +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. + + +| Field Type | Name | Description | +|------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------| +| **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. | +| | [Long text](https://nocodb.com/docs/product-docs/fields/field-types/text-based/long-text) | Suitable for paragraphs or detailed notes. | +| | [Email](https://nocodb.com/docs/product-docs/fields/field-types/text-based/email) | Stores and validates email addresses. | +| | [Phone](https://nocodb.com/docs/product-docs/fields/field-types/text-based/phonenumber) | For storing phone numbers. | +| | [URL](https://nocodb.com/docs/product-docs/fields/field-types/text-based/url) | Stores website or web resource links. | +| **Numerical** | [Number](https://nocodb.com/docs/product-docs/fields/field-types/numerical/number) | Whole numbers, positive or negative. | +| | [Decimal](https://nocodb.com/docs/product-docs/fields/field-types/numerical/decimal) | Numbers with decimal precision. | +| | [Percentage](https://nocodb.com/docs/product-docs/fields/field-types/numerical/percent) | Represents numeric values as percentages. | +| | [Currency](https://nocodb.com/docs/product-docs/fields/field-types/numerical/currency) | Stores monetary values with currency symbol. | +| **Date & Time** | [Date](https://nocodb.com/docs/product-docs/fields/field-types/date-time-based/date) | Captures calendar dates. | +| | [Time](https://nocodb.com/docs/product-docs/fields/field-types/date-time-based/time) | Stores time of day. | +| | [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. | +| | [Duration](https://nocodb.com/docs/product-docs/fields/field-types/date-time-based/duration) | Measures length of time (e.g., hours or days). | +| **Select based** | [Single select](https://nocodb.com/docs/product-docs/fields/field-types/select-based/single-select) | Allows choosing one option from a list. | +| | [Multi select](https://nocodb.com/docs/product-docs/fields/field-types/select-based/multi-select) | Allows selecting multiple options from a list. | +| **Link based** | [Links](https://nocodb.com/docs/product-docs/fields/field-types/links-based/links) | Creates relationships between tables. | +| | [Lookup](https://nocodb.com/docs/product-docs/fields/field-types/links-based/lookup) | Pulls data from linked records. | +| | [Rollup](https://nocodb.com/docs/product-docs/fields/field-types/links-based/rollup) | Aggregates values from related records. | +| **Custom types** | [Attachment](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/attachment) | Upload and store files or images. | +| | [Barcode](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/barcode) | Stores and displays barcodes. | +| | [QR-code](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/QR-code) | Stores and displays QR codes. | +| | [Geometry](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/geometry) | For geographic or spatial data. | +| | [Specific DB type](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/specific-db-type) | Maps directly to native DB field types. | +| | [JSON](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/json) | Stores structured data in JSON format. | +| | [Checkbox](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/checkbox) | Boolean toggle for true/false values. | +| | [Rating](https://nocodb.com/docs/product-docs/fields/field-types/custom-types/rating) | Displays star-based or numeric rating. | +| **Formula** | [Formula](https://nocodb.com/docs/product-docs/fields/field-types/formula/formula) | Computes values using expressions based on other fields. | + +--- + +## Field Actions + +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: + +* [Rename a field](/docs/product-docs/fields/actions-on-field#rename-field) +* [Change field type](/docs/product-docs/fields/actions-on-field#change-field-type) +* [Set default value](/docs/product-docs/fields/actions-on-field#change-default-value) +* [Adjust field width](/docs/product-docs/fields/actions-on-field#change-field-width) +* [Hide or unhide fields](/docs/product-docs/fields/actions-on-field#hide-field) +* [Set as display value](/docs/product-docs/fields/actions-on-field#set-as-display-value) +* [Sort by field (ascending/descending)](/docs/product-docs/fields/actions-on-field#sort-ascending) +* [Duplicate a field](/docs/product-docs/fields/actions-on-field#duplicate-field) +* [Insert new field before or after](/docs/product-docs/fields/actions-on-field#insert-before-a-field) +* [Delete a field](/docs/product-docs/fields/actions-on-field#delete-field) +* [Add or edit field description](/docs/product-docs/fields/actions-on-field#add--edit-field-description) + +For step-by-step instructions and visuals, refer to the full guide on [Actions on Field](/docs/product-docs/fields/actions-on-field). + +--- diff --git a/content/docs/fields/primary-key.mdx b/content/docs/fields/primary-key.mdx index 059880f5..62558717 100644 --- a/content/docs/fields/primary-key.mdx +++ b/content/docs/fields/primary-key.mdx @@ -5,39 +5,37 @@ tags: ['Fields', 'Primary Key'] keywords : ['NocoDB primary key', 'primary key', 'primary key in NocoDB', 'primary key in database'] --- -# Primary Key -A primary key is a special database table field 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 +A primary key is a special database table field designated to uniquely identify each table record. 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 + 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`) - - **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 +### FAQ + +**What if Primary Key was missing?** - 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 + In NocoDB, it's possible for a table to have no primary key—this can happen if the table is created externally or through the SDK/API without specifying one. While new records can still be added to such tables, updating or deleting them won’t be possible since there's no unique identifier to reference each record. - +**Can I change the Primary Key to another field within tables?** - - **Can I change the Primary Key to another field within tables?** -- You can't update Primary Key from NocoDB UI. You can reconfigure it at database level directly & trigger `meta sync` explicitly. - \ No newline at end of file + You can't update Primary Key from NocoDB UI. You can reconfigure it at database level directly & trigger `meta sync` explicitly. + +--- diff --git a/public/img/v2/fields/create-field-1.png b/public/img/v2/fields/create-field-1.png new file mode 100644 index 00000000..b4fb80e1 Binary files /dev/null and b/public/img/v2/fields/create-field-1.png differ diff --git a/public/img/v2/fields/create-field-2.png b/public/img/v2/fields/create-field-2.png new file mode 100644 index 00000000..618a0f8e Binary files /dev/null and b/public/img/v2/fields/create-field-2.png differ diff --git a/public/img/v2/fields/display-value-in-linked-record.png b/public/img/v2/fields/display-value-in-linked-record.png index 213e7ee4..82d6a23f 100644 Binary files a/public/img/v2/fields/display-value-in-linked-record.png and b/public/img/v2/fields/display-value-in-linked-record.png differ diff --git a/public/img/v2/fields/display-value.png b/public/img/v2/fields/display-value.png index 34ce596a..6430ad36 100644 Binary files a/public/img/v2/fields/display-value.png and b/public/img/v2/fields/display-value.png differ diff --git a/public/img/v2/fields/fields-intro.png b/public/img/v2/fields/fields-intro.png new file mode 100644 index 00000000..0a86a42a Binary files /dev/null and b/public/img/v2/fields/fields-intro.png differ diff --git a/public/img/v2/fields/set-as-display-value.png b/public/img/v2/fields/set-as-display-value.png index 0b12a019..ee00e64c 100644 Binary files a/public/img/v2/fields/set-as-display-value.png and b/public/img/v2/fields/set-as-display-value.png differ