Add broker setting to override default implicit query response limit #14452
There are no files selected for viewing
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
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
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,189 @@ | ||
| /** | ||
| * 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.pinot.integration.tests; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.google.common.collect.ImmutableList; | ||
| import java.io.File; | ||
| import org.apache.avro.file.DataFileWriter; | ||
| import org.apache.avro.generic.GenericData; | ||
| import org.apache.avro.generic.GenericDatumWriter; | ||
| import org.apache.commons.io.FileUtils; | ||
| import org.apache.pinot.spi.config.table.TableConfig; | ||
| import org.apache.pinot.spi.config.table.TableType; | ||
| import org.apache.pinot.spi.data.FieldSpec; | ||
| import org.apache.pinot.spi.data.Schema; | ||
| import org.apache.pinot.spi.env.PinotConfiguration; | ||
| import org.apache.pinot.spi.utils.CommonConstants; | ||
| import org.apache.pinot.spi.utils.builder.ControllerRequestURLBuilder; | ||
| import org.apache.pinot.spi.utils.builder.TableConfigBuilder; | ||
| import org.apache.pinot.util.TestUtils; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.testng.annotations.AfterClass; | ||
| import org.testng.annotations.BeforeClass; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| import static org.testng.Assert.*; | ||
|
|
||
|
|
||
| // this test uses separate cluster because it needs to change broker configuration | ||
| // which is only done once per suite | ||
| public class BrokerQueryLimitTest extends BaseClusterIntegrationTest { | ||
bziobrowski marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| protected static final Logger LOGGER = LoggerFactory.getLogger(BrokerQueryLimitTest.class); | ||
| private static final String LONG_COLUMN = "longCol"; | ||
| public static final int DEFAULT_LIMIT = 5; | ||
|
|
||
| @Test | ||
| public void testWhenLimitIsNOTSetExplicitlyThenDefaultLimitIsApplied() | ||
| throws Exception { | ||
| setUseMultiStageQueryEngine(false); | ||
| String query = String.format("SELECT %s FROM %s", LONG_COLUMN, getTableName()); | ||
|
|
||
| JsonNode result = postQuery(query).get("resultTable"); | ||
| JsonNode columnDataTypesNode = result.get("dataSchema").get("columnDataTypes"); | ||
| assertEquals(columnDataTypesNode.get(0).textValue(), "LONG"); | ||
|
|
||
| JsonNode rows = result.get("rows"); | ||
| assertEquals(rows.size(), DEFAULT_LIMIT); | ||
|
|
||
| for (int rowNum = 0; rowNum < rows.size(); rowNum++) { | ||
| JsonNode row = rows.get(rowNum); | ||
| assertEquals(row.size(), 1); | ||
| assertEquals(row.get(0).asLong(), rowNum); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testWhenLimitISSetExplicitlyThenDefaultLimitIsNotApplied() | ||
| throws Exception { | ||
| setUseMultiStageQueryEngine(false); | ||
| String query = String.format("SELECT %s FROM %s limit 20", LONG_COLUMN, getTableName()); | ||
|
|
||
| JsonNode result = postQuery(query).get("resultTable"); | ||
| JsonNode columnDataTypesNode = result.get("dataSchema").get("columnDataTypes"); | ||
| assertEquals(columnDataTypesNode.get(0).textValue(), "LONG"); | ||
|
|
||
| JsonNode rows = result.get("rows"); | ||
| assertEquals(rows.size(), 20); | ||
|
|
||
| for (int rowNum = 0; rowNum < rows.size(); rowNum++) { | ||
| JsonNode row = rows.get(rowNum); | ||
| assertEquals(row.size(), 1); | ||
| assertEquals(row.get(0).asLong(), rowNum); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void overrideBrokerConf(PinotConfiguration brokerConf) { | ||
| brokerConf.setProperty(CommonConstants.Broker.CONFIG_OF_BROKER_DEFAULT_QUERY_RESPONSE_LIMIT, DEFAULT_LIMIT); | ||
| } | ||
|
|
||
| @Override | ||
| public String getTableName() { | ||
| return DEFAULT_TABLE_NAME; | ||
| } | ||
|
|
||
| @Override | ||
| public Schema createSchema() { | ||
| return new Schema.SchemaBuilder().setSchemaName(getTableName()) | ||
| .addSingleValueDimension(LONG_COLUMN, FieldSpec.DataType.LONG) | ||
| .build(); | ||
| } | ||
|
|
||
| public File createAvroFile() | ||
| throws Exception { | ||
| org.apache.avro.Schema avroSchema = org.apache.avro.Schema.createRecord("myRecord", null, null, false); | ||
| avroSchema.setFields(ImmutableList.of( | ||
| new org.apache.avro.Schema.Field(LONG_COLUMN, org.apache.avro.Schema.create(org.apache.avro.Schema.Type.LONG), | ||
| null, null))); | ||
|
|
||
| File avroFile = new File(_tempDir, "data.avro"); | ||
| try (DataFileWriter<GenericData.Record> writer = new DataFileWriter<>(new GenericDatumWriter<>(avroSchema))) { | ||
| writer.create(avroSchema, avroFile); | ||
| for (int i = 0; i < getCountStarResult(); i++) { | ||
| GenericData.Record record = new GenericData.Record(avroSchema); | ||
| record.put(LONG_COLUMN, i); | ||
| writer.append(record); | ||
| } | ||
| } | ||
| return avroFile; | ||
| } | ||
|
|
||
| @BeforeClass | ||
| public void setUp() | ||
| throws Exception { | ||
| LOGGER.warn("Setting up integration test class: {}", getClass().getSimpleName()); | ||
| TestUtils.ensureDirectoriesExistAndEmpty(_tempDir, _segmentDir, _tarDir); | ||
|
|
||
| // Start the Pinot cluster | ||
| startZk(); | ||
| LOGGER.warn("Start Kafka in the integration test class"); | ||
| startKafka(); | ||
| startController(); | ||
| startBroker(); | ||
| startServer(); | ||
|
|
||
| if (_controllerRequestURLBuilder == null) { | ||
| _controllerRequestURLBuilder = | ||
| ControllerRequestURLBuilder.baseUrl("http://localhost:" + getControllerPort()); | ||
| } | ||
| TestUtils.ensureDirectoriesExistAndEmpty(_tempDir, _segmentDir, _tarDir); | ||
| // create & upload schema AND table config | ||
| Schema schema = createSchema(); | ||
| addSchema(schema); | ||
|
|
||
| File avroFile = createAvroFile(); | ||
| // create offline table | ||
| TableConfig tableConfig = createOfflineTableConfig(); | ||
| addTableConfig(tableConfig); | ||
|
|
||
| // create & upload segments | ||
| ClusterIntegrationTestUtils.buildSegmentFromAvro(avroFile, tableConfig, schema, 0, _segmentDir, _tarDir); | ||
| uploadSegments(getTableName(), _tarDir); | ||
|
|
||
| waitForAllDocsLoaded(60_000); | ||
| LOGGER.warn("Finished setting up integration test class: {}", getClass().getSimpleName()); | ||
| } | ||
|
|
||
| @AfterClass | ||
| public void tearDown() | ||
| throws Exception { | ||
| LOGGER.warn("Tearing down integration test class: {}", getClass().getSimpleName()); | ||
| dropOfflineTable(getTableName()); | ||
| FileUtils.deleteDirectory(_tempDir); | ||
|
|
||
| // Stop Kafka | ||
| LOGGER.warn("Stop Kafka in the integration test class"); | ||
| stopKafka(); | ||
| // Shutdown the Pinot cluster | ||
| stopServer(); | ||
| stopBroker(); | ||
| stopController(); | ||
| stopZk(); | ||
| FileUtils.deleteDirectory(_tempDir); | ||
| LOGGER.warn("Finished tearing down integration test class: {}", getClass().getSimpleName()); | ||
| } | ||
|
|
||
| @Override | ||
| public TableConfig createOfflineTableConfig() { | ||
| return new TableConfigBuilder(TableType.OFFLINE).setTableName(getTableName()).build(); | ||
| } | ||
| } | ||
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
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's keep the variable name unchanged. This is not only for override, but actually the cap of the allowed limit