Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add sample for timeout for one RPC (#707)
* docs: add sample for timeout for one RPC Adds a sample for setting a timeout for a single RPC. Fixes GoogleCloudPlatform/java-docs-samples#3805 * fix: fix import order * fix: format code with the correct formatter plugin * fix: delete test data after each test * fix: auto-throttle admin requests
- Loading branch information
Showing
2 changed files
with
92 additions
and
0 deletions.
There are no files selected for viewing
82 changes: 82 additions & 0 deletions
82
samples/snippets/src/main/java/com/example/spanner/StatementTimeoutExample.java
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
/* | ||
* Copyright 2020 Google Inc. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package com.example.spanner; | ||
|
||
import com.google.api.gax.grpc.GrpcCallContext; | ||
import com.google.api.gax.rpc.ApiCallContext; | ||
import com.google.cloud.spanner.DatabaseClient; | ||
import com.google.cloud.spanner.DatabaseId; | ||
import com.google.cloud.spanner.Spanner; | ||
import com.google.cloud.spanner.SpannerOptions; | ||
import com.google.cloud.spanner.SpannerOptions.CallContextConfigurator; | ||
import com.google.cloud.spanner.Statement; | ||
import com.google.cloud.spanner.TransactionContext; | ||
import com.google.cloud.spanner.TransactionRunner.TransactionCallable; | ||
import com.google.spanner.v1.SpannerGrpc; | ||
import io.grpc.CallOptions; | ||
import io.grpc.Context; | ||
import io.grpc.MethodDescriptor; | ||
import java.util.concurrent.TimeUnit; | ||
|
||
class StatementTimeoutExample { | ||
|
||
static void executeSqlWithTimeout() { | ||
// TODO(developer): Replace these variables before running the sample. | ||
String projectId = "my-project"; | ||
String instanceId = "my-instance"; | ||
String databaseId = "my-database"; | ||
|
||
try (Spanner spanner = | ||
SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) { | ||
DatabaseClient client = | ||
spanner.getDatabaseClient(DatabaseId.of(projectId, instanceId, databaseId)); | ||
executeSqlWithTimeout(client); | ||
} | ||
} | ||
|
||
static void executeSqlWithTimeout(DatabaseClient client) { | ||
CallContextConfigurator configurator = new CallContextConfigurator() { | ||
public <ReqT, RespT> ApiCallContext configure(ApiCallContext context, ReqT request, | ||
MethodDescriptor<ReqT, RespT> method) { | ||
// DML uses the ExecuteSql RPC. | ||
if (method == SpannerGrpc.getExecuteSqlMethod()) { | ||
return GrpcCallContext.createDefault() | ||
.withCallOptions(CallOptions.DEFAULT.withDeadlineAfter(60L, TimeUnit.SECONDS)); | ||
} | ||
// Return null to indicate that the default should be used for other methods. | ||
return null; | ||
} | ||
}; | ||
// Create a context that uses the custom call configuration. | ||
Context context = | ||
Context.current().withValue(SpannerOptions.CALL_CONTEXT_CONFIGURATOR_KEY, configurator); | ||
// Run the transaction in the custom context. | ||
context.run(new Runnable() { | ||
public void run() { | ||
client.readWriteTransaction().run(new TransactionCallable<long[]>() { | ||
public long[] run(TransactionContext transaction) throws Exception { | ||
String sql = "INSERT Singers (SingerId, FirstName, LastName)\n" | ||
+ "VALUES (20, 'George', 'Washington')"; | ||
long rowCount = transaction.executeUpdate(Statement.of(sql)); | ||
System.out.printf("%d record inserted.%n", rowCount); | ||
return null; | ||
} | ||
}); | ||
} | ||
}); | ||
} | ||
} |
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