An entity table describes how to map an input data frame to a Cypher entity (i.e.
Annotation to use when mapping a case class to a node with more than one label, or a label different to the class name.
Annotation to use when mapping a case class to a node with more than one label, or a label different to the class name.
@ Labels("Person", "Employee") case class Employee(id: Long, name: String, salary: Double)
the labels that the node has.
If a node has no label annotation, then the class name is used as its label.
If a node has no label annotation, then the class name is used as its label.
If a Labels
annotation, for example @Labels("Person", "Mammal")
, is present,
then the labels from that annotation are used instead.
A node table describes how to map an input data frame to a Cypher node.
A node table describes how to map an input data frame to a Cypher node.
A node table needs to have the canonical column ordering specified by EntityMapping#allSourceKeys. The easiest way to transform the table to a canonical column ordering is to use one of the constructors on the companion object.
Column names prefixed with property#
are decoded by org.opencypher.spark.api.io.util.StringEncodingUtilities to
recover the original property name.
If a relationship has no type annotation, then the class name in all caps is used as its type.
If a relationship has no type annotation, then the class name in all caps is used as its type.
If a Type
annotation, for example @RelationshipType("FRIEND_OF")
is present,
then the type from that annotation is used instead.
A relationship table describes how to map an input data frame to a Cypher relationship.
A relationship table describes how to map an input data frame to a Cypher relationship.
A relationship table needs to have the canonical column ordering specified by EntityMapping#allSourceKeys. The easiest way to transform the table to a canonical column ordering is to use one of the constructors on the companion object.
Annotation to use when mapping a case class to a relationship with a different relationship type to the class name.
Annotation to use when mapping a case class to a relationship with a different relationship type to the class name.
@ RelationshipType("FRIEND_OF") case class Friend(id: Long, src: Long, dst: Long, since: Int)
the relationship type that the relationship has.
An entity table describes how to map an input data frame to a Cypher entity (i.e. nodes or relationships).