kfaraz commented on code in PR #17382: URL: https://github.com/apache/druid/pull/17382#discussion_r1807218448
########## sql/src/main/java/org/apache/druid/sql/guice/BrokerServiceModule.java: ########## @@ -0,0 +1,74 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.druid.sql.guice; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.google.inject.Provides; +import org.apache.druid.discovery.DruidNodeDiscoveryProvider; +import org.apache.druid.discovery.NodeRole; +import org.apache.druid.guice.LazySingleton; +import org.apache.druid.guice.ManageLifecycle; +import org.apache.druid.guice.annotations.EscalatedGlobal; +import org.apache.druid.guice.annotations.Json; +import org.apache.druid.rpc.DiscoveryServiceLocator; +import org.apache.druid.rpc.ServiceClientFactory; +import org.apache.druid.rpc.ServiceLocator; +import org.apache.druid.rpc.StandardRetryPolicy; +import org.apache.druid.rpc.guice.ServiceClientModule; +import org.apache.druid.sql.client.Broker; +import org.apache.druid.sql.client.BrokerClient; +import org.apache.druid.sql.client.BrokerClientImpl; + +/** + * Module that processes can bind to if they require a {@link BrokerClient}. + * <p> + * This extend {@link ServiceClientModule} because the {@link BrokerClient} requires + * classes present in the sql module. + * </p> + */ +public class BrokerServiceModule extends ServiceClientModule Review Comment: Nit: Why extend `ServiceClientModule`? I think the only required method from `ServiceClientModule` is `makeServiceClientFactory()`. I guess it is okay to copy over that method. ########## sql/src/main/java/org/apache/druid/sql/http/ExplainPlanInformation.java: ########## @@ -0,0 +1,112 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.druid.sql.http; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.JsonDeserializer; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import org.apache.druid.sql.calcite.planner.ExplainAttributes; + +import java.io.IOException; +import java.util.Objects; + +/** + * Class that encapsulates the information of a single plan for an {@code EXPLAIN PLAN FOR} query. + * <p> + * Similar to {@link #getAttributes()}, it's possible to provide more structure to {@link #getPlan()}, + * at least for the native query explain, but there's currently no use case for it. + * </p> + */ +public class ExplainPlanInformation +{ + @JsonProperty("PLAN") + private final String plan; + + @JsonProperty("RESOURCES") + private final String resources; + + @JsonProperty("ATTRIBUTES") + @JsonDeserialize(using = ExplainAttributesDeserializer.class) + private final ExplainAttributes attributes; + + @JsonCreator + public ExplainPlanInformation( + @JsonProperty("PLAN") final String plan, + @JsonProperty("RESOURCES") final String resources, + @JsonProperty("ATTRIBUTES") final ExplainAttributes attributes + ) + { + this.plan = plan; + this.resources = resources; + this.attributes = attributes; + } + + public String getPlan() + { + return plan; + } + + public String getResources() + { + return resources; + } + + public ExplainAttributes getAttributes() + { + return attributes; + } + + private static class ExplainAttributesDeserializer extends JsonDeserializer<ExplainAttributes> Review Comment: Why is the custom deserializer needed? I don't see it doing anything special. ########## sql/src/main/java/org/apache/druid/sql/calcite/planner/ExplainAttributes.java: ########## @@ -117,6 +120,31 @@ public String getReplaceTimeChunks() return replaceTimeChunks; } + @Override + public boolean equals(Object o) + { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ExplainAttributes that = (ExplainAttributes) o; + return Objects.equals(statementType, that.statementType) && Objects.equals( + targetDataSource, + that.targetDataSource + ) && Objects.equals(partitionedBy, that.partitionedBy) && Objects.equals( + clusteredBy, + that.clusteredBy + ) && Objects.equals(replaceTimeChunks, that.replaceTimeChunks); Review Comment: Formatting: please put each `Objects.equals()` in a separate line. ########## sql/src/main/java/org/apache/druid/sql/client/Broker.java: ########## @@ -0,0 +1,34 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.druid.sql.client; + +import com.google.inject.BindingAnnotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@BindingAnnotation +@Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD}) +@Retention(RetentionPolicy.RUNTIME) +public @interface Broker Review Comment: Please add a javadoc indicating the usage of this annotation. ########## sql/src/main/java/org/apache/druid/sql/client/BrokerClient.java: ########## @@ -0,0 +1,51 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.druid.sql.client; + +import com.google.common.util.concurrent.ListenableFuture; +import org.apache.druid.sql.http.ExplainPlanInformation; +import org.apache.druid.sql.http.SqlQuery; +import org.apache.druid.sql.http.SqlTaskStatus; + +import java.util.List; + +/** + * High-level Broker client. + * <p> + * All methods return futures, enabling asynchronous logic. If you want a synchronous response, use + * {@code FutureUtils.get} or {@code FutureUtils.getUnchecked}. + * Futures resolve to exceptions in the manner described by {@link org.apache.druid.rpc.ServiceClient#asyncRequest}. + * </p> + * Typically acquired via Guice, where it is registered using {@link org.apache.druid.rpc.guice.ServiceClientModule}. + */ +public interface BrokerClient +{ + /** + * Submit the given {@code sqlQuery} to the Broker's SQL task endpoint. + */ + ListenableFuture<SqlTaskStatus> submitSqlTask(SqlQuery sqlQuery); + + /** + * Fetches the explain plan information for the given {@code sqlQuery}. Review Comment: It would be nice if the javadoc also mentioned the HTTP endpoint being hit. ########## sql/src/main/java/org/apache/druid/sql/client/BrokerClient.java: ########## @@ -0,0 +1,51 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.druid.sql.client; + +import com.google.common.util.concurrent.ListenableFuture; +import org.apache.druid.sql.http.ExplainPlanInformation; +import org.apache.druid.sql.http.SqlQuery; +import org.apache.druid.sql.http.SqlTaskStatus; + +import java.util.List; + +/** + * High-level Broker client. + * <p> + * All methods return futures, enabling asynchronous logic. If you want a synchronous response, use + * {@code FutureUtils.get} or {@code FutureUtils.getUnchecked}. + * Futures resolve to exceptions in the manner described by {@link org.apache.druid.rpc.ServiceClient#asyncRequest}. + * </p> + * Typically acquired via Guice, where it is registered using {@link org.apache.druid.rpc.guice.ServiceClientModule}. + */ +public interface BrokerClient +{ + /** + * Submit the given {@code sqlQuery} to the Broker's SQL task endpoint. + */ + ListenableFuture<SqlTaskStatus> submitSqlTask(SqlQuery sqlQuery); + + /** + * Fetches the explain plan information for the given {@code sqlQuery}. + * + * @param sqlQuery the SQL query for which the {@code EXPLAIN PLAN FOR} information is to be fetched + */ + ListenableFuture<List<ExplainPlanInformation>> fetchExplainPlanInformation(SqlQuery sqlQuery); Review Comment: ```suggestion ListenableFuture<List<ExplainPlanInformation>> fetchExplainPlan(SqlQuery sqlQuery); ``` ########## sql/src/main/java/org/apache/druid/sql/http/ExplainPlanInformation.java: ########## @@ -0,0 +1,112 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.druid.sql.http; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.JsonDeserializer; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import org.apache.druid.sql.calcite.planner.ExplainAttributes; + +import java.io.IOException; +import java.util.Objects; + +/** + * Class that encapsulates the information of a single plan for an {@code EXPLAIN PLAN FOR} query. + * <p> + * Similar to {@link #getAttributes()}, it's possible to provide more structure to {@link #getPlan()}, + * at least for the native query explain, but there's currently no use case for it. + * </p> + */ +public class ExplainPlanInformation Review Comment: Rename to `ExplainPlan`? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
