Skip to content

Commit

Permalink
[pLz5YbCW] update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nadja-muller committed Oct 24, 2023
1 parent 9adfaff commit ee355d1
Show file tree
Hide file tree
Showing 17 changed files with 72 additions and 72 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
¦signature
¦apoc.merge.node(label :: LIST? OF STRING?, identProps :: MAP?, props = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)
¦apoc.merge.relationship(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, props :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)
¦apoc.merge.node(label :: LIST? OF STRING?, identProps :: MAP?, onCreateProps = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)
¦apoc.merge.relationship(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, onCreateProps :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
¦signature
¦apoc.merge.node(label :: LIST? OF STRING?, identProps :: MAP?, props = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)
¦apoc.merge.node(label :: LIST? OF STRING?, identProps :: MAP?, onCreateProps = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
¦signature
¦apoc.merge.node.eager(label :: LIST? OF STRING?, identProps :: MAP?, props = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)
¦apoc.merge.node.eager(label :: LIST? OF STRING?, identProps :: MAP?, onCreateProps = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
¦type¦qualified name¦signature¦description
¦procedure¦apoc.merge.node.eager¦apoc.merge.node.eager(label :: LIST? OF STRING?, identProps :: MAP?, props = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)¦apoc.merge.node.eager(['Label'], identProps:{key:value, ...}, onCreateProps:{key:value,...}, onMatchProps:{key:value,...}}) - merge nodes eagerly, with dynamic labels, with support for setting properties ON CREATE or ON MATCH
¦procedure¦apoc.merge.node.eager¦apoc.merge.node.eager(label :: LIST? OF STRING?, identProps :: MAP?, onCreateProps = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)¦apoc.merge.node.eager(['Label'], identProps:{key:value, ...}, onCreateProps:{key:value,...}, onMatchProps:{key:value,...}}) - merge nodes eagerly, with dynamic labels, with support for setting properties ON CREATE or ON MATCH
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
¦signature
¦apoc.merge.relationship(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, props :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)
¦apoc.merge.relationship(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, onCreateProps :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
¦signature
¦apoc.merge.relationship.eager(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, props :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)
¦apoc.merge.relationship.eager(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, onCreateProps :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
¦type¦qualified name¦signature¦description
¦procedure¦apoc.merge.relationship.eager¦apoc.merge.relationship.eager(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, props :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)¦apoc.merge.relationship(startNode, relType, identProps:{key:value, ...}, onCreateProps:{key:value, ...}, endNode, onMatchProps:{key:value, ...}) - merge relationship with dynamic type, with support for setting properties ON CREATE or ON MATCH
¦procedure¦apoc.merge.relationship.eager¦apoc.merge.relationship.eager(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, onCreateProps :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)¦apoc.merge.relationship(startNode, relType, identProps:{key:value, ...}, onCreateProps:{key:value, ...}, endNode, onMatchProps:{key:value, ...}) - merge relationship with dynamic type, with support for setting properties ON CREATE or ON MATCH
Original file line number Diff line number Diff line change
Expand Up @@ -164,10 +164,10 @@
¦procedure¦apoc.log.stream¦apoc.log.stream(path :: STRING?, config = {} :: MAP?) :: (lineNo :: INTEGER?, line :: STRING?, path :: STRING?)¦apoc.log.stream('neo4j.log', { last: n }) - retrieve log file contents, optionally return only the last n lines¦true¦
¦procedure¦apoc.log.warn¦apoc.log.warn(message :: STRING?, params = [] :: LIST? OF ANY?) :: VOID¦apoc.log.warn(message, params) - logs warn message¦false¦
¦procedure¦apoc.math.regr¦apoc.math.regr(label :: STRING?, propertyY :: STRING?, propertyX :: STRING?) :: (r2 :: FLOAT?, avgX :: FLOAT?, avgY :: FLOAT?, slope :: FLOAT?)¦apoc.math.regr(label, propertyY, propertyX) - It calculates the coefficient of determination (R-squared) for the values of propertyY and propertyX in the provided label¦true¦xref::mathematical/math-functions.adoc
¦procedure¦apoc.merge.node¦apoc.merge.node(label :: LIST? OF STRING?, identProps :: MAP?, props = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)¦"apoc.merge.node.eager(['Label'], identProps:{key:value, ...}, onCreateProps:{key:value,...}, onMatchProps:{key:value,...}}) - merge nodes with dynamic labels, with support for setting properties ON CREATE or ON MATCH¦true¦xref::graph-updates/data-creation.adoc
¦procedure¦apoc.merge.node.eager¦apoc.merge.node.eager(label :: LIST? OF STRING?, identProps :: MAP?, props = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)¦apoc.merge.node.eager(['Label'], identProps:{key:value, ...}, onCreateProps:{key:value,...}, onMatchProps:{key:value,...}}) - merge nodes eagerly, with dynamic labels, with support for setting properties ON CREATE or ON MATCH¦true¦xref::graph-updates/data-creation.adoc
¦procedure¦apoc.merge.relationship¦apoc.merge.relationship(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, props :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)¦apoc.merge.relationship(startNode, relType, identProps:{key:value, ...}, onCreateProps:{key:value, ...}, endNode, onMatchProps:{key:value, ...}) - merge relationship with dynamic type, with support for setting properties ON CREATE or ON MATCH¦true¦xref::graph-updates/data-creation.adoc
¦procedure¦apoc.merge.relationship.eager¦apoc.merge.relationship.eager(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, props :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)¦apoc.merge.relationship(startNode, relType, identProps:{key:value, ...}, onCreateProps:{key:value, ...}, endNode, onMatchProps:{key:value, ...}) - merge relationship with dynamic type, with support for setting properties ON CREATE or ON MATCH¦true¦xref::graph-updates/data-creation.adoc
¦procedure¦apoc.merge.node¦apoc.merge.node(label :: LIST? OF STRING?, identProps :: MAP?, onCreateProps = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)¦"apoc.merge.node.eager(['Label'], identProps:{key:value, ...}, onCreateProps:{key:value,...}, onMatchProps:{key:value,...}}) - merge nodes with dynamic labels, with support for setting properties ON CREATE or ON MATCH¦true¦xref::graph-updates/data-creation.adoc
¦procedure¦apoc.merge.node.eager¦apoc.merge.node.eager(label :: LIST? OF STRING?, identProps :: MAP?, onCreateProps = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)¦apoc.merge.node.eager(['Label'], identProps:{key:value, ...}, onCreateProps:{key:value,...}, onMatchProps:{key:value,...}}) - merge nodes eagerly, with dynamic labels, with support for setting properties ON CREATE or ON MATCH¦true¦xref::graph-updates/data-creation.adoc
¦procedure¦apoc.merge.relationship¦apoc.merge.relationship(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, onCreateProps :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)¦apoc.merge.relationship(startNode, relType, identProps:{key:value, ...}, onCreateProps:{key:value, ...}, endNode, onMatchProps:{key:value, ...}) - merge relationship with dynamic type, with support for setting properties ON CREATE or ON MATCH¦true¦xref::graph-updates/data-creation.adoc
¦procedure¦apoc.merge.relationship.eager¦apoc.merge.relationship.eager(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, onCreateProps :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)¦apoc.merge.relationship.eager(startNode, relType, identProps:{key:value, ...}, onCreateProps:{key:value, ...}, endNode, onMatchProps:{key:value, ...}) - merge relationship with dynamic type, with support for setting properties ON CREATE or ON MATCH¦true¦xref::graph-updates/data-creation.adoc
¦procedure¦apoc.meta.data¦apoc.meta.data(config = {} :: MAP?) :: (label :: STRING?, property :: STRING?, count :: INTEGER?, unique :: BOOLEAN?, index :: BOOLEAN?, existence :: BOOLEAN?, type :: STRING?, array :: BOOLEAN?, sample :: LIST? OF ANY?, left :: INTEGER?, right :: INTEGER?, other :: LIST? OF STRING?, otherLabels :: LIST? OF STRING?, elementType :: STRING?)¦apoc.meta.data(\{config}) - examines a subset of the graph to provide a tabular meta information¦true¦
¦procedure¦apoc.meta.data.of¦apoc.meta.data.of(graph :: ANY?, config = {} :: MAP?) :: (label :: STRING?, property :: STRING?, count :: INTEGER?, unique :: BOOLEAN?, index :: BOOLEAN?, existence :: BOOLEAN?, type :: STRING?, array :: BOOLEAN?, sample :: LIST? OF ANY?, left :: INTEGER?, right :: INTEGER?, other :: LIST? OF STRING?, otherLabels :: LIST? OF STRING?, elementType :: STRING?)¦apoc.meta.data.of(\{graph}, \{config}) - examines a subset of the graph to provide a tabular meta information¦true¦
¦procedure¦apoc.meta.graph¦apoc.meta.graph(config = {} :: MAP?) :: (nodes :: LIST? OF NODE?, relationships :: LIST? OF RELATIONSHIP?)¦apoc.meta.graph - examines the full graph to create the meta-graph¦true¦
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ label:procedure[] label:apoc-core[]

[source]
----
apoc.merge.node(label :: LIST? OF STRING?, identProps :: MAP?, props = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)
apoc.merge.node(label :: LIST? OF STRING?, identProps :: MAP?, onCreateProps = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)
----

== Input parameters
[.procedures, opts=header]
|===
| Name | Type | Default
|label|LIST? OF STRING?|null
|identProps|MAP?|null
|props|MAP?|{}
|onMatchProps|MAP?|{}
| Name | Type | Default | Description
| labels | LIST? OF STRING? | null | The list of labels used for the generated merge statement. Passing `null` or an empty list will merge a node without any labels. `null` or empty strings within the list are not supported.
| identProps | MAP? | null | Properties that are always merged.
| onCreateProps | MAP? | {} | Properties that are merged when a node is created.
| onMatchProps | MAP? | {} | Properties that are merged when a node is matched.
|===

== Output parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ apoc.merge.node.eager(['Label'], identProps:{key:value, ...}, onCreateProps:{key

[source]
----
apoc.merge.node.eager(label :: LIST? OF STRING?, identProps :: MAP?, props = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)
apoc.merge.node.eager(label :: LIST? OF STRING?, identProps :: MAP?, onCreateProps = {} :: MAP?, onMatchProps = {} :: MAP?) :: (node :: NODE?)
----

== Input parameters
[.procedures, opts=header]
|===
| Name | Type | Default
|label|LIST? OF STRING?|null
|identProps|MAP?|null
|props|MAP?|{}
|onMatchProps|MAP?|{}
| Name | Type | Default | Description
| labels | LIST? OF STRING? | null | The list of labels used for the generated merge statement. Passing `null` or an empty list will merge a node without any labels. `null` or empty strings within the list are not supported.
| identProps | MAP? | null | Properties that are always merged.
| onCreateProps | MAP? | {} | Properties that are merged when a node is created.
| onMatchProps | MAP? | {} | Properties that are merged when a node is matched.
|===

== Output parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ apoc.merge.nodeWithStats - same as apoc.merge.node providing queryStatistics int

[source]
----
apoc.merge.nodeWithStats(label :: LIST? OF STRING?, identProps :: MAP?, props = {} :: MAP?, onMatchProps = {} :: MAP?) :: (stats :: MAP?, node :: NODE?)
apoc.merge.nodeWithStats(label :: LIST? OF STRING?, identProps :: MAP?, onCreateProps = {} :: MAP?, onMatchProps = {} :: MAP?) :: (stats :: MAP?, node :: NODE?)
----

== Input parameters
[.procedures, opts=header]
|===
| Name | Type | Default
|label|LIST? OF STRING?|null
|identProps|MAP?|null
|props|MAP?|{}
|onMatchProps|MAP?|{}
| Name | Type | Default | Description
| label | LIST? OF STRING? | null | The list of labels used for the generated merge statement. Passing `null` or an empty list will merge a node without any labels. `null` or empty strings within the list are not supported.
| identProps | MAP? | null | Properties that are always merged.
| onCreateProps | MAP? | {} | Properties that are merged when a node is created.
| onMatchProps | MAP? | {} | Properties that are merged when a node is matched.
|===

== Output parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ apoc.merge.nodeWithStats.eager - same as apoc.merge.node.eager providing querySt

[source]
----
apoc.merge.nodeWithStats.eager(label :: LIST? OF STRING?, identProps :: MAP?, props = {} :: MAP?, onMatchProps = {} :: MAP?) :: (stats :: MAP?, node :: NODE?)
apoc.merge.nodeWithStats.eager(label :: LIST? OF STRING?, identProps :: MAP?, onCreateProps = {} :: MAP?, onMatchProps = {} :: MAP?) :: (stats :: MAP?, node :: NODE?)
----

== Input parameters
[.procedures, opts=header]
|===
| Name | Type | Default
|label|LIST? OF STRING?|null
|identProps|MAP?|null
|props|MAP?|{}
|onMatchProps|MAP?|{}
| Name | Type | Default | Description
| labels | LIST? OF STRING? | null | The list of labels used for the generated merge statement. Passing `null` or an empty list will merge a node without any labels. `null` or empty strings within the list are not supported.
| identProps | MAP? | null | Properties that are always merged.
| onCreateProps | MAP? | {} | Properties that are merged when a node is created.
| onMatchProps | MAP? | {} | Properties that are merged when a node is matched.
|===

== Output parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ apoc.merge.relationship(startNode, relType, identProps:{key:value, ...}, onCrea

[source]
----
apoc.merge.relationship(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, props :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)
apoc.merge.relationship(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, onCreateProps :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)
----

== Input parameters
[.procedures, opts=header]
|===
| Name | Type | Default
|startNode|NODE?|null
|relationshipType|STRING?|null
|identProps|MAP?|null
|props|MAP?|null
|endNode|NODE?|null
|onMatchProps|MAP?|{}
| Name | Type | Default | Description
| startNode | NODE? | null | Start node of the merge pattern.
| relationshipType | STRING? | null | Relationship type of the merge pattern.
| identProps | MAP? | null | Properties on the relationships that are always merged.
| onCreateProps | MAP? | null | Properties that are merged when the relationship is created.
| endNode | NODE? | null | End node of the merge pattern.
| onMatchProps | MAP? | {} | Properties that are merged when the relationship is matched.
|===

== Output parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ apoc.merge.relationship(startNode, relType, identProps:{key:value, ...}, onCrea

[source]
----
apoc.merge.relationship.eager(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, props :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)
apoc.merge.relationship.eager(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, onCreateProps :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (rel :: RELATIONSHIP?)
----

== Input parameters
[.procedures, opts=header]
|===
| Name | Type | Default
|startNode|NODE?|null
|relationshipType|STRING?|null
|identProps|MAP?|null
|props|MAP?|null
|endNode|NODE?|null
|onMatchProps|MAP?|{}
| Name | Type | Default | Description
| startNode | NODE? | null | Start node of the merge pattern.
| relationshipType | STRING? | null | Relationship type of the merge pattern.
| identProps | MAP? | null | Properties on the relationships that are always merged.
| onCreateProps | MAP? | null | Properties that are merged when the relationship is created.
| endNode | NODE? | null | End node of the merge pattern.
| onMatchProps | MAP? | {} | Properties that are merged when the relationship is matched.
|===

== Output parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ apoc.merge.relationshipWithStats - same as apoc.merge.relationship providing que

[source]
----
apoc.merge.relationshipWithStats(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, props :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (stats :: MAP?, rel :: RELATIONSHIP?)
apoc.merge.relationshipWithStats(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, onCreateProps :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (stats :: MAP?, rel :: RELATIONSHIP?)
----

== Input parameters
[.procedures, opts=header]
|===
| Name | Type | Default
|startNode|NODE?|null
|relationshipType|STRING?|null
|identProps|MAP?|null
|props|MAP?|null
|endNode|NODE?|null
|onMatchProps|MAP?|{}
| Name | Type | Default | Description
| startNode | NODE? | null | Start node of the merge pattern.
| relationshipType | STRING? | null | Relationship type of the merge pattern.
| identProps | MAP? | null | Properties on the relationships that are always merged.
| onCreateProps | MAP? | null | Properties that are merged when the relationship is created.
| endNode | NODE? | null | End node of the merge pattern.
| onMatchProps | MAP? | {} | Properties that are merged when the relationship is matched.
|===

== Output parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ apoc.merge.relationshipWithStats.eager - same as apoc.merge.relationship.eager p

[source]
----
apoc.merge.relationshipWithStats.eager(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, props :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (stats :: MAP?, rel :: RELATIONSHIP?)
apoc.merge.relationshipWithStats.eager(startNode :: NODE?, relationshipType :: STRING?, identProps :: MAP?, onCreateProps :: MAP?, endNode :: NODE?, onMatchProps = {} :: MAP?) :: (stats :: MAP?, rel :: RELATIONSHIP?)
----

== Input parameters
[.procedures, opts=header]
|===
| Name | Type | Default
|startNode|NODE?|null
|relationshipType|STRING?|null
|identProps|MAP?|null
|props|MAP?|null
|endNode|NODE?|null
|onMatchProps|MAP?|{}
| Name | Type | Default | Description
| startNode | NODE? | null | Start node of the merge pattern.
| relationshipType | STRING? | null | Relationship type of the merge pattern.
| identProps | MAP? | null | Properties on the relationships that are always merged.
| onCreateProps | MAP? | null | Properties that are merged when the relationship is created.
| endNode | NODE? | null | End node of the merge pattern.
| onMatchProps | MAP? | {} | Properties that are merged when the relationship is matched.
|===

== Output parameters
Expand Down
Loading

0 comments on commit ee355d1

Please sign in to comment.