Skip to content
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

Jump to bottom

Spanner: Added extra documentation to the DatabaseClient.singleUse methods #4721

Merged
merged 2 commits into from
Mar 26, 2019
Merged

Spanner: Added extra documentation to the DatabaseClient.singleUse methods #4721

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78ff5f2
added extra documentation to the singleUse methods #4212
olavloite Mar 22, 2019
2e98517
changed formatting manually and re-run mvn formatter
olavloite Mar 23, 2019
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
15 changes: 9 additions & 6 deletions ...d-clients/google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,9 @@ public interface DatabaseClient {

/**
* Returns a context in which a single read can be performed using {@link TimestampBound#strong()}
* concurrency.
* concurrency. This method will return a {@link ReadContext} that will not return the read
* timestamp that was used by Cloud Spanner. If you want to be able to access the read timestamp,
* you should use the method {@link #singleUseReadOnlyTransaction()}.
*
* <p>Example of single use.
*
Expand All @@ -100,17 +102,18 @@ public interface DatabaseClient {
ReadContext singleUse();

/**
* Returns a context in which a single read can be performed at the given timestamp bound.
* Returns a context in which a single read can be performed at the given timestamp bound. This
* method will return a {@link ReadContext} that will not return the read timestamp that was used
* by Cloud Spanner. If you want to be able to access the read timestamp, you should use the
* method {@link #singleUseReadOnlyTransaction()}.
*
* <p>Example of single use with timestamp bound.
*
* <pre>{@code
* long singerId = my_singer_id;
* String column = "FirstName";
* Struct row =
* dbClient
* .singleUse(TimestampBound.ofMaxStaleness(10, TimeUnit.SECONDS))
* .readRow("Singers", Key.of(singerId), Collections.singleton(column));
* Struct row = dbClient.singleUse(TimestampBound.ofMaxStaleness(10, TimeUnit.SECONDS))
* .readRow("Singers", Key.of(singerId), Collections.singleton(column));
* String firstName = row.getString(column);
* }</pre>
*
Expand Down