Skip to main content

SchemaInfo

$schemauri

A URL to the JSON Schema for this object.

Example: https://example.com/schemas/SchemaInfo.json
constraints object[]required

Database constraints

  • Array [
  • entityTypestringrequired

    NODE or RELATIONSHIP

    labelsstring[]nullablerequired

    Labels or types the constraint applies to

    namestringrequired

    Constraint name

    propertiesstring[]nullablerequired

    Constrained properties

    typestringrequired

    Constraint type (UNIQUENESS, EXISTS, etc.)

  • ]
  • indexes object[]required

    Database indexes

  • Array [
  • entityTypestringrequired

    NODE or RELATIONSHIP

    labelsstring[]nullablerequired

    Labels or types the index applies to

    namestringrequired

    Index name

    propertiesstring[]nullablerequired

    Indexed properties

    statestringrequired

    Index state (ONLINE, POPULATING, etc.)

    typestringrequired

    Index type (BTREE, FULLTEXT, VECTOR, etc.)

  • ]
  • labels object[]required

    Node labels with counts

  • Array [
  • countint64required

    Number of nodes with this label

    namestringrequired

    Label name

    propertiesstring[]nullablerequired

    Properties on nodes with this label

  • ]
  • nodeCountint64required

    Total node count

    relationshipCountint64required

    Total relationship count

    relationshipTypes object[]required

    Relationship types with counts

  • Array [
  • countint64required

    Number of relationships of this type

    namestringrequired

    Relationship type name

    propertiesstring[]nullablerequired

    Properties on this relationship type

  • ]
  • SchemaInfo
    {
    "$schema": "https://example.com/schemas/SchemaInfo.json",
    "constraints": "Unknown Type: array,null",
    "indexes": "Unknown Type: array,null",
    "labels": "Unknown Type: array,null",
    "nodeCount": 0,
    "relationshipCount": 0,
    "relationshipTypes": "Unknown Type: array,null"
    }