Skip to main content

Databases

Use databases to sync service-owned schema files into UiGraph.

Supported dialects​

  • postgres
  • mysql
  • sqlite
  • dynamodb
  • mongodb
  • other

Minimal config​

databases:
  - name: Core PostgreSQL Database
    dbType: PostgreSQL
    dialect: postgres
    schemaPath: ./postgresql-core.sql

Each item requires:

  • name
  • dialect
  • schemaPath

Optional:

  • dbType

What the CLI does​

For each database entry, the CLI:

  1. validates the dialect
  2. checks that schemaPath exists
  3. reads the schema file as raw content
  4. sends the file content and database metadata to the gateway

If the schema file is missing, validation fails before sync.

Multi-database example​

databases:
  - name: Core MySQL Database
    dbType: MySQL
    dialect: mysql
    schemaPath: ./mysql-core.sql

  - name: Local SQLite Database
    dbType: SQLite
    dialect: sqlite
    schemaPath: ./sqlite-local.sql

  - name: Event DynamoDB Database
    dbType: DynamoDB
    dialect: dynamodb
    schemaPath: ./dynamodb-events.json

  - name: Event MongoDB Database
    dbType: MongoDB
    dialect: mongodb
    schemaPath: ./mongodb-events.json
  • SQL dialects: .sql
  • DynamoDB or MongoDB: .json
  • keep schema files in version control
  • use stable file paths so CI remains predictable
  • choose dbType for clearer display naming when needed
  • sync one entry per logical database, not one catch-all file for unrelated systems

Keep schema files updated together with source changes so the visual model stays useful.