Copilot commented on code in PR #2527: URL: https://github.com/apache/phoenix/pull/2527#discussion_r3408389302
########## phoenix-core/src/test/java/org/apache/phoenix/query/explain/ExplainJsonOutputTest.java: ########## @@ -0,0 +1,103 @@ +/* + * 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.phoenix.query.explain; + +import static org.apache.phoenix.util.TestUtil.TEST_PROPERTIES; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +import com.fasterxml.jackson.databind.JsonNode; +import java.sql.Connection; +import java.sql.DriverManager; +import java.sql.ResultSet; +import java.sql.Statement; +import java.util.Properties; +import org.apache.phoenix.compile.ExplainPlan; +import org.apache.phoenix.query.BaseConnectionlessQueryTest; +import org.apache.phoenix.util.PropertiesUtil; +import org.junit.BeforeClass; +import org.junit.Test; + +/** + * End-to-end tests for {@code EXPLAIN (FORMAT JSON) <stmt>}. Exercises the + * {@code Statement.executeQuery} ResultSet path and confirms the single emitted row carries a + * pretty-printed JSON document that matches the in process {@code ExplainPlanAttributes} tree for + * the same query. Review Comment: These Javadoc lines exceed the 100-character Checkstyle LineLength limit; wrap them to avoid build failures. ########## phoenix-core/src/test/java/org/apache/phoenix/query/explain/ExplainJsonOutputTest.java: ########## @@ -0,0 +1,103 @@ +/* + * 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.phoenix.query.explain; + +import static org.apache.phoenix.util.TestUtil.TEST_PROPERTIES; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +import com.fasterxml.jackson.databind.JsonNode; +import java.sql.Connection; +import java.sql.DriverManager; +import java.sql.ResultSet; +import java.sql.Statement; +import java.util.Properties; +import org.apache.phoenix.compile.ExplainPlan; +import org.apache.phoenix.query.BaseConnectionlessQueryTest; +import org.apache.phoenix.util.PropertiesUtil; +import org.junit.BeforeClass; +import org.junit.Test; + +/** + * End-to-end tests for {@code EXPLAIN (FORMAT JSON) <stmt>}. Exercises the + * {@code Statement.executeQuery} ResultSet path and confirms the single emitted row carries a + * pretty-printed JSON document that matches the in process {@code ExplainPlanAttributes} tree for + * the same query. + */ +public class ExplainJsonOutputTest extends BaseConnectionlessQueryTest { + + private static final String QUERY = "SELECT a_string, b_string FROM atable" + + " WHERE organization_id = '00D000000000001' AND entity_id = '00E00000000001'" + + " AND x_integer = 2 AND a_integer < 5"; + + private static ExplainOracle oracle; + + @BeforeClass + public static synchronized void setUpOracle() throws Exception { + oracle = new ExplainOracle(); + } + + private static Properties defaultProps() { + return PropertiesUtil.deepCopy(TEST_PROPERTIES); + } + + /** + * Read the single VARCHAR cell of an {@code EXPLAIN (FORMAT JSON)} result set, asserting that + * exactly one row is returned. Review Comment: This Javadoc line is likely to exceed the 100-character Checkstyle LineLength limit; wrap it to keep the build green. ########## phoenix-core-client/src/main/java/org/apache/phoenix/compile/ExplainJsonRenderer.java: ########## @@ -0,0 +1,79 @@ +/* + * 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.phoenix.compile; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.util.DefaultIndenter; +import com.fasterxml.jackson.core.util.DefaultPrettyPrinter; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.ObjectWriter; +import com.fasterxml.jackson.databind.SerializationFeature; +import java.sql.SQLException; + +/** + * Serializes an {@link ExplainPlanAttributes} tree to a JSON document for the + * {@code EXPLAIN (FORMAT JSON) <stmt>} statement. + * <p> + * The output is pretty-printed with two space indentation for both objects and arrays. + * <p> + * The JSON layout tracks the Java field names and structure of {@link ExplainPlanAttributes}. It is + * deliberately not a stable contract and carries no version field. It is an opt-in view onto an + * internal structure, useful for tooling and assertions. + * <p> + * This class intentionally does not reuse the shared {@link org.apache.phoenix.util.JacksonUtil} + * mapper so that the general-purpose mapper configuration can change without affecting the EXPLAIN + * JSON contract. Review Comment: Several Javadoc lines exceed the 100-character Checkstyle LineLength limit; wrap them to avoid style-check failures. -- 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]
