Installation · Database · AntelopeJS DMS

The module plugs into an existing DMS project. It needs no migration: it reads the schemas other modules register and creates its own tables (dms-database schema) for the diagram layouts, diagram notes, query history and saved queries.

Add the module

Run the CLI from the project root:

Terminal

ajs project modules add @antelopejs/dms-database

The command adds a dms-database entry to the modules map of antelope.config.ts and installs the package.

Configure it (optional)

The module works without configuration. To show the database name on the Overview and label your schemas, add a config block:

antelope.config.ts

import { defineConfig } from "@antelopejs/interface-core/config";

export default defineConfig({
  name: "my-project",
  modules: {
    "dms-database": {
      source: {
        type: "package",
        package: "@antelopejs/dms-database",
        version: ">=0.2.0 <1.0.0",
      },
      config: {
        driverLabel: "MongoDB 8.0",
        schemaLabels: {
          "app-*": { label: "Application", color: "info" },
        },
      },
    },
    // dms, mongodb, api, ...
  },
});

Configuration lists every option.

Restart the backend, then the frontend

Restart the backend first: the module registers its Vue frontend module (DmsDatabase component prefix) when it starts. Then restart ajs dms dev, or rebuild the frontend with ajs dms build, so the dashboard picks up the new layer.

Open the console

To see the module with sample data first, run its playground: pnpm dev then pnpm frontend:dev from a clone of AntelopeJS/dms-database. It registers a demo schema and a shop schema with eu and us instances, seeded on first start.