[xa1QAhHL] Update documentation to warn about unpredictable procedure…

…s in clusters (#3191)
neo4j-contrib · Oct 4, 2022 · 22448d3 · 22448d3
1 parent 10f5612
commit 22448d3
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 0 deletions.
diff --git a/...ciidoc/modules/ROOT/pages/overview/apoc.custom/apoc.custom.declareFunction.adoc b/...ciidoc/modules/ROOT/pages/overview/apoc.custom/apoc.custom.declareFunction.adoc
@@ -17,6 +17,11 @@ apoc.custom.declareFunction(signature, statement, forceSingle, description) - re
 apoc.custom.declareFunction(signature :: STRING?, statement :: STRING?, forceSingle = false :: BOOLEAN?, description =  :: STRING?) :: VOID
 ----
 
+[WARNING]
+====
+This procedure is not intended to be used in a cluster environment, and may act unpredictably.
+====
+
 == Input parameters
 [.procedures, opts=header]
 |===

diff --git a/...iidoc/modules/ROOT/pages/overview/apoc.custom/apoc.custom.declareProcedure.adoc b/...iidoc/modules/ROOT/pages/overview/apoc.custom/apoc.custom.declareProcedure.adoc
@@ -17,6 +17,11 @@ apoc.custom.declareProcedure(signature, statement, mode, description) - register
 apoc.custom.declareProcedure(signature :: STRING?, statement :: STRING?, mode = read :: STRING?, description =  :: STRING?) :: VOID
 ----
 
+[WARNING]
+====
+This procedure is not intended to be used in a cluster environment, and may act unpredictably.
+====
+
 == Input parameters
 [.procedures, opts=header]
 |===

diff --git a/...sciidoc/modules/ROOT/pages/overview/apoc.custom/apoc.custom.removeFunction.adoc b/...sciidoc/modules/ROOT/pages/overview/apoc.custom/apoc.custom.removeFunction.adoc
@@ -17,6 +17,11 @@ apoc.custom.removeFunction(name, type) - remove the targeted custom function
 apoc.custom.removeFunction(name :: STRING?) :: VOID
 ----
 
+[WARNING]
+====
+This procedure is not intended to be used in a cluster environment, and may act unpredictably.
+====
+
 == Input parameters
 [.procedures, opts=header]
 |===

diff --git a/...ciidoc/modules/ROOT/pages/overview/apoc.custom/apoc.custom.removeProcedure.adoc b/...ciidoc/modules/ROOT/pages/overview/apoc.custom/apoc.custom.removeProcedure.adoc
@@ -17,6 +17,11 @@ apoc.custom.removeProcedure(name) - remove the targeted custom procedure
 apoc.custom.removeProcedure(name :: STRING?) :: VOID
 ----
 
+[WARNING]
+====
+This procedure is not intended to be used in a cluster environment, and may act unpredictably.
+====
+
 == Input parameters
 [.procedures, opts=header]
 |===

diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.dv/apoc.dv.catalog.add.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.dv/apoc.dv.catalog.add.adoc
@@ -17,6 +17,11 @@ Add a virtualized resource configuration
 apoc.dv.catalog.add(name :: STRING?, config = {} :: MAP?) :: (name :: STRING?, type :: STRING?, url :: STRING?, desc :: STRING?, labels :: LIST? OF STRING?, query :: STRING?, params :: LIST? OF STRING?)
 ----
 
+[WARNING]
+====
+This procedure is not intended to be used in a cluster environment, and may act unpredictably.
+====
+
 == Input parameters
 [.procedures, opts=header]
 |===

diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.dv/apoc.dv.catalog.remove.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.dv/apoc.dv.catalog.remove.adoc
@@ -17,6 +17,11 @@ Remove a virtualized resource config by name
 apoc.dv.catalog.remove(name :: STRING?) :: (name :: STRING?, type :: STRING?, url :: STRING?, desc :: STRING?, labels :: LIST? OF STRING?, query :: STRING?, params :: LIST? OF STRING?)
 ----
 
+[WARNING]
+====
+This procedure is not intended to be used in a cluster environment, and may act unpredictably.
+====
+
 == Input parameters
 [.procedures, opts=header]
 |===

diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.uuid/apoc.uuid.install.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.uuid/apoc.uuid.install.adoc
@@ -18,6 +18,11 @@ for the provided `label` and `uuidProperty`, in case the UUID handler is already
 apoc.uuid.install(label :: STRING?, config = {} :: MAP?) :: (batchComputationResult :: MAP?, label :: STRING?, installed :: BOOLEAN?, properties :: MAP?)
 ----
 
+[WARNING]
+====
+This procedure is not intended to be used in a cluster environment, and may act unpredictably.
+====
+
 == Input parameters
 [.procedures, opts=header]
 |===

diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.uuid/apoc.uuid.remove.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.uuid/apoc.uuid.remove.adoc
@@ -17,6 +17,11 @@ CALL apoc.uuid.remove(label) yield label, installed, properties | remove previou
 apoc.uuid.remove(label :: STRING?) :: (label :: STRING?, installed :: BOOLEAN?, properties :: MAP?)
 ----
 
+[WARNING]
+====
+This procedure is not intended to be used in a cluster environment, and may act unpredictably.
+====
+
 == Input parameters
 [.procedures, opts=header]
 |===

diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.uuid/apoc.uuid.removeAll.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.uuid/apoc.uuid.removeAll.adoc
@@ -17,6 +17,11 @@ CALL apoc.uuid.removeAll() yield label, installed, properties | it removes all p
 apoc.uuid.removeAll() :: (label :: STRING?, installed :: BOOLEAN?, properties :: MAP?)
 ----
 
+[WARNING]
+====
+This procedure is not intended to be used in a cluster environment, and may act unpredictably.
+====
+
 == Output parameters
 [.procedures, opts=header]
 |===