From 397c30e61133b814cb6978dd73827d27dfffa76d Mon Sep 17 00:00:00 2001 From: Robsdedude Date: Thu, 28 Sep 2023 10:44:36 +0200 Subject: [PATCH] Docs: improve wording around transaction timeout (#1144) * 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> --- packages/neo4j-driver/src/docs.js | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/neo4j-driver/src/docs.js b/packages/neo4j-driver/src/docs.js index 2d7c28c3d..6bcfadcc8 100644 --- a/packages/neo4j-driver/src/docs.js +++ b/packages/neo4j-driver/src/docs.js @@ -29,12 +29,12 @@ * * @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