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

feat: add new types ExplainOptions, ExplainMetrics, PlanSummary, ExecutionStats #1608

Merged
merged 3 commits into from
Mar 13, 2024
Merged

feat: add new types ExplainOptions, ExplainMetrics, PlanSummary, ExecutionStats #1608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9008dc6
feat: add new types ExplainOptions, ExplainMetrics, PlanSummary, Exec…
gcf-owl-bot[bot] Mar 12, 2024
32b5b63
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 12, 2024
900a4a7
Satisfy CLIRR
tom-andersen Mar 13, 2024
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
11 changes: 9 additions & 2 deletions google-cloud-firestore/src/main/java/com/google/cloud/firestore/v1/FirestoreClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1107,7 +1107,11 @@ public final UnaryCallable<RollbackRequest, Empty> rollbackCallable() {
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
* RunQueryRequest request = RunQueryRequest.newBuilder().setParent("parent-995424086").build();
* RunQueryRequest request =
* RunQueryRequest.newBuilder()
* .setParent("parent-995424086")
* .setExplainOptions(ExplainOptions.newBuilder().build())
* .build();
* ServerStream<RunQueryResponse> stream = firestoreClient.runQueryCallable().call(request);
* for (RunQueryResponse response : stream) {
* // Do something when a response is received.
Expand Down Expand Up @@ -1143,7 +1147,10 @@ public final ServerStreamingCallable<RunQueryRequest, RunQueryResponse> runQuery
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
* RunAggregationQueryRequest request =
* RunAggregationQueryRequest.newBuilder().setParent("parent-995424086").build();
* RunAggregationQueryRequest.newBuilder()
* .setParent("parent-995424086")
* .setExplainOptions(ExplainOptions.newBuilder().build())
* .build();
* ServerStream<RunAggregationQueryResponse> stream =
* firestoreClient.runAggregationQueryCallable().call(request);
* for (RunAggregationQueryResponse response : stream) {
Expand Down
72 changes: 72 additions & 0 deletions ...rc/main/resources/META-INF/native-image/com.google.cloud.firestore.v1/reflect-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -854,6 +854,24 @@
"allDeclaredClasses": true,
"allPublicClasses": true
},
{
"name": "com.google.firestore.v1.ExecutionStats",
"queryAllDeclaredConstructors": true,
"queryAllPublicConstructors": true,
"queryAllDeclaredMethods": true,
"allPublicMethods": true,
"allDeclaredClasses": true,
"allPublicClasses": true
},
{
"name": "com.google.firestore.v1.ExecutionStats$Builder",
"queryAllDeclaredConstructors": true,
"queryAllPublicConstructors": true,
"queryAllDeclaredMethods": true,
"allPublicMethods": true,
"allDeclaredClasses": true,
"allPublicClasses": true
},
{
"name": "com.google.firestore.v1.ExistenceFilter",
"queryAllDeclaredConstructors": true,
Expand All @@ -872,6 +890,42 @@
"allDeclaredClasses": true,
"allPublicClasses": true
},
{
"name": "com.google.firestore.v1.ExplainMetrics",
"queryAllDeclaredConstructors": true,
"queryAllPublicConstructors": true,
"queryAllDeclaredMethods": true,
"allPublicMethods": true,
"allDeclaredClasses": true,
"allPublicClasses": true
},
{
"name": "com.google.firestore.v1.ExplainMetrics$Builder",
"queryAllDeclaredConstructors": true,
"queryAllPublicConstructors": true,
"queryAllDeclaredMethods": true,
"allPublicMethods": true,
"allDeclaredClasses": true,
"allPublicClasses": true
},
{
"name": "com.google.firestore.v1.ExplainOptions",
"queryAllDeclaredConstructors": true,
"queryAllPublicConstructors": true,
"queryAllDeclaredMethods": true,
"allPublicMethods": true,
"allDeclaredClasses": true,
"allPublicClasses": true
},
{
"name": "com.google.firestore.v1.ExplainOptions$Builder",
"queryAllDeclaredConstructors": true,
"queryAllPublicConstructors": true,
"queryAllDeclaredMethods": true,
"allPublicMethods": true,
"allDeclaredClasses": true,
"allPublicClasses": true
},
{
"name": "com.google.firestore.v1.GetDocumentRequest",
"queryAllDeclaredConstructors": true,
Expand Down Expand Up @@ -1052,6 +1106,24 @@
"allDeclaredClasses": true,
"allPublicClasses": true
},
{
"name": "com.google.firestore.v1.PlanSummary",
"queryAllDeclaredConstructors": true,
"queryAllPublicConstructors": true,
"queryAllDeclaredMethods": true,
"allPublicMethods": true,
"allDeclaredClasses": true,
"allPublicClasses": true
},
{
"name": "com.google.firestore.v1.PlanSummary$Builder",
"queryAllDeclaredConstructors": true,
"queryAllPublicConstructors": true,
"queryAllDeclaredMethods": true,
"allPublicMethods": true,
"allDeclaredClasses": true,
"allPublicClasses": true
},
{
"name": "com.google.firestore.v1.Precondition",
"queryAllDeclaredConstructors": true,
Expand Down
26 changes: 22 additions & 4 deletions google-cloud-firestore/src/test/java/com/google/cloud/firestore/v1/FirestoreClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@
import com.google.firestore.v1.DeleteDocumentRequest;
import com.google.firestore.v1.Document;
import com.google.firestore.v1.DocumentMask;
import com.google.firestore.v1.ExplainMetrics;
import com.google.firestore.v1.ExplainOptions;
import com.google.firestore.v1.GetDocumentRequest;
import com.google.firestore.v1.ListCollectionIdsRequest;
import com.google.firestore.v1.ListCollectionIdsResponse;
Expand Down Expand Up @@ -505,9 +507,14 @@ public void runQueryTest() throws Exception {
.setDocument(Document.newBuilder().build())
.setReadTime(Timestamp.newBuilder().build())
.setSkippedResults(880286183)
.setExplainMetrics(ExplainMetrics.newBuilder().build())
.build();
mockFirestore.addResponse(expectedResponse);
RunQueryRequest request = RunQueryRequest.newBuilder().setParent("parent-995424086").build();
RunQueryRequest request =
RunQueryRequest.newBuilder()
.setParent("parent-995424086")
.setExplainOptions(ExplainOptions.newBuilder().build())
.build();

MockStreamObserver<RunQueryResponse> responseObserver = new MockStreamObserver<>();

Expand All @@ -523,7 +530,11 @@ public void runQueryTest() throws Exception {
public void runQueryExceptionTest() throws Exception {
StatusRuntimeException exception = new StatusRuntimeException(io.grpc.Status.INVALID_ARGUMENT);
mockFirestore.addException(exception);
RunQueryRequest request = RunQueryRequest.newBuilder().setParent("parent-995424086").build();
RunQueryRequest request =
RunQueryRequest.newBuilder()
.setParent("parent-995424086")
.setExplainOptions(ExplainOptions.newBuilder().build())
.build();

MockStreamObserver<RunQueryResponse> responseObserver = new MockStreamObserver<>();

Expand All @@ -547,10 +558,14 @@ public void runAggregationQueryTest() throws Exception {
.setResult(AggregationResult.newBuilder().build())
.setTransaction(ByteString.EMPTY)
.setReadTime(Timestamp.newBuilder().build())
.setExplainMetrics(ExplainMetrics.newBuilder().build())
.build();
mockFirestore.addResponse(expectedResponse);
RunAggregationQueryRequest request =
RunAggregationQueryRequest.newBuilder().setParent("parent-995424086").build();
RunAggregationQueryRequest.newBuilder()
.setParent("parent-995424086")
.setExplainOptions(ExplainOptions.newBuilder().build())
.build();

MockStreamObserver<RunAggregationQueryResponse> responseObserver = new MockStreamObserver<>();

Expand All @@ -568,7 +583,10 @@ public void runAggregationQueryExceptionTest() throws Exception {
StatusRuntimeException exception = new StatusRuntimeException(io.grpc.Status.INVALID_ARGUMENT);
mockFirestore.addException(exception);
RunAggregationQueryRequest request =
RunAggregationQueryRequest.newBuilder().setParent("parent-995424086").build();
RunAggregationQueryRequest.newBuilder()
.setParent("parent-995424086")
.setExplainOptions(ExplainOptions.newBuilder().build())
.build();

MockStreamObserver<RunAggregationQueryResponse> responseObserver = new MockStreamObserver<>();

Expand Down
30 changes: 30 additions & 0 deletions proto-google-cloud-firestore-v1/clirr-ignored-differences.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,34 @@
<className>com/google/firestore/v1/Run*QueryResponse$Builder</className>
<method>* mergeStats(*)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/firestore/v1/Run*QueryRequestOrBuilder</className>
<method>com.google.firestore.v1.ExplainOptions getExplainOptions()</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/firestore/v1/Run*QueryRequestOrBuilder</className>
<method>com.google.firestore.v1.ExplainOptionsOrBuilder getExplainOptionsOrBuilder()</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/firestore/v1/Run*QueryRequestOrBuilder</className>
<method>boolean hasExplainOptions()</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/firestore/v1/Run*QueryResponseOrBuilder</className>
<method>com.google.firestore.v1.ExplainMetrics getExplainMetrics()</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/firestore/v1/Run*QueryResponseOrBuilder</className>
<method>com.google.firestore.v1.ExplainMetricsOrBuilder getExplainMetricsOrBuilder()</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/firestore/v1/Run*QueryResponseOrBuilder</className>
<method>boolean hasExplainMetrics()</method>
</difference>
</differences>
Loading
Loading