APES
Overview
Last Updated: 06/04/2026Data modeling is a key step in designing databases, involving a deep analysis and abstraction process of various types of data and their interrelationships in the real world. In this process, we try to reveal the intrinsic connections between data and formalize them into data models, laying the foundation for the database structure of the...
Connect Foreign Data Tables(FDW)
Last Updated: 06/04/2026Introduction This is a plugin that connects to remote data tables based on the foreign data wrapper of the database. Currently, it supports MySQL and PostgreSQL databases. Connecting Data Sources vs Connecting External Data Tables The two can also be used in combination. The former is used to establish a connection with the data source,...
How to Enable the Federated Engine in MySQL
Last Updated: 06/04/2026The MySQL database does not enable the federated module by default. You need to modify the my.cnf configuration. If you are using the Docker version, you can handle the extension situation through volumes: Create a new ./storage/mysql-conf/federated.cnf file Restart MySQL Check if federated is activated
Data Source Manager
Last Updated: 06/04/2026Introduction APES provides a data source management plugin for managing data sources and their collections. The data source management plugin only provides a management interface for all data sources and does not provide the ability to access data sources. It needs to be used in conjunction with various data source plugins. The data sources currently...
Main DataBase
Last Updated: 06/04/2026Introduction APES's main database can be used to store both business data and the metadata of the application, including system table data and custom table data. The main database supports relational databases such as MySQL, PostgreSQL, etc. During the installation of the APES application, the main database must be installed synchronously and cannot be deleted....
External Database
Last Updated: 06/04/2026Introduction Use an existing external database as a data source. Currently supported external databases include MySQL, MariaDB, PostgreSQL, MSSQL, and Oracle. Usage Instructions Adding an External Database After activating the plugin, you can select and add it from the “Add new” dropdown menu in data source management. Fill in the information for the database you...
External Data Source – MySQL
Last Updated: 06/04/2026Introduction Use an external MySQL database as a data source. Currently supported versions: MySQL >= 5.7 Installation This is a commercial plugin. For detailed activation instructions, please refer to: Commercial Plugin Activation Guide Usage Instructions Refer to the Data Source / External Database section.
External Data Source – MariaDB
Last Updated: 06/04/2026Introduction Use an external MariaDB database as a data source. Currently supported versions: MariaDB >= 10.3 Installation This is a commercial plugin. For detailed activation instructions, please refer to: Commercial Plugin Activation Guide Usage Instructions Refer to the Data Source / External Database section.
External Data Source – PostgreSQL
Last Updated: 06/04/2026Introduction Use an external PostgreSQL database as a data source. Currently supported versions: PostgreSQL >= 9.5 Installation This is a commercial plugin. For detailed activation instructions, please refer to: Commercial Plugin Activation Guide Usage Instructions Refer to the Data Source / External Database section.
External Data Source – MSSQL
Last Updated: 06/04/2026Introduction Use an external MSSQL database as a data source. Currently supported versions: SQL Server 2014-2019 Installation This is a commercial plugin. For detailed activation instructions, please refer to: Commercial Plugin Activation Guide Usage Instructions Refer to the Data Source / External Database section.
External Data Source – Oracle
Last Updated: 06/04/2026Introduction This plugin allows you to use an external Oracle database as a data source. It supports Oracle versions >= 11g. Installation Install Oracle Client For Oracle server versions earlier than 12.1, you need to install the Oracle client. Example for Linux: If the client is not installed as described above, you will need to...
Main vs External Databases
Last Updated: 06/04/2026The differences between main databases and external databases in APES are primarily reflected in four aspects: database type support, collection type support, field type support, and backup and migration capabilities. 1. Database Type Support For more details, see: Data Source Manager Database Types Database Type Main Database Support External Database Support PostgreSQL ✅ ✅ MySQL...
REST API Data Source
Last Updated: 06/04/2026Introduction This plugin allows you to integrate data from REST API sources seamlessly. Installation This is a commercial plugin. For detailed activation instructions, please refer to: Commercial Plugin Activation Guide Adding a REST API Source After activating the plugin, you can add a REST API source by selecting it from the Add new dropdown menu...
Data Source – KingbaseES Database
Last Updated: 06/04/2026Introduction KingbaseES can be used as a data source, either as the primary database or an external database. WARNING Currently, only KingbaseES databases running in pg mode are supported. Installation Using as the Primary Database Refer to the Installation documentation for the setup procedures, the difference is mainly due to the environment variables. Environment Variables...
Collection Overview
Last Updated: 06/04/2026APES provides a unique DSL to describe the structure of data, known as Collection, which unifies the data structure from various sources, providing a reliable foundation for data management, analysis, and application. To conveniently use various data models, it supports various types of collections:
General Collection
Last Updated: 06/04/2026Introduction It is used in most scenarios. A general collection can be used unless a special collection template is needed. User Manual Set Primary Key When creating a collection, you need to specify a primary key field. It is recommended to enable the preset ID field when creating a new collection. The default primary key...
Inheritance Collection
Last Updated: 06/04/2026Introduction You can create a parent collection and derive child collection from that parent collection. The child collection will inherit the structure of the parent collection, and can also define its own columns. This design pattern helps organize and manage data with similar structures but possible differences. Here are some common features of support for...
File Collection
Last Updated: 06/04/2026Introduction Files are records in a specially structured collection known as a file collection. It is used to store file metadata and can be managed through the File Manager. User Manual Creating a File Collection Preset Fields in a File Collection Using in Blocks Association Field Association Blocks
Tree Collection
Last Updated: 06/04/2026Introduction A tree structure collection is a data collection design pattern used for organizing hierarchical data. This collection structure mirrors a tree, where each data item may have one or more child items, and those child items can, in turn, have their own descendants. User Manual
Calendar collection
Last Updated: 06/04/2026Introduction A calendar Collection is a specialized data table designed to store dates and date-related information. It is commonly used to manage and track time within applications or systems. The primary goal of the calendar table is to offer flexible and efficient access to date information, allowing for the swift retrieval of relevant data as...
Comment Collection
Last Updated: 06/04/2026Introduction Comment collection is a specialized data table template designed for storing user comments and feedback. With the comment feature, you can add commenting capabilities to any data table, allowing users to discuss, provide feedback, or annotate specific records. The comment collection supports rich text editing, providing flexible content creation capabilities. Features User Guide Creating...
Expression Collection
Last Updated: 06/04/2026Creating an “Expression collection” Template Before utilizing dynamic expression operation nodes within a workflow, it's essential to first create an “Expression” template collection using the collection management tool. This collection serves as a repository for various expressions: Entering Expression Data Following this, you can set up a table block and input several formula entries into...
SQL Collection
Last Updated: 06/04/2026Introduction The SQL collection provides a powerful method for retrieving data using SQL queries. By extracting data fields through SQL queries and configuring the associated field metadata, users can utilize these fields as though they were working with a standard table. This feature is particularly beneficial for scenarios involving complex join queries, statistical analysis, and...
Collection Fields
Last Updated: 06/04/2026Interface Types of Fields APES classifies fields into the following categories from the Interface perspective: Field Data Types Each Field Interface has a default data type. For instance, for fields with the Interface as a Number, the default data type is double, but it can also be float, decimal, etc. The data types currently supported...
Field Validation
Last Updated: 06/04/2026To ensure data accuracy, security, and consistency in collections, APES provides field validation functionality. This feature consists of two main parts: rule configuration and rule application. Rule Configuration APES system fields integrate Joi rules, with support as follows: String Joi string types correspond to the following APES field types: Single Line Text, Long Text, Phone, Email, URL,...
Single Line Text
Last Updated: 06/04/2026Introduction Field Configuration Interface Configuration Edit Mode Read-only Mode
Long Text
Last Updated: 06/04/2026Introduction Field Configuration UI Configuration Edit Mode View Mode
Attachment Field
Last Updated: 06/04/2026Introduction The attachment field is a specialized relational field that connects directly to the file collection. Field Configuration Example (Example to be added)
Data Field: Attachment (URL)
Last Updated: 06/04/2026Introduction Supports attachments in URL format. Installation This plugin is a commercial plugin. User Manual Field Configuration External Data Source Interface
DateTime Field Types
Last Updated: 06/04/2026DateTime field types can be categorized as follows: Here are examples for each DateTime-related field type: Field Type Example Value Description DateTime (with Time Zone) 2024-08-24T07:30:00.000Z Converted to UTC and can be adjusted for time zones DateTime (without Time Zone) 2024-08-24 15:30:00 Stores date and time without time zone considerations Date (without Time) 2024-08-24 Captures...
Datetime (with time zone)
Last Updated: 06/04/2026Introduction Field configuration Example To be added.
Datetime (without time zone)
Last Updated: 06/04/2026Introduction Field configuration Example To be added.
Sort Field
Last Updated: 06/04/2026Introduction Sort fields are used to sort records in a collection, supporting sorting within groups. WARNING Since the sort field is part of the same collection, a record cannot be assigned to multiple groups when using group sorting. Installation Built-in plugin, no separate installation required. User Manual Create a Sort Field When creating sort fields,...
Encryption
Last Updated: 06/04/2026Introduction You can encrypt sensitive business data—such as customer phone numbers, email addresses, or card numbers—so that it is stored in the database as ciphertext. Encryption Method WARNING The plugin automatically generates an application key, which is stored under the directory /storage/apps/main/encryption-field-keys. Each application key is saved as a file whose name is the key...
Last updated by
Last Updated: 06/04/2026Introduction To be added Field Configuration Example To be added
One-to-One
Last Updated: 06/04/2026In the relationship between employees and personal profiles, each employee can only have one personal profile record, and each personal profile record can only correspond to one employee. In this case, the relationship between the employee and the personal profile is one-to-one. The foreign key in a one-to-one relationship can be placed in either the...
One-to-Many
Last Updated: 06/04/2026The relationship between a class and its students is an example of a one-to-many relationship: one class can have multiple students, but each student belongs to only one class. ER Diagram: Field Configuration: Parameter Description Source Collection The source collection, which is the collection where the current field resides. Target Collection The target collection, which...
Many-to-One
Last Updated: 06/04/2026In a library database, there are two entities: books and authors. An author can write multiple books, but each book usually has only one author. In this case, the relationship between authors and books is many-to-one. Multiple books can be associated with the same author, but each book can have only one author. ER Diagram:...
Many-to-Many
Last Updated: 06/04/2026In a course enrollment system, there are two entities: students and courses. A student can enroll in multiple courses, and a course can have multiple students enrolled, constituting a many-to-many relationship. In a relational database, to represent the many-to-many relationship between students and courses, an intermediary collection, such as an enrollment collection, is usually used....
Many-to-Many (Array)
Last Updated: 06/04/2026Introduction This feature allows you to use array fields in a data Collection to store multiple unique keys from the target table, thereby creating a many-to-many relationship between the two tables. For instance, consider the entities Articles and Tags. An article can be linked to multiple tags, with the article table storing the IDs of...