Entity Specification Version

The erdia stores entity information in versions. Use versioned entity information to affected changes between versions in each documentation.

Why?

1. entity changes are affected in documents
2. entity versions can be managed as package.json version field, specific files, timestamps.
3. versioning is automatic. If there is any incorrect information, you can correct it manually because the version DB is a JSON format file

Example

The documentation below is the result of changing the entities and generating the documentation.

Entity versioning example in HTML document

Changes to entity information are important information in each release. Generating documentation with ERDIA helps you manage change information.

erdiadb.json

example of erdiadb.json file content: changed description column

{
  {
    "$kind": "column",
    "name": "description",
    "version": "1.1.0",
    "createdAt": "2023-08-25T10:28:16+09:00",
    "updatedAt": "2023-08-25T10:28:16+09:00",
    "change": "change",
    "entity": "tbl_license",
    "dbName": "description",
    "attributeKey": [],
    "isNullable": "",
    "columnType": "varchar",
    "charset": "utf8mb4",
    "columnTypeWithLength": "varchar(2000)",
    "comment": "organization description",
    "weight": 743022.21,
    "prev": {
      "$kind": "column",
      "name": "description",
      "version": "1.0.0",
      "createdAt": "2023-08-24T20:53:22+09:00",
      "updatedAt": "2023-08-24T20:53:22+09:00",
      "change": "none",
      "entity": "tbl_license",
      "dbName": "description",
      "attributeKey": [],
      "isNullable": "",
      "columnType": "varchar",
      "charset": "utf8mb4",
      "columnTypeWithLength": "varchar(2048)",
      "comment": "organization description",
      "weight": 743022.21
    }
  },
  {
    "$kind": "column",
    "name": "description",
    "version": "1.0.0",
    "createdAt": "2023-08-24T20:53:22+09:00",
    "updatedAt": "2023-08-24T20:53:22+09:00",
    "change": "none",
    "entity": "tbl_license",
    "dbName": "description",
    "attributeKey": [],
    "isNullable": "",
    "columnType": "varchar",
    "charset": "utf8mb4",
    "columnTypeWithLength": "varchar(2048)",
    "comment": "organization description",
    "weight": 743022.21
  },
}