Expose transaction timeout and metadata in the API #518
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lutovich
force-pushed
the
1.7-tx-meta-and-timeout
branch
2 times, most recently
from
dbc0e4c to
910aff1
Compare
zhenlineo
force-pushed
the
1.7-tx-meta-and-timeout
branch
from
ed68e6c to
7e0c16a
Compare
lutovich
force-pushed
the
1.7-tx-meta-and-timeout
branch
from
7e0c16a to
86d9d36
Compare
This is the first draft of the API to allow transaction timeout and/or
metadata be set for explicit and auto-commit transactions. Both
settings can be specified in a `TransactionConfig` object which can be
created like this:
```
TransactionConfig config = TransactionConfig.builder()
.withTimeout(Duration.ofSeconds(5))
.withMetadata(Collections.singletonMap("key", "value"))
.build();
```
Explicit transactions can take config like this:
```
Transaction tx = session.beginTransaction(config);
```
and auto-commit transactions accept it in various overloads of
`Session#run()` and `Session#runAsync()`:
```
session.run("CREATE ()", config);
session.runAsync("RETURN $x", Collections.singletonMap("x", 1) config);
```
Transaction functions accept config like this:
```
session.readTransaction(tx -> {...}, config);
session.writeTransactionAsync(tx -> {...}, config);
```
There also exists a possibility to specify default transaction
configuration per driver. It can be configured in the driver's config:
```
Config driverConfig = Config.build()
.withDefaultTransactionConfig(txConfig)
.toConfig();
```
More tests and javadocs will be added in subsequent commits.
It might be a nice thing to have but we are not yet sure about it. Should be easy to add later, if required.
lutovich
force-pushed
the
1.7-tx-meta-and-timeout
branch
from
c6282a1 to
b355c4b
Compare
zhenlineo
approved these changes
Aug 1, 2018
| { | ||
| if ( config != null && !config.isEmpty() ) | ||
| { | ||
| return txConfigNotSupported(); |
There was a problem hiding this comment.
This check is amazing! Finally, we do not need to check with server version anymore!
| */ | ||
| public class TransactionConfig | ||
| { | ||
| private static final TransactionConfig EMPTY = builder().build(); |
There was a problem hiding this comment.
Since we now have this builder style, shall we also give Driver config a builder style?
So we deprecate the old method and then provides a new builder API. WDYT?
There was a problem hiding this comment.
I would prefer to just change it in the next major release, tbh
| otherTx.run( "MATCH (n:Node) SET n.prop = 1" ).consume(); | ||
|
|
||
| TransactionConfig config = TransactionConfig.builder() | ||
| .withTimeout( ofSeconds( 1 ) ) |
There was a problem hiding this comment.
does it need 1s? Can we give it 1ms to speed up this test? This 1s might slow down my fancy new compute to run tests. (The minimal legal value server accept is 1ms)
Similar for the async one.
There was a problem hiding this comment.
Fixed to keep your computer cool
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the first draft of the API to allow transaction timeout and/or metadata be set for explicit and auto-commit transactions. Both settings can be specified in a
TransactionConfigobject which can be created like this:Explicit transactions can take config like this:
and auto-commit transactions accept it in various overloads of
Session#run()andSession#runAsync():Transaction functions accept config like this: