diff --git a/core/src/main/java/apoc/trigger/Trigger.java b/core/src/main/java/apoc/trigger/Trigger.java index e06bda417f..59bbdefc09 100644 --- a/core/src/main/java/apoc/trigger/Trigger.java +++ b/core/src/main/java/apoc/trigger/Trigger.java @@ -105,7 +105,7 @@ public TriggerInfo toTriggerInfo(Map.Entry e) { @Admin @Procedure(mode = Mode.READ) - @Description("CALL apoc.trigger.list() | list all currently working triggers for all databases for the session database") + @Description("CALL apoc.trigger.list() | it lists all currently installed triggers for the session database") public Stream list() { return triggerHandler.list().entrySet().stream() .map( (e) -> new TriggerInfo(e.getKey(), diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.csv b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.csv index 1daf04d746..57a540749c 100644 --- a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.csv +++ b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.csv @@ -6,7 +6,7 @@ add a trigger kernelTransaction under a name, in the kernelTransaction you can u |label:apoc-core[] |xref::overview/apoc.trigger/apoc.trigger.adoc[apoc.trigger.list icon:book[]] -CALL apoc.trigger.list() | list all currently working triggers for all databases for the session database +CALL apoc.trigger.list() | it lists all currently installed triggers for the session database |label:procedure[] |label:apoc-core[] |xref::overview/apoc.trigger/apoc.trigger.adoc[apoc.trigger.pause icon:book[]] diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.dropAll.adoc b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.dropAll.adoc index 80df668c8e..a29178d1ee 100644 --- a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.dropAll.adoc +++ b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.dropAll.adoc @@ -1,5 +1,5 @@ ¦xref::overview/apoc.trigger/apoc.trigger.dropAll.adoc[apoc.trigger.dropAll icon:book[]] + -`CALL apoc.trigger.dropAll(databaseName) | eventually removes all previously added trigger, returns triggers' information +`CALL apoc.trigger.dropAll(databaseName) | eventually removes all previously added trigger, returns triggers' information` ¦label:procedure[] ¦label:apoc-core[] diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.list.adoc b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.list.adoc index 8109450877..a0bd25108e 100644 --- a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.list.adoc +++ b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.list.adoc @@ -1,5 +1,5 @@ ¦xref::overview/apoc.trigger/apoc.trigger.list.adoc[apoc.trigger.list icon:book[]] + -`CALL apoc.trigger.list() | list all currently working triggers for all databases for the session database` +`CALL apoc.trigger.list() | it lists all currently installed triggers for the session database` ¦label:procedure[] ¦label:apoc-core[] diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.list.csv b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.list.csv index afdf038cee..66e1261423 100644 --- a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.list.csv +++ b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.trigger.list.csv @@ -1,2 +1,2 @@ ¦type¦qualified name¦signature¦description -¦procedure¦apoc.trigger.list¦apoc.trigger.list() :: (name :: STRING?, query :: STRING?, selector :: MAP?, params :: MAP?, installed :: BOOLEAN?, paused :: BOOLEAN?)¦CALL apoc.trigger.list() | list all currently working triggers for all databases for the session database +¦procedure¦apoc.trigger.list¦apoc.trigger.list() :: (name :: STRING?, query :: STRING?, selector :: MAP?, params :: MAP?, installed :: BOOLEAN?, paused :: BOOLEAN?)¦CALL apoc.trigger.list() | it lists all currently installed triggers for the session database diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/documentation.csv b/docs/asciidoc/modules/ROOT/examples/generated-documentation/documentation.csv index 0c306dfe97..9461e9e874 100644 --- a/docs/asciidoc/modules/ROOT/examples/generated-documentation/documentation.csv +++ b/docs/asciidoc/modules/ROOT/examples/generated-documentation/documentation.csv @@ -289,7 +289,7 @@ ¦procedure¦apoc.trigger.drop¦apoc.trigger.drop(databaseName :: STRING?, name :: STRING?) :: (name :: STRING?, query :: STRING?, selector :: MAP?, params :: MAP?, installed :: BOOLEAN?, paused :: BOOLEAN?)¦CALL apoc.trigger.drop(databaseName, name) | eventually removes an existing trigger, returns the trigger's information¦true¦xref::background-operations/triggers.adoc ¦procedure¦apoc.trigger.dropAll¦apoc.trigger.dropAll(databaseName :: STRING?) :: (name :: STRING?, query :: STRING?, selector :: MAP?, params :: MAP?, installed :: BOOLEAN?, paused :: BOOLEAN?)¦CALL apoc.trigger.dropAll(databaseName) | eventually removes all previously added trigger, returns triggers' information¦true¦xref::background-operations/triggers.adoc ¦procedure¦apoc.trigger.install¦apoc.trigger.install(databaseName :: STRING?, name :: STRING?, statement :: STRING?, selector :: MAP?, config = {} :: MAP?) :: (name :: STRING?, query :: STRING?, selector :: MAP?, params :: MAP?, installed :: BOOLEAN?, paused :: BOOLEAN?)¦CALL apoc.trigger.install(databaseName, name, statement, selector, config) | eventually adds a trigger for a given database which is invoked when a successful transaction occurs.¦true¦xref::background-operations/triggers.adoc -¦procedure¦apoc.trigger.list¦apoc.trigger.list() :: (name :: STRING?, query :: STRING?, selector :: MAP?, params :: MAP?, installed :: BOOLEAN?, paused :: BOOLEAN?)¦CALL apoc.trigger.list() | list all currently working triggers for all databases for the session database¦true¦xref::background-operations/triggers.adoc +¦procedure¦apoc.trigger.list¦apoc.trigger.list() :: (name :: STRING?, query :: STRING?, selector :: MAP?, params :: MAP?, installed :: BOOLEAN?, paused :: BOOLEAN?)¦CALL apoc.trigger.list() | it lists all currently installed triggers for the session database¦true¦xref::background-operations/triggers.adoc ¦procedure¦apoc.trigger.pause¦apoc.trigger.pause(name :: STRING?) :: (name :: STRING?, query :: STRING?, selector :: MAP?, params :: MAP?, installed :: BOOLEAN?, paused :: BOOLEAN?)¦CALL apoc.trigger.pause(name) | it pauses the trigger¦true¦xref::background-operations/triggers.adoc ¦procedure¦apoc.trigger.remove¦apoc.trigger.remove(name :: STRING?) :: (name :: STRING?, query :: STRING?, selector :: MAP?, params :: MAP?, installed :: BOOLEAN?, paused :: BOOLEAN?)¦remove previously added trigger, returns trigger information¦true¦xref::background-operations/triggers.adoc ¦procedure¦apoc.trigger.removeAll¦apoc.trigger.removeAll() :: (name :: STRING?, query :: STRING?, selector :: MAP?, params :: MAP?, installed :: BOOLEAN?, paused :: BOOLEAN?)¦removes all previously added trigger, returns trigger information¦true¦xref::background-operations/triggers.adoc diff --git a/docs/asciidoc/modules/ROOT/pages/background-operations/triggers.adoc b/docs/asciidoc/modules/ROOT/pages/background-operations/triggers.adoc index c0aa6026d2..5124fa7c43 100644 --- a/docs/asciidoc/modules/ROOT/pages/background-operations/triggers.adoc +++ b/docs/asciidoc/modules/ROOT/pages/background-operations/triggers.adoc @@ -10,6 +10,7 @@ You can run them before or after commit. ==== All these `apoc.trigger.*` procedures are intended to be executed in the system database, therefore they have to be used executed by opening a system database session. There are several ways of doing this: + - when using cypher-shell or Neo4j Browser, one can prefix their Cypher query with `:use system` - when using fabric, one can prefix their Cypher query with `USE system` - when using the drivers, one can open a session directly against the system database @@ -39,9 +40,10 @@ include::partial$triggers/triggersConfig.adoc[] include::example$generated-documentation/apoc.trigger.install.adoc[] include::example$generated-documentation/apoc.trigger.drop.adoc[] include::example$generated-documentation/apoc.trigger.dropAll.adoc[] -include::example$generated-documentation/apoc.trigger.show.adoc[] include::example$generated-documentation/apoc.trigger.stop.adoc[] include::example$generated-documentation/apoc.trigger.start.adoc[] +include::example$generated-documentation/apoc.trigger.show.adoc[] +include::example$generated-documentation/apoc.trigger.list.adoc[] |=== diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.trigger/apoc.trigger.list.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.trigger/apoc.trigger.list.adoc index 50bf03db43..558a0bb826 100644 --- a/docs/asciidoc/modules/ROOT/pages/overview/apoc.trigger/apoc.trigger.list.adoc +++ b/docs/asciidoc/modules/ROOT/pages/overview/apoc.trigger/apoc.trigger.list.adoc @@ -8,7 +8,7 @@ This file is generated by DocsTest, so don't change it! label:procedure[] label:apoc-core[] [.emphasis] -CALL apoc.trigger.list() | list all currently working triggers for all databases for the session database +CALL apoc.trigger.list() | it lists all currently installed triggers for the session database [WARNING] ==== diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.trigger/index.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.trigger/index.adoc index 905715ffe7..c33f2ff5db 100644 --- a/docs/asciidoc/modules/ROOT/pages/overview/apoc.trigger/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/overview/apoc.trigger/index.adoc @@ -5,104 +5,124 @@ This file is generated by DocsTest, so don't change it! = apoc.trigger :description: This section contains reference documentation for the apoc.trigger procedures. -== APOC new procedures +== Current procedures + [.new procedures, opts=header, cols='5a,1a,1a'] |=== | Qualified Name | Type | Release + +|xref::overview/apoc.trigger/apoc.trigger.install.adoc[apoc.trigger.install icon:book[]] + +CALL apoc.trigger.install(databaseName, name, statement, selector, config) \| eventually adds a trigger for a given database which is invoked when a successful transaction occurs. +|label:procedure[] +|label:apoc-core[] + + |xref::overview/apoc.trigger/apoc.trigger.drop.adoc[apoc.trigger.drop icon:book[]] CALL apoc.trigger.drop(databaseName, name) \| eventually removes an existing trigger, returns the trigger's information |label:procedure[] |label:apoc-core[] + + |xref::overview/apoc.trigger/apoc.trigger.dropAll.adoc[apoc.trigger.dropAll icon:book[]] CALL apoc.trigger.dropAll(databaseName) \| eventually removes all previously added trigger, returns triggers' information |label:procedure[] |label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.install.adoc[apoc.trigger.install icon:book[]] -CALL apoc.trigger.install(databaseName, name, statement, selector, config) \| eventually adds a trigger for a given database which is invoked when a successful transaction occurs. + +|xref::overview/apoc.trigger/apoc.trigger.start.adoc[apoc.trigger.start icon:book[]] + +CALL apoc.trigger.start(databaseName, name) \| eventually unpauses the paused trigger |label:procedure[] |label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.pause.adoc[apoc.trigger.pause icon:book[]] -CALL apoc.trigger.pause(name) \| it pauses the trigger +|xref::overview/apoc.trigger/apoc.trigger.stop.adoc[apoc.trigger.stop icon:book[]] + +CALL apoc.trigger.stop(databaseName, name) \| eventually pauses the trigger |label:procedure[] |label:apoc-core[] + |xref::overview/apoc.trigger/apoc.trigger.show.adoc[apoc.trigger.show icon:book[]] CALL apoc.trigger.show(databaseName) \| it lists all eventually installed triggers for a database |label:procedure[] |label:apoc-core[] + + +|xref::overview/apoc.trigger/apoc.trigger.list.adoc[apoc.trigger.list icon:book[]] + +CALL apoc.trigger.list() \| it lists all currently installed triggers for the session database +|label:procedure[] +|label:apoc-core[] + |=== -== APOC deprecated procedures +== Deprecated procedures [.deprecated procedures, opts=header, cols='5a,1a,1a'] |=== | Qualified Name | Type | Release + + |xref::overview/apoc.trigger/apoc.trigger.add.adoc[apoc.trigger.add icon:book[]] add a trigger kernelTransaction under a name, in the kernelTransaction you can use \{createdNodes}, \{deletedNodes} etc., the selector is {phase:'before/after/rollback/afterAsync'} returns previous and new trigger information. Takes in an optional configuration. |label:procedure[] |label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.list.adoc[apoc.trigger.list icon:book[]] -CALL apoc.trigger.list() | list all currently working triggers for all databases for the session database -|label:procedure[] -|label:apoc-core[] |xref::overview/apoc.trigger/apoc.trigger.remove.adoc[apoc.trigger.remove icon:book[]] remove previously added trigger, returns trigger information |label:procedure[] |label:apoc-core[] + + |xref::overview/apoc.trigger/apoc.trigger.removeAll.adoc[apoc.trigger.removeAll icon:book[]] removes all previously added trigger, returns trigger information |label:procedure[] |label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.resume.adoc[apoc.trigger.resume icon:book[]] -CALL apoc.trigger.resume(name) \| it resumes the paused trigger -|label:procedure[] -|label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.start.adoc[apoc.trigger.start icon:book[]] -CALL apoc.trigger.start(databaseName, name) \| eventually unpauses the paused trigger +|xref::overview/apoc.trigger/apoc.trigger.pause.adoc[apoc.trigger.pause icon:book[]] + +CALL apoc.trigger.pause(name) \| it pauses the trigger |label:procedure[] |label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.stop.adoc[apoc.trigger.stop icon:book[]] -CALL apoc.trigger.stop(databaseName, name) \| eventually pauses the trigger + +|xref::overview/apoc.trigger/apoc.trigger.resume.adoc[apoc.trigger.resume icon:book[]] + +CALL apoc.trigger.resume(name) \| it resumes the paused trigger |label:procedure[] |label:apoc-core[] + |=== -== APOC Full functions +== Full functions [.full, opts=header, cols='5a,1a,1a'] |=== + |xref::overview/apoc.trigger/apoc.trigger.nodesByLabel.adoc[apoc.trigger.nodesByLabel icon:book[]] |label:function[] |label:apoc-full[] |xref::overview/apoc.trigger/apoc.trigger.propertiesByKey.adoc[apoc.trigger.propertiesByKey icon:book[]] - - |label:function[] |label:apoc-full[] -|xref::overview/apoc.trigger/apoc.trigger.toNode.adoc[apoc.trigger.toNode icon:book[]] - +|xref::overview/apoc.trigger/apoc.trigger.toNode.adoc[apoc.trigger.toNode icon:book[]] |label:function[] |label:apoc-full[] -|xref::overview/apoc.trigger/apoc.trigger.toRelationship.adoc[apoc.trigger.toRelationship icon:book[]] - +|xref::overview/apoc.trigger/apoc.trigger.toRelationship.adoc[apoc.trigger.toRelationship icon:book[]] |label:function[] |label:apoc-full[] |=== diff --git a/docs/asciidoc/modules/ROOT/partials/generated-documentation/documentation.adoc b/docs/asciidoc/modules/ROOT/partials/generated-documentation/documentation.adoc index 7eecd53906..d8ddd6fa8b 100644 --- a/docs/asciidoc/modules/ROOT/partials/generated-documentation/documentation.adoc +++ b/docs/asciidoc/modules/ROOT/partials/generated-documentation/documentation.adoc @@ -3365,76 +3365,107 @@ apoc.text.urlencode(text) - return the urlencoded text [.procedures, opts=header, cols='5a,1a,1a'] |=== | Qualified Name | Type | Release -|xref::overview/apoc.trigger/apoc.trigger.add.adoc[apoc.trigger.add icon:book[]] -add a trigger kernelTransaction under a name, in the kernelTransaction you can use \{createdNodes}, \{deletedNodes} etc., the selector is {phase:'before/after/rollback/afterAsync'} returns previous and new trigger information. Takes in an optional configuration. +|xref::overview/apoc.trigger/apoc.trigger.install.adoc[apoc.trigger.install icon:book[]] + +CALL apoc.trigger.install(databaseName, name, statement, selector, config) \| eventually adds a trigger for a given database which is invoked when a successful transaction occurs. |label:procedure[] |label:apoc-core[] + |xref::overview/apoc.trigger/apoc.trigger.drop.adoc[apoc.trigger.drop icon:book[]] CALL apoc.trigger.drop(databaseName, name) \| eventually removes an existing trigger, returns the trigger's information |label:procedure[] |label:apoc-core[] + |xref::overview/apoc.trigger/apoc.trigger.dropAll.adoc[apoc.trigger.dropAll icon:book[]] CALL apoc.trigger.dropAll(databaseName) \| eventually removes all previously added trigger, returns triggers' information |label:procedure[] |label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.install.adoc[apoc.trigger.install icon:book[]] -CALL apoc.trigger.install(databaseName, name, statement, selector, config) \| eventually adds a trigger for a given database which is invoked when a successful transaction occurs. +|xref::overview/apoc.trigger/apoc.trigger.start.adoc[apoc.trigger.start icon:book[]] + +CALL apoc.trigger.start(databaseName, name) \| eventually unpauses the paused trigger +|label:procedure[] +|label:apoc-core[] + +|xref::overview/apoc.trigger/apoc.trigger.stop.adoc[apoc.trigger.stop icon:book[]] + +CALL apoc.trigger.stop(databaseName, name) \| eventually pauses the trigger |label:procedure[] |label:apoc-core[] + +|xref::overview/apoc.trigger/apoc.trigger.show.adoc[apoc.trigger.show icon:book[]] + +CALL apoc.trigger.show(databaseName) \| it lists all eventually installed triggers for a database +|label:procedure[] +|label:apoc-core[] + |xref::overview/apoc.trigger/apoc.trigger.list.adoc[apoc.trigger.list icon:book[]] -CALL apoc.trigger.list() | list all currently working triggers for all databases for the session database +CALL apoc.trigger.list() \| it lists all currently installed triggers for the session database |label:procedure[] |label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.pause.adoc[apoc.trigger.pause icon:book[]] -CALL apoc.trigger.pause(name) \| it pauses the trigger +|xref::overview/apoc.trigger/apoc.trigger.nodesByLabel.adoc[apoc.trigger.nodesByLabel icon:book[]] + +|label:function[] +|label:apoc-full[] + +|xref::overview/apoc.trigger/apoc.trigger.propertiesByKey.adoc[apoc.trigger.propertiesByKey icon:book[]] + +|label:function[] +|label:apoc-full[] + +|xref::overview/apoc.trigger/apoc.trigger.toNode.adoc[apoc.trigger.toNode icon:book[]] + +|label:function[] +|label:apoc-full[] + +|xref::overview/apoc.trigger/apoc.trigger.toRelationship.adoc[apoc.trigger.toRelationship icon:book[]] + +|label:function[] +|label:apoc-full[] + +|=== + +**Deprecated Procedures** + +[.procedures, opts=header, cols='5a,1a,1a'] +|=== +| Qualified Name | Type | Release + +|xref::overview/apoc.trigger/apoc.trigger.add.adoc[apoc.trigger.add icon:book[]] + +add a trigger kernelTransaction under a name, in the kernelTransaction you can use \{createdNodes}, \{deletedNodes} etc., the selector is {phase:'before/after/rollback/afterAsync'} returns previous and new trigger information. Takes in an optional configuration. |label:procedure[] |label:apoc-core[] + |xref::overview/apoc.trigger/apoc.trigger.remove.adoc[apoc.trigger.remove icon:book[]] remove previously added trigger, returns trigger information |label:procedure[] |label:apoc-core[] + |xref::overview/apoc.trigger/apoc.trigger.removeAll.adoc[apoc.trigger.removeAll icon:book[]] removes all previously added trigger, returns trigger information |label:procedure[] |label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.resume.adoc[apoc.trigger.resume icon:book[]] -CALL apoc.trigger.resume(name) \| it resumes the paused trigger -|label:procedure[] -|label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.show.adoc[apoc.trigger.show icon:book[]] +|xref::overview/apoc.trigger/apoc.trigger.pause.adoc[apoc.trigger.pause icon:book[]] -CALL apoc.trigger.show(databaseName) \| it lists all eventually installed triggers for a database +CALL apoc.trigger.pause(name) \| it pauses the trigger |label:procedure[] |label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.start.adoc[apoc.trigger.start icon:book[]] -CALL apoc.trigger.start(databaseName, name) \| eventually unpauses the paused trigger -|label:procedure[] -|label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.stop.adoc[apoc.trigger.stop icon:book[]] +|xref::overview/apoc.trigger/apoc.trigger.resume.adoc[apoc.trigger.resume icon:book[]] -CALL apoc.trigger.stop(databaseName, name) \| eventually pauses the trigger +CALL apoc.trigger.resume(name) \| it resumes the paused trigger |label:procedure[] |label:apoc-core[] -|xref::overview/apoc.trigger/apoc.trigger.nodesByLabel.adoc[apoc.trigger.nodesByLabel icon:book[]] - - -|label:function[] -|label:apoc-full[] -|xref::overview/apoc.trigger/apoc.trigger.propertiesByKey.adoc[apoc.trigger.propertiesByKey icon:book[]] - -|label:function[] -|label:apoc-full[] |=== == xref::overview/apoc.ttl/index.adoc[]