graph-guard-validate/io.github.cfraser.graphguard.validate/Schema

Schema

A Schema describes the nodes and relationships in a Neo4j database via the (potentially) interconnected graphs.

Schema implements Rule, thus has the capability to Rule.validate that a Cypher query adheres to the nodes and relationships defined in the graphs.

Types

Companion

object Companion

Graph

@JvmRecord

data class Graph : Record

A Graph is a KList of nodes that specify the expected entities in a Neo4j database.

Metadata

@JvmRecord

data class Metadata : Record

Graph entity Metadata.

Node

@JvmRecord

data class Node : Record

A Node in the graph.

Property

@JvmRecord

data class Property : Record

A Property on a Node or Relationship.

Relationship

@JvmRecord

data class Relationship : Record

A Relationship in the graph.

Violation

sealed class Violation

A Schema caused by a Cypher query, or entities in the Neo4j graph.

Properties

graphs

val graphs: List<Schema.Graph>

the Schema.Graphs defining the Schema.Nodes and Schema.Relationships

nodes

val nodes: Map<String, Schema.Node>

the Nodes in the graphs indexed by Node.name

relationships

val relationships: Map<Schema.Relationship.Id, Schema.Relationship>

the Relationships in the graphs indexed by Relationship.Id

Functions

excludes

open infix fun excludes(regexes: Collection<Regex>): Rule

Exclude the Cypher query from Rule validation if it matches any of the regexes.

then

open infix fun then(that: Rule): Rule

Run this Rule then that.

toString

open override fun toString(): String

validate

open override fun validate(cypher: String, parameters: Map<String, Any?>): Rule.Violation?

Validate the cypher and parameters.