Skip to content

Docs: improve wording around transaction timeout #1144

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

Merged
merged 2 commits into from
Sep 28, 2023
Merged

Docs: improve wording around transaction timeout #1144

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df73e6a
Docs: improve wording around transaction timeout
robsdedude Sep 27, 2023
2ad956b
Fix capitalization
robsdedude Sep 27, 2023
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
12 changes: 6 additions & 6 deletions packages/neo4j-driver/src/docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@
* </ul>
* @typedef {Object} TransactionConfig
* @property {number} timeout - the transaction timeout in **milliseconds**. Transactions that execute longer than the
* configured timeout will be terminated by the database. This functionality allows to limit query/transaction execution
* time. The Specified timeout overrides the default timeout configured in the database using the
* `db.transaction.timeout` setting (``dbms.transaction.timeout`` before Neo4j 5.0). Values higher than
* `db.transaction.timeout` will be ignored and will fall back to the default for server versions 4.2 to including 5.2.
* The value should not represent a negative duration. A timeout of `0` will make the transaction execute indefinitely.
* `null` (default) will use the default timeout configured on the server.
* configured timeout will be terminated by the database. This functionality allows user code to limit
* query/transaction execution time. The specified timeout overrides the default timeout configured in the database
* using the `db.transaction.timeout` setting (``dbms.transaction.timeout`` before Neo4j 5.0). Values higher than
* `db.transaction.timeout` will be ignored and will fall back to the default for server versions between 4.2 and 5.2
* (inclusive). The value should not represent a negative duration. A timeout of `0` will make the transaction execute
* indefinitely. `null` (default) will use the default timeout configured on the server.
* @property {Object} metadata - the transaction metadata. 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` file. 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
Expand Down