🔦 Feature: Field Descriptions / Help text

[candideu]

Please confirm if feature request does NOT exists already ?

• [X] I confirm there is no existing issue for this

Describe the usecase for the feature

Adding additional information to help users understand the function of a field.

Suggested Solution

Airtable example:

On hover:

Additional Context

No response

[salim-b]

Related to https://github.com/nocodb/nocodb/issues/3571.

[salim-b]

For tables from external SQL data sources, it would be nice if you could just read the data from the (Postgre)SQL COMMENTs[^c] that are set on the table's columns (if any). Ideally, you would interpret the COMMENTs the same way that PostgREST does[^m]:

• If the comment is a single line, treat it as a column description.
• If the comment consists of multiple lines, treat the first paragraph as column summary (= human-friendly column title) and everything from the second paragraph on as column description (with paragraphs being separated by an empty line).

[^c]: PostgreSQL's COMMENT keyword is not part of the SQL standard, but a lot of other DBMS' offer the same (e.g. Oracle Database) or very similar (e.g MariaDB/MySQL) functionality. Note that SQLite unfortunately has no such notion.

In PostgreSQL, `COMMENT`s can be retrieved via the internal [functions `col_description()` and `obj_description()`](https://www.postgresql.org/docs/current/functions-info.html#FUNCTIONS-INFO-COMMENT-TABLE).

[^m]: Note that there are discussions to extend the comment syntax to allow for more structured data, i.a. to accommodate the needs of tools like pg_graphql which uses special syntax referred to as comment directives. In the medium term, the emergence of a vendor-neutral standard for structured data in (Postgre)SQL comments seems likely to me.

[springfielddatarecovery]

+1 for this feature

[dstala]

will be available from next release