Skip to content

Commit 397c30e

Browse files
authored
Docs: improve wording around transaction timeout (#1144)
* Docs: improve wording around transaction timeout Signed-off-by: Grant Lodge <[email protected]> * Fix capitalization Signed-off-by: Richard Irons <[email protected]> --------- Signed-off-by: Grant Lodge <[email protected]> Signed-off-by: Richard Irons <[email protected]>
1 parent 266671a commit 397c30e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

packages/neo4j-driver/src/docs.js

+6-6
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@
2929
* </ul>
3030
* @typedef {Object} TransactionConfig
3131
* @property {number} timeout - the transaction timeout in **milliseconds**. Transactions that execute longer than the
32-
* configured timeout will be terminated by the database. This functionality allows to limit query/transaction execution
33-
* time. The Specified timeout overrides the default timeout configured in the database using the
34-
* `db.transaction.timeout` setting (``dbms.transaction.timeout`` before Neo4j 5.0). Values higher than
35-
* `db.transaction.timeout` will be ignored and will fall back to the default for server versions 4.2 to including 5.2.
36-
* The value should not represent a negative duration. A timeout of `0` will make the transaction execute indefinitely.
37-
* `null` (default) will use the default timeout configured on the server.
32+
* configured timeout will be terminated by the database. This functionality allows user code to limit
33+
* query/transaction execution time. The specified timeout overrides the default timeout configured in the database
34+
* using the `db.transaction.timeout` setting (``dbms.transaction.timeout`` before Neo4j 5.0). Values higher than
35+
* `db.transaction.timeout` will be ignored and will fall back to the default for server versions between 4.2 and 5.2
36+
* (inclusive). The value should not represent a negative duration. A timeout of `0` will make the transaction execute
37+
* indefinitely. `null` (default) will use the default timeout configured on the server.
3838
* @property {Object} metadata - the transaction metadata. Specified metadata will be attached to the executing transaction and visible in the output
3939
* of `SHOW TRANSACTIONS YIELD *`. It will also get logged to the `query.log` file. This functionality makes it easier to tag transactions and is
4040
* equivalent to the `dbms.setTXMetaData` procedure, see https://neo4j.com/docs/cypher-manual/current/clauses/transaction-clauses/#query-listing-transactions

0 commit comments

Comments
 (0)