Skip to content

Commit

Permalink
Docs: improve wording around transaction timeout (#1144)
Browse files Browse the repository at this point in the history
* Docs: improve wording around transaction timeout

Signed-off-by: Grant Lodge <6323995+thelonelyvulpes@users.noreply.github.com>

* Fix capitalization

Signed-off-by: Richard Irons <115992270+RichardIrons-neo4j@users.noreply.github.com>

---------

Signed-off-by: Grant Lodge <6323995+thelonelyvulpes@users.noreply.github.com>
Signed-off-by: Richard Irons <115992270+RichardIrons-neo4j@users.noreply.github.com>
  • Loading branch information
robsdedude authored Sep 28, 2023
1 parent 266671a commit 397c30e
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions packages/neo4j-driver/src/docs.js
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

0 comments on commit 397c30e

Please sign in to comment.