Skip to content

Commit 620d105

Browse files
olavloitekolea2
authored andcommitted
Spanner: Added extra documentation to the DatabaseClient.singleUse methods (#4721)
* added extra documentation to the singleUse methods #4212 * changed formatting manually and re-run mvn formatter
1 parent 249d163 commit 620d105

File tree

1 file changed

+9
-6
lines changed
  • google-cloud-clients/google-cloud-spanner/src/main/java/com/google/cloud/spanner

1 file changed

+9
-6
lines changed

google-cloud-clients/google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseClient.java

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,9 @@ public interface DatabaseClient {
8585

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

102104
/**
103-
* Returns a context in which a single read can be performed at the given timestamp bound.
105+
* Returns a context in which a single read can be performed at the given timestamp bound. This
106+
* method will return a {@link ReadContext} that will not return the read timestamp that was used
107+
* by Cloud Spanner. If you want to be able to access the read timestamp, you should use the
108+
* method {@link #singleUseReadOnlyTransaction()}.
104109
*
105110
* <p>Example of single use with timestamp bound.
106111
*
107112
* <pre>{@code
108113
* long singerId = my_singer_id;
109114
* String column = "FirstName";
110-
* Struct row =
111-
* dbClient
112-
* .singleUse(TimestampBound.ofMaxStaleness(10, TimeUnit.SECONDS))
113-
* .readRow("Singers", Key.of(singerId), Collections.singleton(column));
115+
* Struct row = dbClient.singleUse(TimestampBound.ofMaxStaleness(10, TimeUnit.SECONDS))
116+
* .readRow("Singers", Key.of(singerId), Collections.singleton(column));
114117
* String firstName = row.getString(column);
115118
* }</pre>
116119
*

0 commit comments

Comments
 (0)