app.prismaliser.schema Documentation (EN)

main record

A Prismaliser Prisma schema and graph layout snapshot.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

The time at which this snapshot was created.

name string Optional

An optional name for the shared diagram.

maxLength: 160 bytesmaxGraphemes: 80 graphemes

positions array of ref #position Required

The saved positions of the diagram's nodes.

maxLength: 5000 items

prismaVersion string Required

The Prisma version used to parse the schema.

maxLength: 64 bytes

schema blob Required

The Prisma schema text used to render the diagram.

maxSize: 500.0 KB

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "schema",
      "positions",
      "prismaVersion",
      "createdAt"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 160,
        "description": "An optional name for the shared diagram.",
        "maxGraphemes": 80
      },
      "schema": {
        "type": "blob",
        "accept": [
          "text/plain"
        ],
        "maxSize": 500000,
        "description": "The Prisma schema text used to render the diagram."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "The time at which this snapshot was created."
      },
      "positions": {
        "type": "array",
        "items": {
          "ref": "#position",
          "type": "ref"
        },
        "maxLength": 5000,
        "description": "The saved positions of the diagram's nodes."
      },
      "prismaVersion": {
        "type": "string",
        "maxLength": 64,
        "description": "The Prisma version used to parse the schema."
      }
    }
  },
  "description": "A Prismaliser Prisma schema and graph layout snapshot."
}

position object

The saved canvas position of one diagram node.

Properties

id string Required

The identifier of the diagram node.

maxLength: 512 bytes

x integer Required

The horizontal node position in canvas coordinates.

minimum: -10000000maximum: 10000000

y integer Required

The vertical node position in canvas coordinates.

minimum: -10000000maximum: 10000000

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "x",
    "y"
  ],
  "properties": {
    "x": {
      "type": "integer",
      "maximum": 10000000,
      "minimum": -10000000,
      "description": "The horizontal node position in canvas coordinates."
    },
    "y": {
      "type": "integer",
      "maximum": 10000000,
      "minimum": -10000000,
      "description": "The vertical node position in canvas coordinates."
    },
    "id": {
      "type": "string",
      "maxLength": 512,
      "description": "The identifier of the diagram node."
    }
  },
  "description": "The saved canvas position of one diagram node."
}