Model Field Description
Common Field Properties
- Field Name: The friendly text name displayed on the content management interface
- Field Identifier: Corresponds to the field name in the database. When reading or writing via SDK or HTTP API, it will be based on the field identifier.
- Field Description: The descriptive information displayed on the content management interface
- Default Value: The value used by default in the content management interface when the user does not fill in the content.
- Required: Specifies whether a field must be filled in. If not filled in, an error will be reported.
- Unique: When enabled, the value of this field must be unique within a content table.
- Is Primary Display Column: When associated by other content tables, the displayed list will show data based on the primary display column by default. The default primary display column is _id.
Supported Field Types
Currently supported types: Text, Boolean, Number, Array, Object, JSON, Email, Phone, URL, Image, Rich Text, Markdown, Date & Time, Enum, Geolocation, File, Auto ID, Region, Relationship (New)
| Type | Description | Example | Remarks |
|---|---|---|---|
| Text | Used to store string-type text information, supporting both single-line and multi-line text. | "Hello, World!" | The maximum storage capacity is 4000 bytes. For longer content, use the rich text field. |
| Boolean | Used to store logical values of true or false. | true/ false | - |
| Number | Used to store integers or floating-point numbers | 42 / 3.14 | The total number of integer and decimal digits must not exceed 16; decimal calculations may experience precision loss. |
| Array | Used to store a set of elements of the same type. | [1, 2, 3] | - |
| Object | Used to store collections of key-value pairs, supporting nested types. | {"name": "Alice", "age": 30} | - |
| JSON | Used to store JSON-formatted data. | {"key": "value"} | Suitable for complex data structures or dynamic properties. |
| Used to store email addresses. | "john@example.com" | - | |
| Phone | Used to store phone numbers, supporting both mobile and landline numbers. | "18888888888" | Mobile numbers: 11-digit string compliant with Chinese mainland standards; landline numbers: string starting with 0 followed by 2-3 digit area code and local number, or 7-8 digit string without area code |
| URL | Used to store web links. | "https://www.example.com" | - |
| Image | Used to store links or paths to image files. | "cloud://xxx.com/path/to/image.jpg" / "https://foo.bar/example.png" | Maximum 10M per image |
| Multimedia | Used to store links or paths to audio or video files. | "cloud://xxx.com/path/to/a.mp4" / "https://foo.bar/example.mp4" | Maximum 500M per file |
| Rich Text | Used to store formatted text content, such as HTML. | <p>This is a paragraph</p> | Maximum length 262144 bytes |
| Markdown | Used to store text content in Markdown format. | "# This is a heading" | Can be edited using a Markdown editor with real-time preview support. |
| DateTime | Used to store date and time information. | "1645977600000" | Timestamp in milliseconds |
| Enum | Used to store values from a predefined set, supporting single or multiple selection. | "am" / ["1", "2"] | Single selection stores a string; multiple selection stores an array. |
| Geolocation | Used to store geographic location information. | {"geopoint": {"type": "Point","coordinates": [40.56, 5.89]}, "address": "Shennan Avenue, Nanshan District, Shenzhen"} | Fixed-format object where address is the textual location description and coordinates is an array containing latitude and longitude. |
| File | Used to store links or paths to files. | "cloud:://xxx.com/path/to/file.pdf" / "https://foo.bar/example.pdf" | Maximum 500M per file |
| Auto-increment ID | Used to automatically generate unique identifiers. | 1001 | If left blank, the backend auto-populates; if provided, uses the user-defined value. |
| Region | Used to store regional information. | "Shaanxi Province, Xi'an City, Yanta District" / "Beijing City, Haidian District" | Comma-separated geographical locations supporting province, city, and district levels |
| Relationship (New) | Used to represent associations between models. | - | Supports one-to-one, many-to-one, one-to-many |