Hydra.Pg.Mapping

A model for property graph mapping specifications. See https://github.com/CategoricalData/hydra/wiki/Property-graphs

Documentation

data AnnotationSchema

Configurable annotation keys for property graph mapping specifications

Constructors

AnnotationSchema

Fields

• annotationSchemaVertexLabel :: String
• annotationSchemaEdgeLabel :: String
• annotationSchemaVertexId :: String
• annotationSchemaEdgeId :: String
• annotationSchemaPropertyKey :: String
• annotationSchemaPropertyValue :: String
• annotationSchemaOutVertex :: String
• annotationSchemaOutVertexLabel :: String
• annotationSchemaInVertex :: String
• annotationSchemaInVertexLabel :: String
• annotationSchemaOutEdge :: String
• annotationSchemaOutEdgeLabel :: String
• annotationSchemaInEdge :: String
• annotationSchemaInEdgeLabel :: String
• annotationSchemaIgnore :: String

Instances

Read AnnotationSchema

Defined in Hydra.Pg.Mapping

Methods

readsPrec :: Int -> ReadS AnnotationSchema

readList :: ReadS [AnnotationSchema]

readPrec :: ReadPrec AnnotationSchema

readListPrec :: ReadPrec [AnnotationSchema]

Show AnnotationSchema

Defined in Hydra.Pg.Mapping

Methods

showsPrec :: Int -> AnnotationSchema -> ShowS

show :: AnnotationSchema -> String

showList :: [AnnotationSchema] -> ShowS

Eq AnnotationSchema

Defined in Hydra.Pg.Mapping

Methods

(==) :: AnnotationSchema -> AnnotationSchema -> Bool

(/=) :: AnnotationSchema -> AnnotationSchema -> Bool

Ord AnnotationSchema

Defined in Hydra.Pg.Mapping

Methods

compare :: AnnotationSchema -> AnnotationSchema -> Ordering

(<) :: AnnotationSchema -> AnnotationSchema -> Bool

(<=) :: AnnotationSchema -> AnnotationSchema -> Bool

(>) :: AnnotationSchema -> AnnotationSchema -> Bool

(>=) :: AnnotationSchema -> AnnotationSchema -> Bool

max :: AnnotationSchema -> AnnotationSchema -> AnnotationSchema

min :: AnnotationSchema -> AnnotationSchema -> AnnotationSchema

_AnnotationSchema :: Name

_AnnotationSchema_vertexLabel :: Name

_AnnotationSchema_edgeLabel :: Name

_AnnotationSchema_vertexId :: Name

_AnnotationSchema_edgeId :: Name

_AnnotationSchema_propertyKey :: Name

_AnnotationSchema_propertyValue :: Name

_AnnotationSchema_outVertex :: Name

_AnnotationSchema_outVertexLabel :: Name

_AnnotationSchema_inVertex :: Name

_AnnotationSchema_inVertexLabel :: Name

_AnnotationSchema_outEdge :: Name

_AnnotationSchema_outEdgeLabel :: Name

_AnnotationSchema_inEdge :: Name

_AnnotationSchema_inEdgeLabel :: Name

_AnnotationSchema_ignore :: Name

data EdgeSpec

A mapping specification producing edges of a specified label.

Constructors

EdgeSpec

Fields

• edgeSpecLabel :: EdgeLabel

  The label of the target edges, which must conform to the edge type associated with that label.

• edgeSpecId :: ValueSpec

  A specification of the id of each target edge

• edgeSpecOut :: ValueSpec

  A specification of the out-vertex reference of each target edge

• edgeSpecIn :: ValueSpec

  A specification of the in-vertex reference of each target edge

• edgeSpecProperties :: [PropertySpec]

  Zero or more property specifications for each target edge

Instances

Read EdgeSpec

Defined in Hydra.Pg.Mapping

Methods

readsPrec :: Int -> ReadS EdgeSpec

readList :: ReadS [EdgeSpec]

readPrec :: ReadPrec EdgeSpec

readListPrec :: ReadPrec [EdgeSpec]

Show EdgeSpec

Defined in Hydra.Pg.Mapping

Methods

showsPrec :: Int -> EdgeSpec -> ShowS

show :: EdgeSpec -> String

showList :: [EdgeSpec] -> ShowS

Eq EdgeSpec

Defined in Hydra.Pg.Mapping

Methods

(==) :: EdgeSpec -> EdgeSpec -> Bool

(/=) :: EdgeSpec -> EdgeSpec -> Bool

Ord EdgeSpec

Defined in Hydra.Pg.Mapping

Methods

compare :: EdgeSpec -> EdgeSpec -> Ordering

(<) :: EdgeSpec -> EdgeSpec -> Bool

(<=) :: EdgeSpec -> EdgeSpec -> Bool

(>) :: EdgeSpec -> EdgeSpec -> Bool

(>=) :: EdgeSpec -> EdgeSpec -> Bool

max :: EdgeSpec -> EdgeSpec -> EdgeSpec

min :: EdgeSpec -> EdgeSpec -> EdgeSpec

_EdgeSpec :: Name

_EdgeSpec_label :: Name

_EdgeSpec_id :: Name

_EdgeSpec_out :: Name

_EdgeSpec_in :: Name

_EdgeSpec_properties :: Name

data ElementSpec

Either a vertex specification or an edge specification

Constructors

ElementSpecVertex VertexSpec

ElementSpecEdge EdgeSpec

Instances

Read ElementSpec

Defined in Hydra.Pg.Mapping

Methods

readsPrec :: Int -> ReadS ElementSpec

readList :: ReadS [ElementSpec]

readPrec :: ReadPrec ElementSpec

readListPrec :: ReadPrec [ElementSpec]

Show ElementSpec

Defined in Hydra.Pg.Mapping

Methods

showsPrec :: Int -> ElementSpec -> ShowS

show :: ElementSpec -> String

showList :: [ElementSpec] -> ShowS

Eq ElementSpec

Defined in Hydra.Pg.Mapping

Methods

(==) :: ElementSpec -> ElementSpec -> Bool

(/=) :: ElementSpec -> ElementSpec -> Bool

Ord ElementSpec

Defined in Hydra.Pg.Mapping

Methods

compare :: ElementSpec -> ElementSpec -> Ordering

(<) :: ElementSpec -> ElementSpec -> Bool

(<=) :: ElementSpec -> ElementSpec -> Bool

(>) :: ElementSpec -> ElementSpec -> Bool

(>=) :: ElementSpec -> ElementSpec -> Bool

max :: ElementSpec -> ElementSpec -> ElementSpec

min :: ElementSpec -> ElementSpec -> ElementSpec

_ElementSpec :: Name

_ElementSpec_vertex :: Name

_ElementSpec_edge :: Name

data PropertySpec

A mapping specification producing properties of a specified key, and values of the appropriate type.

Constructors

PropertySpec

Fields

• propertySpecKey :: PropertyKey

  The key of the target properties

• propertySpecValue :: ValueSpec

  A specification of the value of each target property, which must conform to the type associated with the property key

Instances

Read PropertySpec

Defined in Hydra.Pg.Mapping

Methods

readsPrec :: Int -> ReadS PropertySpec

readList :: ReadS [PropertySpec]

readPrec :: ReadPrec PropertySpec

readListPrec :: ReadPrec [PropertySpec]

Show PropertySpec

Defined in Hydra.Pg.Mapping

Methods

showsPrec :: Int -> PropertySpec -> ShowS

show :: PropertySpec -> String

showList :: [PropertySpec] -> ShowS

Eq PropertySpec

Defined in Hydra.Pg.Mapping

Methods

(==) :: PropertySpec -> PropertySpec -> Bool

(/=) :: PropertySpec -> PropertySpec -> Bool

Ord PropertySpec

Defined in Hydra.Pg.Mapping

Methods

compare :: PropertySpec -> PropertySpec -> Ordering

(<) :: PropertySpec -> PropertySpec -> Bool

(<=) :: PropertySpec -> PropertySpec -> Bool

(>) :: PropertySpec -> PropertySpec -> Bool

(>=) :: PropertySpec -> PropertySpec -> Bool

max :: PropertySpec -> PropertySpec -> PropertySpec

min :: PropertySpec -> PropertySpec -> PropertySpec

_PropertySpec :: Name

_PropertySpec_key :: Name

_PropertySpec_value :: Name

data Schema s t v

A set of mappings which translates between Hydra terms and annotations, and application-specific property graph types

Constructors

Schema

Fields

• schemaVertexIdTypes :: Coder s s Type t
• schemaVertexIds :: Coder s s Term v
• schemaEdgeIdTypes :: Coder s s Type t
• schemaEdgeIds :: Coder s s Term v
• schemaPropertyTypes :: Coder s s Type t
• schemaPropertyValues :: Coder s s Term v
• schemaAnnotations :: AnnotationSchema
• schemaDefaultVertexId :: v
• schemaDefaultEdgeId :: v

_Schema :: Name

_Schema_vertexIdTypes :: Name

_Schema_vertexIds :: Name

_Schema_edgeIdTypes :: Name

_Schema_edgeIds :: Name

_Schema_propertyTypes :: Name

_Schema_propertyValues :: Name

_Schema_annotations :: Name

_Schema_defaultVertexId :: Name

_Schema_defaultEdgeId :: Name

data ValueSpec

A mapping specification producing values (usually literal values) whose type is understood in context

Constructors

ValueSpecValue

A trivial no-op specification which passes the entire value

ValueSpecPattern String

A compact path representing the function, e.g. engine-${engineInfomodelname}

Instances

Read ValueSpec

Defined in Hydra.Pg.Mapping

Methods

readsPrec :: Int -> ReadS ValueSpec

readList :: ReadS [ValueSpec]

readPrec :: ReadPrec ValueSpec

readListPrec :: ReadPrec [ValueSpec]

Show ValueSpec

Defined in Hydra.Pg.Mapping

Methods

showsPrec :: Int -> ValueSpec -> ShowS

show :: ValueSpec -> String

showList :: [ValueSpec] -> ShowS

Eq ValueSpec

Defined in Hydra.Pg.Mapping

Methods

(==) :: ValueSpec -> ValueSpec -> Bool

(/=) :: ValueSpec -> ValueSpec -> Bool

Ord ValueSpec

Defined in Hydra.Pg.Mapping

Methods

compare :: ValueSpec -> ValueSpec -> Ordering

(<) :: ValueSpec -> ValueSpec -> Bool

(<=) :: ValueSpec -> ValueSpec -> Bool

(>) :: ValueSpec -> ValueSpec -> Bool

(>=) :: ValueSpec -> ValueSpec -> Bool

max :: ValueSpec -> ValueSpec -> ValueSpec

min :: ValueSpec -> ValueSpec -> ValueSpec

_ValueSpec :: Name

_ValueSpec_value :: Name

_ValueSpec_pattern :: Name

data VertexSpec

A mapping specification producing vertices of a specified label

Constructors

VertexSpec

Fields

• vertexSpecLabel :: VertexLabel

  The label of the target vertices, which must conform to the vertex type associated with that label.

• vertexSpecId :: ValueSpec

  A specification of the id of each target vertex

• vertexSpecProperties :: [PropertySpec]

  Zero or more property specifications for each target vertex

Instances

Read VertexSpec

Defined in Hydra.Pg.Mapping

Methods

readsPrec :: Int -> ReadS VertexSpec

readList :: ReadS [VertexSpec]

readPrec :: ReadPrec VertexSpec

readListPrec :: ReadPrec [VertexSpec]

Show VertexSpec

Defined in Hydra.Pg.Mapping

Methods

showsPrec :: Int -> VertexSpec -> ShowS

show :: VertexSpec -> String

showList :: [VertexSpec] -> ShowS

Eq VertexSpec

Defined in Hydra.Pg.Mapping

Methods

(==) :: VertexSpec -> VertexSpec -> Bool

(/=) :: VertexSpec -> VertexSpec -> Bool

Ord VertexSpec

Defined in Hydra.Pg.Mapping

Methods

compare :: VertexSpec -> VertexSpec -> Ordering

(<) :: VertexSpec -> VertexSpec -> Bool

(<=) :: VertexSpec -> VertexSpec -> Bool

(>) :: VertexSpec -> VertexSpec -> Bool

(>=) :: VertexSpec -> VertexSpec -> Bool

max :: VertexSpec -> VertexSpec -> VertexSpec

min :: VertexSpec -> VertexSpec -> VertexSpec

_VertexSpec :: Name

_VertexSpec_label :: Name

_VertexSpec_id :: Name

_VertexSpec_properties :: Name