logologo
Get Started
Guide
Development
Plugins
API
Home
English
简体中文
日本語
한국어
Español
Português
Deutsch
Français
Русский
Italiano
Türkçe
Українська
Tiếng Việt
Bahasa Indonesia
ไทย
Polski
Nederlands
Čeština
العربية
עברית
हिन्दी
Svenska
Get Started
Guide
Development
Plugins
API
Home
logologo
Overview

Data sources

Data source manager
Main data source

External data sources (Databases)

Overview
External MySQL
External MariaDB
External PostgreSQL
External MSSQL
External Oracle
Main vs External Databases
REST API data source
KingbaseES data source

Collections

Overview
General collection
Inheritance collection
File collection
Tree collection
Calendar collection
Comment collection
Expression collection
SQL collection
View collection

Collection fields

Overview
Field Validation

Basic

Single text
Long text
Phone
Email
URL
Integer
Number
Percent
Password
Color
Icon

Choices

Checkbox
Select
Multiple select
Radio group
Checkbox group

Media

Markdown
Markdown (Vditor)
Rich text
Attachment (Relationship)
Attachment (URL)

Date & Time

Overview
Date & time (with timezone)
Date & time (without timezone)
Unix timestamp
Date (without time)
Time

Geometry

Point
Line
Circle
Polygon

Advanced

Snowflake ID (53-bit)
UUID
Nano ID
Sort
Formula
Sequence
JSON
Collection select
Encryption

System info

Created at
Updated at
Created by
Last updated by
Space
Table OID

Associations

Overview
One to one
One to many
Many to one
Many to many
Many to many (array)

Development

Overview
Next PageOverview

#Overview

#Built-in Engines

Currently, NocoBase supports the following built-in engine types:

  • Local Storage
  • Alibaba Cloud OSS
  • Amazon S3
  • Tencent Cloud COS

A local storage engine is automatically added during system installation and can be used directly. You can also add new engines or edit the parameters of existing ones.

#Common Engine Parameters

In addition to the specific parameters for different engine types, the following are common parameters (using local storage as an example):

Example of File Storage Engine Configuration

#Title

The name of the storage engine, used for human identification.

#System Name

The system name of the storage engine, used for system identification. It must be unique across the system. If left blank, it will be randomly generated by the system.

#Access base URL

The prefix of the URL address for external access to the file. This can be the base URL of a CDN, for example: "https://cdn.nocobase.com/app" (without the trailing "/").

#Path

The relative path used when storing files. This part will also be automatically concatenated to the final URL when accessed. For example: "user/avatar" (without the leading or trailing "/").

#File Size Limit

The size limit for files uploaded to this storage engine. Files exceeding this size cannot be uploaded. The system default limit is 20MB, and the maximum adjustable limit is 1GB.

#File Type

Limits the types of files that can be uploaded, using the MIME syntax description format. For example, image/* represents image files. Multiple types can be separated by commas, such as image/*, application/pdf to allow both image and PDF files.

#Default Storage Engine

When checked, this is set as the system's default storage engine. When an attachment field or file collection does not specify a storage engine, uploaded files will be saved to the default storage engine. The default storage engine cannot be deleted.

#Keep Files When Destroying Records

When checked, uploaded files in the storage engine are retained even when the data records in the attachment or file collection are deleted. By default, this is unchecked, meaning files in the storage engine are deleted along with the records.

Tip

After a file is uploaded, the final access path is constructed by concatenating several parts:

<Access base URL>/<Path>/<FileName><Extension>

For example: https://cdn.nocobase.com/app/user/avatar/20240529115151.png.