Skip to content

Commit 4086c1f

Browse files
JPryce-Aklundhrenetapopova
authored andcommitted
prototype
1 parent f07e88b commit 4086c1f

File tree

1 file changed

+91
-0
lines changed

1 file changed

+91
-0
lines changed

modules/ROOT/pages/reference/procedures.adoc

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,97 @@ These procedures are labeled with label:admin-only[].
3232
For more information, see xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-execute[the `EXECUTE` privileges section].
3333
====
3434

35+
[role=label--new-5.14 label--beta label--deprecated]
36+
[[cdc_current]]
37+
== cdc.current()
38+
39+
.Details
40+
|===
41+
| *Name* 3+| `cdc.current`
42+
| *Syntax* 3+| `cdc.current() :: (id)`
43+
| *Description* 3+| Returns the current change identifier that can be used to stream changes from.
44+
.2+| *Return arguments* | *Name* | *Type* | *Description*
45+
| `id` | `STRING` | The change identifier.
46+
| *Mode* 3+| READ
47+
|===
48+
49+
Replaced by: xref:reference/procedures.adoc#db_cdc_current[`db.cdc.current()`]
50+
For more information, see the link:{neo4j-docs-base-uri}/cdc/{page-version}/[CDC documentation].
51+
52+
[role=label--new-5.13 label--beta label--deprecated]
53+
[[cdc_earliest]]
54+
== cdc.earliest()
55+
56+
.Details
57+
|===
58+
| *Name* 3+| `cdc.earliest`
59+
| *Syntax* 3+| `cdc.earliest() :: (id)`
60+
| *Description* 3+| Returns the earliest change identifier that can be used to stream changes from.
61+
.2+| *Return arguments* | *Name* | *Type* | *Description*
62+
| `id` | `STRING` | The change identifier.
63+
| *Mode* 3+| READ
64+
|===
65+
66+
Replaced by: xref:reference/procedures.adoc#db_cdc_earliest[`db.cdc.earliest()`].
67+
For more information, see the link:{neo4j-docs-base-uri}/cdc/{page-version}/[CDC documentation].
68+
69+
[role=label--new-5.13 label--beta label--deprecated]
70+
[[cdc_query]]
71+
== cdc.query()
72+
73+
.Details
74+
|===
75+
| *Name* 3+| `cdc.query`
76+
| *Syntax* 3+| `cdc.query([ from selectors ]) :: (id, txId, seq, metadata, event)`
77+
| *Description* 3+| Query changes happened from the provided change identifier.
78+
.3+| *Input arguments* | *Name* | *Type* | *Description*
79+
| `from` | `STRING` | The change identifier to query changes from.
80+
| `selectors` | `LIST<MAP>` | An optional list of selectors to filter out changes.
81+
.6+| *Return arguments* | *Name* | *Type* | *Description*
82+
| `id` | `STRING` | The change identifier for this change event. Used to continue querying from this change event.
83+
| `txId` | `INTEGER` | A number identifying which transaction the change happened in, unique in combination with seq.
84+
| `seq` | `INTEGER` | A number used for ordering changes that happened in the same transaction.
85+
| `metadata` | `MAP` | Metadata from the transaction that caused this change event.
86+
| `event` | `MAP` | The retrieved changes on the affected entity.
87+
| *Mode* 3+| READ
88+
|===
89+
90+
Replaced by: xref:reference/procedures.adoc#db_cdc_query[`db.cdc.query()`].
91+
For more information, see the link:{neo4j-docs-base-uri}/cdc/{page-version}/[CDC documentation].
92+
93+
[[db_awaitindex]]
94+
== db.awaitIndex()
95+
96+
.Details
97+
|===
98+
| *Name* 3+| `db.awaitIndex`
99+
| *Syntax* 3+| `db.awaitIndex(indexName [, timeOutSeconds ])`
100+
| *Description* 3+| Wait for an index to come online (for example: CALL db.awaitIndex("MyIndex", 300)).
101+
.3+| *Input arguments* | *Name* | *Type* | *Description*
102+
| `indexName` | `STRING` | The name of the awaited index.
103+
| `timeOutSeconds` | `INTEGER` | The maximum time to wait.
104+
| *Mode* 3+| READ
105+
|===
106+
107+
[[db_awaitIndexes]]
108+
== db.awaitIndexes()
109+
110+
.Details
111+
|===
112+
| *Name* 3+| `db.awaitIndexes`
113+
| *Syntax* 3+| `db.awaitIndexes([ timeOutSeconds ])`
114+
| *Description* 3+| Wait for all indexes to come online (for example: CALL db.awaitIndexes(300)).
115+
.2+| *Input arguments* | *Name* | *Type* | *Description*
116+
| `timeOutSeconds` | `INTEGER` | The maximum time to wait.
117+
| *Mode* 3+| READ
118+
|===
119+
120+
121+
122+
123+
124+
125+
35126
== List of procedures
36127

37128
.Neo4j procedures

0 commit comments

Comments
 (0)