Browse Source

docs: update column types

pull/5204/head
Wing-Kam Wong 2 years ago
parent
commit
7899e53c8e
  1. 75
      packages/noco-docs/content/en/setup-and-usages/column-types.md

75
packages/noco-docs/content/en/setup-and-usages/column-types.md

@ -10,9 +10,9 @@ menuTitle: 'Column Types'
| Type | Description | | Type | Description |
|---|---| |---|---|
| [ID](#id) | Primary column of the table | <!-- | [ID](#id) | Primary column of the table | -->
| [LinkToAnotherRecord](#linktoanotherrecord) | Has Many or Many To Many columns | | [LinkToAnotherRecord](#linktoanotherrecord) | Has Many or Many To Many columns |
| [ForeignKey](#foreignkey)| Belongs To relation | <!-- | [ForeignKey](#foreignkey)| Belongs To relation | -->
| [SingleLineText](#singlelinetext) | For short text | | [SingleLineText](#singlelinetext) | For short text |
| [LongText](#longtext) | For lengthy string content | | [LongText](#longtext) | For lengthy string content |
| [Attachment](#attachment) | File attachment column | | [Attachment](#attachment) | File attachment column |
@ -26,28 +26,25 @@ menuTitle: 'Column Types'
| [Email](#email) | Email field | | [Email](#email) | Email field |
| [URL](#url) | Valid URL field | | [URL](#url) | Valid URL field |
| [Number](#number) | Any type of number | | [Number](#number) | Any type of number |
|[Decimal](#decimal)| Fractional number | | [Decimal](#decimal)| Fractional number |
|[Currency](#currency)| Currency value | | [Currency](#currency)| Currency value |
|[Percent](#percent)| Percentage | | [Percent](#percent)| Percentage |
|[Duration](#duration)| Duration | | [Duration](#duration)| Duration |
|[Rating](#rating)| Rating | | [Rating](#rating)| Rating |
|[Formula](#formula)| Formula based generated column | | [Formula](#formula)| Formula based generated column |
|[QR Code](#qr-code)| QR Code visualization of another referenced column | | [Rollup](#rollup)| Performs calculations and aggregations |
|[Barcode](#barcode)| Barcode visualization of another referenced column | | [DateTime](#datetime)| Date & Time selector |
| [Count](#count) | | | [QR Code](#qr-code)| QR Code visualization of another referenced column |
|[DateTime](#datetime)| Date & Time selector | | [Barcode](#barcode)| Barcode visualization of another referenced column |
|[CreateTime](#createtime)| | <!-- | [CreateTime](#createtime)| | -->
|[AutoNumber](#autonumber)| | | [Geometry](#geometry)| Geometry column |
|[Geometry](#geometry)| Geometry column | | [GeoData](#geodata)| GeoData column |
|[SpecificDBType](#specificdbtype)| Custom DB type option | | [Json](#json)| Json column |
| [SpecificDBType](#specificdbtype)| Custom DB type option |
## Database Types ## Database Types
<!-- ### ID
### ID
#### Available Database Types #### Available Database Types
@ -56,20 +53,20 @@ menuTitle: 'Column Types'
|**MySQL**|_All types are available_|int| |**MySQL**|_All types are available_|int|
|**PostgreSQL**|_All types are available_|int4| |**PostgreSQL**|_All types are available_|int4|
|**SQL Server**|_All types are available_|int| |**SQL Server**|_All types are available_|int|
|**SQLite**|_All types are available_|integer| |**SQLite**|_All types are available_|integer| -->
### LinkToAnotherRecord ### LinkToAnotherRecord
N/A For more about Link To Another Record, please visit [here](./link-to-another-record).
### ForeignKey <!-- ### ForeignKey
#### Available Database Types #### Available Database Types
|Database| Types| |Database| Types|
|-----|----------| |-----|----------|
|**MySQL**|_All types are available_| |**MySQL**|_All types are available_|
|**PostgreSQL**|_All types are available_| |**PostgreSQL**|_All types are available_|
|**SQL Server**|_All types are available_| |**SQL Server**|_All types are available_|
|**SQLite**|_All types are available_| |**SQLite**|_All types are available_| -->
### SingleLineText ### SingleLineText
@ -292,16 +289,10 @@ Encodes the value of a reference column as Barcode. Supported barcode formats: C
* Email * Email
Since it's a virtual column, the cell content (Barcode) cannot be changed directly. Since it's a virtual column, the cell content (Barcode) cannot be changed directly.
### Count
#### Available Database Types ### Rollup
|Database| Types| Default Type| For more about rollup, please visit [here](./rollup).
|-----|----------|----------|
|**MySQL**|int, smallint, mediumint, bigint, serial|int|
|**PostgreSQL**|int, integer, bigint, bigserial, int2, int4, int8, serial, serial2, serial8, smallint, smallserial|int8|
|**SQL Server**|int, bigint, smallint, tinyint|int|
|**SQLite**|int, integer, tinyint, smallint, mediumint, bigint, int2, int8|integer|
### DateTime ### DateTime
@ -314,7 +305,7 @@ Since it's a virtual column, the cell content (Barcode) cannot be changed direct
|**SQL Server**|datetime, datetime2, datetimeoffset|datetime| |**SQL Server**|datetime, datetime2, datetimeoffset|datetime|
|**SQLite**|datetime, timestamp|datetime| |**SQLite**|datetime, timestamp|datetime|
### CreateTime <!-- ### CreateTime
#### Available Database Types #### Available Database Types
@ -323,7 +314,7 @@ Since it's a virtual column, the cell content (Barcode) cannot be changed direct
|**MySQL**|datetime, timestamp, varchar|datetime| |**MySQL**|datetime, timestamp, varchar|datetime|
|**PostgreSQL**|timestamp, timestamp without time zone, timestamptz, timestamp with time zone|datetime| |**PostgreSQL**|timestamp, timestamp without time zone, timestamptz, timestamp with time zone|datetime|
|**SQL Server**|datetime, datetime2, datetimeoffset|datetime| |**SQL Server**|datetime, datetime2, datetimeoffset|datetime|
|**SQLite**|datetime, timestamp|datetime| |**SQLite**|datetime, timestamp|datetime| -->
### Geometry ### Geometry
@ -337,6 +328,20 @@ Since it's a virtual column, the cell content (Barcode) cannot be changed direct
|**SQL Server**|geometry| |**SQL Server**|geometry|
|**SQLite**|text| |**SQLite**|text|
<!-- TODO: add GeoData -->
### JSON
#### Available Database Types
|Database| Types|
|-----|----------|
|**MySQL**|json|
|**PostgreSQL**|json|
|**SQL Server**|text, ntext|
|**SQLite**|text|
### SpecificDBType ### SpecificDBType
#### Available Database Types #### Available Database Types

Loading…
Cancel
Save