Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API docs: replace deprecated Cypher procedures #850

Merged
merged 1 commit into from
Nov 4, 2022
Merged

API docs: replace deprecated Cypher procedures #850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions neo4j/_async/work/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,9 +416,14 @@ async def begin_transaction(

:param metadata:
a dictionary with metadata.
Specified metadata will be attached to the executing transaction and visible in the output of ``dbms.listQueries`` and ``dbms.listTransactions`` procedures.
Specified metadata will be attached to the executing transaction
and visible in the output of ``SHOW TRANSACTIONS YIELD *``
It will also get logged to the ``query.log``.
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.
This functionality makes it easier to tag transactions and is
equivalent to the ``dbms.setTXMetaData`` procedure, see
https://neo4j.com/docs/cypher-manual/current/clauses/transaction-clauses/#query-listing-transactions
and https://neo4j.com/docs/operations-manual/current/reference/procedures/
for reference.

:param timeout:
the transaction timeout in seconds.
Expand Down
9 changes: 7 additions & 2 deletions neo4j/_sync/work/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,9 +416,14 @@ def begin_transaction(

:param metadata:
a dictionary with metadata.
Specified metadata will be attached to the executing transaction and visible in the output of ``dbms.listQueries`` and ``dbms.listTransactions`` procedures.
Specified metadata will be attached to the executing transaction
and visible in the output of ``SHOW TRANSACTIONS YIELD *``
It will also get logged to the ``query.log``.
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.
This functionality makes it easier to tag transactions and is
equivalent to the ``dbms.setTXMetaData`` procedure, see
https://neo4j.com/docs/cypher-manual/current/clauses/transaction-clauses/#query-listing-transactions
and https://neo4j.com/docs/operations-manual/current/reference/procedures/
for reference.

:param timeout:
the transaction timeout in seconds.
Expand Down
12 changes: 6 additions & 6 deletions neo4j/work/query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,14 @@ def count_people_tx(tx):

:param metadata:
a dictionary with metadata.
Specified metadata will be attached to the executing transaction and
visible in the output of ``dbms.listQueries`` and
``dbms.listTransactions`` procedures.
Specified metadata will be attached to the executing transaction
and visible in the output of ``SHOW TRANSACTIONS YIELD *``
It will also get logged to the ``query.log``.
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.
equivalent to the ``dbms.setTXMetaData`` procedure, see
https://neo4j.com/docs/cypher-manual/current/clauses/transaction-clauses/#query-listing-transactions
and https://neo4j.com/docs/operations-manual/current/reference/procedures/
for reference.

:param timeout:
the transaction timeout in seconds.
Expand Down