Skip to content

Commit 2e09174

Browse files
authored
API docs: replace deprecated Cypher procedures (#850)
`dbms.listQueries` and `dbms.listTransactions` have been deprecated in favor of `SHOW TRANSACTIONS YIELD *`
1 parent e26111c commit 2e09174

File tree

3 files changed

+20
-10
lines changed

3 files changed

+20
-10
lines changed

neo4j/_async/work/session.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -416,9 +416,14 @@ async def begin_transaction(
416416
417417
:param metadata:
418418
a dictionary with metadata.
419-
Specified metadata will be attached to the executing transaction and visible in the output of ``dbms.listQueries`` and ``dbms.listTransactions`` procedures.
419+
Specified metadata will be attached to the executing transaction
420+
and visible in the output of ``SHOW TRANSACTIONS YIELD *``
420421
It will also get logged to the ``query.log``.
421-
This functionality makes it easier to tag transactions and is equivalent to ``dbms.setTXMetaData`` procedure, see https://neo4j.com/docs/operations-manual/current/reference/procedures/ for procedure reference.
422+
This functionality makes it easier to tag transactions and is
423+
equivalent to the ``dbms.setTXMetaData`` procedure, see
424+
https://neo4j.com/docs/cypher-manual/current/clauses/transaction-clauses/#query-listing-transactions
425+
and https://neo4j.com/docs/operations-manual/current/reference/procedures/
426+
for reference.
422427
423428
:param timeout:
424429
the transaction timeout in seconds.

neo4j/_sync/work/session.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -416,9 +416,14 @@ def begin_transaction(
416416
417417
:param metadata:
418418
a dictionary with metadata.
419-
Specified metadata will be attached to the executing transaction and visible in the output of ``dbms.listQueries`` and ``dbms.listTransactions`` procedures.
419+
Specified metadata will be attached to the executing transaction
420+
and visible in the output of ``SHOW TRANSACTIONS YIELD *``
420421
It will also get logged to the ``query.log``.
421-
This functionality makes it easier to tag transactions and is equivalent to ``dbms.setTXMetaData`` procedure, see https://neo4j.com/docs/operations-manual/current/reference/procedures/ for procedure reference.
422+
This functionality makes it easier to tag transactions and is
423+
equivalent to the ``dbms.setTXMetaData`` procedure, see
424+
https://neo4j.com/docs/cypher-manual/current/clauses/transaction-clauses/#query-listing-transactions
425+
and https://neo4j.com/docs/operations-manual/current/reference/procedures/
426+
for reference.
422427
423428
:param timeout:
424429
the transaction timeout in seconds.

neo4j/work/query.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,14 @@ def count_people_tx(tx):
6767
6868
:param metadata:
6969
a dictionary with metadata.
70-
Specified metadata will be attached to the executing transaction and
71-
visible in the output of ``dbms.listQueries`` and
72-
``dbms.listTransactions`` procedures.
70+
Specified metadata will be attached to the executing transaction
71+
and visible in the output of ``SHOW TRANSACTIONS YIELD *``
7372
It will also get logged to the ``query.log``.
7473
This functionality makes it easier to tag transactions and is
75-
equivalent to ``dbms.setTXMetaData`` procedure, see
76-
https://neo4j.com/docs/operations-manual/current/reference/procedures/
77-
for procedure reference.
74+
equivalent to the ``dbms.setTXMetaData`` procedure, see
75+
https://neo4j.com/docs/cypher-manual/current/clauses/transaction-clauses/#query-listing-transactions
76+
and https://neo4j.com/docs/operations-manual/current/reference/procedures/
77+
for reference.
7878
7979
:param timeout:
8080
the transaction timeout in seconds.

0 commit comments

Comments
 (0)