• English

      • PostgreSQL

      Data source managerCommunity Edition+

      Introduction

      PostgreSQL can be used as the NocoBase main database. It stores NocoBase system-table data and business data in the main data source. Configure the main database when deploying NocoBase; it cannot be deleted after the application is running.

      SettingDescription
      Supported version>= 10.
      Commercial editionsCommunity, Standard, Professional, and Enterprise.
      Database typePostgreSQL.

      PostgreSQL supports inheritance collections, which are suitable for data models that need inheritance.

      Plugin installation

      PostgreSQL is built in and does not require a separate plugin.

      Usage

      1. Select or enter PostgreSQL connection settings when deploying NocoBase.
      2. After NocoBase starts, open Data source management, select Main, and manage collections and fields in the main database.
      3. To connect tables that already exist in the database, use Sync from database on the main-database management page.
      4. When configuring fields, use Collections and Collection fields to choose Field types and Field interfaces.

      Field type mapping

      When you create a field in NocoBase, NocoBase creates the corresponding PostgreSQL column. When you synchronize an existing table, NocoBase maps the PostgreSQL column type to a suitable Field type and Field interface. You can adjust the display interface in field configuration.

      PostgreSQL typeNocoBase Field typeAvailable Field interfaces
      BOOLEANbooleanCheckbox, Switch.
      SMALLINT, INTEGER, SERIAL, SMALLSERIALinteger, boolean, sortInteger, Sort, Checkbox, Switch, Select, Radio group.
      BIGINT, BIGSERIALbigInt, sortInteger, Sort, Checkbox, Switch, Select, Radio group, Unix timestamp, Created at, Updated at.
      REALfloatNumber, Percent.
      DOUBLE PRECISIONdoubleNumber, Percent.
      DECIMAL, NUMERICdecimalNumber, Percent, Currency.
      VARCHAR, CHARstring, password, uuid, nanoidInput, Email, Phone, Password, Color, Icon, Select, Radio group, UUID, Nano ID.
      TEXTtext, jsonTextarea, Markdown, Vditor, Rich text, URL, JSON.
      UUIDuuidUUID.
      JSON, JSONBjsonJSON.
      TIMESTAMPdateDate, Time, Created at, Updated at.
      DATEdateOnlyDate.
      TIMEtimeTime.
      POINT, LINESTRING, POLYGON, CIRCLEpoint, lineString, polygon, circlePoint, Line string, Polygon, Circle, JSON.
      ARRAYarrayMultiple select, Checkbox group.
      Note

      Unsupported PostgreSQL types are shown separately in field configuration. They require development support before they can be used as normal NocoBase fields.

      For common configuration, see Main database.