You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pinot.apache.org by ya...@apache.org on 2026/07/30 19:17:05 UTC
(pinot) branch master updated: Convert Javadoc comments to the /// Markdown style (#19126)
This is an automated email from the ASF dual-hosted git repository.
yashmayya pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pinot.git
The following commit(s) were added to refs/heads/master by this push:
new 6fe09ea6b59 Convert Javadoc comments to the /// Markdown style (#19126)
6fe09ea6b59 is described below
commit 6fe09ea6b590063d94fb2d31fe5ec23756fb0607
Author: Yash Mayya <ya...@gmail.com>
AuthorDate: Thu Jul 30 15:16:59 2026 -0400
Convert Javadoc comments to the /// Markdown style (#19126)
---
config/checkstyle.xml | 18 +-
.../org/apache/pinot/broker/api/AccessControl.java | 108 +-
.../pinot/broker/api/HttpRequesterIdentity.java | 14 +-
.../broker/api/resources/InstanceResource.java | 4 +-
.../api/resources/PinotBrokerAppConfigs.java | 6 +-
.../broker/api/resources/PinotBrokerDebug.java | 6 +-
.../broker/api/resources/PinotBrokerLogger.java | 4 +-
.../broker/api/resources/PinotClientRequest.java | 42 +-
.../api/resources/QueryWorkloadConfigResource.java | 100 +-
.../api/resources/ResponseStoreResource.java | 6 +-
.../api/resources/SqlSyntaxValidationResponse.java | 8 +-
.../pinot/broker/broker/AccessControlFactory.java | 12 +-
.../pinot/broker/broker/AuthenticationFilter.java | 6 +-
.../broker/BasicAuthAccessControlFactory.java | 24 +-
.../broker/BrokerManagedAsyncExecutorProvider.java | 18 +-
.../broker/ZkBasicAuthAccessControlFactory.java | 19 +-
.../broker/broker/helix/BaseBrokerStarter.java | 109 +-
...okerResourceOnlineOfflineStateModelFactory.java | 8 +-
.../BrokerUserDefinedMessageHandlerFactory.java | 12 +-
.../broker/broker/helix/ClusterChangeHandler.java | 12 +-
.../broker/broker/helix/ClusterChangeMediator.java | 36 +-
.../broker/broker/helix/HelixBrokerStarter.java | 6 +-
.../helix/MultiClusterHelixBrokerStarter.java | 18 +-
.../pinot/broker/cursors/FsResponseStore.java | 15 +-
.../apache/pinot/broker/grpc/BrokerGrpcServer.java | 4 +-
.../pinot/broker/grpc/GrpcRequesterIdentity.java | 16 +-
.../apache/pinot/broker/querylog/QueryLogger.java | 46 +-
.../HelixExternalViewBasedQueryQuotaManager.java | 187 +--
.../apache/pinot/broker/queryquota/HitCounter.java | 32 +-
.../pinot/broker/queryquota/MaxHitRateTracker.java | 20 +-
.../pinot/broker/queryquota/QueryQuotaManager.java | 56 +-
.../requesthandler/BaseBrokerRequestHandler.java | 62 +-
.../BaseSingleStageBrokerRequestHandler.java | 225 ++-
.../requesthandler/BrokerRequestHandler.java | 46 +-
.../BrokerRequestHandlerDelegate.java | 10 +-
.../requesthandler/GrpcBrokerRequestHandler.java | 24 +-
.../MultiStageBrokerRequestHandler.java | 78 +-
.../requesthandler/MultiStageQueryThrottler.java | 60 +-
.../SingleConnectionBrokerRequestHandler.java | 36 +-
.../requesthandler/TimeSeriesRequestHandler.java | 34 +-
.../AdaptiveServerSelector.java | 44 +-
.../AdaptiveServerSelectorFactory.java | 6 +-
.../adaptiveserverselector/HybridSelector.java | 28 +-
.../adaptiveserverselector/LatencySelector.java | 12 +-
.../NumInFlightReqSelector.java | 8 +-
.../PriorityPoolInstanceSelector.java | 181 ++-
.../ServerSelectionContext.java | 40 +-
.../instanceselector/BalancedInstanceSelector.java | 1 -
.../instanceselector/BaseInstanceSelector.java | 67 +-
.../routing/instanceselector/InstanceSelector.java | 71 +-
.../MultiStageReplicaGroupSelector.java | 66 +-
.../routing/instanceselector/NewSegmentState.java | 4 +-
.../ReplicaGroupInstanceSelector.java | 78 +-
.../instanceselector/SegmentInstanceCandidate.java | 4 +-
.../routing/instanceselector/SegmentStates.java | 3 +-
.../StrictReplicaGroupInstanceSelector.java | 58 +-
.../routing/manager/BaseBrokerRoutingManager.java | 141 +-
.../routing/manager/BrokerRoutingManager.java | 12 +-
.../manager/MultiClusterRoutingManager.java | 16 +-
.../manager/RemoteClusterBrokerRoutingManager.java | 8 +-
.../SegmentZkMetadataFetchListener.java | 31 +-
.../segmentmetadata/SegmentZkMetadataFetcher.java | 6 +-
.../SegmentPartitionMetadataManager.java | 14 +-
.../segmentpartition/SegmentPartitionUtils.java | 24 +-
.../SegmentLineageBasedSegmentPreSelector.java | 10 +-
.../segmentpreselector/SegmentPreSelector.java | 21 +-
.../routing/segmentpruner/EmptySegmentPruner.java | 6 +-
.../MultiPartitionColumnsSegmentPruner.java | 6 +-
.../routing/segmentpruner/SegmentPruner.java | 8 +-
.../SinglePartitionColumnSegmentPruner.java | 6 +-
.../routing/segmentpruner/TimeSegmentPruner.java | 57 +-
.../routing/segmentpruner/interval/Interval.java | 4 +-
.../segmentpruner/interval/IntervalTree.java | 32 +-
.../routing/segmentselector/SegmentSelector.java | 29 +-
.../tablesampler/FirstNSegmentsTableSampler.java | 13 +-
.../broker/routing/tablesampler/TableSampler.java | 24 +-
.../routing/tablesampler/TableSamplerFactory.java | 8 +-
.../routing/timeboundary/TimeBoundaryManager.java | 41 +-
.../broker/broker/HelixBrokerStarterTest.java | 4 +-
.../broker/helix/ClusterChangeMediatorTest.java | 16 +-
.../pinot/broker/cursors/FsResponseStoreTest.java | 6 +-
.../pinot/broker/grpc/BrokerGrpcServerTest.java | 4 +-
.../BaseSingleStageBrokerRequestHandlerTest.java | 110 +-
.../requesthandler/BrokerRequestOptionsTest.java | 4 +-
.../LiteralOnlyBrokerRequestTest.java | 2 +-
.../SelectStarWithOtherColsRewriteTest.java | 33 +-
...gleConnectionBrokerRequestHandlerMergeTest.java | 6 +-
.../BrokerRoutingManagerConcurrencyTest.java | 114 +-
.../routing/manager/BrokerRoutingManagerTest.java | 4 +-
.../manager/MultiClusterRoutingManagerTest.java | 4 +-
.../RemoteClusterBrokerRoutingManagerTest.java | 8 +-
.../org/apache/pinot/client/AbstractResultSet.java | 4 +-
.../apache/pinot/client/AggregationResultSet.java | 8 +-
.../apache/pinot/client/BaseResultSetGroup.java | 66 +-
.../java/org/apache/pinot/client/BrokerCache.java | 6 +-
.../pinot/client/BrokerCacheUpdaterPeriodic.java | 4 +-
.../org/apache/pinot/client/BrokerResponse.java | 4 +-
.../org/apache/pinot/client/BrokerSelector.java | 16 +-
.../java/org/apache/pinot/client/Connection.java | 158 +-
.../org/apache/pinot/client/ConnectionFactory.java | 176 +--
.../apache/pinot/client/ConnectionTimeouts.java | 4 +-
.../client/ControllerBasedBrokerSelector.java | 4 +-
.../pinot/client/CursorAwareBrokerResponse.java | 10 +-
.../org/apache/pinot/client/CursorCapable.java | 190 ++-
.../apache/pinot/client/CursorResultSetGroup.java | 26 +-
.../pinot/client/DefaultSslContextProvider.java | 4 +-
.../apache/pinot/client/DynamicBrokerSelector.java | 4 +-
.../org/apache/pinot/client/ExecutionStats.java | 12 +-
.../apache/pinot/client/ExternalViewReader.java | 4 +-
.../org/apache/pinot/client/GroupByResultSet.java | 12 +-
.../client/JsonAsyncHttpPinotClientTransport.java | 84 +-
.../JsonAsyncHttpPinotClientTransportFactory.java | 4 +-
.../apache/pinot/client/PinotClientException.java | 4 +-
.../pinot/client/PinotClientNettyResources.java | 64 +-
.../apache/pinot/client/PinotClientTransport.java | 14 +-
.../pinot/client/PinotClientTransportFactory.java | 8 +-
.../org/apache/pinot/client/PreparedStatement.java | 70 +-
.../java/org/apache/pinot/client/ResultCursor.java | 189 +--
.../org/apache/pinot/client/ResultCursorImpl.java | 40 +-
.../java/org/apache/pinot/client/ResultSet.java | 226 ++-
.../org/apache/pinot/client/ResultSetGroup.java | 24 +-
.../apache/pinot/client/ResultTableResultSet.java | 4 +-
.../apache/pinot/client/SelectionResultSet.java | 4 +-
.../apache/pinot/client/SimpleBrokerSelector.java | 6 +-
.../apache/pinot/client/SslContextProvider.java | 26 +-
.../pinot/client/SslContextProviderFactory.java | 10 +-
.../java/org/apache/pinot/client/TextTable.java | 4 +-
.../java/org/apache/pinot/client/TlsProtocols.java | 4 +-
.../apache/pinot/client/UpdatableBrokerCache.java | 36 +-
.../pinot/client/admin/BaseServiceAdminClient.java | 6 +-
.../pinot/client/admin/BrokerAdminClient.java | 4 +-
.../pinot/client/admin/ClusterAdminClient.java | 24 +-
.../pinot/client/admin/FileIngestClient.java | 28 +-
.../pinot/client/admin/InstanceAdminClient.java | 186 +--
.../client/admin/LogicalTableAdminClient.java | 12 +-
.../client/admin/PinotAdminAuthentication.java | 62 +-
.../admin/PinotAdminAuthenticationException.java | 4 +-
.../pinot/client/admin/PinotAdminClient.java | 170 +--
.../client/admin/PinotAdminClientExample.java | 4 +-
.../pinot/client/admin/PinotAdminException.java | 4 +-
.../client/admin/PinotAdminNotFoundException.java | 4 +-
.../pinot/client/admin/PinotAdminTransport.java | 222 ++-
.../admin/PinotAdminValidationException.java | 4 +-
.../pinot/client/admin/QueryAdminClient.java | 12 +-
.../client/admin/QueryWorkloadAdminClient.java | 12 +-
.../pinot/client/admin/RebalanceAdminClient.java | 32 +-
.../pinot/client/admin/SchemaAdminClient.java | 202 ++-
.../pinot/client/admin/SegmentAdminClient.java | 442 +++---
.../pinot/client/admin/TableAdminClient.java | 556 +++----
.../apache/pinot/client/admin/TaskAdminClient.java | 244 ++-
.../pinot/client/admin/TenantAdminClient.java | 272 ++--
.../apache/pinot/client/admin/UserAdminClient.java | 4 +-
.../pinot/client/admin/ZookeeperAdminClient.java | 4 +-
.../apache/pinot/client/grpc/GrpcConnection.java | 146 +-
.../pinot/client/grpc/GrpcPreparedStatement.java | 70 +-
.../apache/pinot/client/grpc/GrpcResultSet.java | 4 +-
.../pinot/client/grpc/GrpcResultSetGroup.java | 12 +-
.../java/org/apache/pinot/client/package-info.java | 168 ++-
.../pinot/client/utils/BrokerSelectorUtils.java | 34 +-
.../apache/pinot/client/ConnectionFactoryTest.java | 4 +-
.../pinot/client/CursorResultSetGroupTest.java | 4 +-
.../apache/pinot/client/PreparedStatementTest.java | 5 +-
.../apache/pinot/client/ResultSetGroupTest.java | 5 +-
.../pinot/client/admin/PinotAdminClientTest.java | 4 +-
.../java/org/apache/pinot/client/PinotDriver.java | 40 +-
.../pinot/client/AbstractJdbcDriverAuthTest.java | 90 +-
.../pinot/client/HttpJdbcDriverAuthTest.java | 24 +-
.../apache/pinot/client/PinotResultSetTest.java | 5 +-
.../pinot/client/grpc/GrpcJdbcDriverAuthTest.java | 24 +-
.../main/java/org/apache/pinot/common/Utils.java | 37 +-
.../assignment/InstanceAssignmentConfigUtils.java | 28 +-
.../common/assignment/InstancePartitions.java | 67 +-
.../common/assignment/InstancePartitionsUtils.java | 62 +-
.../org/apache/pinot/common/audit/AuditConfig.java | 6 +-
.../pinot/common/audit/AuditConfigManager.java | 16 +-
.../org/apache/pinot/common/audit/AuditEvent.java | 12 +-
.../pinot/common/audit/AuditIdentityResolver.java | 62 +-
.../apache/pinot/common/audit/AuditLogFilter.java | 8 +-
.../org/apache/pinot/common/audit/AuditLogger.java | 18 +-
.../apache/pinot/common/audit/AuditMetrics.java | 44 +-
.../pinot/common/audit/AuditRequestProcessor.java | 80 +-
.../pinot/common/audit/AuditResponseContext.java | 6 +-
.../pinot/common/audit/AuditServiceBinder.java | 6 +-
.../pinot/common/audit/AuditUrlPathFilter.java | 70 +-
.../org/apache/pinot/common/auth/AuthConfig.java | 7 +-
.../pinot/common/auth/AuthProviderUtils.java | 137 +-
.../pinot/common/auth/BasicAuthTokenUtils.java | 36 +-
.../apache/pinot/common/auth/NullAuthProvider.java | 4 +-
.../pinot/common/auth/StaticTokenAuthProvider.java | 4 +-
.../apache/pinot/common/auth/UrlAuthProvider.java | 8 +-
.../pinot/common/collections/DualValueList.java | 6 +-
.../pinot/common/compression/Compressor.java | 6 +-
.../common/concurrency/AdjustableSemaphore.java | 16 +-
.../apache/pinot/common/config/NettyConfig.java | 4 +-
.../org/apache/pinot/common/config/TlsConfig.java | 4 +-
.../config/provider/AccessControlUserCache.java | 6 +-
.../config/provider/LogicalTableMetadataCache.java | 10 +-
.../common/config/provider/StaticTableCache.java | 8 +-
.../pinot/common/config/provider/TableCache.java | 76 +-
.../pinot/common/config/provider/ZkTableCache.java | 71 +-
.../common/cursors/AbstractResponseStore.java | 130 +-
.../pinot/common/datablock/BaseDataBlock.java | 103 +-
.../pinot/common/datablock/ColumnarDataBlock.java | 4 +-
.../apache/pinot/common/datablock/DataBlock.java | 44 +-
.../pinot/common/datablock/DataBlockEquals.java | 91 +-
.../pinot/common/datablock/DataBlockSerde.java | 80 +-
.../pinot/common/datablock/DataBlockUtils.java | 156 +-
.../pinot/common/datablock/MetadataBlock.java | 28 +-
.../pinot/common/datablock/RowDataBlock.java | 4 +-
.../common/datablock/ZeroCopyDataBlockSerde.java | 14 +-
.../apache/pinot/common/datatable/DataTable.java | 12 +-
.../pinot/common/datatable/DataTableImplV4.java | 138 +-
.../pinot/common/datatable/DataTableUtils.java | 18 +-
.../org/apache/pinot/common/datatable/StatMap.java | 75 +-
.../common/evaluator/FunctionEvaluatorFactory.java | 33 +-
.../common/evaluator/GroovyFunctionEvaluator.java | 54 +-
.../common/evaluator/InbuiltFunctionEvaluator.java | 19 +-
.../evaluator/TimeSpecFunctionEvaluator.java | 10 +-
.../exception/RebalanceInProgressException.java | 6 +-
...BaseExponentialBackoffRetryFailureDetector.java | 10 +-
.../failuredetector/ConnectionFailureDetector.java | 12 +-
.../common/failuredetector/FailureDetector.java | 58 +-
.../common/function/DateTimePatternHandler.java | 106 +-
.../pinot/common/function/DateTimeUtils.java | 12 +-
.../pinot/common/function/FunctionInvoker.java | 40 +-
.../pinot/common/function/FunctionRegistry.java | 108 +-
.../pinot/common/function/FunctionUtils.java | 12 +-
.../pinot/common/function/PinotScalarFunction.java | 67 +-
.../apache/pinot/common/function/TimeZoneKey.java | 8 +-
.../common/function/TransformFunctionType.java | 10 +-
.../function/scalar/ArithmeticFunctions.java | 56 +-
.../common/function/scalar/ArrayFunctions.java | 18 +-
.../scalar/DataTypeConversionFunctions.java | 74 +-
.../common/function/scalar/DateTimeConvert.java | 4 +-
.../common/function/scalar/DateTimeFunctions.java | 462 +++---
.../common/function/scalar/GeohashFunctions.java | 42 +-
.../common/function/scalar/HashFunctions.java | 342 ++---
.../common/function/scalar/IpAddressFunctions.java | 237 ++-
.../common/function/scalar/JsonFunctions.java | 169 +--
.../common/function/scalar/LogicalFunctions.java | 177 ++-
.../common/function/scalar/StringFunctions.java | 835 +++++------
.../function/scalar/TrigonometricFunctions.java | 6 +-
.../pinot/common/function/scalar/UrlFunctions.java | 316 ++--
.../common/function/scalar/VectorFunctions.java | 100 +-
.../scalar/arithmetic/AbsScalarFunction.java | 8 +-
.../scalar/arithmetic/ArithmeticFunctionUtils.java | 8 +-
.../BaseBinaryArithmeticScalarFunction.java | 12 +-
.../BaseUnaryArithmeticScalarFunction.java | 12 +-
.../scalar/arithmetic/GreatestScalarFunction.java | 8 +-
.../scalar/arithmetic/LeastScalarFunction.java | 8 +-
.../scalar/arithmetic/ModScalarFunction.java | 8 +-
.../arithmetic/ModuloOrZeroScalarFunction.java | 8 +-
.../scalar/arithmetic/NegateScalarFunction.java | 8 +-
.../arithmetic/PositiveModuloScalarFunction.java | 8 +-
.../bitwise/BaseBinaryIntegralScalarFunction.java | 8 +-
.../scalar/bitwise/BaseShiftScalarFunction.java | 8 +-
.../bitwise/BaseUnaryIntegralScalarFunction.java | 8 +-
.../scalar/bitwise/BitAndScalarFunction.java | 8 +-
.../scalar/bitwise/BitExtractScalarFunction.java | 8 +-
.../function/scalar/bitwise/BitFunctionUtils.java | 8 +-
.../scalar/bitwise/BitMaskScalarFunction.java | 8 +-
.../scalar/bitwise/BitNotScalarFunction.java | 8 +-
.../scalar/bitwise/BitOrScalarFunction.java | 8 +-
.../scalar/bitwise/BitShiftLeftScalarFunction.java | 8 +-
.../bitwise/BitShiftRightScalarFunction.java | 8 +-
.../BitShiftRightUnsignedScalarFunction.java | 8 +-
.../scalar/bitwise/BitXorScalarFunction.java | 8 +-
.../scalar/comparison/BetweenScalarFunction.java | 4 +-
.../scalar/comparison/EqualsScalarFunction.java | 4 +-
.../GreaterThanOrEqualScalarFunction.java | 4 +-
.../comparison/GreaterThanScalarFunction.java | 4 +-
.../comparison/LessThanOrEqualScalarFunction.java | 4 +-
.../scalar/comparison/LessThanScalarFunction.java | 4 +-
.../scalar/comparison/NotEqualsScalarFunction.java | 4 +-
.../PolymorphicComparisonScalarFunction.java | 18 +-
.../scalar/regexp/RegexpExtractConstFunctions.java | 38 +-
.../scalar/regexp/RegexpExtractVarFunctions.java | 40 +-
.../scalar/regexp/RegexpLikeConstFunctions.java | 4 +-
.../scalar/regexp/RegexpLikeVarFunctions.java | 4 +-
.../scalar/regexp/RegexpReplaceConstFunctions.java | 92 +-
.../scalar/regexp/RegexpReplaceVarFunctions.java | 94 +-
.../function/scalar/string/LTrimFunction.java | 6 +-
.../function/scalar/string/NgramFunctions.java | 44 +-
.../function/scalar/string/RTrimFunction.java | 6 +-
.../function/scalar/string/StringFunctions.java | 16 +-
.../common/function/sql/PinotSqlAggFunction.java | 4 +-
.../common/function/sql/PinotSqlFunction.java | 4 +-
.../pinot/common/helix/ExtraInstanceConfig.java | 12 +-
.../apache/pinot/common/http/MultiHttpRequest.java | 58 +-
.../apache/pinot/common/lineage/LineageEntry.java | 5 +-
.../pinot/common/lineage/LineageEntryState.java | 4 +-
.../pinot/common/lineage/SegmentLineage.java | 90 +-
.../common/lineage/SegmentLineageAccessHelper.java | 54 +-
.../pinot/common/lineage/SegmentLineageUtils.java | 33 +-
.../MaterializedViewAggregationCatalog.java | 56 +-
.../ApplicationQpsQuotaRefreshMessage.java | 14 +-
.../messages/DatabaseConfigRefreshMessage.java | 13 +-
.../pinot/common/messages/ForceCommitMessage.java | 6 +-
.../messages/IngestionMetricsRemoveMessage.java | 8 +-
.../messages/LogicalTableConfigRefreshMessage.java | 20 +-
.../messages/RoutingTableRebuildMessage.java | 22 +-
.../common/messages/RunPeriodicTaskMessage.java | 14 +-
.../common/messages/SegmentRefreshMessage.java | 36 +-
.../common/messages/SegmentReloadMessage.java | 52 +-
.../common/messages/TableConfigRefreshMessage.java | 18 +-
.../messages/TableConfigSchemaRefreshMessage.java | 8 +-
.../common/messages/TableDeletionMessage.java | 4 +-
.../pinot/common/metadata/ZKMetadataProvider.java | 196 +--
.../metadata/segment/SegmentPartitionMetadata.java | 70 +-
.../common/metadata/segment/SegmentZKMetadata.java | 18 +-
.../SegmentZKMetadataCustomMapModifier.java | 6 +-
.../metadata/segment/SegmentZKMetadataUtils.java | 12 +-
.../pinot/common/metrics/AbstractMetrics.java | 492 +++----
.../apache/pinot/common/metrics/BrokerGauge.java | 56 +-
.../apache/pinot/common/metrics/BrokerMeter.java | 193 +--
.../apache/pinot/common/metrics/BrokerMetrics.java | 21 +-
.../pinot/common/metrics/BrokerQueryPhase.java | 5 +-
.../apache/pinot/common/metrics/BrokerTimer.java | 13 +-
.../pinot/common/metrics/ControllerGauge.java | 12 +-
.../pinot/common/metrics/ControllerMeter.java | 12 +-
.../pinot/common/metrics/ControllerMetrics.java | 4 +-
.../pinot/common/metrics/ControllerTimer.java | 13 +-
.../apache/pinot/common/metrics/MinionGauge.java | 4 +-
.../apache/pinot/common/metrics/ServerGauge.java | 30 +-
.../apache/pinot/common/metrics/ServerMeter.java | 86 +-
.../apache/pinot/common/metrics/ServerMetrics.java | 13 +-
.../pinot/common/metrics/ServerQueryPhase.java | 5 +-
.../apache/pinot/common/metrics/ServerTimer.java | 47 +-
.../pinot/common/metrics/ValidationMetrics.java | 134 +-
.../pinot/common/minion/BaseTaskGeneratorInfo.java | 12 +-
.../pinot/common/minion/BaseTaskMetadata.java | 22 +-
.../common/minion/MergeRollupTaskMetadata.java | 17 +-
.../apache/pinot/common/minion/MinionClient.java | 8 +-
.../common/minion/MinionRequestURLBuilder.java | 4 +-
.../common/minion/MinionTaskMetadataUtils.java | 54 +-
.../RealtimeToOfflineSegmentsTaskMetadata.java | 36 +-
.../minion/TaskGeneratorMostRecentRunInfo.java | 42 +-
.../protocols/SegmentCompletionProtocol.java | 38 +-
.../common/request/context/ExpressionContext.java | 18 +-
.../common/request/context/FilterContext.java | 10 +-
.../common/request/context/FunctionContext.java | 11 +-
.../common/request/context/LiteralContext.java | 11 +-
.../request/context/OrderByExpressionContext.java | 10 +-
.../request/context/RequestContextUtils.java | 34 +-
.../request/context/predicate/BaseInPredicate.java | 4 +-
.../request/context/predicate/BasePredicate.java | 4 +-
.../request/context/predicate/EqPredicate.java | 4 +-
.../request/context/predicate/InPredicate.java | 4 +-
.../context/predicate/IsNotNullPredicate.java | 4 +-
.../request/context/predicate/IsNullPredicate.java | 4 +-
.../context/predicate/JsonMatchPredicate.java | 4 +-
.../request/context/predicate/NotEqPredicate.java | 4 +-
.../request/context/predicate/NotInPredicate.java | 4 +-
.../request/context/predicate/Predicate.java | 21 +-
.../request/context/predicate/RangePredicate.java | 25 +-
.../context/predicate/RegexpLikePredicate.java | 4 +-
.../context/predicate/TextMatchPredicate.java | 4 +-
.../predicate/VectorSimilarityPredicate.java | 20 +-
.../predicate/VectorSimilarityRadiusPredicate.java | 42 +-
.../pinot/common/response/BrokerResponse.java | 306 ++--
.../pinot/common/response/CursorResponse.java | 110 +-
.../response/PinotBrokerTimeSeriesResponse.java | 16 +-
.../response/broker/BrokerResponseNative.java | 12 +-
.../response/broker/BrokerResponseNativeV2.java | 44 +-
.../response/broker/QueryProcessingException.java | 14 +-
.../pinot/common/response/broker/ResultTable.java | 4 +-
.../common/response/encoder/ResponseEncoder.java | 22 +-
.../response/mapper/TimeSeriesResponseMapper.java | 6 +-
.../server/SegmentReloadFailureResponse.java | 4 +-
.../common/restlet/resources/DiskUsageInfo.java | 4 +-
.../resources/EndReplaceSegmentsRequest.java | 16 +-
.../resources/PinotControllerJobMetadataDto.java | 6 +-
.../resources/RebalancePreCheckerResult.java | 12 +-
.../restlet/resources/RebalanceSummaryResult.java | 152 +-
.../common/restlet/resources/ResourceUtils.java | 4 +-
.../resources/RevertReplaceSegmentsRequest.java | 8 +-
.../restlet/resources/SegmentConsumerInfo.java | 4 +-
.../common/restlet/resources/SegmentErrorInfo.java | 27 +-
.../restlet/resources/SegmentServerDebugInfo.java | 8 +-
.../ServerSegmentsReloadCheckResponse.java | 8 +-
.../resources/StartReplaceSegmentsRequest.java | 14 +-
.../restlet/resources/SystemResourceInfo.java | 22 +-
.../restlet/resources/TableRebalanceContext.java | 34 +-
.../resources/TableRebalanceProgressStats.java | 20 +-
.../TableSegmentsReloadCheckResponse.java | 10 +-
.../pinot/common/restlet/resources/TableView.java | 4 +-
.../restlet/resources/TenantRebalanceResult.java | 36 +-
.../segment/generation/SegmentGenerationUtils.java | 90 +-
.../common/tier/FixedTierSegmentSelector.java | 4 +-
.../pinot/common/tier/PinotServerTierStorage.java | 8 +-
.../java/org/apache/pinot/common/tier/Tier.java | 10 +-
.../org/apache/pinot/common/tier/TierFactory.java | 8 +-
.../pinot/common/tier/TierSegmentSelector.java | 4 +-
.../org/apache/pinot/common/tier/TierStorage.java | 8 +-
.../common/tier/TimeBasedTierSegmentSelector.java | 8 +-
.../apache/pinot/common/utils/ArrayListUtils.java | 153 +-
.../common/utils/CachedExecutorServicePlugin.java | 24 +-
.../org/apache/pinot/common/utils/DataSchema.java | 100 +-
.../apache/pinot/common/utils/DatabaseUtils.java | 166 +--
.../apache/pinot/common/utils/DateTimeUtils.java | 10 +-
.../common/utils/ExponentialMovingAverage.java | 46 +-
.../common/utils/FileUploadDownloadClient.java | 966 ++++++------
.../org/apache/pinot/common/utils/FileUtils.java | 92 +-
.../common/utils/FixedExecutorServicePlugin.java | 18 +-
.../org/apache/pinot/common/utils/HashUtil.java | 23 +-
.../apache/pinot/common/utils/LLCSegmentName.java | 14 +-
.../org/apache/pinot/common/utils/LoggerUtils.java | 30 +-
.../common/utils/LogicalTableConfigSerDe.java | 24 +-
.../utils/LogicalTableConfigSerDeProvider.java | 14 +-
.../pinot/common/utils/NamedThreadFactory.java | 37 +-
.../common/utils/PauselessConsumptionUtils.java | 14 +-
.../apache/pinot/common/utils/PinotAppConfigs.java | 19 +-
.../pinot/common/utils/PinotStaticHttpHandler.java | 12 +-
.../pinot/common/utils/PrimitiveArrayUtils.java | 14 +-
.../org/apache/pinot/common/utils/RateLimiter.java | 20 +-
.../common/utils/RegexpPatternConverterUtils.java | 46 +-
.../apache/pinot/common/utils/RetentionUtils.java | 39 +-
.../pinot/common/utils/RoaringBitmapUtils.java | 22 +-
.../pinot/common/utils/RoundRobinURIProvider.java | 8 +-
.../common/utils/ScalingThreadPoolExecutor.java | 61 +-
.../apache/pinot/common/utils/SegmentUtils.java | 17 +-
.../pinot/common/utils/ServiceStartableUtils.java | 16 +-
.../apache/pinot/common/utils/ServiceStatus.java | 54 +-
.../pinot/common/utils/SimpleHttpErrorInfo.java | 4 +-
.../pinot/common/utils/TarCompressionUtils.java | 57 +-
.../apache/pinot/common/utils/ThrottledLogger.java | 21 +-
.../java/org/apache/pinot/common/utils/Timer.java | 20 +-
.../org/apache/pinot/common/utils/URIUtils.java | 38 +-
.../common/utils/UploadedRealtimeSegmentName.java | 69 +-
.../pinot/common/utils/WorkloadBudgetUtils.java | 162 +-
.../org/apache/pinot/common/utils/ZkStarter.java | 32 +-
.../utils/config/AccessControlUserConfigUtils.java | 8 +-
.../pinot/common/utils/config/InstanceUtils.java | 44 +-
.../common/utils/config/QueryOptionsUtils.java | 56 +-
.../utils/config/QueryWorkloadConfigUtils.java | 86 +-
.../common/utils/config/SchemaSerDeUtils.java | 8 +-
.../pinot/common/utils/config/TagNameUtils.java | 85 +-
.../pinot/common/utils/config/TierConfigUtils.java | 33 +-
.../common/utils/fetcher/BaseSegmentFetcher.java | 35 +-
.../pinot/common/utils/fetcher/SegmentFetcher.java | 30 +-
.../utils/fetcher/SegmentFetcherFactory.java | 48 +-
.../common/utils/grpc/BaseGrpcQueryClient.java | 6 +-
.../common/utils/helix/FakePropertyStore.java | 20 +-
.../pinot/common/utils/helix/HelixHelper.java | 253 ++--
.../common/utils/helix/IdealStateGroupCommit.java | 54 +-
.../common/utils/helix/IdealStateSingleCommit.java | 4 +-
.../common/utils/helix/LeadControllerUtils.java | 44 +-
.../common/utils/helix/ZkMultiWriteBuilder.java | 100 +-
.../apache/pinot/common/utils/http/HttpClient.java | 138 +-
.../pinot/common/utils/http/HttpClientConfig.java | 10 +-
.../pinot/common/utils/log/DummyLogFileServer.java | 4 +-
.../pinot/common/utils/log/LocalLogFileServer.java | 4 +-
.../pinot/common/utils/log/LogFileServer.java | 20 +-
.../apache/pinot/common/utils/regex/Matcher.java | 10 +-
.../apache/pinot/common/utils/regex/Pattern.java | 10 +-
.../pinot/common/utils/regex/PatternFactory.java | 30 +-
.../utils/request/QueryFingerprintVisitor.java | 112 +-
.../pinot/common/utils/request/RequestUtils.java | 42 +-
.../common/utils/tls/JvmDefaultSslContext.java | 28 +-
.../pinot/common/utils/tls/PinotInsecureMode.java | 6 +-
.../pinot/common/utils/tls/RenewableTlsUtils.java | 70 +-
.../apache/pinot/common/utils/tls/TlsUtils.java | 185 +--
.../apache/pinot/common/version/PinotVersion.java | 22 +-
.../common/workload/WorkloadChangeListener.java | 30 +-
.../main/java/org/apache/pinot/sql/FilterKind.java | 8 +-
.../apache/pinot/sql/parsers/CalciteSqlParser.java | 22 +-
.../org/apache/pinot/sql/parsers/ParserUtils.java | 18 +-
.../pinot/sql/parsers/SqlCompilationException.java | 4 +-
.../sql/parsers/dml/DataManipulationStatement.java | 32 +-
.../sql/parsers/parser/SqlInsertFromFile.java | 9 +-
.../sql/parsers/parser/SqlPhysicalExplain.java | 8 +-
.../sql/parsers/parser/TableNameExtractor.java | 50 +-
.../pinot/sql/parsers/parser/UnparseUtils.java | 10 +-
.../sql/parsers/rewriter/AggregationOptimizer.java | 150 +-
.../parsers/rewriter/CastTypeAliasRewriter.java | 1 -
.../pinot/sql/parsers/rewriter/ClpRewriter.java | 204 ++-
.../sql/parsers/rewriter/ExprMinMaxRewriter.java | 66 +-
...nAggregationGroupByToDistinctQueryRewriter.java | 30 +-
.../rewriter/PredicateComparisonRewriter.java | 66 +-
.../pinot/sql/parsers/rewriter/QueryRewriter.java | 6 +-
.../sql/parsers/rewriter/RlsFiltersRewriter.java | 37 +-
.../pinot/common/audit/AuditConfigManagerTest.java | 6 +-
.../pinot/common/audit/AuditLogFilterTest.java | 4 +-
.../pinot/common/audit/AuditMetricsTest.java | 10 +-
.../common/audit/AuditRequestProcessorTest.java | 4 +-
.../pinot/common/audit/AuditUrlPathFilterTest.java | 6 +-
.../pinot/common/audit/MockAuditTokenResolver.java | 31 +-
.../common/cursors/AbstractResponseStoreTest.java | 4 +-
.../function/DateTimePatternHandlerTest.java | 14 +-
.../common/function/FastJsonPathExtractorTest.java | 34 +-
.../pinot/common/function/FunctionUtilsTest.java | 8 +-
.../pinot/common/function/JsonFunctionsTest.java | 20 +-
.../function/scalar/ArithmeticFunctionsTest.java | 4 +-
.../function/scalar/IpAddressFunctionsTest.java | 4 +-
.../function/scalar/JsonFunctionsUtilTest.java | 4 +-
.../function/scalar/LogicalFunctionsTest.java | 4 +-
.../scalar/TrigonometricFunctionsTest.java | 4 +-
.../arithmetic/ArithmeticFunctionUtilsTest.java | 8 +-
.../arithmetic/ArithmeticScalarFunctionTest.java | 24 +-
.../function/test/MutableStringTestFunction.java | 4 +-
.../MaterializedViewAggregationCatalogTest.java | 6 +-
.../metadata/MetadataEqualsHashCodeTest.java | 5 +-
.../RealtimeToOfflineSegmentsTaskMetadataTest.java | 4 +-
.../pinot/common/metrics/AbstractMetricsTest.java | 41 +-
.../pinot/common/metrics/BrokerMetricsTest.java | 4 +-
.../pinot/common/metrics/MetricValueUtils.java | 12 +-
.../pinot/common/metrics/MetricsInspector.java | 45 +-
.../pinot/common/metrics/MseMetricsTest.java | 6 +-
.../prometheus/PinotPrometheusMetricsTest.java | 54 +-
.../prometheus/PrometheusTemplateRegexpTest.java | 92 +-
.../common/minion/MinionTaskMetadataUtilsTest.java | 4 +-
.../partition/function/PartitionFunctionTest.java | 81 +-
.../VectorSimilarityRadiusPredicateTest.java | 4 +-
.../pinot/common/tier/TierConfigUtilsTest.java | 12 +-
.../utils/DefaultLogicalTableConfigSerDeTest.java | 6 +-
.../pinot/common/utils/FALFInternerTest.java | 6 +-
.../pinot/common/utils/LLCSegmentNameTest.java | 4 +-
.../apache/pinot/common/utils/RateLimiterTest.java | 4 +-
.../utils/RegexpPatternConverterUtilsTest.java | 4 +-
.../pinot/common/utils/ServiceStatusTest.java | 4 +-
.../apache/pinot/common/utils/StringUtilTest.java | 4 +-
.../org/apache/pinot/common/utils/UtilsTest.java | 4 +-
.../utils/fetcher/PinotFSSegmentFetcherTest.java | 4 +-
.../utils/request/QueryFingerprintUtilsTest.java | 48 +-
.../utils/request/QueryFingerprintVisitorTest.java | 4 +-
.../common/utils/tls/RenewableTlsUtilsTest.java | 14 +-
.../fake/FakeMetricsAbstractMetricsTest.java | 6 +-
.../plugin/metrics/fake/FakeMetricsFactory.java | 6 +-
.../metrics/fake/FakePinotMetricsRegistry.java | 10 +-
.../pinot/plugin/metrics/fake/FakePinotTimer.java | 2 +-
.../pinot/sql/parsers/CalciteSqlCompilerTest.java | 21 +-
.../pinot/sql/parsers/CalciteSqlParserTest.java | 2 -
.../parsers/CalciteSqlParserVectorRadiusTest.java | 6 +-
.../pinot/sql/parsers/GroupingSetsParserTest.java | 6 +-
.../sql/parsers/parser/TableNameExtractorTest.java | 46 +-
.../parsers/rewriter/AggregationOptimizerTest.java | 20 +-
.../rewriter/CastTypeAliasRewriterTest.java | 44 +-
.../sql/parsers/rewriter/ClpRewriterTest.java | 26 +-
.../test/java/org/apache/pinot/util/TestUtils.java | 59 +-
.../main/java/org/apache/pinot/compat/QueryOp.java | 12 +-
.../java/org/apache/pinot/compat/SegmentOp.java | 98 +-
.../java/org/apache/pinot/compat/StreamOp.java | 18 +-
.../main/java/org/apache/pinot/compat/TableOp.java | 20 +-
.../main/java/org/apache/pinot/compat/Utils.java | 14 +-
.../pinot/connector/flink/FlinkQuickStart.java | 8 +-
.../flink/common/FlinkRowGenericRowConverter.java | 2 +-
.../flink/common/PinotGenericRowConverter.java | 28 +-
.../connector/flink/sink/FlinkSegmentWriter.java | 42 +-
.../pinot/connector/flink/sink/PinotSink.java | 34 +-
.../connector/flink/sink/PinotSinkFunction.java | 14 +-
.../spark/common/CaseInsensitiveStringMap.java | 48 +-
.../pinot/controller/BaseControllerStarter.java | 58 +-
.../apache/pinot/controller/ControllerConf.java | 88 +-
.../apache/pinot/controller/ControllerStarter.java | 4 +-
...ControllerUserDefinedMessageHandlerFactory.java | 6 +-
.../pinot/controller/LeadControllerManager.java | 64 +-
.../api/ControllerAdminApiApplication.java | 12 +-
.../pinot/controller/api/access/AccessControl.java | 56 +-
.../api/access/AccessControlFactory.java | 16 +-
.../controller/api/access/AccessControlUtils.java | 20 +-
.../pinot/controller/api/access/AccessType.java | 4 +-
.../pinot/controller/api/access/Authenticate.java | 6 +-
.../api/access/AuthenticationFilter.java | 6 +-
.../api/access/BasicAuthAccessControlFactory.java | 28 +-
.../access/ZkBasicAuthAccessControlFactory.java | 19 +-
.../pinot/controller/api/debug/TableDebugInfo.java | 39 +-
.../pinot/controller/api/dto/package-info.java | 33 +-
.../api/resources/ControllerFilePathProvider.java | 6 +-
.../controller/api/resources/CopyTablePayload.java | 18 +-
.../controller/api/resources/DebugResource.java | 102 +-
.../InflightRequestMetricsInterceptor.java | 14 +-
.../resources/LLCSegmentCompletionHandlers.java | 20 +-
.../api/resources/MinionStatusResponse.java | 10 +-
.../PinotAccessControlUserRestletResource.java | 43 +-
.../PinotApplicationQuotaRestletResource.java | 12 +-
.../api/resources/PinotControllerAppConfigs.java | 6 +-
.../api/resources/PinotControllerAuthResource.java | 42 +-
.../api/resources/PinotControllerLogger.java | 4 +-
.../resources/PinotDatabaseRestletResource.java | 12 +-
.../resources/PinotIngestionRestletResource.java | 97 +-
.../PinotInstanceAssignmentRestletResource.java | 12 +-
.../resources/PinotInstanceRestletResource.java | 49 +-
.../api/resources/PinotMinionRestletResource.java | 4 +-
.../PinotQueryWorkloadRestletResource.java | 416 +++---
.../api/resources/PinotSchemaRestletResource.java | 54 +-
.../api/resources/PinotSegmentRestletResource.java | 183 +--
.../api/resources/PinotTableReloadResource.java | 27 +-
.../api/resources/PinotTableRestletResource.java | 72 +-
.../api/resources/PinotTaskRestletResource.java | 36 +-
.../api/resources/PinotTenantRestletResource.java | 50 +-
.../api/resources/PinotUpsertRestletResource.java | 46 +-
.../api/resources/PinotVersionRestletResource.java | 4 +-
.../controller/api/resources/ResourceUtils.java | 36 +-
.../api/resources/SegmentStatusInfo.java | 5 +-
.../api/resources/ServerTableSizeReader.java | 6 +-
.../api/resources/TableAndSchemaConfig.java | 7 +-
.../api/resources/TableConfigValidationUtils.java | 44 +-
.../api/resources/TableConfigsRestletResource.java | 70 +-
.../pinot/controller/api/resources/TableViews.java | 4 +-
.../api/resources/TrackInflightRequestMetrics.java | 8 +-
.../controller/api/resources/TrackedByGauge.java | 8 +-
.../api/resources/ddl/DdlExecutionResponse.java | 2 +-
.../controller/api/upload/SegmentMetadataInfo.java | 16 +-
.../api/upload/SegmentUploadMetadata.java | 26 +-
.../api/upload/SegmentValidationUtils.java | 4 +-
.../pinot/controller/api/upload/ZKOperator.java | 37 +-
.../controller/helix/SegmentStatusChecker.java | 40 +-
...erResourceOnlineOfflineStateModelGenerator.java | 24 +-
.../helix/core/PinotHelixResourceManager.java | 1551 ++++++++------------
...lixSegmentOnlineOfflineStateModelGenerator.java | 13 +-
.../helix/core/PinotTableIdealStateBuilder.java | 72 +-
.../helix/core/SegmentDeletionManager.java | 44 +-
.../helix/core/WatermarkInductionResult.java | 68 +-
.../instance/FDAwareInstancePartitionSelector.java | 37 +-
.../HashBasedRotateInstanceConstraintApplier.java | 6 +-
.../ImplicitRealtimeTablePartitionSelector.java | 6 +-
.../instance/InstanceAssignmentDriver.java | 16 +-
.../instance/InstanceConstraintApplier.java | 12 +-
.../instance/InstancePartitionSelector.java | 6 +-
.../InstanceReplicaGroupPartitionSelector.java | 16 +-
.../instance/InstanceTagPoolSelector.java | 8 +-
.../MirrorServerSetInstancePartitionSelector.java | 32 +-
.../assignment/segment/BaseSegmentAssignment.java | 51 +-
.../BaseStrictRealtimeSegmentAssignment.java | 61 +-
.../MultiTierStrictRealtimeSegmentAssignment.java | 18 +-
.../segment/OfflineSegmentAssignment.java | 4 +-
.../segment/RealtimeSegmentAssignment.java | 55 +-
.../core/assignment/segment/SegmentAssignment.java | 44 +-
.../segment/SegmentAssignmentFactory.java | 4 +-
.../assignment/segment/SegmentAssignmentUtils.java | 130 +-
.../SingleTierStrictRealtimeSegmentAssignment.java | 10 +-
.../AllServersSegmentAssignmentStrategy.java | 17 +-
.../BalancedNumSegmentAssignmentStrategy.java | 10 +-
.../ReplicaGroupSegmentAssignmentStrategy.java | 16 +-
...RobinReplicaGroupSegmentAssignmentStrategy.java | 39 +-
.../RoundRobinSegmentAssignmentStrategy.java | 36 +-
.../strategy/SegmentAssignmentStrategy.java | 48 +-
.../strategy/SegmentAssignmentStrategyFactory.java | 8 +-
.../core/cleanup/StaleInstancesCleanupTask.java | 17 +-
.../core/controllerjob/ControllerJobTypes.java | 4 +-
.../helix/core/lineage/DefaultLineageManager.java | 34 +-
.../helix/core/lineage/LineageManager.java | 54 +-
.../helix/core/lineage/LineageManagerFactory.java | 4 +-
.../helix/core/minion/ClusterInfoAccessor.java | 172 +--
.../core/minion/DistributedTaskLockManager.java | 96 +-
.../core/minion/PinotHelixTaskResourceManager.java | 698 ++++-----
.../helix/core/minion/PinotTaskManager.java | 166 +--
.../helix/core/minion/TaskMetricsEmitter.java | 10 +-
.../helix/core/minion/TaskSchedulingContext.java | 99 +-
.../core/minion/generator/BaseTaskGenerator.java | 52 +-
.../core/minion/generator/PinotTaskGenerator.java | 92 +-
.../minion/generator/TaskGeneratorRegistry.java | 28 +-
.../core/minion/generator/TaskGeneratorUtils.java | 62 +-
.../core/periodictask/ControllerPeriodicTask.java | 78 +-
.../RealtimeOffsetAutoResetHandler.java | 24 +-
.../RealtimeOffsetAutoResetKafkaHandler.java | 54 +-
.../realtime/BlockingSegmentCompletionFSM.java | 87 +-
.../realtime/MissingConsumingSegmentFinder.java | 12 +-
.../realtime/PinotLLCRealtimeSegmentManager.java | 475 +++---
.../helix/core/realtime/SegmentCompletionFSM.java | 176 +--
.../core/realtime/SegmentCompletionFSMFactory.java | 50 +-
.../core/realtime/SegmentCompletionManager.java | 64 +-
.../segment/CommittingSegmentDescriptor.java | 4 +-
.../segment/DefaultFlushThresholdUpdater.java | 6 +-
.../segment/FlushThresholdUpdateManager.java | 32 +-
.../realtime/segment/FlushThresholdUpdater.java | 12 +-
.../SegmentSizeBasedFlushThresholdUpdater.java | 14 +-
.../SizeBasedSegmentFlushThresholdComputer.java | 22 +-
.../core/rebalance/DefaultRebalancePreChecker.java | 26 +-
.../core/rebalance/NoOpTableRebalanceObserver.java | 4 +-
.../helix/core/rebalance/RebalanceChecker.java | 26 +-
.../helix/core/rebalance/RebalancePreChecker.java | 6 +-
.../core/rebalance/TableRebalanceManager.java | 140 +-
.../core/rebalance/TableRebalanceObserver.java | 8 +-
.../helix/core/rebalance/TableRebalancer.java | 288 ++--
.../rebalance/ZkBasedTableRebalanceObserver.java | 79 +-
.../rebalance/tenant/TenantRebalanceChecker.java | 100 +-
.../rebalance/tenant/TenantRebalanceContext.java | 8 +-
.../core/rebalance/tenant/TenantRebalancer.java | 44 +-
.../tenant/TenantTableWithProperties.java | 10 +-
.../tenant/ZkBasedTenantRebalanceObserver.java | 14 +-
.../helix/core/relocation/SegmentRelocator.java | 8 +-
.../helix/core/retention/RetentionManager.java | 53 +-
.../core/retention/TableConfigRetentionUtils.java | 4 +-
.../core/retention/strategy/RetentionStrategy.java | 32 +-
.../retention/strategy/TimeRetentionStrategy.java | 4 +-
.../helix/core/util/ControllerZkHelixUtils.java | 44 +-
.../helix/core/util/HelixSetupUtils.java | 22 +-
.../controller/recommender/RecommenderDriver.java | 8 +-
.../recommender/data/generator/BytesGenerator.java | 4 +-
.../recommender/data/generator/DataGenerator.java | 4 +-
.../recommender/data/generator/Generator.java | 4 +-
.../data/generator/MultiValueGeneratorHelper.java | 18 +-
.../data/generator/NumberGenerator.java | 4 +-
.../data/generator/PatternMixtureGenerator.java | 39 +-
.../data/generator/PatternSeasonalGenerator.java | 40 +-
.../data/generator/PatternSequenceGenerator.java | 36 +-
.../data/generator/PatternSpikeGenerator.java | 38 +-
.../data/generator/PatternStringGenerator.java | 34 +-
.../recommender/data/generator/PatternType.java | 10 +-
.../data/generator/StringGenerator.java | 4 +-
.../recommender/data/generator/TimeGenerator.java | 4 +-
.../controller/recommender/data/writer/Writer.java | 30 +-
.../exceptions/InvalidInputException.java | 4 +-
.../controller/recommender/io/ConfigManager.java | 18 +-
.../controller/recommender/io/InputManager.java | 56 +-
.../io/metadata/DateTimeFieldSpecMetadata.java | 11 +-
.../recommender/io/metadata/FieldMetadata.java | 6 +-
.../io/metadata/SchemaWithMetaData.java | 6 +-
.../realtime/provisioning/MemoryEstimator.java | 169 +--
.../controller/recommender/rules/AbstractRule.java | 11 +-
.../recommender/rules/RulesToExecute.java | 10 +-
.../rules/impl/AggregateMetricsRule.java | 10 +-
.../recommender/rules/impl/BloomFilterRule.java | 18 +-
.../recommender/rules/impl/FlagQueryRule.java | 10 +-
.../rules/impl/InvertedSortedIndexJointRule.java | 42 +-
.../recommender/rules/impl/JsonIndexRule.java | 2 +-
.../recommender/rules/impl/KafkaPartitionRule.java | 8 +-
.../NoDictionaryOnHeapDictionaryJointRule.java | 28 +-
.../rules/impl/PinotTablePartitionRule.java | 40 +-
.../recommender/rules/impl/RangeIndexRule.java | 14 +-
.../rules/impl/RealtimeProvisioningRule.java | 26 +-
.../recommender/rules/impl/SegmentSizeRule.java | 59 +-
.../rules/impl/VariedLengthDictionaryRule.java | 4 +-
.../recommender/rules/io/FlaggedQueries.java | 4 +-
.../recommender/rules/io/configs/IndexConfig.java | 6 +-
.../rules/io/configs/PartitionConfig.java | 4 +-
.../io/configs/SegmentSizeRecommendations.java | 4 +-
.../rules/io/params/BloomFilterRuleParams.java | 4 +-
.../rules/io/params/FlagQueryRuleParams.java | 4 +-
.../params/InvertedSortedIndexJointRuleParams.java | 4 +-
...oDictionaryOnHeapDictionaryJointRuleParams.java | 4 +-
.../rules/io/params/PartitionRuleParams.java | 4 +-
.../rules/io/params/RangeIndexRuleParams.java | 4 +-
.../io/params/RealtimeProvisioningRuleParams.java | 4 +-
.../rules/io/params/RecommenderConstants.java | 6 +-
.../rules/io/params/SegmentSizeRuleParams.java | 4 +-
.../recommender/rules/utils/FixedLenBitset.java | 47 +-
.../rules/utils/PredicateParseResult.java | 4 +-
.../utils/QueryInvertedSortedIndexRecommender.java | 109 +-
.../services/PinotTableReloadService.java | 14 +-
.../services/PinotTableReloadStatusReporter.java | 10 +-
.../controller/tuner/RealTimeAutoIndexTuner.java | 10 +-
.../pinot/controller/tuner/TableConfigTuner.java | 34 +-
.../controller/tuner/TableConfigTunerRegistry.java | 20 +-
.../controller/tuner/TableConfigTunerUtils.java | 8 +-
.../org/apache/pinot/controller/tuner/Tuner.java | 14 +-
.../controller/util/AutoAddInvertedIndex.java | 46 +-
.../pinot/controller/util/BrokerServiceHelper.java | 4 +-
.../controller/util/CompletionServiceHelper.java | 72 +-
.../util/ConsumingSegmentInfoReader.java | 38 +-
.../pinot/controller/util/FileIngestionHelper.java | 26 +-
.../controller/util/SegmentIntervalUtils.java | 20 +-
.../controller/util/ServerQueryInfoFetcher.java | 6 +-
.../util/ServerSegmentMetadataReader.java | 94 +-
.../controller/util/ServerTableTierReader.java | 6 +-
.../util/TableIngestionStatusHelper.java | 4 +-
.../pinot/controller/util/TableMetadataReader.java | 48 +-
.../controller/util/TableRetentionValidator.java | 32 +-
.../pinot/controller/util/TableSizeReader.java | 4 +-
.../pinot/controller/util/TableTierReader.java | 18 +-
.../BrokerResourceValidationManager.java | 4 +-
.../validation/DiskUtilizationChecker.java | 8 +-
.../OfflineSegmentValidationManager.java | 39 +-
.../validation/RealtimeOffsetAutoResetManager.java | 4 +-
.../RealtimeSegmentValidationManager.java | 15 +-
.../validation/ResourceUtilizationChecker.java | 8 +-
.../validation/ResourceUtilizationInfo.java | 6 +-
.../validation/ResourceUtilizationManager.java | 14 +-
.../controller/validation/StorageQuotaChecker.java | 15 +-
.../controller/validation/UtilizationChecker.java | 32 +-
.../controller/workload/QueryWorkloadManager.java | 193 +--
.../controller/workload/QueryWorkloadRequest.java | 40 +-
.../workload/WorkloadPropagationClient.java | 42 +-
.../workload/scheme/PropagationScheme.java | 31 +-
.../workload/scheme/PropagationUtils.java | 168 +--
.../workload/scheme/TablePropagationScheme.java | 76 +-
.../workload/scheme/TenantPropagationScheme.java | 10 +-
.../controller/workload/splitter/CostSplitter.java | 18 +-
.../pinot/controller/ControllerConfTest.java | 6 +-
.../ControllerStarterDynamicEnvTest.java | 4 +-
.../pinot/controller/ControllerTestSetup.java | 26 +-
.../ConsumingSegmentInfoReaderStatelessTest.java | 28 +-
.../api/PinotControllerAppConfigsTest.java | 10 +-
.../pinot/controller/api/PinotFileUploadTest.java | 4 +-
...PinotIngestionRestletResourceStatelessTest.java | 5 +-
.../api/PinotInstanceRestletResourceTest.java | 4 +-
.../api/PinotTableRestletResourceTest.java | 72 +-
.../api/TableConfigsRestletResourceTest.java | 12 +-
...inotDummyExtraRestletResourceStatelessTest.java | 4 +-
.../PinotQueryResourceStaticValidationTest.java | 4 +-
.../api/resources/ResourceUtilsTest.java | 4 +-
...ControllerPeriodicTaskStarterStatelessTest.java | 4 +-
.../pinot/controller/helix/ControllerTest.java | 110 +-
.../pinot/controller/helix/HelixHelperTest.java | 8 +-
.../helix/IdealStateGroupCommitTest.java | 106 +-
.../controller/helix/PinotResourceManagerTest.java | 10 +-
...notHelixResourceManagerLastLLCSegmentsTest.java | 8 +-
...esourceManagerMaterializedViewBackfillTest.java | 6 +-
...ResourceManagerMaterializedViewListingTest.java | 2 +-
.../PinotHelixResourceManagerMinionDrainTest.java | 10 +-
.../PinotHelixResourceManagerMinionStatusTest.java | 12 +-
.../PinotHelixResourceManagerStatelessTest.java | 26 +-
.../instance/InstanceAssignmentTest.java | 66 +-
...NonReplicaGroupTieredSegmentAssignmentTest.java | 26 +-
...NonReplicaGroupTieredSegmentAssignmentTest.java | 16 +-
.../RealtimeReplicaGroupSegmentAssignmentTest.java | 61 +-
.../segment/SegmentAssignmentTestUtils.java | 4 +-
.../StrictRealtimeSegmentAssignmentTest.java | 16 +-
.../SegmentAssignmentStrategyFactoryTest.java | 4 +-
.../cleanup/StaleInstancesCleanupTaskTest.java | 30 +-
.../core/lineage/LineageDeleteExclusionTest.java | 18 +-
.../LineageDeleteInterleavingIntegrationTest.java | 37 +-
.../minion/PinotHelixTaskResourceManagerTest.java | 4 +-
...ManagerConcurrentSchedulingIntegrationTest.java | 62 +-
.../PinotTaskManagerConcurrentSchedulingTest.java | 12 +-
.../PinotTaskManagerDistributedLockingTest.java | 66 +-
.../helix/core/minion/TaskMetricsEmitterTest.java | 52 +-
.../minion/generator/TaskGeneratorUtilsTest.java | 4 +-
.../PinotLLCRealtimeSegmentManagerTest.java | 134 +-
.../segment/FlushThresholdUpdaterTest.java | 16 +-
.../helix/core/retention/RetentionManagerTest.java | 8 +-
.../strategy/TimeRetentionStrategyTest.java | 4 +-
.../controller/recommender/TestConfigEngine.java | 2 +-
.../services/PinotTableReloadServiceTest.java | 4 +-
.../pinot/controller/util/JsonSerializerTest.java | 4 +-
.../controller/util/ListenerConfigUtilTest.java | 42 +-
.../pinot/controller/utils/FakeHttpServer.java | 4 +-
.../BrokerResourceValidationManagerTest.java | 14 +-
.../RealtimeOffsetAutoResetManagerTest.java | 10 +-
.../validation/ValidationManagerStatelessTest.java | 10 +-
.../validation/ValidationManagerTest.java | 4 +-
.../HeapUsagePublishingAccountantFactory.java | 4 +-
.../PerQueryCPUMemAccountantFactory.java | 40 +-
.../pinot/core/accounting/QueryMonitorConfig.java | 14 +-
.../core/accounting/QueryResourceAggregator.java | 30 +-
.../core/api/ServiceAutoDiscoveryFeature.java | 71 +-
.../java/org/apache/pinot/core/auth/Actions.java | 6 +-
.../java/org/apache/pinot/core/auth/Authorize.java | 6 +-
.../apache/pinot/core/auth/BasicAuthPrincipal.java | 20 +-
.../pinot/core/auth/BasicAuthPrincipalUtils.java | 40 +-
.../pinot/core/auth/FineGrainedAccessControl.java | 62 +-
.../pinot/core/auth/FineGrainedAuthUtils.java | 48 +-
.../pinot/core/auth/ManualAuthorization.java | 8 +-
.../org/apache/pinot/core/auth/TargetType.java | 4 +-
.../pinot/core/auth/ZkBasicAuthPrincipal.java | 4 +-
.../java/org/apache/pinot/core/common/Block.java | 6 +-
.../pinot/core/common/BlockDocIdIterator.java | 43 +-
.../apache/pinot/core/common/BlockDocIdSet.java | 28 +-
.../org/apache/pinot/core/common/BlockValSet.java | 196 +--
.../apache/pinot/core/common/DataBlockCache.java | 218 ++-
.../org/apache/pinot/core/common/DataFetcher.java | 286 ++--
.../pinot/core/common/ExplainPlanRowData.java | 4 +-
.../apache/pinot/core/common/ExplainPlanRows.java | 4 +-
.../apache/pinot/core/common/MinionConstants.java | 172 +--
.../apache/pinot/core/common/ObjectSerDeUtils.java | 32 +-
.../org/apache/pinot/core/common/Operator.java | 94 +-
.../common/datatable/BaseDataTableBuilder.java | 4 +-
.../core/common/datatable/DataTableBuilder.java | 33 +-
.../common/datatable/DataTableBuilderFactory.java | 4 +-
.../common/datatable/DataTableBuilderUtils.java | 14 +-
.../core/data/manager/BaseTableDataManager.java | 131 +-
.../core/data/manager/DuoSegmentDataManager.java | 10 +-
.../core/data/manager/InstanceDataManager.java | 162 +-
.../manager/SegmentOperationsExecutorService.java | 4 +-
.../data/manager/SegmentOperationsTaskContext.java | 12 +-
.../data/manager/SegmentOperationsTaskType.java | 18 +-
.../core/data/manager/offline/DimensionTable.java | 10 +-
.../manager/offline/DimensionTableDataManager.java | 28 +-
.../manager/offline/FastLookupDimensionTable.java | 4 +-
.../offline/ImmutableSegmentDataManager.java | 4 +-
.../manager/offline/OfflineTableDataManager.java | 4 +-
.../provider/DefaultTableDataManagerProvider.java | 4 +-
.../manager/provider/TableDataManagerProvider.java | 8 +-
.../data/manager/realtime/ConsumerCoordinator.java | 56 +-
.../core/data/manager/realtime/IdleTimer.java | 10 +-
.../manager/realtime/IngestionDelayTracker.java | 260 ++--
.../realtime/PauselessSegmentCommitter.java | 34 +-
.../manager/realtime/PinotFSSegmentUploader.java | 8 +-
.../realtime/RealtimeConsumptionRateManager.java | 92 +-
.../realtime/RealtimeSegmentDataManager.java | 124 +-
.../realtime/RealtimeSegmentMetadataUtils.java | 22 +-
.../manager/realtime/RealtimeTableDataManager.java | 138 +-
.../realtime/SegmentBuildTimeLeaseExtender.java | 22 +-
.../data/manager/realtime/SegmentCommitter.java | 12 +-
.../manager/realtime/SegmentCommitterFactory.java | 4 +-
.../manager/realtime/SegmentCompletionUtils.java | 10 +-
.../data/manager/realtime/SegmentUploader.java | 10 +-
.../manager/realtime/SplitSegmentCommitter.java | 6 +-
.../apache/pinot/core/data/table/BaseTable.java | 4 +-
.../core/data/table/ConcurrentIndexedTable.java | 8 +-
.../table/DeterministicConcurrentIndexedTable.java | 4 +-
.../apache/pinot/core/data/table/IndexedTable.java | 36 +-
.../pinot/core/data/table/IntermediateRecord.java | 8 +-
.../java/org/apache/pinot/core/data/table/Key.java | 29 +-
.../org/apache/pinot/core/data/table/Record.java | 41 +-
.../pinot/core/data/table/SimpleIndexedTable.java | 8 +-
.../pinot/core/data/table/SortedRecordTable.java | 10 +-
.../org/apache/pinot/core/data/table/Table.java | 42 +-
.../apache/pinot/core/data/table/TableResizer.java | 88 +-
.../table/UnboundedConcurrentIndexedTable.java | 20 +-
.../ThrottleOnCriticalHeapUsageExecutor.java | 100 +-
.../function/scalar/FilterMvScalarFunction.java | 12 +-
.../core/function/scalar/SketchFunctions.java | 208 ++-
.../function/BaseBinaryGeoTransformFunction.java | 4 +-
.../function/ConstructFromGeoJsonFunction.java | 4 +-
.../function/ConstructFromTextFunction.java | 4 +-
.../function/ConstructFromWKBFunction.java | 4 +-
.../transform/function/GeoToH3Function.java | 8 +-
.../transform/function/GridDiskFunction.java | 8 +-
.../transform/function/GridDistanceFunction.java | 8 +-
.../transform/function/ScalarFunctions.java | 150 +-
.../transform/function/StAreaFunction.java | 8 +-
.../transform/function/StAsBinaryFunction.java | 4 +-
.../transform/function/StAsGeoJsonFunction.java | 4 +-
.../transform/function/StAsTextFunction.java | 4 +-
.../transform/function/StContainsFunction.java | 8 +-
.../transform/function/StDistanceFunction.java | 19 +-
.../transform/function/StEqualsFunction.java | 4 +-
.../function/StGeogFromGeoJsonFunction.java | 4 +-
.../transform/function/StGeogFromTextFunction.java | 4 +-
.../transform/function/StGeogFromWKBFunction.java | 4 +-
.../function/StGeomFromGeoJsonFunction.java | 4 +-
.../transform/function/StGeomFromTextFunction.java | 4 +-
.../transform/function/StGeomFromWKBFunction.java | 4 +-
.../transform/function/StGeometryTypeFunction.java | 4 +-
.../transform/function/StPointFunction.java | 4 +-
.../transform/function/StPolygonFunction.java | 4 +-
.../transform/function/StWithinFunction.java | 6 +-
.../transform/function/StringBuilderWriter.java | 6 +-
.../transform/function/StringReader.java | 12 +-
.../pinot/core/instance/context/BrokerContext.java | 4 +-
.../core/instance/context/ControllerContext.java | 4 +-
.../pinot/core/instance/context/ServerContext.java | 4 +-
.../core/metadata/DefaultMetadataExtractor.java | 6 +-
.../pinot/core/metadata/MetadataExtractor.java | 18 +-
.../core/metadata/MetadataExtractorFactory.java | 6 +-
.../apache/pinot/core/minion/SegmentPurger.java | 42 +-
.../AcquireReleaseColumnsSegmentOperator.java | 30 +-
.../apache/pinot/core/operator/BaseOperator.java | 4 +-
.../pinot/core/operator/BaseProjectOperator.java | 24 +-
.../core/operator/BitmapDocIdSetOperator.java | 9 +-
.../apache/pinot/core/operator/ColumnContext.java | 14 +-
.../pinot/core/operator/DocIdSetOperator.java | 11 +-
.../pinot/core/operator/ExecutionStatistics.java | 4 +-
.../core/operator/ExplainAttributeBuilder.java | 4 +-
.../core/operator/ProjectionOperatorUtils.java | 4 +-
.../pinot/core/operator/blocks/DocIdSetBlock.java | 18 +-
.../pinot/core/operator/blocks/FilterBlock.java | 8 +-
.../operator/blocks/InstanceResponseBlock.java | 8 +-
.../core/operator/blocks/ProjectionBlock.java | 6 +-
.../pinot/core/operator/blocks/TransformBlock.java | 4 +-
.../pinot/core/operator/blocks/ValueBlock.java | 24 +-
.../blocks/results/AggregationResultsBlock.java | 4 +-
.../operator/blocks/results/BaseResultsBlock.java | 32 +-
.../blocks/results/DistinctResultsBlock.java | 4 +-
.../blocks/results/ExplainResultsBlock.java | 4 +-
.../blocks/results/GroupByResultsBlock.java | 20 +-
.../blocks/results/SelectionResultsBlock.java | 4 +-
.../combine/AggregationCombineOperator.java | 4 +-
.../core/operator/combine/BaseCombineOperator.java | 20 +-
.../combine/BaseSingleBlockCombineOperator.java | 15 +-
.../operator/combine/DistinctCombineOperator.java | 4 +-
.../operator/combine/GroupByCombineOperator.java | 33 +-
...xValueBasedSelectionOrderByCombineOperator.java | 49 +-
.../combine/SelectionOnlyCombineOperator.java | 13 +-
.../combine/SelectionOrderByCombineOperator.java | 13 +-
.../SequentialSortedGroupByCombineOperator.java | 38 +-
.../combine/SortedGroupByCombineOperator.java | 51 +-
.../combine/merger/ResultsBlockMerger.java | 28 +-
.../operator/dociditerators/AndDocIdIterator.java | 9 +-
.../dociditerators/BitmapBasedDocIdIterator.java | 8 +-
.../dociditerators/BitmapDocIdIterator.java | 4 +-
.../dociditerators/EmptyDocIdIterator.java | 6 +-
.../ExpressionScanDocIdIterator.java | 10 +-
.../dociditerators/MVScanDocIdIterator.java | 16 +-
.../dociditerators/MatchAllDocIdIterator.java | 4 +-
.../operator/dociditerators/NotDocIdIterator.java | 6 +-
.../operator/dociditerators/OrDocIdIterator.java | 40 +-
.../RangelessBitmapDocIdIterator.java | 8 +-
.../dociditerators/SVScanDocIdIterator.java | 26 +-
.../dociditerators/ScanBasedDocIdIterator.java | 33 +-
.../dociditerators/SortedDocIdIterator.java | 6 +-
.../pinot/core/operator/docidsets/AndDocIdSet.java | 28 +-
.../core/operator/docidsets/EmptyDocIdSet.java | 4 +-
.../pinot/core/operator/docidsets/OrDocIdSet.java | 26 +-
.../docidsets/ShortCircuitingDocIdSet.java | 8 +-
.../core/operator/docvalsets/DataBlockValSet.java | 12 +-
.../docvalsets/FilteredDataBlockValSet.java | 16 +-
.../docvalsets/FilteredRowBasedBlockValSet.java | 8 +-
.../operator/docvalsets/ProjectionBlockValSet.java | 33 +-
.../operator/docvalsets/RowBasedBlockValSet.java | 8 +-
.../operator/docvalsets/TransformBlockValSet.java | 11 +-
.../core/operator/filter/BaseFilterOperator.java | 50 +-
.../core/operator/filter/BitmapCollection.java | 54 +-
.../operator/filter/CombinedFilterOperator.java | 6 +-
.../core/operator/filter/EmptyFilterOperator.java | 4 +-
.../filter/ExactVectorScanFilterOperator.java | 68 +-
.../core/operator/filter/FilterOperatorUtils.java | 43 +-
.../filter/H3InclusionIndexFilterOperator.java | 8 +-
.../operator/filter/H3IndexFilterOperator.java | 48 +-
.../operator/filter/JsonMatchFilterOperator.java | 12 +-
.../core/operator/filter/MapFilterOperator.java | 22 +-
.../operator/filter/PrioritizedFilterOperator.java | 24 +-
.../operator/filter/ScanBasedFilterOperator.java | 6 +-
.../operator/filter/TextMatchFilterOperator.java | 6 +-
.../core/operator/filter/VectorDistanceUtils.java | 4 +-
.../core/operator/filter/VectorExplainContext.java | 48 +-
.../filter/VectorQueryExecutionContext.java | 41 +-
.../filter/VectorRadiusFilterOperator.java | 67 +-
.../core/operator/filter/VectorSearchMetrics.java | 73 +-
.../core/operator/filter/VectorSearchMode.java | 36 +-
.../core/operator/filter/VectorSearchParams.java | 102 +-
.../core/operator/filter/VectorSearchStrategy.java | 86 +-
.../filter/VectorSimilarityFilterOperator.java | 141 +-
.../BaseDictionaryBasedPredicateEvaluator.java | 22 +-
.../BaseRawValueBasedPredicateEvaluator.java | 22 +-
.../predicate/EqualsPredicateEvaluatorFactory.java | 30 +-
.../FSTBasedRegexpPredicateEvaluatorFactory.java | 22 +-
.../IFSTBasedRegexpPredicateEvaluatorFactory.java | 18 +-
.../predicate/InPredicateEvaluatorFactory.java | 32 +-
.../NotEqualsPredicateEvaluatorFactory.java | 30 +-
.../predicate/NotInPredicateEvaluatorFactory.java | 32 +-
.../filter/predicate/PredicateEvaluator.java | 272 ++--
.../operator/filter/predicate/PredicateUtils.java | 16 +-
.../predicate/RangePredicateEvaluatorFactory.java | 30 +-
.../RegexpLikePredicateEvaluatorFactory.java | 32 +-
.../core/operator/query/AggregationOperator.java | 4 +-
.../query/DictionaryBasedDistinctOperator.java | 4 +-
.../core/operator/query/DistinctOperator.java | 4 +-
.../operator/query/EmptyAggregationOperator.java | 6 +-
.../operator/query/EmptySelectionOperator.java | 9 +-
.../query/FilteredAggregationOperator.java | 10 +-
.../operator/query/FilteredGroupByOperator.java | 6 +-
.../pinot/core/operator/query/GroupByOperator.java | 4 +-
.../query/LinearSelectionOrderByOperator.java | 177 +--
.../query/NonScanBasedAggregationOperator.java | 28 +-
.../operator/query/SelectionOrderByOperator.java | 39 +-
.../SelectionPartiallyOrderedByDescOperation.java | 8 +-
.../SelectionPartiallyOrderedByLinearOperator.java | 16 +-
.../streaming/BaseStreamingCombineOperator.java | 12 +-
.../streaming/StreamingGroupByCombineOperator.java | 13 +-
.../StreamingInstanceResponseOperator.java | 10 +-
.../StreamingSelectionOnlyCombineOperator.java | 4 +-
.../streaming/StreamingSelectionOnlyOperator.java | 10 +-
.../core/operator/transform/TransformOperator.java | 4 +-
.../transform/TransformResultMetadata.java | 4 +-
.../function/AndOperatorTransformFunction.java | 17 +-
.../function/ArrayAverageTransformFunction.java | 14 +-
.../function/ArrayLengthTransformFunction.java | 14 +-
.../function/ArrayLiteralTransformFunction.java | 6 +-
.../function/ArrayMaxTransformFunction.java | 14 +-
.../function/ArrayMinTransformFunction.java | 14 +-
.../function/ArraySumTransformFunction.java | 14 +-
.../transform/function/BaseTransformFunction.java | 4 +-
.../function/BinaryOperatorTransformFunction.java | 34 +-
.../function/CLPDecodeTransformFunction.java | 64 +-
.../transform/function/CaseTransformFunction.java | 42 +-
.../ClpEncodedVarsMatchTransformFunction.java | 19 +-
.../function/CoalesceTransformFunction.java | 71 +-
...lyWhenNullHandlingEnabledTransformFunction.java | 6 +-
.../DateTimeConversionHopTransformFunction.java | 47 +-
.../DateTimeConversionTransformFunction.java | 95 +-
.../function/DateTruncTransformFunction.java | 75 +-
.../function/DistinctFromTransformFunction.java | 20 +-
.../function/EqualsTransformFunction.java | 31 +-
.../function/FilterMvTransformFunction.java | 8 +-
.../GreaterThanOrEqualTransformFunction.java | 31 +-
.../function/GreaterThanTransformFunction.java | 31 +-
.../function/GreatestTransformFunction.java | 18 +-
.../function/GroovyTransformFunction.java | 24 +-
.../function/IdentifierTransformFunction.java | 6 +-
.../function/InIdSetTransformFunction.java | 17 +-
.../transform/function/InTransformFunction.java | 12 +-
.../function/IsDistinctFromTransformFunction.java | 32 +-
.../IsNotDistinctFromTransformFunction.java | 32 +-
.../transform/function/ItemTransformFunction.java | 4 +-
.../JsonExtractIndexTransformFunction.java | 14 +-
.../function/JsonExtractKeyTransformFunction.java | 29 +-
.../transform/function/LeastTransformFunction.java | 18 +-
.../function/LessThanOrEqualTransformFunction.java | 31 +-
.../function/LessThanTransformFunction.java | 31 +-
.../function/LiteralTransformFunction.java | 6 +-
.../function/LogicalOperatorTransformFunction.java | 6 +-
.../function/LookupTransformFunction.java | 55 +-
.../function/MapValueTransformFunction.java | 30 +-
.../function/NotEqualsTransformFunction.java | 31 +-
.../transform/function/NotInTransformFunction.java | 4 +-
.../function/NotOperatorTransformFunction.java | 32 +-
.../function/OrOperatorTransformFunction.java | 17 +-
.../function/RegexpExtractTransformFunction.java | 28 +-
.../function/ScalarTransformFunctionWrapper.java | 8 +-
.../function/SingleParamMathTransformFunction.java | 20 +-
.../TimeSeriesBucketTransformFunction.java | 13 +-
.../transform/function/TransformFunction.java | 137 +-
.../function/TransformFunctionFactory.java | 39 +-
.../function/ValueInTransformFunction.java | 8 +-
.../transform/transformer/DataTransformer.java | 22 +-
.../datetime/BaseDateTimeTransformer.java | 9 +-
.../datetime/EpochToEpochTransformer.java | 4 +-
.../datetime/EpochToSDFTransformer.java | 4 +-
.../datetime/SDFToEpochTransformer.java | 4 +-
.../transformer/datetime/SDFToSDFTransformer.java | 6 +-
.../timeunit/CustomTimeUnitTransformer.java | 14 +-
.../timeunit/JavaTimeUnitTransformer.java | 4 +-
.../transformer/timeunit/TimeUnitTransformer.java | 4 +-
.../pinot/core/periodictask/BasePeriodicTask.java | 68 +-
.../pinot/core/periodictask/PeriodicTask.java | 54 +-
.../core/periodictask/PeriodicTaskScheduler.java | 23 +-
.../plan/AcquireReleaseColumnsSegmentPlanNode.java | 24 +-
.../pinot/core/plan/AggregationPlanNode.java | 36 +-
.../apache/pinot/core/plan/CombinePlanNode.java | 20 +-
.../apache/pinot/core/plan/DistinctPlanNode.java | 4 +-
.../org/apache/pinot/core/plan/ExplainInfo.java | 10 +-
.../org/apache/pinot/core/plan/FilterPlanNode.java | 133 +-
.../apache/pinot/core/plan/GlobalPlanImplV0.java | 6 +-
.../apache/pinot/core/plan/GroupByPlanNode.java | 4 +-
.../pinot/core/plan/PinotExplainedRelNode.java | 41 +-
.../main/java/org/apache/pinot/core/plan/Plan.java | 8 +-
.../java/org/apache/pinot/core/plan/PlanNode.java | 12 +-
.../apache/pinot/core/plan/ProjectPlanNode.java | 4 +-
.../apache/pinot/core/plan/SelectionPlanNode.java | 36 +-
.../core/plan/StreamingSelectionPlanNode.java | 9 +-
.../core/plan/maker/InstancePlanMakerImplV2.java | 14 +-
.../apache/pinot/core/plan/maker/PlanMaker.java | 28 +-
.../query/aggregation/AggregationExecutor.java | 22 +-
.../query/aggregation/AggregationResultHolder.java | 57 +-
.../aggregation/DoubleAggregationResultHolder.java | 67 +-
.../aggregation/ObjectAggregationResultHolder.java | 44 +-
.../aggregation/function/AggregationFunction.java | 113 +-
.../function/AggregationFunctionFactory.java | 11 +-
.../function/AggregationFunctionUtils.java | 78 +-
.../function/AnyValueAggregationFunction.java | 69 +-
.../BaseDistinctAggregateAggregationFunction.java | 88 +-
...istinctCountSmartSketchAggregationFunction.java | 68 +-
.../BaseSingleInputAggregationFunction.java | 12 +-
.../function/ChildAggregationFunction.java | 28 +-
.../function/CovarianceAggregationFunction.java | 26 +-
.../function/DistinctAvgAggregationFunction.java | 4 +-
.../function/DistinctAvgMVAggregationFunction.java | 4 +-
.../function/DistinctCountAggregationFunction.java | 4 +-
.../DistinctCountBitmapAggregationFunction.java | 38 +-
.../DistinctCountBitmapMVAggregationFunction.java | 8 +-
.../DistinctCountCPCSketchAggregationFunction.java | 113 +-
.../DistinctCountHLLAggregationFunction.java | 50 +-
.../DistinctCountHLLPlusAggregationFunction.java | 28 +-
.../DistinctCountMVAggregationFunction.java | 4 +-
...stinctCountRawCPCSketchAggregationFunction.java | 6 +-
...inctCountRawThetaSketchAggregationFunction.java | 6 +-
.../DistinctCountSmartHLLAggregationFunction.java | 54 +-
...stinctCountSmartHLLPlusAggregationFunction.java | 36 +-
.../DistinctCountSmartULLAggregationFunction.java | 80 +-
...istinctCountThetaSketchAggregationFunction.java | 126 +-
.../DistinctCountULLAggregationFunction.java | 28 +-
.../function/DistinctSumAggregationFunction.java | 4 +-
.../function/DistinctSumMVAggregationFunction.java | 4 +-
.../function/FastHLLAggregationFunction.java | 4 +-
...irstDoubleValueWithTimeAggregationFunction.java | 19 +-
...FirstFloatValueWithTimeAggregationFunction.java | 19 +-
.../FirstIntValueWithTimeAggregationFunction.java | 21 +-
.../FirstLongValueWithTimeAggregationFunction.java | 19 +-
...irstStringValueWithTimeAggregationFunction.java | 19 +-
.../function/FirstWithTimeAggregationFunction.java | 21 +-
.../FrequentLongsSketchAggregationFunction.java | 66 +-
.../FrequentStringsSketchAggregationFunction.java | 66 +-
.../function/HistogramAggregationFunction.java | 20 +-
.../function/IdSetAggregationFunction.java | 45 +-
.../IntegerTupleSketchAggregationFunction.java | 123 +-
...LastDoubleValueWithTimeAggregationFunction.java | 19 +-
.../LastFloatValueWithTimeAggregationFunction.java | 19 +-
.../LastIntValueWithTimeAggregationFunction.java | 21 +-
.../LastLongValueWithTimeAggregationFunction.java | 19 +-
...LastStringValueWithTimeAggregationFunction.java | 19 +-
.../function/LastWithTimeAggregationFunction.java | 21 +-
.../function/ModeAggregationFunction.java | 57 +-
.../NullableSingleInputAggregationFunction.java | 66 +-
.../function/ParentAggregationFunction.java | 8 +-
.../function/PercentileAggregationFunction.java | 22 +-
.../function/PercentileEstAggregationFunction.java | 23 +-
.../function/PercentileKLLAggregationFunction.java | 58 +-
.../PercentileRawEstAggregationFunction.java | 6 +-
.../PercentileRawEstMVAggregationFunction.java | 6 +-
.../PercentileRawTDigestAggregationFunction.java | 6 +-
.../PercentileRawTDigestMVAggregationFunction.java | 6 +-
.../PercentileSmartTDigestAggregationFunction.java | 29 +-
.../PercentileTDigestAggregationFunction.java | 38 +-
...artitionedDistinctCountAggregationFunction.java | 44 +-
.../function/StUnionAggregationFunction.java | 14 +-
.../function/SumIntAggregationFunction.java | 20 +-
.../function/SumLongAggregationFunction.java | 20 +-
.../function/SumPrecisionAggregationFunction.java | 19 +-
.../function/TimeSeriesAggregationFunction.java | 69 +-
.../function/VarianceAggregationFunction.java | 12 +-
.../function/array/ListAggDistinctFunction.java | 6 +-
.../function/distinct/BaseOffHeapSet.java | 72 +-
.../function/distinct/OffHeap128BitSet.java | 8 +-
.../function/distinct/OffHeap32BitSet.java | 8 +-
.../function/distinct/OffHeap64BitSet.java | 8 +-
.../function/funnel/AggregationStrategy.java | 68 +-
.../function/funnel/BitmapAggregationStrategy.java | 4 +-
.../funnel/BitmapResultExtractionStrategy.java | 20 +-
.../function/funnel/DictIdsWrapper.java | 32 +-
.../funnel/FunnelCountAggregationFunction.java | 60 +-
.../FunnelCountAggregationFunctionFactory.java | 33 +-
.../FunnelCountSortedAggregationFunction.java | 39 +-
.../aggregation/function/funnel/MergeStrategy.java | 12 +-
.../function/funnel/ResultExtractionStrategy.java | 22 +-
.../funnel/SetResultExtractionStrategy.java | 10 +-
.../function/funnel/SortedAggregationResult.java | 30 +-
.../function/funnel/SortedAggregationStrategy.java | 8 +-
.../funnel/ThetaSketchAggregationStrategy.java | 4 +-
.../window/FunnelBaseAggregationFunction.java | 12 +-
...unnelEventsFunctionEvalAggregationFunction.java | 14 +-
.../groupby/AggregationGroupByResult.java | 16 +-
.../groupby/DefaultGroupByExecutor.java | 22 +-
.../groupby/DictionaryBasedGroupKeyGenerator.java | 143 +-
.../groupby/DoubleGroupByResultHolder.java | 16 +-
.../groupby/DummyAggregationResultHolder.java | 6 +-
.../groupby/DummyGroupByResultHolder.java | 6 +-
.../query/aggregation/groupby/GroupByExecutor.java | 37 +-
.../aggregation/groupby/GroupByResultHolder.java | 116 +-
.../aggregation/groupby/GroupKeyGenerator.java | 68 +-
.../groupby/GroupingSetsGroupKeyGenerator.java | 12 +-
.../groupby/IntGroupByResultHolder.java | 12 +-
.../groupby/LongGroupByResultHolder.java | 12 +-
.../NoDictionaryMultiColumnGroupKeyGenerator.java | 40 +-
.../NoDictionarySingleColumnGroupKeyGenerator.java | 19 +-
.../groupby/ObjectGroupByResultHolder.java | 14 +-
.../aggregation/groupby/utils/DoubleToIdMap.java | 4 +-
.../aggregation/groupby/utils/FloatToIdMap.java | 4 +-
.../aggregation/groupby/utils/IntToIdMap.java | 4 +-
.../aggregation/groupby/utils/LongToIdMap.java | 4 +-
.../aggregation/groupby/utils/ObjectToIdMap.java | 4 +-
.../aggregation/groupby/utils/ValueToIdMap.java | 28 +-
.../groupby/utils/ValueToIdMapFactory.java | 4 +-
.../aggregation/utils/DoubleVectorOpUtils.java | 16 +-
.../ParentAggregationFunctionResultObject.java | 10 +-
.../utils/StatisticalAggregationFunctionUtils.java | 8 +-
.../ExprMinMaxMeasuringValSetWrapper.java | 6 +-
.../utils/exprminmax/ExprMinMaxObject.java | 36 +-
.../ExprMinMaxProjectionValSetWrapper.java | 6 +-
.../utils/exprminmax/ExprMinMaxWrapperValSet.java | 6 +-
.../core/query/config/SegmentPrunerConfig.java | 4 +-
.../distinct/BaseSingleColumnDistinctExecutor.java | 20 +-
.../core/query/distinct/DistinctExecutor.java | 16 +-
.../query/distinct/DistinctExecutorFactory.java | 8 +-
.../core/query/distinct/DistinctExecutorUtils.java | 8 +-
...DictionaryBasedMultiColumnDistinctExecutor.java | 4 +-
...ictionaryBasedSingleColumnDistinctExecutor.java | 5 +-
.../distinct/raw/BigDecimalDistinctExecutor.java | 5 +-
.../query/distinct/raw/BytesDistinctExecutor.java | 5 +-
.../query/distinct/raw/DoubleDistinctExecutor.java | 5 +-
.../query/distinct/raw/FloatDistinctExecutor.java | 5 +-
.../query/distinct/raw/IntDistinctExecutor.java | 5 +-
.../query/distinct/raw/LongDistinctExecutor.java | 5 +-
.../raw/RawMultiColumnDistinctExecutor.java | 4 +-
.../query/distinct/raw/StringDistinctExecutor.java | 5 +-
.../distinct/table/BigDecimalDistinctTable.java | 8 +-
.../query/distinct/table/BytesDistinctTable.java | 8 +-
.../query/distinct/table/DictIdDistinctTable.java | 14 +-
.../core/query/distinct/table/DistinctTable.java | 60 +-
.../query/distinct/table/DoubleDistinctTable.java | 8 +-
.../query/distinct/table/FloatDistinctTable.java | 8 +-
.../query/distinct/table/IntDistinctTable.java | 8 +-
.../query/distinct/table/LongDistinctTable.java | 8 +-
.../distinct/table/MultiColumnDistinctTable.java | 12 +-
.../query/distinct/table/StringDistinctTable.java | 8 +-
.../query/executor/LogicalTableExecutionInfo.java | 10 +-
.../pinot/core/query/executor/QueryExecutor.java | 28 +-
.../core/query/executor/ResultsBlockStreamer.java | 8 +-
.../query/executor/ServerQueryExecutorV1Impl.java | 40 +-
.../core/query/executor/TableExecutionInfo.java | 118 +-
.../core/query/executor/sql/SqlQueryExecutor.java | 29 +-
.../killing/CompositeQueryKillingStrategy.java | 19 +-
.../pinot/core/query/killing/QueryKillReport.java | 46 +-
.../core/query/killing/QueryKillingManager.java | 87 +-
.../core/query/killing/QueryKillingStrategy.java | 56 +-
.../query/killing/QueryKillingStrategyFactory.java | 47 +-
.../strategy/ScanEntriesThresholdStrategy.java | 51 +-
.../pinot/core/query/logger/ServerQueryLogger.java | 8 +-
.../pinot/core/query/optimizer/QueryOptimizer.java | 4 +-
.../filter/BaseAndOrBooleanFilterOptimizer.java | 34 +-
.../query/optimizer/filter/FilterOptimizer.java | 10 +-
.../filter/FlattenAndOrFilterOptimizer.java | 6 +-
.../filter/IdenticalPredicateFilterOptimizer.java | 28 +-
.../optimizer/filter/MergeEqInFilterOptimizer.java | 33 +-
.../filter/MergeRangeFilterOptimizer.java | 24 +-
.../optimizer/filter/NumericalFilterOptimizer.java | 106 +-
.../pinot/core/query/optimizer/filter/Range.java | 18 +-
.../optimizer/filter/TextMatchFilterOptimizer.java | 14 +-
.../filter/TimePredicateFilterOptimizer.java | 81 +-
.../optimizer/statement/StatementOptimizer.java | 8 +-
.../postaggregation/PostAggregationFunction.java | 14 +-
.../core/query/prefetch/DefaultFetchPlanner.java | 8 +-
.../pinot/core/query/prefetch/FetchPlanner.java | 40 +-
.../core/query/prefetch/FetchPlannerRegistry.java | 10 +-
.../query/pruner/BloomFilterSegmentPruner.java | 16 +-
.../query/pruner/ColumnValueSegmentPruner.java | 66 +-
.../pinot/core/query/pruner/SegmentPruner.java | 23 +-
.../core/query/pruner/SegmentPrunerProvider.java | 4 +-
.../core/query/pruner/SegmentPrunerService.java | 60 +-
.../query/pruner/SelectionQuerySegmentPruner.java | 133 +-
.../core/query/pruner/ValueBasedSegmentPruner.java | 16 +-
.../query/reduce/AggregationDataTableReducer.java | 30 +-
.../core/query/reduce/BaseGapfillProcessor.java | 26 +-
.../pinot/core/query/reduce/BaseReduceService.java | 4 +-
.../core/query/reduce/BrokerReduceService.java | 101 +-
.../core/query/reduce/CountGapfillProcessor.java | 18 +-
.../pinot/core/query/reduce/DataTableReducer.java | 62 +-
.../core/query/reduce/DataTableReducerContext.java | 18 +-
.../query/reduce/DistinctDataTableReducer.java | 10 +-
.../query/reduce/ExecutionStatsAggregator.java | 65 +-
.../query/reduce/ExplainPlanDataTableReducer.java | 22 +-
.../core/query/reduce/GapfillFilterHandler.java | 12 +-
.../pinot/core/query/reduce/GapfillProcessor.java | 18 +-
.../core/query/reduce/GapfillProcessorFactory.java | 8 +-
.../core/query/reduce/GroupByDataTableReducer.java | 47 +-
.../core/query/reduce/HavingFilterHandler.java | 8 +-
.../core/query/reduce/PostAggregationHandler.java | 26 +-
.../core/query/reduce/ReducerDataSchemaUtils.java | 33 +-
.../core/query/reduce/ResultReducerFactory.java | 8 +-
.../query/reduce/SelectionDataTableReducer.java | 8 +-
.../core/query/reduce/StreamingReduceService.java | 6 +-
.../core/query/reduce/SumAvgGapfillProcessor.java | 18 +-
.../core/query/reduce/filter/AndRowMatcher.java | 4 +-
.../query/reduce/filter/ColumnValueExtractor.java | 4 +-
.../query/reduce/filter/LiteralValueExtractor.java | 4 +-
.../core/query/reduce/filter/NotRowMatcher.java | 4 +-
.../core/query/reduce/filter/OrRowMatcher.java | 4 +-
.../query/reduce/filter/PredicateRowMatcher.java | 4 +-
.../pinot/core/query/reduce/filter/RowMatcher.java | 8 +-
.../query/reduce/filter/RowMatcherFactory.java | 8 +-
.../core/query/reduce/filter/ValueExtractor.java | 16 +-
.../query/reduce/filter/ValueExtractorFactory.java | 14 +-
.../reduce/function/InternalReduceFunctions.java | 8 +-
.../core/query/request/ServerQueryRequest.java | 39 +-
.../core/query/request/context/ExplainMode.java | 37 +-
.../core/query/request/context/QueryContext.java | 204 +--
.../core/query/request/context/TimerContext.java | 28 +-
.../context/utils/QueryContextConverterUtils.java | 8 +-
.../request/context/utils/QueryContextUtils.java | 26 +-
.../query/scheduler/AbstractSchedulerGroup.java | 8 +-
.../query/scheduler/BinaryWorkloadScheduler.java | 31 +-
.../query/scheduler/MultiLevelPriorityQueue.java | 22 +-
.../query/scheduler/OutOfCapacityException.java | 4 +-
.../core/query/scheduler/PriorityScheduler.java | 10 +-
.../pinot/core/query/scheduler/QueryScheduler.java | 78 +-
.../query/scheduler/QuerySchedulerFactory.java | 18 +-
...erySchedulerThreadPoolConfigChangeListener.java | 6 +-
.../pinot/core/query/scheduler/SchedulerGroup.java | 54 +-
.../query/scheduler/SchedulerGroupAccountant.java | 58 +-
.../query/scheduler/SchedulerGroupFactory.java | 14 +-
.../core/query/scheduler/SchedulerGroupMapper.java | 16 +-
.../query/scheduler/SchedulerPriorityQueue.java | 32 +-
.../query/scheduler/SchedulerQueryContext.java | 10 +-
.../query/scheduler/SecondaryWorkloadQueue.java | 18 +-
.../query/scheduler/TableBasedGroupMapper.java | 14 +-
.../core/query/scheduler/WorkloadScheduler.java | 17 +-
.../query/scheduler/fcfs/BoundedFCFSScheduler.java | 8 +-
.../query/scheduler/fcfs/FCFSQueryScheduler.java | 8 +-
.../query/scheduler/fcfs/FCFSSchedulerGroup.java | 12 +-
.../resources/BinaryWorkloadResourceManager.java | 22 +-
.../resources/BoundedAccountingExecutor.java | 18 +-
.../resources/PolicyBasedResourceManager.java | 20 +-
.../scheduler/resources/QueryExecutorService.java | 8 +-
.../scheduler/resources/ResourceLimitPolicy.java | 4 +-
.../query/scheduler/resources/ResourceManager.java | 104 +-
.../resources/UnboundedResourceManager.java | 8 +-
.../tokenbucket/TokenPriorityScheduler.java | 8 +-
.../scheduler/tokenbucket/TokenSchedulerGroup.java | 40 +-
.../query/selection/SelectionOperatorService.java | 59 +-
.../query/selection/SelectionOperatorUtils.java | 136 +-
.../core/query/utils/OrderByComparatorFactory.java | 20 +-
.../pinot/core/query/utils/QueryIdUtils.java | 8 +-
.../core/query/utils/idset/BloomFilterIdSet.java | 13 +-
.../pinot/core/query/utils/idset/EmptyIdSet.java | 4 +-
.../apache/pinot/core/query/utils/idset/IdSet.java | 71 +-
.../pinot/core/query/utils/idset/IdSets.java | 91 +-
.../utils/idset/Roaring64NavigableMapIdSet.java | 13 +-
.../core/query/utils/idset/RoaringBitmapIdSet.java | 11 +-
.../rewriter/ParentAggregationResultRewriter.java | 50 +-
.../core/query/utils/rewriter/ResultRewriter.java | 4 +-
.../core/routing/ImplicitHybridTableRouteInfo.java | 12 +-
.../routing/ImplicitHybridTableRouteProvider.java | 8 +-
.../core/routing/LogicalTableRouteProvider.java | 6 +-
.../core/routing/MultiClusterRoutingContext.java | 34 +-
.../core/routing/PhysicalTableRouteProvider.java | 18 +-
.../apache/pinot/core/routing/RoutingManager.java | 112 +-
.../apache/pinot/core/routing/SegmentsToQuery.java | 30 +-
.../pinot/core/routing/TablePartitionInfo.java | 4 +-
.../TablePartitionReplicatedServersInfo.java | 6 +-
.../apache/pinot/core/routing/TableRouteInfo.java | 182 +--
.../pinot/core/routing/TableRouteProvider.java | 26 +-
.../routing/timeboundary/TimeBoundaryStrategy.java | 34 +-
.../timeboundary/TimeBoundaryStrategyService.java | 16 +-
.../processing/aggregator/MaxValueAggregator.java | 4 +-
.../processing/aggregator/MinValueAggregator.java | 4 +-
.../aggregator/PercentileKLLSketchAggregator.java | 10 +-
.../aggregator/PercentileTDigestAggregator.java | 8 +-
.../processing/aggregator/SumValueAggregator.java | 4 +-
.../processing/aggregator/ValueAggregator.java | 10 +-
.../aggregator/ValueAggregatorFactory.java | 4 +-
.../framework/DefaultSegmentNumRowProvider.java | 4 +-
.../segment/processing/framework/MergeType.java | 16 +-
.../processing/framework/SegmentConfig.java | 12 +-
.../framework/SegmentNumRowProvider.java | 6 +-
.../framework/SegmentProcessorConfig.java | 40 +-
.../framework/SegmentProcessorFramework.java | 30 +-
.../genericrow/AdaptiveConstraintsWriter.java | 4 +-
.../genericrow/AdaptiveSizeBasedWriter.java | 28 +-
.../segment/processing/genericrow/FileWriter.java | 4 +-
.../genericrow/GenericRowDeserializer.java | 16 +-
.../genericrow/GenericRowFileManager.java | 36 +-
.../genericrow/GenericRowFileReader.java | 24 +-
.../genericrow/GenericRowFileRecordReader.java | 16 +-
.../genericrow/GenericRowFileWriter.java | 18 +-
.../genericrow/GenericRowSerializer.java | 12 +-
.../segment/processing/mapper/SegmentMapper.java | 20 +-
.../partitioner/ColumnValuePartitioner.java | 4 +-
.../processing/partitioner/NoOpPartitioner.java | 4 +-
.../processing/partitioner/Partitioner.java | 34 +-
.../processing/partitioner/PartitionerConfig.java | 28 +-
.../processing/partitioner/PartitionerFactory.java | 32 +-
.../partitioner/RoundRobinPartitioner.java | 4 +-
.../partitioner/TableConfigPartitioner.java | 4 +-
.../partitioner/TransformFunctionPartitioner.java | 4 +-
.../segment/processing/reducer/ConcatReducer.java | 4 +-
.../segment/processing/reducer/DedupReducer.java | 4 +-
.../core/segment/processing/reducer/Reducer.java | 8 +-
.../segment/processing/reducer/ReducerFactory.java | 4 +-
.../processing/timehandler/EpochTimeHandler.java | 4 +-
.../processing/timehandler/NoOpTimeHandler.java | 4 +-
.../processing/timehandler/TimeHandler.java | 44 +-
.../processing/timehandler/TimeHandlerConfig.java | 4 +-
.../processing/timehandler/TimeHandlerFactory.java | 4 +-
.../processing/utils/SegmentProcessorUtils.java | 18 +-
.../core/startree/CompositePredicateEvaluator.java | 20 +-
.../apache/pinot/core/startree/StarTreeUtils.java | 70 +-
.../executor/StarTreeAggregationExecutor.java | 13 +-
.../startree/executor/StarTreeGroupByExecutor.java | 13 +-
.../startree/operator/StarTreeFilterOperator.java | 105 +-
.../pinot/core/transport/AsyncQueryResponse.java | 16 +-
.../core/transport/ChannelHandlerFactory.java | 34 +-
.../pinot/core/transport/DataTableHandler.java | 6 +-
.../pinot/core/transport/DirectOOMHandler.java | 14 +-
.../core/transport/HttpServerThreadPoolConfig.java | 4 +-
.../core/transport/InstanceRequestHandler.java | 36 +-
.../pinot/core/transport/ListenerConfig.java | 6 +-
.../PooledByteBufAllocatorWithLimits.java | 22 +-
.../apache/pinot/core/transport/QueryResponse.java | 48 +-
.../apache/pinot/core/transport/QueryRouter.java | 25 +-
.../apache/pinot/core/transport/QueryServer.java | 28 +-
.../pinot/core/transport/ServerChannels.java | 19 +-
.../pinot/core/transport/ServerInstance.java | 32 +-
.../pinot/core/transport/ServerResponse.java | 4 +-
.../core/transport/ServerRoutingInstance.java | 11 +-
.../routing/stats/ServerRoutingStatsEntry.java | 7 +-
.../routing/stats/ServerRoutingStatsManager.java | 62 +-
.../pinot/core/util/DataBlockExtractUtils.java | 4 +-
.../org/apache/pinot/core/util/GapfillUtils.java | 14 +-
.../org/apache/pinot/core/util/GroupByUtils.java | 42 +-
.../apache/pinot/core/util/ListenerConfigUtil.java | 34 +-
.../pinot/core/util/MemoizedClassAssociation.java | 6 +-
.../org/apache/pinot/core/util/NumberUtils.java | 46 +-
.../java/org/apache/pinot/core/util/OsCheck.java | 14 +-
.../pinot/core/util/PeerServerSegmentFinder.java | 13 +-
.../pinot/core/util/QueryMultiThreadingUtils.java | 33 +-
.../core/util/SegmentCompletionProtocolUtils.java | 8 +-
.../pinot/core/util/SortedRangeIntersection.java | 4 +-
.../pinot/core/util/trace/TraceCallable.java | 8 +-
.../apache/pinot/core/util/trace/TraceContext.java | 76 +-
.../pinot/core/util/trace/TraceRunnable.java | 8 +-
.../apache/pinot/server/access/AccessControl.java | 19 +-
.../pinot/server/access/AccessControlFactory.java | 16 +-
.../server/access/BasicAuthAccessFactory.java | 4 +-
.../pinot/server/access/GrpcRequesterIdentity.java | 4 +-
.../pinot/server/access/HttpRequesterIdentity.java | 4 +-
.../server/access/ZkBasicAuthAccessFactory.java | 19 +-
.../server/realtime/ControllerLeaderLocator.java | 76 +-
.../ServerSegmentCompletionProtocolHandler.java | 12 +-
.../core/accounting/QueryMonitorConfigTest.java | 6 +-
.../accounting/QueryResourceAggregatorTest.java | 2 +-
.../pinot/core/accounting/TestThreadMXBean.java | 18 +-
.../pinot/core/common/SyntheticBlockValSets.java | 22 +-
.../core/common/datatable/DataTableSerDeTest.java | 4 +-
.../data/function/ArithmeticFunctionsTest.java | 4 +-
.../core/data/function/ArrayFunctionsTest.java | 4 +-
.../pinot/core/data/function/BitFunctionsTest.java | 4 +-
.../core/data/function/DateTimeFunctionsTest.java | 4 +-
.../data/function/GroovyFunctionEvaluatorTest.java | 4 +-
.../function/GroovyStaticAnalyzerConfigTest.java | 4 +-
.../core/data/function/JsonFunctionsTest.java | 4 +-
.../core/data/function/LogicalFunctionsTest.java | 6 +-
.../core/data/function/VectorFunctionsTest.java | 4 +-
.../BaseTableDataManagerAcquireSegmentTest.java | 20 +-
...ableDataManagerEnqueueSegmentToReplaceTest.java | 28 +-
.../data/manager/BaseTableDataManagerTest.java | 70 +-
.../realtime/RealtimeSegmentDataManagerTest.java | 52 +-
.../pinot/core/data/table/IndexedTableTest.java | 4 +-
.../pinot/core/data/table/TableResizerTest.java | 12 +-
.../core/geospatial/transform/GeoFunctionTest.java | 4 +-
.../operator/combine/CombineSlowOperatorsTest.java | 14 +-
.../combine/SelectionCombineOperatorTest.java | 4 +-
.../combine/SortedGroupByCombineOperatorsTest.java | 4 +-
.../core/operator/docidsets/AndDocIdSetTest.java | 4 +-
.../filter/ExactVectorScanFilterOperatorTest.java | 4 +-
.../filter/FilterAwareVectorSearchTest.java | 12 +-
.../filter/InvertedIndexFilterOperatorTest.java | 6 +-
.../operator/filter/VectorCompoundQueryTest.java | 13 +-
.../filter/VectorQueryExecutionContextTest.java | 4 +-
.../filter/VectorRadiusFilterOperatorTest.java | 4 +-
.../operator/filter/VectorSearchParamsTest.java | 4 +-
.../operator/filter/VectorSearchStrategyTest.java | 4 +-
.../filter/VectorSimilarityFilterOperatorTest.java | 8 +-
.../NoDictionaryEqualsPredicateEvaluatorsTest.java | 4 +-
.../NoDictionaryInPredicateEvaluatorTest.java | 4 +-
.../NoDictionaryRangePredicateEvaluatorTest.java | 4 +-
.../query/OperatorScanCostTrackingTest.java | 4 +-
.../StreamingGroupByCombineOperatorTest.java | 2 +-
.../function/BaseTransformFunctionTest.java | 4 +-
.../BinaryOperatorTransformFunctionTest.java | 21 +-
.../function/GroovyTransformFunctionTest.java | 4 +-
.../JsonExtractScalarTransformFunctionTest.java | 16 +-
.../LogicalOperatorTransformFunctionTest.java | 9 +-
.../function/LookupTransformFunctionTest.java | 17 +-
.../periodictask/PeriodicTaskSchedulerTest.java | 30 +-
.../pinot/core/plan/CombinePlanNodeTest.java | 18 +-
.../plan/maker/InstancePlanMakerImplV2Test.java | 6 +-
.../DefaultAggregationExecutorTest.java | 98 +-
.../DoubleAggregationResultHolderTest.java | 12 +-
.../function/AnyValueAggregationFunctionTest.java | 6 +-
.../DistinctCountHLLAggregationFunctionTest.java | 18 +-
.../function/MaxStringAggregationFunctionTest.java | 8 +-
.../function/MinStringAggregationFunctionTest.java | 8 +-
.../DictionaryBasedGroupKeyGeneratorTest.java | 30 +-
.../groupby/DoubleGroupByResultHolderTest.java | 44 +-
.../query/aggregation/groupby/GroupByTrimTest.java | 81 +-
.../groupby/NoDictionaryGroupKeyGeneratorTest.java | 16 +-
.../executor/LogicalTableExecutionInfoTest.java | 39 +-
.../executor/QueryExecutorExceptionsTest.java | 11 +-
.../executor/SingleTableExecutionInfoTest.java | 30 +-
.../core/query/killing/QueryKillReportTest.java | 4 +-
.../query/killing/QueryKillingManagerTest.java | 12 +-
.../core/query/optimizer/QueryOptimizerTest.java | 4 +-
.../filter/TimePredicateFilterOptimizerTest.java | 16 +-
.../core/query/optimizer/statement/TestHelper.java | 6 +-
.../PostAggregationFunctionTest.java | 8 +-
.../query/pruner/SegmentPrunerServiceTest.java | 16 +-
.../pruner/SelectionQuerySegmentPrunerTest.java | 4 +-
.../core/query/reduce/BrokerReduceServiceTest.java | 28 +-
.../query/reduce/ExecutionStatsAggregatorTest.java | 83 +-
.../core/query/reduce/MergeDataTablesOnlyTest.java | 42 +-
.../request/context/predicate/PredicateTest.java | 6 +-
.../selection/SelectionOperatorServiceTest.java | 6 +-
.../core/query/selection/SelectionOrderByTest.java | 2 +-
.../fakestream/FakePartitionLevelConsumer.java | 12 +-
.../impl/fakestream/FakeStreamConfigUtils.java | 42 +-
.../impl/fakestream/FakeStreamConsumerFactory.java | 10 +-
.../impl/fakestream/FakeStreamMessageBatch.java | 4 +-
.../impl/fakestream/FakeStreamMessageDecoder.java | 4 +-
.../fakestream/FakeStreamMetadataProvider.java | 4 +-
.../stream/MetadataEqualsHashCodeTest.java | 5 +-
.../core/realtime/stream/OffsetCriteriaTest.java | 4 +-
.../core/realtime/stream/StreamConfigTest.java | 16 +-
...HybridTableRouteProviderCalculateRouteTest.java | 42 +-
...tHybridTableRouteProviderGetTableRouteTest.java | 94 +-
.../core/routing/MockRoutingManagerFactory.java | 12 +-
.../BaseSegmentProcessorFrameworkTest.java | 32 +-
.../processing/framework/PartitionerTest.java | 4 +-
.../segment/processing/framework/ReducerTest.java | 4 +-
.../processing/framework/SegmentMapperTest.java | 28 +-
.../framework/SegmentProcessorFrameworkTest.java | 12 +-
.../pinot/core/startree/v2/BaseStarTreeV2Test.java | 20 +-
.../pinot/core/transport/QueryRoutingTest.java | 8 +-
.../org/apache/pinot/core/util/CrcUtilsTest.java | 6 +-
.../apache/pinot/core/util/SchemaUtilsTest.java | 30 +-
.../core/util/SortedRangeIntersectionTest.java | 12 +-
.../apache/pinot/queries/AllNullQueriesTest.java | 6 +-
.../apache/pinot/queries/ArrayAggQueriesTest.java | 4 +-
.../queries/BaseFSTBasedRegexpLikeQueriesTest.java | 4 +-
.../pinot/queries/BaseFunnelCountQueriesTest.java | 6 +-
.../pinot/queries/BaseMultiValueQueriesTest.java | 34 +-
.../queries/BaseMultiValueRawQueriesTest.java | 34 +-
.../org/apache/pinot/queries/BaseQueriesTest.java | 178 ++-
.../pinot/queries/BaseSingleValueQueriesTest.java | 36 +-
.../pinot/queries/BigDecimalQueriesTest.java | 4 +-
.../queries/BooleanNullEnabledQueriesTest.java | 4 +-
.../apache/pinot/queries/BooleanQueriesTest.java | 4 +-
.../pinot/queries/CustomReloadQueriesTest.java | 10 +-
.../queries/DistinctCountBitmapQueriesTest.java | 4 +-
.../pinot/queries/DistinctCountQueriesTest.java | 4 +-
.../DistinctCountThetaSketchQueriesTest.java | 4 +-
.../apache/pinot/queries/DistinctQueriesTest.java | 260 ++--
.../pinot/queries/ExplainPlanQueriesTest.java | 14 +-
.../org/apache/pinot/queries/ExprMinMaxTest.java | 4 +-
.../queries/FSTBasedRegexpLikeQueriesTest.java | 6 +-
.../apache/pinot/queries/FastHllQueriesTest.java | 36 +-
.../pinot/queries/FirstWithTimeQueriesTest.java | 4 +-
.../org/apache/pinot/queries/FluentQueryTest.java | 317 ++--
.../ForwardIndexDisabledMultiValueQueriesTest.java | 36 +-
...dexDisabledMultiValueQueriesWithReloadTest.java | 38 +-
...ForwardIndexDisabledSingleValueQueriesTest.java | 40 +-
.../ForwardIndexHandlerReloadQueriesTest.java | 56 +-
.../queries/FrequentItemsSketchQueriesTest.java | 14 +-
.../queries/FunnelCountQueriesBitmapTest.java | 4 +-
.../FunnelCountQueriesPartitionedSortedTest.java | 4 +-
.../queries/FunnelCountQueriesPartitionedTest.java | 4 +-
.../pinot/queries/FunnelCountQueriesSetTest.java | 4 +-
.../queries/FunnelCountQueriesThetaSketchTest.java | 4 +-
.../queries/GapfillQueriesScalabilityTest.java | 4 +-
.../apache/pinot/queries/GapfillQueriesTest.java | 4 +-
.../apache/pinot/queries/H3IndexQueriesTest.java | 4 +-
.../apache/pinot/queries/HistogramQueriesTest.java | 4 +-
.../queries/IFSTBasedRegexpLikeQueriesTest.java | 6 +-
.../org/apache/pinot/queries/IdSetQueriesTest.java | 4 +-
.../InterSegmentGroupByMultiValueQueriesTest.java | 10 +-
...nterSegmentGroupByMultiValueRawQueriesTest.java | 10 +-
.../InterSegmentGroupBySingleValueQueriesTest.java | 10 +-
.../pinot/queries/IsSubnetOfQueriesTest.java | 4 +-
.../pinot/queries/JsonDataTypeQueriesTest.java | 12 +-
.../pinot/queries/JsonExtractScalarTest.java | 8 +-
.../queries/JsonIngestionFromAvroQueriesTest.java | 20 +-
.../apache/pinot/queries/JsonMatchQueriesTest.java | 4 +-
.../apache/pinot/queries/JsonPathQueriesTest.java | 18 +-
.../JsonUnnestIngestionFromAvroQueriesTest.java | 10 +-
.../pinot/queries/LastWithTimeQueriesTest.java | 4 +-
.../org/apache/pinot/queries/ModeQueriesTest.java | 4 +-
.../pinot/queries/MultiValueRawQueriesTest.java | 16 +-
.../NoDictionaryCompressionQueriesTest.java | 52 +-
.../pinot/queries/NullEnabledQueriesTest.java | 4 +-
.../pinot/queries/PercentileKLLMVQueriesTest.java | 4 +-
.../pinot/queries/PercentileKLLQueriesTest.java | 18 +-
.../queries/PercentileTDigestMVQueriesTest.java | 22 +-
.../queries/PercentileTDigestQueriesTest.java | 22 +-
.../queries/ResultRewriterRegressionTest.java | 4 +-
...SegmentPartitionedDistinctCountQueriesTest.java | 4 +-
.../queries/SegmentWithNullValueVectorTest.java | 26 +-
.../pinot/queries/SerializedBytesQueriesTest.java | 21 +-
.../apache/pinot/queries/StUnionQueriesTest.java | 4 +-
.../pinot/queries/StatisticalQueriesTest.java | 4 +-
.../TextSearchMultiColIndexQueriesTest.java | 6 +-
.../pinot/queries/TextSearchQueriesTest.java | 49 +-
.../TextSearchQueriesWithCombinedFilesTest.java | 6 +-
.../apache/pinot/queries/TimestampQueriesTest.java | 4 +-
.../apache/pinot/queries/TransformQueriesTest.java | 6 +-
.../realtime/ControllerLeaderLocatorTest.java | 8 +-
.../verifier/PinotCustomDependencyVersionRule.java | 16 +-
.../tests/BaseClusterIntegrationTest.java | 153 +-
.../tests/ClusterIntegrationTestUtils.java | 227 ++-
.../pinot/integration/tests/ClusterTest.java | 100 +-
.../pinot/integration/tests/QueryGenerator.java | 310 ++--
.../tests/AdminConsoleIntegrationTest.java | 8 +-
.../tests/BaseClusterIntegrationTestSet.java | 123 +-
.../tests/BaseDedupIntegrationTest.java | 4 +-
.../tests/BaseHybridClusterIntegrationTest.java | 14 +-
.../tests/BasePauselessRealtimeIngestionTest.java | 4 +-
.../tests/BaseRealtimeClusterIntegrationTest.java | 18 +-
.../tests/BasicAuthBatchIntegrationTest.java | 9 +-
.../BrokerServiceDiscoveryIntegrationTest.java | 4 +-
.../tests/CancelQueryIntegrationTests.java | 4 +-
.../tests/ChaosMonkeyIntegrationTest.java | 4 +-
.../tests/CommitTimeCompactionIntegrationTest.java | 22 +-
.../ControllerPeriodicTasksIntegrationTest.java | 14 +-
.../ControllerServiceDiscoveryIntegrationTest.java | 4 +-
.../tests/CursorCronCleanupIntegrationTest.java | 8 +-
.../integration/tests/CursorFsIntegrationTest.java | 8 +-
.../integration/tests/CursorIntegrationTest.java | 6 +-
...eTimeFieldSpecHybridClusterIntegrationTest.java | 4 +-
.../tests/EmptyResponseIntegrationTest.java | 4 +-
.../tests/ErrorCodesIntegrationTest.java | 4 +-
...tlyOnceKafkaRealtimeClusterIntegrationTest.java | 68 +-
.../tests/GrpcBrokerClusterIntegrationTest.java | 4 +-
.../integration/tests/HelixZNodeSizeLimitTest.java | 8 +-
.../IngestionConfigHybridIntegrationTest.java | 4 +-
.../tests/JmxMetricsIntegrationTest.java | 4 +-
...ssageDecoderRealtimeClusterIntegrationTest.java | 6 +-
.../tests/LLCRealtimeClusterIntegrationTest.java | 6 +-
.../LLCRealtimeKafka3ClusterIntegrationTest.java | 4 +-
.../LLCRealtimeKafka4ClusterIntegrationTest.java | 4 +-
.../MaterializedViewClusterIntegrationTest.java | 115 +-
.../MergeRollupMinionClusterIntegrationTest.java | 62 +-
.../MultiNodesOfflineClusterIntegrationTest.java | 4 +-
.../tests/MultiStageEngineIntegrationTest.java | 12 +-
.../tests/NullHandlingIntegrationTest.java | 6 +-
.../tests/OfflineClusterIntegrationTest.java | 100 +-
...sRealtimeIngestionSegmentCommitFailureTest.java | 4 +-
...rDownloadLLCRealtimeClusterIntegrationTest.java | 18 +-
...otLLCRealtimeSegmentManagerIntegrationTest.java | 4 +-
...geMetadataPushMinionClusterIntegrationTest.java | 8 +-
.../tests/PurgeMinionClusterIntegrationTest.java | 35 +-
.../tests/QueryQuotaClusterIntegrationTest.java | 17 +-
.../tests/QueryWorkloadIntegrationTest.java | 28 +-
...fflineSegmentsMinionClusterIntegrationTest.java | 8 +-
.../tests/SegmentCompletionIntegrationTest.java | 16 +-
...gmentGenerationMinionRealtimeIngestionTest.java | 12 +-
...PartitionLLCRealtimeClusterIntegrationTest.java | 4 +-
.../tests/SegmentUploadIntegrationTest.java | 14 +-
.../SegmentWriterUploaderIntegrationTest.java | 12 +-
.../tests/SimpleMinionClusterIntegrationTest.java | 7 +-
.../SparkSegmentMetadataPushIntegrationTest.java | 26 +-
.../integration/tests/SpoolIntegrationTest.java | 30 +-
.../StarTreeFunctionParametersIntegrationTest.java | 20 +-
.../tests/StreamStatsReportingIntegrationTest.java | 150 +-
.../UpsertCompactMergeTaskIntegrationTest.java | 50 +-
.../tests/UpsertTableIntegrationTest.java | 12 +-
.../tests/custom/AggregateMetricsTest.java | 4 +-
.../custom/ArithmeticFunctionsIntegrationTest.java | 12 +-
.../tests/custom/BigDecimalTypeTest.java | 6 +-
.../tests/custom/BigNumberOfSegmentsTest.java | 8 +-
.../custom/BitwiseFunctionsIntegrationTest.java | 10 +-
.../CustomDataQueryClusterIntegrationTest.java | 50 +-
.../tests/custom/DistinctQueriesTest.java | 16 +-
.../tests/custom/FloatingPointDataTypeTest.java | 4 +-
.../integration/tests/custom/FunnelCountTest.java | 140 +-
.../tests/custom/GroupByOptionsTest.java | 8 +-
.../tests/custom/GroupingSetsQueriesTest.java | 18 +-
.../tests/custom/HnswConsolidatedVectorTest.java | 34 +-
.../custom/IvfFlatConsolidatedVectorTest.java | 28 +-
.../tests/custom/IvfFlatVectorTest.java | 34 +-
.../tests/custom/IvfPqVectorRealtimeTest.java | 4 +-
.../integration/tests/custom/IvfPqVectorTest.java | 4 +-
.../integration/tests/custom/JsonPathTest.java | 40 +-
.../MultiTopicRealtimeClusterIntegrationTest.java | 28 +-
.../tests/custom/OfflineUpsertTableTest.java | 26 +-
.../custom/OpenStructIngestionCommitTestBase.java | 2 +-
.../custom/ProtoBufCodeGenMessageDecoderTest.java | 103 +-
.../custom/RawForwardIndexWithDictionaryTest.java | 231 ++-
.../tests/custom/RefreshSegmentMinionTest.java | 6 +-
.../integration/tests/custom/SSBQueryTest.java | 8 +-
.../integration/tests/custom/StarTreeTest.java | 21 +-
.../pinot/integration/tests/custom/VectorTest.java | 14 +-
.../BaseLogicalTableIntegrationTest.java | 22 +-
.../KafkaPartitionSubsetChaosIntegrationTest.java | 143 +-
.../BaseMultiClusterIntegrationTest.java | 42 +-
.../multicluster/MultiClusterIntegrationTest.java | 12 +-
.../SameTableNameMultiClusterIntegrationTest.java | 16 +-
.../minion/tasks/TestEventObserverFactory.java | 4 +-
.../minion/tasks/TestTaskExecutorFactory.java | 4 +-
.../plugin/minion/tasks/TestTaskGenerator.java | 4 +-
.../ingestion/BaseKinesisIntegrationTest.java | 4 +-
.../realtime/ingestion/KinesisShardChangeTest.java | 82 +-
...FailureInjectingRealtimeSegmentDataManager.java | 10 +-
.../FailureInjectingTableDataManagerProvider.java | 4 +-
.../tests/startree/SegmentInfoProvider.java | 78 +-
.../tests/startree/StarTreeQueryGenerator.java | 88 +-
.../pinot/integration/tests/tpch/Constants.java | 4 +-
.../tpch/TPCHGeneratedQueryIntegrationTest.java | 10 +-
.../tests/tpch/TPCHQueryIntegrationTest.java | 10 +-
.../pinot/integration/tests/tpch/TblToAvro.java | 4 +-
.../pinot/integration/tests/udf/AvroSink.java | 4 +-
.../ControllerLeaderLocatorIntegrationTest.java | 4 +-
.../pinot/java11/CannedResponseTransport.java | 6 +-
.../pinot/java11/ClasspathClosureScanner.java | 36 +-
.../pinot/java11/Java11CompatibilityVerifier.java | 42 +-
.../pinot/java11/ClasspathClosureScannerTest.java | 6 +-
.../analysis/MaterializedViewAnalyzer.java | 7 +-
.../analysis/timeexpr/TimeExprValidator.java | 36 +-
.../MaterializedViewConsistencyManager.java | 2 +-
.../GrpcMaterializedViewQueryExecutor.java | 1 -
.../metadata/MaterializedViewPartitionManager.java | 20 +-
.../rewrite/MaterializedViewMatchUtils.java | 5 -
.../rewrite/MaterializedViewMetadataCache.java | 1 -
.../MaterializedViewQueryRewriteEngine.java | 5 +-
.../equivalence/PassthroughEquivalence.java | 1 -
.../equivalence/SketchMergeEquivalence.java | 1 -
.../strategy/AbstractSubsumptionStrategy.java | 1 -
.../strategy/AggregationSubsumptionStrategy.java | 1 -
.../rewrite/strategy/ScanSubsumptionStrategy.java | 1 -
.../scheduler/MaterializedViewTaskScheduler.java | 3 +-
.../scheduler/MaterializedViewTaskUtils.java | 4 +-
.../analysis/timeexpr/TimeExprParserTest.java | 6 +-
.../AggregationSubsumptionStrategyTest.java | 1 -
.../org/apache/pinot/minion/BaseMinionStarter.java | 29 +-
.../pinot/minion/MinionAdminApiApplication.java | 11 +-
.../java/org/apache/pinot/minion/MinionConf.java | 6 +-
.../org/apache/pinot/minion/MinionContext.java | 4 +-
.../org/apache/pinot/minion/MinionStarter.java | 7 +-
.../minion/api/resources/HealthCheckResource.java | 4 +-
.../api/resources/PinotMinionAppConfigs.java | 6 +-
.../minion/api/resources/PinotMinionLogger.java | 4 +-
.../api/resources/PinotTaskProgressResource.java | 4 +-
.../event/BaseMinionProgressObserverFactory.java | 16 +-
.../minion/event/DefaultMinionEventObserver.java | 4 +-
.../minion/event/EventObserverFactoryRegistry.java | 24 +-
.../pinot/minion/event/MinionEventObserver.java | 68 +-
.../minion/event/MinionEventObserverFactory.java | 22 +-
.../pinot/minion/event/MinionEventObservers.java | 14 +-
.../pinot/minion/event/MinionProgressObserver.java | 14 +-
.../apache/pinot/minion/event/MinionTaskState.java | 24 +-
.../pinot/minion/exception/FatalException.java | 6 +-
.../minion/exception/TaskCancelledException.java | 4 +-
.../executor/MinionTaskZkMetadataManager.java | 26 +-
.../pinot/minion/executor/PinotTaskExecutor.java | 12 +-
.../minion/executor/PinotTaskExecutorFactory.java | 20 +-
.../executor/TaskExecutorFactoryRegistry.java | 28 +-
.../minion/taskfactory/TaskFactoryRegistry.java | 11 +-
...BenchmarkAggregateGroupByOrderByQueriesSSE.java | 175 ++-
.../pinot/perf/BenchmarkFSTRegexpMatcher.java | 20 +-
.../pinot/perf/BenchmarkFunctionOperand.java | 35 +-
.../pinot/perf/BenchmarkInvertedIndexDistinct.java | 76 +-
.../BenchmarkInvertedIndexGetNumMatchingDocs.java | 108 +-
.../pinot/perf/BenchmarkJsonIndexDistinct.java | 35 +-
.../apache/pinot/perf/BenchmarkJsonParsing.java | 38 +-
.../pinot/perf/BenchmarkJsonPathExtraction.java | 18 +-
.../pinot/perf/BenchmarkNgramFilteringIndex.java | 4 +-
.../pinot/perf/BenchmarkObjectOpenHashMap.java | 10 +-
.../perf/BenchmarkProtoBufRecordExtractor.java | 55 +-
.../apache/pinot/perf/BenchmarkQueriesMSQE.java | 4 +-
.../apache/pinot/perf/BenchmarkQueryEngine.java | 19 +-
.../perf/BenchmarkRealtimeConsumptionSpeed.java | 6 +-
.../pinot/perf/BenchmarkRoaringBitmapCreation.java | 8 +-
.../pinot/perf/BenchmarkRoaringBitmapMapping.java | 12 +-
.../BenchmarkSelectionOrderByFilterPruning.java | 34 +-
.../org/apache/pinot/perf/BenchmarkSplitPart.java | 4 +-
.../pinot/perf/BenchmarkStreamStatsMSQE.java | 77 +-
.../perf/BenchmarkVectorFeatureWorkloads.java | 12 +-
.../pinot/perf/BenchmarkVectorFilterWorkloads.java | 12 +-
.../apache/pinot/perf/BenchmarkVectorIndex.java | 217 +--
.../apache/pinot/perf/BenchmarkVectorSanity.java | 14 +-
.../org/apache/pinot/perf/RawIndexBenchmark.java | 96 +-
.../pinot/perf/StringDictionaryPerfTest.java | 23 +-
.../pinot/perf/SyntheticNullBitmapFactories.java | 36 +-
.../AbstractAggregationFunctionBenchmark.java | 138 +-
.../AbstractAggregationQueryBenchmark.java | 10 +-
.../BenchmarkDistinctCountHLLThreshold.java | 11 +-
.../SumIntAggregationFunctionBenchmark.java | 10 +-
.../batch/common/BaseSegmentPushJobRunner.java | 36 +-
.../batch/common/SegmentGenerationJobUtils.java | 29 +-
.../hadoop/HadoopSegmentGenerationJobRunner.java | 20 +-
.../spark3/SparkSegmentMetadataPushJobRunner.java | 10 +-
.../BaseSparkSegmentMetadataPushJobRunner.java | 14 +-
.../common/BaseSparkSegmentTarPushJobRunner.java | 12 +-
.../common/BaseSparkSegmentUriPushJobRunner.java | 12 +-
.../batch/standalone/SegmentTarPushJobRunner.java | 8 +-
.../standalone/SegmentGenerationJobRunnerTest.java | 6 +-
.../plugin/provider/AzureEnvironmentProvider.java | 13 +-
.../provider/AzureEnvironmentProviderTest.java | 4 +-
.../pinot/plugin/filesystem/ADLSGen2PinotFS.java | 184 +--
.../pinot/plugin/filesystem/AzurePinotFSUtil.java | 32 +-
.../test/ADLSGen2PinotFSPaginatedListTest.java | 6 +-
.../filesystem/test/ADLSGen2PinotFSTest.java | 4 +-
.../apache/pinot/plugin/filesystem/GcsPinotFS.java | 26 +-
.../org/apache/pinot/plugin/filesystem/GcsUri.java | 76 +-
.../filesystem/GcsPinotFSNullSafetyTest.java | 8 +-
.../filesystem/GcsPinotFSPaginatedListTest.java | 6 +-
.../pinot/plugin/filesystem/GcsPinotFSTest.java | 40 +-
.../pinot/plugin/filesystem/HadoopPinotFS.java | 10 +-
.../apache/pinot/plugin/filesystem/S3Config.java | 4 +-
.../apache/pinot/plugin/filesystem/S3PinotFS.java | 91 +-
.../pinot/plugin/filesystem/S3PinotFSCopyTest.java | 64 +-
.../filesystem/S3PinotFSPaginatedListTest.java | 6 +-
.../inputformat/arrow/ArrowAccumulators.java | 38 +-
.../inputformat/arrow/ArrowColumnReader.java | 48 +-
.../arrow/ArrowColumnReaderFactory.java | 67 +-
.../arrow/ArrowFileColumnReaderFactory.java | 70 +-
.../inputformat/arrow/ArrowMessageDecoder.java | 2 +-
.../inputformat/arrow/ArrowRecordReader.java | 4 +-
.../arrow/ArrowToPinotTypeConverter.java | 55 +-
.../inputformat/arrow/BatchedArrowFileSource.java | 56 +-
.../arrow/ArrowColumnReaderFactoryTest.java | 42 +-
.../arrow/ArrowColumnarBuildIntegrationTest.java | 113 +-
.../arrow/ArrowFileColumnReaderFactoryTest.java | 18 +-
.../avro/AvroIngestionSchemaValidator.java | 4 +-
.../plugin/inputformat/avro/AvroRecordReader.java | 4 +-
.../pinot/plugin/inputformat/avro/AvroUtils.java | 106 +-
.../inputformat/avro/KafkaAvroMessageDecoder.java | 43 +-
.../inputformat/avro/SimpleAvroMessageDecoder.java | 22 +-
.../inputformat/clplog/CLPLogMessageDecoder.java | 8 +-
.../inputformat/clplog/CLPLogRecordExtractor.java | 14 +-
.../clplog/CLPLogRecordExtractorConfig.java | 29 +-
...aConfluentSchemaRegistryAvroMessageDecoder.java | 18 +-
...aConfluentSchemaRegistryJsonMessageDecoder.java | 20 +-
...fluentSchemaRegistryProtoBufMessageDecoder.java | 20 +-
.../inputformat/csv/CSVRecordExtractorConfig.java | 20 +-
.../plugin/inputformat/csv/CSVRecordReader.java | 4 +-
.../csv/CSVRecordExtractorConfigTest.java | 4 +-
.../inputformat/json/JSONMessageDecoder.java | 26 +-
.../plugin/inputformat/json/JSONRecordReader.java | 4 +-
.../json/format/AutoDetectPayloadParser.java | 2 +-
.../json/format/CborJsonPayloadParser.java | 2 +-
.../inputformat/json/format/JsonPayloadParser.java | 6 +-
.../json/format/SmileJsonPayloadParser.java | 2 +-
.../json/format/SqliteJsonbPayloadParser.java | 22 +-
.../json/JSONMessageDecoderBinaryTest.java | 4 +-
.../json/format/JsonPayloadFormatTest.java | 6 +-
.../parquet/ParquetAvroRecordReader.java | 16 +-
.../parquet/ParquetNativeRecordReader.java | 4 +-
.../inputformat/parquet/ParquetRecordReader.java | 7 +-
.../plugin/inputformat/parquet/ParquetUtils.java | 8 +-
.../inputformat/parquet/ParquetMapUDFTest.java | 26 +-
.../parquet/ParquetReaderLogicalTypesTest.java | 8 +-
.../inputformat/parquet/ParquetTestUtils.java | 4 +-
.../com/google/protobuf/ProtobufInternalUtils.java | 8 +-
.../inputformat/protobuf/ProtoBufSchemaUtils.java | 26 +-
.../plugin/inputformat/protobuf/ProtoBufUtils.java | 8 +-
.../ProtoBufCodeGenMessageDecoderTest.java | 37 +-
.../ProtoBufRecordExtractorCachingTest.java | 55 +-
.../thrift/ThriftRecordExtractorConfig.java | 4 +-
.../inputformat/thrift/ThriftRecordReader.java | 4 +-
.../inputformat/thrift/ThriftRecordReaderTest.java | 6 +-
.../compound/CompoundPinotMetricsFactory.java | 97 +-
.../metrics/dropwizard/DropwizardMetricName.java | 8 +-
.../dropwizard/DropwizardSettableGauge.java | 10 +-
.../dropwizard/DropwizardAbstractMetricsTest.java | 4 +-
.../dropwizard/DropwizardMetricValueUtils.java | 6 +-
.../dropwizard/DropwizardMetricsInspector.java | 4 +-
.../DropwizardBrokerPrometheusMetricsTest.java | 4 +-
.../DropwizardControllerPrometheusMetricsTest.java | 4 +-
.../DropwizardMinionPrometheusMetricsTest.java | 4 +-
.../DropwizardServerPrometheusMetricsTest.java | 4 +-
.../plugin/metrics/yammer/YammerMetricName.java | 8 +-
.../plugin/metrics/yammer/YammerSettableGauge.java | 10 +-
.../metrics/yammer/YammerAbstractMetricsTest.java | 6 +-
.../metrics/yammer/YammerMetricValueUtils.java | 10 +-
.../metrics/yammer/YammerMetricsInspector.java | 6 +-
.../BaseMultipleSegmentsConversionExecutor.java | 49 +-
.../tasks/BaseSingleSegmentConversionExecutor.java | 24 +-
.../plugin/minion/tasks/BaseTaskExecutor.java | 56 +-
.../pinot/plugin/minion/tasks/MergeTaskUtils.java | 34 +-
.../pinot/plugin/minion/tasks/MinionTaskUtils.java | 172 +--
.../minion/tasks/SegmentConversionResult.java | 7 +-
.../minion/tasks/SegmentConversionUtils.java | 38 +-
.../MaterializedViewTaskExecutor.java | 2 -
.../mergerollup/DimensionValueTransformer.java | 6 +-
.../tasks/mergerollup/MergeRollupTaskExecutor.java | 4 +-
.../mergerollup/MergeRollupTaskGenerator.java | 233 ++-
.../tasks/mergerollup/MergeRollupTaskUtils.java | 28 +-
.../MergeRollupTaskSegmentGroupManager.java | 8 +-
...MergeRollupTaskSegmentGroupManagerProvider.java | 8 +-
.../RealtimeToOfflineSegmentsTaskExecutor.java | 56 +-
...altimeToOfflineSegmentsTaskExecutorFactory.java | 4 +-
.../RealtimeToOfflineSegmentsTaskGenerator.java | 76 +-
.../refreshsegment/RefreshSegmentTaskExecutor.java | 10 +-
.../RefreshSegmentTaskGenerator.java | 14 +-
.../SegmentGenerationAndPushResult.java | 6 +-
.../SegmentGenerationAndPushTaskExecutor.java | 67 +-
.../SegmentGenerationAndPushTaskGenerator.java | 65 +-
.../UpsertCompactMergeTaskExecutor.java | 20 +-
.../UpsertCompactMergeTaskGenerator.java | 8 +-
.../BaseSingleSegmentConversionExecutorTest.java | 22 +-
.../plugin/minion/tasks/MinionTaskUtilsTest.java | 20 +-
.../MergeRollupAvgTaskExecutorTest.java | 58 +-
.../MergeRollupTDigestTaskExecutorTest.java | 74 +-
.../mergerollup/MergeRollupTaskGeneratorTest.java | 56 +-
.../minion/tasks/purge/PurgeTaskExecutorTest.java | 6 +-
.../RealtimeToOfflineSegmentsTaskExecutorTest.java | 4 +-
...RealtimeToOfflineSegmentsTaskGeneratorTest.java | 32 +-
.../SegmentGenerationAndPushTaskExecutorTest.java | 4 +-
.../UpsertCompactMergeTaskExecutorTest.java | 32 +-
.../UpsertCompactMergeTaskGeneratorTest.java | 50 +-
.../segmentuploader/SegmentUploaderDefault.java | 6 +-
.../filebased/FileBasedSegmentWriter.java | 38 +-
.../filebased/FileBasedSegmentWriterTest.java | 24 +-
.../KafkaPartitionLevelConnectionHandler.java | 43 +-
.../kafka30/KafkaStreamMetadataProvider.java | 6 +-
.../SynchronizedKafkaStreamMetadataProvider.java | 10 +-
.../kafka30/server/KafkaServerStartable.java | 10 +-
...tionLevelConsumerBackwardCompatibilityTest.java | 4 +-
.../kafka30/KafkaPartitionLevelConsumerTest.java | 4 +-
.../kafka30/server/EmbeddedKafkaCluster.java | 10 +-
.../KafkaPartitionLevelConnectionHandler.java | 43 +-
.../kafka40/KafkaStreamMetadataProvider.java | 6 +-
.../SynchronizedKafkaStreamMetadataProvider.java | 10 +-
.../kafka40/KafkaPartitionLevelConsumerTest.java | 4 +-
.../stream/kafka40/utils/MiniKafkaCluster.java | 6 +-
.../stream/kafka/KafkaAdminClientManager.java | 42 +-
.../kafka/KafkaConfigBackwardCompatibleUtils.java | 4 +-
.../stream/kafka/KafkaJSONMessageDecoder.java | 6 +-
.../plugin/stream/kafka/KafkaMessageBatch.java | 14 +-
.../kafka/KafkaPartitionLevelStreamConfig.java | 16 +-
.../stream/kafka/KafkaPartitionSubsetUtils.java | 48 +-
.../pinot/plugin/stream/kafka/KafkaSSLUtils.java | 8 +-
.../stream/kafka/KafkaStreamConfigProperties.java | 22 +-
.../pinot/plugin/stream/kinesis/KinesisConfig.java | 30 +-
.../stream/kinesis/KinesisConnectionHandler.java | 8 +-
.../plugin/stream/kinesis/KinesisConsumer.java | 32 +-
.../stream/kinesis/KinesisConsumerFactory.java | 4 +-
.../plugin/stream/kinesis/KinesisMessageBatch.java | 4 +-
.../stream/kinesis/KinesisMsgOffsetFactory.java | 4 +-
.../kinesis/KinesisPartitionGroupOffset.java | 20 +-
.../kinesis/KinesisStreamMetadataProvider.java | 40 +-
.../stream/pulsar/MessageIdStreamOffset.java | 4 +-
.../pulsar/MessageIdStreamOffsetFactory.java | 4 +-
.../stream/pulsar/PulsarConsumerFactory.java | 4 +-
.../plugin/stream/pulsar/PulsarMessageBatch.java | 4 +-
.../PulsarPartitionLevelConnectionHandler.java | 25 +-
.../pulsar/PulsarPartitionLevelConsumer.java | 4 +-
.../stream/pulsar/PulsarStreamMessageMetadata.java | 7 +-
.../pulsar/PulsarStreamMetadataProvider.java | 28 +-
.../pinot/plugin/stream/pulsar/PulsarUtils.java | 29 +-
.../stream/pulsar/server/PulsarDataProducer.java | 9 +-
.../pinot/query/planner/spi/RuleSetCustomizer.java | 1 -
.../pinot/spi/plugin/PluginRealmExportTest.java | 8 +-
.../pinot/calcite/rel/hint/PinotHintOptions.java | 112 +-
.../calcite/rel/hint/PinotHintStrategyTable.java | 73 +-
.../calcite/rel/logical/PinotLogicalAggregate.java | 4 +-
.../calcite/rel/logical/PinotLogicalExchange.java | 6 +-
.../rel/logical/PinotLogicalSortExchange.java | 40 +-
.../calcite/rel/logical/PinotLogicalTableScan.java | 6 +-
.../calcite/rel/logical/PinotRelExchangeType.java | 30 +-
.../calcite/rel/rules/GroupingSetsPlanUtils.java | 36 +-
.../PinotAggregateExchangeNodeInsertRule.java | 123 +-
.../rules/PinotAggregateFunctionRewriteRule.java | 4 +-
.../rules/PinotAggregateReduceFunctionsRule.java | 8 +-
.../rel/rules/PinotEvaluateLiteralRule.java | 18 +-
.../rel/rules/PinotExchangeEliminationRule.java | 9 +-
.../calcite/rel/rules/PinotFilterJoinRule.java | 4 +-
.../rel/rules/PinotImplicitTableHintRule.java | 48 +-
.../rel/rules/PinotJoinExchangeNodeInsertRule.java | 14 +-
.../rel/rules/PinotJoinToDynamicBroadcastRule.java | 139 +-
.../rel/rules/PinotLogicalAggregateRule.java | 34 +-
.../rel/rules/PinotProjectJoinTransposeRule.java | 8 +-
.../calcite/rel/rules/PinotQueryRuleSets.java | 24 +-
.../rel/rules/PinotRelDistributionTraitRule.java | 18 +-
.../pinot/calcite/rel/rules/PinotRuleUtils.java | 29 +-
.../rules/PinotSemiJoinDistinctProjectRule.java | 8 +-
.../rules/PinotSetOpExchangeNodeInsertRule.java | 8 +-
.../rules/PinotSingleValueAggregateRemoveRule.java | 5 +-
.../rel/rules/PinotSortExchangeNodeInsertRule.java | 19 +-
.../rules/PinotWindowExchangeNodeInsertRule.java | 50 +-
.../calcite/rel/rules/PinotWindowSplitRule.java | 30 +-
.../pinot/calcite/rel/rules/TableOptions.java | 10 +-
.../calcite/rel/traits/PinotExecStrategyTrait.java | 33 +-
.../pinot/calcite/rel/traits/TraitAssignment.java | 39 +-
.../pinot/calcite/sql/fun/PinotOperatorTable.java | 76 +-
.../calcite/sql2rel/PinotConvertletTable.java | 28 +-
.../calcite/sql2rel/PinotRelDecorrelator.java | 82 +-
.../calcite/sql2rel/RowComparisonConvertlet.java | 20 +-
.../org/apache/pinot/query/QueryEnvironment.java | 293 ++--
.../apache/pinot/query/catalog/PinotCatalog.java | 38 +-
.../org/apache/pinot/query/catalog/PinotTable.java | 18 +-
.../query/context/PhysicalPlannerContext.java | 37 +-
.../apache/pinot/query/context/PlannerContext.java | 36 +-
.../query/parser/CalciteRexExpressionParser.java | 20 +-
.../pinot/query/parser/utils/ParserUtils.java | 4 +-
.../apache/pinot/query/planner/PlanFragment.java | 15 +-
.../apache/pinot/query/planner/PlannerUtils.java | 11 +-
.../org/apache/pinot/query/planner/SubPlan.java | 19 +-
.../pinot/query/planner/SubPlanMetadata.java | 12 +-
.../explain/AskingServerStageExplainer.java | 61 +-
.../planner/explain/ExplainNodeSimplifier.java | 35 +-
.../MultiStageExplainAskingServersUtils.java | 26 +-
.../explain/PhysicalExplainPlanVisitor.java | 72 +-
.../query/planner/explain/PinotRelJsonWriter.java | 8 +-
.../query/planner/explain/PlanNodeMerger.java | 72 +-
.../query/planner/explain/PlanNodeSorter.java | 22 +-
.../planner/logical/EquivalentStagesFinder.java | 74 +-
.../planner/logical/EquivalentStagesReplacer.java | 28 +-
.../pinot/query/planner/logical/GroupedStages.java | 98 +-
.../planner/logical/LeafStageToPinotQuery.java | 86 +-
.../query/planner/logical/LiteralValueNode.java | 6 +-
.../query/planner/logical/LogicalPlanner.java | 4 +-
.../planner/logical/PinotLogicalQueryPlanner.java | 8 +-
.../query/planner/logical/PlanFragmenter.java | 21 +-
.../planner/logical/PlanNodeToRelConverter.java | 12 +-
.../planner/logical/RelToPlanNodeConverter.java | 69 +-
.../pinot/query/planner/logical/RexExpression.java | 9 +-
.../query/planner/logical/RexExpressionUtils.java | 8 +-
.../query/planner/logical/SubPlanFragmenter.java | 16 +-
.../planner/logical/TransformationTracker.java | 62 +-
.../planner/partitioning/HashFunctionSelector.java | 26 +-
.../query/planner/partitioning/KeySelector.java | 24 +-
.../planner/physical/DispatchablePlanContext.java | 10 +-
.../planner/physical/DispatchablePlanFragment.java | 8 +-
.../planner/physical/DispatchablePlanMetadata.java | 19 +-
.../planner/physical/DispatchableSubPlan.java | 85 +-
.../planner/physical/PinotDispatchPlanner.java | 48 +-
.../planner/physical/v2/DistHashFunction.java | 12 +-
.../planner/physical/v2/ExchangeStrategy.java | 74 +-
.../planner/physical/v2/HashDistributionDesc.java | 19 +-
.../pinot/query/planner/physical/v2/PRelNode.java | 52 +-
.../planner/physical/v2/PRelNodeTreeValidator.java | 20 +-
.../physical/v2/PRelToPlanNodeConverter.java | 33 +-
.../planner/physical/v2/PinotDataDistribution.java | 61 +-
.../v2/PlanFragmentAndMailboxAssignment.java | 70 +-
.../planner/physical/v2/RelToPRelConverter.java | 4 +-
.../planner/physical/v2/TableScanMetadata.java | 77 +-
.../physical/v2/mapping/DistMappingGenerator.java | 8 +-
.../physical/v2/mapping/PinotDistMapping.java | 23 +-
.../physical/v2/nodes/PhysicalAggregate.java | 6 +-
.../planner/physical/v2/nodes/PhysicalUnion.java | 4 +-
.../v2/opt/LeftInputFirstRuleExecutor.java | 13 +-
.../physical/v2/opt/PRelNodeTransformer.java | 4 +-
.../query/planner/physical/v2/opt/PRelOptRule.java | 16 +-
.../planner/physical/v2/opt/RuleExecutor.java | 12 +-
.../v2/opt/rules/AggregatePushdownRule.java | 34 +-
.../v2/opt/rules/LeafStageAggregateRule.java | 10 +-
.../v2/opt/rules/LeafStageBoundaryRule.java | 17 +-
.../opt/rules/LeafStageWorkerAssignmentRule.java | 88 +-
.../v2/opt/rules/LiteModeSortInsertRule.java | 20 +-
.../v2/opt/rules/LiteModeWorkerAssignmentRule.java | 18 +-
.../physical/v2/opt/rules/LookupJoinRule.java | 59 +-
.../v2/opt/rules/RootExchangeInsertRule.java | 11 +-
.../physical/v2/opt/rules/SortPushdownRule.java | 11 +-
.../v2/opt/rules/WorkerExchangeAssignmentRule.java | 58 +-
.../query/planner/plannode/AggregateNode.java | 16 +-
.../plannode/DefaultPostOrderTraversalVisitor.java | 6 +-
.../query/planner/plannode/EnrichedJoinNode.java | 6 +-
.../pinot/query/planner/plannode/ExchangeNode.java | 11 +-
.../query/planner/plannode/ExplainedNode.java | 10 +-
.../query/planner/plannode/MailboxSendNode.java | 8 +-
.../pinot/query/planner/plannode/PlanNode.java | 28 +-
.../query/planner/plannode/PlanNodeVisitor.java | 131 +-
.../pinot/query/planner/plannode/SetOpNode.java | 4 +-
.../pinot/query/planner/plannode/UnnestNode.java | 28 +-
.../pinot/query/planner/plannode/WindowNode.java | 26 +-
.../serde/ProtoExpressionToRexExpression.java | 4 +-
.../serde/RexExpressionToProtoExpression.java | 4 +-
.../validation/ArrayToMvValidationVisitor.java | 6 +-
.../apache/pinot/query/routing/MailboxInfo.java | 4 +-
.../query/routing/PlanNodeRoutingQueryBuilder.java | 46 +-
.../pinot/query/routing/QueryPlanSerDeUtils.java | 4 +-
.../pinot/query/routing/QueryServerInstance.java | 10 +-
.../pinot/query/routing/SharedMailboxInfos.java | 6 +-
.../apache/pinot/query/routing/StageMetadata.java | 4 +-
.../org/apache/pinot/query/routing/StagePlan.java | 8 +-
.../pinot/query/routing/VirtualServerAddress.java | 26 +-
.../apache/pinot/query/routing/WorkerManager.java | 164 +--
.../apache/pinot/query/routing/WorkerMetadata.java | 23 +-
.../org/apache/pinot/query/type/TypeFactory.java | 18 +-
.../org/apache/pinot/query/type/TypeSystem.java | 20 +-
.../pinot/query/validate/PinotTypeCoercion.java | 34 +-
.../org/apache/pinot/query/validate/Validator.java | 81 +-
.../PinotAggregateExchangeNodeInsertRuleTest.java | 2 +-
.../rel/rules/PinotImplicitTableHintRuleTest.java | 6 +-
.../calcite/sql2rel/PinotRelDecorrelatorTest.java | 10 +-
.../apache/pinot/query/QueryCompilationTest.java | 108 +-
.../pinot/query/QueryEnvironmentTestBase.java | 6 +-
.../planner/explain/ExplainNodeSimplifierTest.java | 22 +-
.../query/planner/explain/PlanNodeMergerTest.java | 6 +-
.../planner/logical/LeafStageToPinotQueryTest.java | 8 +-
.../planner/logical/RexExpressionUtilsTest.java | 4 +-
.../query/planner/logical/StagesTestBase.java | 327 ++---
.../partitioning/HashFunctionSelectorTest.java | 4 +-
.../partitioning/KeySelectorHashFunctionTest.java | 4 +-
.../physical/MailboxAssignmentVisitorTest.java | 12 +-
.../planner/physical/v2/EmptyTablePlanTest.java | 14 +-
.../planner/physical/v2/LookupJoinPlanTest.java | 34 +-
.../physical/v2/PRelToPlanNodeConverterTest.java | 10 +-
.../query/planner/serde/PlanNodeSerDeTest.java | 6 +-
.../pinot/query/routing/WorkerManagerTest.java | 105 +-
.../pinot/query/testutils/QueryTestUtils.java | 7 +-
.../query/validate/PinotTypeCoercionTest.java | 89 +-
.../pinot/query/access/QueryAccessControl.java | 16 +-
.../query/access/QueryAccessControlFactory.java | 10 +-
.../pinot/query/mailbox/GrpcSendingMailbox.java | 18 +-
.../apache/pinot/query/mailbox/MailboxService.java | 80 +-
.../pinot/query/mailbox/ReceivingMailbox.java | 2 +-
.../apache/pinot/query/mailbox/SendingMailbox.java | 66 +-
.../query/mailbox/channel/ChannelManager.java | 70 +-
.../query/mailbox/channel/GrpcMailboxServer.java | 30 +-
.../mailbox/channel/MailboxContentObserver.java | 12 +-
.../mailbox/channel/MailboxServerInterceptor.java | 6 +-
.../mailbox/channel/MailboxStatusObserver.java | 4 +-
.../query/runtime/InStageStatsTreeBuilder.java | 22 +-
.../query/runtime/MultiStageStatsTreeBuilder.java | 49 +-
.../apache/pinot/query/runtime/QueryRunner.java | 120 +-
.../pinot/query/runtime/blocks/BlockSplitter.java | 29 +-
.../pinot/query/runtime/blocks/ErrorMseBlock.java | 1 -
.../executor/OpChainCompletionListener.java | 48 +-
.../runtime/executor/OpChainSchedulerService.java | 42 +-
.../pinot/query/runtime/function/Adler32Udf.java | 4 +-
.../pinot/query/runtime/function/AndUdf.java | 4 +-
.../pinot/query/runtime/function/ArrayUdf.java | 4 +-
.../query/runtime/operator/AggregateOperator.java | 38 +-
.../query/runtime/operator/BaseJoinOperator.java | 58 +-
.../operator/BaseMailboxReceiveOperator.java | 68 +-
.../query/runtime/operator/FilterOperator.java | 8 +-
.../query/runtime/operator/HashJoinOperator.java | 8 +-
.../pinot/query/runtime/operator/LeafOperator.java | 22 +-
.../runtime/operator/LiteralValueOperator.java | 8 +-
.../query/runtime/operator/LookupJoinOperator.java | 27 +-
.../runtime/operator/MailboxReceiveOperator.java | 7 +-
.../runtime/operator/MailboxSendOperator.java | 91 +-
.../query/runtime/operator/MultiStageOperator.java | 97 +-
.../operator/MultistageAggregationExecutor.java | 14 +-
.../operator/MultistageGroupByExecutor.java | 26 +-
.../runtime/operator/NonEquiJoinOperator.java | 6 +-
.../pinot/query/runtime/operator/OpChain.java | 28 +-
.../runtime/operator/OperatorTypeDescriptor.java | 84 +-
.../runtime/operator/OperatorTypeRegistry.java | 32 +-
.../query/runtime/operator/RepeatOperator.java | 12 +-
.../pinot/query/runtime/operator/SortOperator.java | 8 +-
.../operator/SortedMailboxReceiveOperator.java | 14 +-
.../query/runtime/operator/TransformOperator.java | 26 +-
.../query/runtime/operator/UnnestOperator.java | 26 +-
.../runtime/operator/WindowAggregateOperator.java | 80 +-
.../runtime/operator/exchange/BlockExchange.java | 68 +-
.../operator/exchange/BroadcastExchange.java | 4 +-
.../runtime/operator/exchange/HashExchange.java | 8 +-
.../runtime/operator/exchange/RandomExchange.java | 6 +-
.../operator/exchange/SingletonExchange.java | 6 +-
.../operator/factory/AggregateOperatorFactory.java | 18 +-
.../factory/DefaultAggregateOperatorFactory.java | 4 +-
.../factory/DefaultJoinOperatorFactory.java | 8 +-
.../DefaultQueryOperatorFactoryProvider.java | 4 +-
.../operator/factory/JoinOperatorFactory.java | 4 +-
.../factory/QueryOperatorFactoryProvider.java | 4 +-
.../runtime/operator/groupby/GroupIdGenerator.java | 16 +-
.../runtime/operator/join/DoubleLookupTable.java | 4 +-
.../runtime/operator/join/FloatLookupTable.java | 4 +-
.../runtime/operator/join/IntLookupTable.java | 4 +-
.../query/runtime/operator/join/JoinedRowView.java | 8 +-
.../runtime/operator/join/LongLookupTable.java | 4 +-
.../query/runtime/operator/join/LookupTable.java | 42 +-
.../runtime/operator/join/ObjectLookupTable.java | 4 +-
.../runtime/operator/operands/FilterOperand.java | 22 +-
.../runtime/operator/set/BinarySetOperator.java | 34 +-
.../runtime/operator/set/IntersectAllOperator.java | 4 +-
.../runtime/operator/set/IntersectOperator.java | 4 +-
.../runtime/operator/set/MinusAllOperator.java | 4 +-
.../query/runtime/operator/set/MinusOperator.java | 4 +-
.../query/runtime/operator/set/SetOperator.java | 12 +-
.../runtime/operator/set/UnionAllOperator.java | 4 +-
.../query/runtime/operator/set/UnionOperator.java | 6 +-
.../runtime/operator/utils/AggregationUtils.java | 16 +-
.../query/runtime/operator/utils/AsyncStream.java | 62 +-
.../utils/BlockingMultiStreamConsumer.java | 186 +--
.../query/runtime/operator/utils/SortUtils.java | 10 +-
.../query/runtime/operator/utils/TypeUtils.java | 14 +-
.../query/runtime/operator/window/WindowFrame.java | 8 +-
.../runtime/operator/window/WindowFunction.java | 63 +-
.../operator/window/WindowFunctionFactory.java | 4 +-
.../window/aggregate/AggregateWindowFunction.java | 24 +-
.../window/aggregate/AvgWindowValueAggregator.java | 4 +-
.../aggregate/BoolAndWindowValueAggregator.java | 4 +-
.../aggregate/BoolOrWindowValueAggregator.java | 4 +-
.../aggregate/CountWindowValueAggregator.java | 4 +-
.../MaxComparableWindowValueAggregator.java | 16 +-
.../aggregate/MaxDoubleWindowValueAggregator.java | 14 +-
.../aggregate/MaxIntWindowValueAggregator.java | 18 +-
.../aggregate/MaxLongWindowValueAggregator.java | 20 +-
.../MinComparableWindowValueAggregator.java | 16 +-
.../aggregate/MinDoubleWindowValueAggregator.java | 14 +-
.../aggregate/MinIntWindowValueAggregator.java | 18 +-
.../aggregate/MinLongWindowValueAggregator.java | 20 +-
.../SortedMultisetMinMaxWindowValueAggregator.java | 20 +-
.../SumBigDecimalWindowValueAggregator.java | 6 +-
.../aggregate/SumDoubleWindowValueAggregator.java | 4 +-
.../aggregate/SumLongWindowValueAggregator.java | 6 +-
.../window/aggregate/WindowValueAggregator.java | 18 +-
.../aggregate/WindowValueAggregatorFactory.java | 28 +-
.../window/range/RankBasedWindowFunction.java | 6 +-
.../window/value/FirstValueWindowFunction.java | 14 +-
.../window/value/LagValueWindowFunction.java | 8 +-
.../window/value/LastValueWindowFunction.java | 14 +-
.../window/value/LeadValueWindowFunction.java | 8 +-
.../window/value/OffsetValueWindowFunction.java | 46 +-
.../query/runtime/plan/MultiStageQueryStats.java | 273 ++--
.../runtime/plan/MultiStageStatsTreeDecoder.java | 44 +-
.../runtime/plan/MultiStageStatsTreeEncoder.java | 182 ++-
.../pinot/query/runtime/plan/OpChainConverter.java | 53 +-
.../runtime/plan/OpChainConverterDispatcher.java | 16 +-
.../runtime/plan/OpChainExecutionContext.java | 90 +-
.../query/runtime/plan/PlanNodeToOpChain.java | 63 +-
.../query/runtime/plan/StageStatsTreeNode.java | 66 +-
.../plan/pipeline/PipelineBreakerContext.java | 6 +-
.../plan/pipeline/PipelineBreakerExecutor.java | 30 +-
.../plan/pipeline/PipelineBreakerOperator.java | 8 +-
.../plan/pipeline/PipelineBreakerResult.java | 4 +-
.../plan/server/ServerPlanRequestContext.java | 12 +-
.../plan/server/ServerPlanRequestUtils.java | 44 +-
.../plan/server/ServerPlanRequestVisitor.java | 17 +-
.../PhysicalTimeSeriesServerPlanVisitor.java | 4 +-
.../TimeSeriesExchangeReceiveOperator.java | 37 +-
.../TimeSeriesExchangeReceivePlanNode.java | 6 +-
.../timeseries/serde/TimeSeriesBlockSerde.java | 86 +-
.../dispatch/AllValuesDispatchObserver.java | 4 +-
.../query/service/dispatch/AsyncResponse.java | 9 +-
.../query/service/dispatch/CancelObserver.java | 4 +-
.../query/service/dispatch/DispatchClient.java | 64 +-
.../dispatch/LastValueDispatchObserver.java | 6 +-
.../query/service/dispatch/QueryDispatcher.java | 191 ++-
.../streaming/StreamingDispatchObserver.java | 105 +-
.../dispatch/streaming/StreamingQuerySession.java | 178 +--
.../dispatch/streaming/StreamingServerHandle.java | 14 +-
.../timeseries/TimeSeriesDispatchClient.java | 12 +-
.../timeseries/TimeSeriesDispatchObserver.java | 16 +-
.../pinot/query/service/server/QueryServer.java | 61 +-
.../apache/pinot/query/QueryServerEnclosure.java | 24 +-
.../java/org/apache/pinot/query/QueryTestSet.java | 10 +-
.../channel/GrpcMailboxServerValidationTest.java | 20 +-
.../runtime/MultiStageStatsTreeBuilderTest.java | 34 +-
.../executor/OpChainSchedulerServiceTest.java | 8 +-
.../query/runtime/operator/OperatorTestUtil.java | 4 +-
.../runtime/operator/join/LookupTableTest.java | 4 +-
.../runtime/plan/MultiStageQueryStatsTest.java | 16 +-
.../plan/MultiStageStatsTreeDecoderTest.java | 46 +-
.../plan/MultiStageStatsTreeEncoderTest.java | 70 +-
.../query/runtime/queries/QueryRunnerTest.java | 24 +-
.../query/runtime/queries/QueryRunnerTestBase.java | 6 +-
.../runtime/queries/ResourceBasedQueriesTest.java | 6 +-
.../timeseries/serde/TimeSeriesBlockSerdeTest.java | 4 +-
.../streaming/StreamingDispatchObserverTest.java | 74 +-
.../streaming/StreamingQuerySessionTest.java | 108 +-
.../local/aggregator/AvgMVValueAggregator.java | 6 +-
.../local/aggregator/AvgValueAggregator.java | 4 +-
.../local/aggregator/CountMVValueAggregator.java | 12 +-
.../DistinctCountBitmapValueAggregator.java | 4 +-
.../DistinctCountHLLPlusValueAggregator.java | 4 +-
.../DistinctCountHLLValueAggregator.java | 4 +-
.../IntegerTupleSketchValueAggregator.java | 12 +-
.../aggregator/PercentileEstValueAggregator.java | 4 +-
.../PercentileTDigestValueAggregator.java | 4 +-
.../local/aggregator/SumMVValueAggregator.java | 6 +-
.../aggregator/SumPrecisionValueAggregator.java | 6 +-
.../local/aggregator/SumValueAggregator.java | 4 +-
.../segment/local/aggregator/ValueAggregator.java | 63 +-
.../local/aggregator/ValueAggregatorFactory.java | 24 +-
.../NullValueColumnTransformer.java | 8 +-
.../SanitizationColumnTransformer.java | 46 +-
.../SpecialValueColumnTransformer.java | 51 +-
.../TimeValidationColumnTransformer.java | 26 +-
.../local/customobject/CovarianceTuple.java | 6 +-
.../local/customobject/CpcSketchAccumulator.java | 8 +-
.../customobject/CustomObjectAccumulator.java | 58 +-
.../local/customobject/PinotFourthMoment.java | 26 +-
.../segment/local/customobject/QuantileDigest.java | 72 +-
.../local/customobject/SerializedCPCSketch.java | 8 +-
.../segment/local/customobject/SerializedKLL.java | 6 +-
.../customobject/SerializedQuantileDigest.java | 4 +-
.../local/customobject/SerializedTDigest.java | 4 +-
.../local/customobject/ThetaSketchAccumulator.java | 16 +-
.../customobject/TupleIntSketchAccumulator.java | 18 +-
.../local/data/manager/SegmentDataManager.java | 38 +-
.../segment/local/data/manager/StaleSegment.java | 4 +-
.../local/data/manager/TableDataManager.java | 344 ++---
.../dedup/BasePartitionDedupMetadataManager.java | 16 +-
.../local/dedup/BaseTableDedupMetadataManager.java | 8 +-
.../pinot/segment/local/dedup/DedupContext.java | 2 +-
.../pinot/segment/local/dedup/DedupUtils.java | 4 +-
.../local/dedup/PartitionDedupMetadataManager.java | 60 +-
.../local/dedup/TableDedupMetadataManager.java | 22 +-
.../segment/local/function/FunctionEvaluator.java | 20 +-
.../local/function/FunctionEvaluatorFactory.java | 20 +-
.../local/function/GroovyFunctionEvaluator.java | 18 +-
.../local/function/GroovyStaticAnalyzerConfig.java | 16 +-
.../local/function/InbuiltFunctionEvaluator.java | 18 +-
.../local/function/TimeSpecFunctionEvaluator.java | 18 +-
.../indexsegment/immutable/EmptyIndexSegment.java | 6 +-
.../immutable/ImmutableSegmentImpl.java | 14 +-
.../immutable/ImmutableSegmentLoader.java | 62 +-
.../indexsegment/mutable/MutableSegmentImpl.java | 73 +-
.../io/compression/ChunkCompressorFactory.java | 38 +-
.../local/io/compression/DeltaCompressor.java | 6 +-
.../local/io/compression/DeltaDecompressor.java | 6 +-
.../local/io/compression/DeltaDeltaCompressor.java | 30 +-
.../io/compression/DeltaDeltaDecompressor.java | 8 +-
.../local/io/compression/GzipCompressor.java | 4 +-
.../local/io/compression/GzipDecompressor.java | 4 +-
.../local/io/compression/LZ4Compressor.java | 6 +-
.../local/io/compression/LZ4Decompressor.java | 8 +-
.../io/compression/LZ4WithLengthCompressor.java | 6 +-
.../io/compression/LZ4WithLengthDecompressor.java | 6 +-
.../io/compression/PassThroughCompressor.java | 8 +-
.../io/compression/PassThroughDecompressor.java | 8 +-
.../local/io/compression/SnappyCompressor.java | 4 +-
.../local/io/compression/SnappyDecompressor.java | 4 +-
.../local/io/compression/ZstandardCompressor.java | 6 +-
.../io/compression/ZstandardDecompressor.java | 8 +-
.../local/io/reader/impl/FixedBitIntReader.java | 22 +-
.../impl/FixedByteSingleValueMultiColReader.java | 120 +-
.../RealtimeIndexOffHeapMemoryManager.java | 58 +-
...ixedByteSingleValueMultiColumnReaderWriter.java | 40 +-
.../local/io/util/FixedBitIntReaderWriterV2.java | 102 +-
.../segment/local/io/util/PinotDataBitSet.java | 29 +-
.../segment/local/io/util/PinotDataBitSetV2.java | 54 +-
.../pinot/segment/local/io/util/ValueReader.java | 48 +-
.../local/io/util/VarLengthValueReader.java | 10 +-
.../local/io/util/VarLengthValueWriter.java | 76 +-
.../writer/impl/BaseChunkForwardIndexWriter.java | 101 +-
.../local/io/writer/impl/DirectMemoryManager.java | 17 +-
.../FixedBitMVEntryDictForwardIndexWriter.java | 40 +-
.../writer/impl/FixedBitMVForwardIndexWriter.java | 40 +-
.../writer/impl/FixedBitSVForwardIndexWriter.java | 6 +-
.../impl/FixedByteChunkForwardIndexWriter.java | 30 +-
.../local/io/writer/impl/MmapMemoryManager.java | 42 +-
.../writer/impl/MutableOffHeapByteArrayStore.java | 116 +-
.../impl/VarByteChunkForwardIndexWriter.java | 59 +-
.../impl/VarByteChunkForwardIndexWriterV4.java | 59 +-
.../impl/VarByteChunkForwardIndexWriterV5.java | 106 +-
.../impl/VarByteChunkForwardIndexWriterV6.java | 32 +-
.../loader/DefaultSegmentDirectoryLoader.java | 26 +-
.../loader/TierBasedSegmentDirectoryLoader.java | 29 +-
.../converter/RealtimeSegmentConverter.java | 14 +-
.../converter/stats/MutableColumnStatistics.java | 4 +-
.../stats/MutableSegmentCreationDataSource.java | 8 +-
.../stats/RealtimeSegmentStatsContainer.java | 14 +-
.../local/realtime/impl/RealtimeSegmentConfig.java | 24 +-
.../realtime/impl/RealtimeSegmentStatsHistory.java | 44 +-
.../dictionary/BaseOffHeapMutableDictionary.java | 238 ++-
.../dictionary/BaseOnHeapMutableDictionary.java | 44 +-
.../dictionary/BytesOffHeapMutableDictionary.java | 16 +-
.../impl/dictionary/OffHeapMutableBytesStore.java | 61 +-
.../dictionary/SameValueMutableDictionary.java | 6 +-
.../impl/forward/CLPMutableForwardIndexV2.java | 196 ++-
.../forward/FixedByteMVMutableForwardIndex.java | 123 +-
.../forward/FixedByteSVMutableForwardIndex.java | 35 +-
.../impl/forward/SameValueMutableForwardIndex.java | 6 +-
.../impl/forward/VarByteSVMutableForwardIndex.java | 4 +-
.../realtime/impl/geospatial/MutableH3Index.java | 11 +-
.../invertedindex/LuceneNRTCachingMergePolicy.java | 16 +-
.../MultiColumnRealtimeLuceneTextIndex.java | 29 +-
.../impl/invertedindex/RealtimeInvertedIndex.java | 11 +-
.../RealtimeLuceneDocIdCollector.java | 12 +-
.../RealtimeLuceneIndexRefreshManager.java | 72 +-
.../RealtimeLuceneIndexingDelayTracker.java | 62 +-
.../RealtimeLuceneRefreshListener.java | 48 +-
.../invertedindex/RealtimeLuceneTextIndex.java | 41 +-
.../RealtimeLuceneTextIndexSearcherPool.java | 44 +-
.../invertedindex/RealtimeNgramFilteringIndex.java | 68 +-
.../realtime/impl/json/MutableJsonIndexImpl.java | 46 +-
.../impl/nullvalue/MutableNullValueVector.java | 4 +-
.../realtime/impl/vector/MutableVectorIndex.java | 9 +-
.../writer/StatelessRealtimeSegmentWriter.java | 26 +-
.../recordtransformer/ComplexTypeTransformer.java | 110 +-
.../recordtransformer/DataTypeTransformer.java | 55 +-
.../recordtransformer/ExpressionTransformer.java | 25 +-
.../local/recordtransformer/FilterTransformer.java | 6 +-
.../recordtransformer/RecordTransformerUtils.java | 14 +-
.../SchemaConformingTransformer.java | 288 ++--
.../recordtransformer/SpecialValueTransformer.java | 39 +-
.../TimeValidationTransformer.java | 11 +-
.../enricher/clp/CLPEncodingEnricher.java | 12 +-
.../enricher/clp/CLPEncodingEnricherConfig.java | 4 +-
.../enricher/function/CustomFunctionEnricher.java | 6 +-
.../function/CustomFunctionEnricherConfig.java | 4 +-
.../creator/ColumnarSegmentCreationDataSource.java | 37 +-
.../RecordReaderSegmentCreationDataSource.java | 6 +-
.../local/segment/creator/TransformPipeline.java | 10 +-
.../segment/creator/impl/BaseSegmentCreator.java | 139 +-
.../segment/creator/impl/ColumnIndexCreators.java | 6 +-
.../creator/impl/ColumnJsonParserException.java | 12 +-
.../creator/impl/ColumnarValueNormalizer.java | 73 +-
.../creator/impl/SegmentColumnarIndexCreator.java | 85 +-
.../creator/impl/SegmentDictionaryCreator.java | 58 +-
.../impl/SegmentIndexCreationDriverImpl.java | 78 +-
.../impl/bloom/OnHeapGuavaBloomFilterCreator.java | 9 +-
.../creator/impl/fwd/CLPForwardIndexCreatorV1.java | 22 +-
.../creator/impl/fwd/CLPForwardIndexCreatorV2.java | 270 ++--
.../creator/impl/fwd/ForwardIndexUtils.java | 16 +-
.../MultiValueEntryDictForwardIndexCreator.java | 4 +-
.../fwd/MultiValueFixedByteRawIndexCreator.java | 30 +-
.../fwd/MultiValueUnsortedForwardIndexCreator.java | 4 +-
.../impl/fwd/MultiValueVarByteRawIndexCreator.java | 96 +-
.../fwd/SingleValueFixedByteRawIndexCreator.java | 44 +-
.../fwd/SingleValueSortedForwardIndexCreator.java | 4 +-
.../SingleValueUnsortedForwardIndexCreator.java | 4 +-
.../fwd/SingleValueVarByteRawIndexCreator.java | 52 +-
.../impl/inv/BitSlicedRangeIndexCreator.java | 22 +-
.../impl/inv/BitmapInvertedIndexWriter.java | 57 +-
.../inv/OffHeapBitmapInvertedIndexCreator.java | 77 +-
.../impl/inv/OnHeapBitmapInvertedIndexCreator.java | 4 +-
.../creator/impl/inv/RangeIndexCreator.java | 77 +-
.../impl/inv/geospatial/BaseH3IndexCreator.java | 34 +-
.../impl/inv/geospatial/OffHeapH3IndexCreator.java | 22 +-
.../impl/inv/geospatial/OnHeapH3IndexCreator.java | 11 +-
.../impl/inv/json/BaseJsonIndexCreator.java | 35 +-
.../impl/inv/json/OffHeapJsonIndexCreator.java | 25 +-
.../impl/inv/json/OnHeapJsonIndexCreator.java | 12 +-
.../impl/inv/text/LuceneFSTIndexCreator.java | 31 +-
.../impl/inv/text/LuceneIFSTIndexCreator.java | 33 +-
.../impl/nullvalue/NullValueVectorCreator.java | 18 +-
.../stats/AbstractColumnStatisticsCollector.java | 22 +-
.../BigDecimalColumnPreIndexStatsCollector.java | 4 +-
.../stats/BytesColumnPreIndexStatsCollector.java | 4 +-
.../creator/impl/stats/CLPStatsProvider.java | 8 +-
.../ColumnarSegmentPreIndexStatsContainer.java | 80 +-
.../stats/MapColumnPreIndexStatsCollector.java | 42 +-
.../stats/NoDictColumnStatisticsCollector.java | 20 +-
.../creator/impl/stats/StatsCollectorUtil.java | 18 +-
.../text/LuceneCombinedTextIndexConstants.java | 56 +-
.../creator/impl/text/LuceneTextIndexCombined.java | 119 +-
.../creator/impl/text/LuceneTextIndexCreator.java | 113 +-
.../text/MultiColumnLuceneTextIndexCreator.java | 111 +-
.../impl/vector/HnswVectorIndexCreator.java | 9 +-
.../creator/impl/vector/lucene99/HnswCodec.java | 62 +-
.../vector/lucene99/HnswVectorIndexCombined.java | 18 +-
.../impl/vector/lucene99/HnswVectorsFormat.java | 27 +-
.../DefaultNullValueVirtualColumnProvider.java | 4 +-
.../converter/SegmentV1V2ToV3FormatConverter.java | 4 +-
.../segment/index/datasource/EmptyDataSource.java | 4 +-
.../index/datasource/ImmutableDataSource.java | 4 +-
.../index/datasource/MutableDataSource.java | 4 +-
.../index/dictionary/DictionaryIndexType.java | 61 +-
.../index/dictionary/DictionaryInternerHolder.java | 4 +-
.../index/forward/ForwardIndexCreatorFactory.java | 12 +-
.../local/segment/index/fst/FstIndexUtils.java | 4 +-
.../segment/index/inverted/InvertedIndexType.java | 22 +-
.../segment/index/loader/BaseIndexHandler.java | 12 +-
.../segment/index/loader/ForwardIndexHandler.java | 32 +-
.../segment/index/loader/IndexLoadingConfig.java | 32 +-
...IndexAndDictionaryBasedForwardIndexCreator.java | 33 +-
.../local/segment/index/loader/LoaderUtils.java | 85 +-
.../segment/index/loader/SegmentPreProcessor.java | 30 +-
.../ColumnMinMaxValueGenerator.java | 4 +-
.../ColumnMinMaxValueGeneratorMode.java | 15 +-
.../defaultcolumn/BaseDefaultColumnHandler.java | 216 ++-
.../loader/defaultcolumn/DefaultColumnHandler.java | 19 +-
.../loader/invertedindex/FSTIndexHandler.java | 36 +-
.../loader/invertedindex/IFSTIndexHandler.java | 36 +-
.../LegacyRawValueInvertedIndexCleanup.java | 4 +-
.../invertedindex/MultiColumnTextIndexHandler.java | 50 +-
.../loader/invertedindex/TextIndexHandler.java | 90 +-
.../loader/invertedindex/VectorIndexHandler.java | 84 +-
.../local/segment/index/map/BaseMapDataSource.java | 14 +-
.../segment/index/map/MutableMapDataSource.java | 4 +-
.../local/segment/index/map/NullDataSource.java | 8 +-
.../openstruct/ImmutableOpenStructDataSource.java | 16 +-
.../openstruct/MutableOpenStructDataSource.java | 6 +-
.../index/openstruct/MutableOpenStructIndex.java | 10 +-
.../index/openstruct/OpenStructIndexPlugin.java | 2 +-
.../index/readers/BaseImmutableDictionary.java | 8 +-
.../index/readers/BigDecimalDictionary.java | 4 +-
.../index/readers/BitmapInvertedIndexReader.java | 8 +-
.../segment/index/readers/BytesDictionary.java | 4 +-
.../readers/ConstantValueBigDecimalDictionary.java | 4 +-
.../readers/ConstantValueBytesDictionary.java | 4 +-
.../readers/ConstantValueDoubleDictionary.java | 4 +-
.../readers/ConstantValueFloatDictionary.java | 4 +-
.../index/readers/ConstantValueIntDictionary.java | 4 +-
.../index/readers/ConstantValueLongDictionary.java | 4 +-
.../readers/ConstantValueStringDictionary.java | 4 +-
.../segment/index/readers/DocIdDictionary.java | 4 +-
.../index/readers/LuceneFSTIndexReader.java | 9 +-
.../index/readers/LuceneIFSTIndexReader.java | 9 +-
.../index/readers/OnHeapBigDecimalDictionary.java | 14 +-
.../index/readers/OnHeapBytesDictionary.java | 14 +-
.../index/readers/OnHeapDoubleDictionary.java | 29 +-
.../index/readers/OnHeapFloatDictionary.java | 29 +-
.../segment/index/readers/OnHeapIntDictionary.java | 29 +-
.../index/readers/OnHeapLongDictionary.java | 29 +-
.../index/readers/OnHeapStringDictionary.java | 17 +-
.../index/readers/RangeIndexReaderImpl.java | 58 +-
.../segment/index/readers/StringDictionary.java | 4 +-
.../readers/bloom/BaseGuavaBloomFilterReader.java | 7 +-
.../readers/bloom/GuavaBloomFilterReaderUtils.java | 12 +-
.../bloom/OffHeapGuavaBloomFilterReader.java | 4 +-
.../bloom/OnHeapGuavaBloomFilterReader.java | 4 +-
.../constant/ConstantMVForwardIndexReader.java | 4 +-
.../constant/ConstantMVInvertedIndexReader.java | 4 +-
.../constant/ConstantSortedIndexReader.java | 4 +-
.../forward/BaseChunkForwardIndexReader.java | 30 +-
.../readers/forward/CLPForwardIndexReaderV2.java | 63 +-
.../index/readers/forward/ChunkReaderContext.java | 18 +-
.../FixedBitMVEntryDictForwardIndexReader.java | 10 +-
.../forward/FixedBitMVForwardIndexReader.java | 32 +-
.../forward/FixedBitSVForwardIndexReader.java | 6 +-
.../forward/FixedBitSVForwardIndexReaderV2.java | 6 +-
.../FixedByteChunkMVForwardIndexReader.java | 25 +-
.../FixedByteChunkSVForwardIndexReader.java | 11 +-
.../FixedBytePower2ChunkSVForwardIndexReader.java | 11 +-
.../forward/VarByteChunkForwardIndexReaderV4.java | 19 +-
.../forward/VarByteChunkForwardIndexReaderV5.java | 11 +-
.../forward/VarByteChunkForwardIndexReaderV6.java | 38 +-
.../forward/VarByteChunkMVForwardIndexReader.java | 29 +-
.../forward/VarByteChunkSVForwardIndexReader.java | 33 +-
.../readers/geospatial/ImmutableH3IndexReader.java | 10 +-
.../readers/json/ImmutableJsonIndexReader.java | 37 +-
.../readers/sorted/SortedIndexReaderImpl.java | 4 +-
.../index/readers/text/DefaultDocIdTranslator.java | 14 +-
.../index/readers/text/LuceneDocIdCollector.java | 26 +-
.../readers/text/LuceneTextIndexBufferReader.java | 102 +-
.../index/readers/text/LuceneTextIndexHeader.java | 14 +-
.../index/readers/text/LuceneTextIndexReader.java | 92 +-
.../text/MultiColumnLuceneTextIndexReader.java | 61 +-
.../index/readers/text/NoOpDocIdTranslator.java | 6 +-
.../index/readers/text/PinotBufferIndexInput.java | 6 +-
.../readers/text/PinotBufferLuceneDirectory.java | 8 +-
.../vector/HnswVectorIndexBufferReader.java | 34 +-
.../readers/vector/HnswVectorIndexReader.java | 144 +-
.../readers/vector/IvfFlatVectorIndexReader.java | 114 +-
.../readers/vector/IvfOnDiskVectorIndexReader.java | 92 +-
.../readers/vector/IvfPqVectorIndexReader.java | 40 +-
.../vector/LuceneHnswRuntimeControlUtils.java | 12 +-
.../index/text/CaseAwareStandardAnalyzer.java | 64 +-
.../segment/index/text/TextIndexConfigBuilder.java | 12 +-
.../text/lucene/parsers/MatchQueryParser.java | 258 ++--
.../lucene/parsers/PrefixPhraseQueryParser.java | 274 ++--
.../local/segment/index/vector/FlatQuantizer.java | 26 +-
.../segment/index/vector/IvfCombinedBuffers.java | 24 +-
.../index/vector/IvfFlatVectorIndexCreator.java | 194 ++-
.../segment/index/vector/IvfPqIndexFormat.java | 38 +-
.../index/vector/IvfPqVectorIndexCreator.java | 65 +-
.../local/segment/index/vector/KMeansTrainer.java | 8 +-
.../segment/index/vector/ProductQuantizer.java | 8 +-
.../segment/index/vector/ScalarQuantizer.java | 135 +-
.../segment/index/vector/VectorIndexType.java | 10 +-
.../index/vector/VectorQuantizationUtils.java | 44 +-
.../readers/CompactedPinotSegmentRecordReader.java | 42 +-
.../segment/readers/DefaultValueColumnReader.java | 32 +-
.../segment/readers/GenericRowRecordReader.java | 4 +-
.../segment/local/segment/readers/LazyRow.java | 25 +-
.../readers/MultiplePinotSegmentRecordReader.java | 45 +-
.../readers/PinotSegmentColumnReaderFactory.java | 77 +-
.../readers/PinotSegmentColumnReaderImpl.java | 73 +-
.../readers/PinotSegmentColumnarDataSource.java | 11 +-
.../segment/readers/PinotSegmentRecordReader.java | 113 +-
.../segment/readers/sort/PinotSegmentSorter.java | 10 +-
.../local/segment/readers/sort/SegmentSorter.java | 12 +-
.../local/segment/store/FilePerIndexDirectory.java | 12 +-
.../segment/local/segment/store/IndexKey.java | 14 +-
.../segment/store/SingleFileIndexDirectory.java | 52 +-
.../local/segment/store/StarTreeIndexReader.java | 14 +-
.../local/segment/store/TextIndexUtils.java | 88 +-
.../local/segment/store/VectorIndexUtils.java | 68 +-
.../virtualcolumn/DocIdVirtualColumnProvider.java | 4 +-
.../PartitionIdVirtualColumnProvider.java | 26 +-
.../virtualcolumn/VirtualColumnContext.java | 6 +-
.../virtualcolumn/VirtualColumnIndexContainer.java | 4 +-
.../virtualcolumn/VirtualColumnProvider.java | 6 +-
.../VirtualColumnProviderFactory.java | 4 +-
.../segment/local/startree/OffHeapStarTree.java | 8 +-
.../local/startree/StarTreeBuilderUtils.java | 62 +-
.../startree/v2/builder/BaseSingleTreeBuilder.java | 147 +-
.../startree/v2/builder/MultipleTreesBuilder.java | 65 +-
.../v2/builder/OffHeapSingleTreeBuilder.java | 20 +-
.../v2/builder/OnHeapSingleTreeBuilder.java | 18 +-
.../startree/v2/builder/SingleTreeBuilder.java | 8 +-
.../startree/v2/builder/StarTreeIndexCombiner.java | 8 +-
.../v2/builder/StarTreeIndexSeparator.java | 20 +-
.../v2/builder/StarTreeV2BuilderConfig.java | 35 +-
.../startree/v2/store/StarTreeIndexContainer.java | 4 +-
.../startree/v2/store/StarTreeIndexMapUtils.java | 74 +-
.../startree/v2/store/StarTreeLoaderUtils.java | 4 +-
.../upsert/BasePartitionUpsertMetadataManager.java | 147 +-
.../upsert/BaseTableUpsertMetadataManager.java | 6 +-
...oncurrentMapPartitionUpsertMetadataManager.java | 4 +-
...nUpsertMetadataManagerForConsistentDeletes.java | 22 +-
.../ConcurrentMapTableUpsertMetadataManager.java | 4 +-
.../segment/local/upsert/PartialUpsertHandler.java | 18 +-
.../upsert/PartitionUpsertMetadataManager.java | 122 +-
.../local/upsert/TableUpsertMetadataManager.java | 22 +-
.../pinot/segment/local/upsert/UpsertContext.java | 12 +-
.../pinot/segment/local/upsert/UpsertUtils.java | 34 +-
.../segment/local/upsert/UpsertViewManager.java | 24 +-
.../upsert/merger/PartialUpsertColumnarMerger.java | 28 +-
.../local/upsert/merger/PartialUpsertMerger.java | 12 +-
.../upsert/merger/PartialUpsertMergerFactory.java | 4 +-
.../local/upsert/merger/columnar/AppendMerger.java | 12 +-
.../local/upsert/merger/columnar/IgnoreMerger.java | 6 +-
.../upsert/merger/columnar/IncrementMerger.java | 10 +-
.../local/upsert/merger/columnar/MaxMerger.java | 4 +-
.../local/upsert/merger/columnar/MinMerger.java | 4 +-
.../upsert/merger/columnar/OverwriteMerger.java | 6 +-
.../merger/columnar/PartialUpsertColumnMerger.java | 12 +-
.../local/upsert/merger/columnar/UnionMerger.java | 12 +-
.../pinot/segment/local/utils/Base64Utils.java | 4 +-
.../segment/local/utils/ClusterConfigForTable.java | 12 +-
.../local/utils/ConsistentDataPushUtils.java | 42 +-
.../apache/pinot/segment/local/utils/CrcUtils.java | 17 +-
.../segment/local/utils/CustomSerDeUtils.java | 20 +-
.../local/utils/DataTypeTransformerUtils.java | 37 +-
.../pinot/segment/local/utils/FPOrdering.java | 28 +-
.../local/utils/FixedIntArrayOffHeapIdMap.java | 10 +-
.../segment/local/utils/GeometrySerializer.java | 54 +-
.../pinot/segment/local/utils/GeometryType.java | 16 +-
.../pinot/segment/local/utils/GeometryUtils.java | 28 +-
.../apache/pinot/segment/local/utils/H3Utils.java | 12 +-
.../pinot/segment/local/utils/HashUtils.java | 30 +-
.../segment/local/utils/HyperLogLogPlusUtils.java | 8 +-
.../segment/local/utils/HyperLogLogUtils.java | 8 +-
.../apache/pinot/segment/local/utils/IdMap.java | 72 +-
.../pinot/segment/local/utils/IngestionUtils.java | 64 +-
.../segment/local/utils/LuceneTextIndexUtils.java | 65 +-
.../pinot/segment/local/utils/MetricUtils.java | 4 +-
.../local/utils/NullValueTransformerUtils.java | 56 +-
.../pinot/segment/local/utils/ReloadJobStatus.java | 6 +-
.../local/utils/SanitizationTransformerUtils.java | 76 +-
.../pinot/segment/local/utils/SchemaUtils.java | 73 +-
.../local/utils/SegmentOperationsThrottler.java | 150 +-
.../local/utils/SegmentOperationsThrottlerSet.java | 40 +-
.../segment/local/utils/SegmentPushUtils.java | 69 +-
.../local/utils/SegmentReloadSemaphore.java | 4 +-
.../local/utils/ServerReloadJobStatusCache.java | 80 +-
.../utils/ServerReloadJobStatusCacheConfig.java | 6 +-
.../local/utils/SpecialValueTransformerUtils.java | 94 +-
.../segment/local/utils/TableConfigUtils.java | 339 ++---
.../utils/TimeValidationTransformerUtils.java | 42 +-
.../pinot/segment/local/utils/WatermarkUtils.java | 16 +-
.../pinot/segment/local/utils/fst/FSTBuilder.java | 6 +-
.../pinot/segment/local/utils/fst/IFSTBuilder.java | 16 +-
.../local/utils/fst/PinotBufferIndexInput.java | 9 +-
.../local/utils/tablestate/TableStateUtils.java | 30 +-
.../local/PinotBuffersAfterClassCheckRule.java | 4 +-
.../local/PinotBuffersAfterMethodCheckRule.java | 2 +-
.../DataTypeColumnTransformerTest.java | 6 +-
.../NullValueColumnTransformerTest.java | 6 +-
.../SanitizationColumnTransformerTest.java | 4 +-
.../SpecialValueColumnTransformerTest.java | 4 +-
.../TimeValidationColumnTransformerTest.java | 4 +-
.../local/dedup/DedupWithTimestampColumnTest.java | 38 +-
.../function/FunctionPackageCompatibilityTest.java | 6 +-
.../immutable/EmptyIndexSegmentTest.java | 24 +-
.../immutable/ImmutableSegmentImplTest.java | 22 +-
.../io/util/VarLengthValueReaderWriterTest.java | 4 +-
.../stats/CompactedColumnStatisticsTest.java | 2 +-
.../impl/dictionary/MutableDictionaryTest.java | 26 +-
.../RealtimeLuceneIndexingDelayTrackerTest.java | 6 +-
...ealtimeLuceneTextIndexResourceTrackingTest.java | 4 +-
.../recordtransformer/DataTypeTransformerTest.java | 22 +-
.../ExpressionTransformerTest.java | 18 +-
.../ExpressionTransformerTimeTest.java | 4 +-
.../SchemaConformingTransformerTest.java | 14 +-
.../local/segment/creator/DictionariesTest.java | 26 +-
.../segment/creator/FixedIntArrayIdMapTest.java | 19 +-
.../segment/creator/OnHeapDictionariesTest.java | 32 +-
.../local/segment/creator/SegmentTestUtils.java | 6 +-
.../creator/impl/ColumnReaderInterfaceTest.java | 17 +-
.../impl/ColumnarRowMajorEquivalenceTest.java | 17 +-
.../creator/impl/ColumnarSchemaEvolutionTest.java | 17 +-
.../impl/ColumnarSegmentBuildingTestBase.java | 23 +-
.../AbstractColumnStatisticsCollectorTest.java | 22 +-
.../text/LuceneTextIndexBufferIntegrationTest.java | 28 +-
.../lucene99/HnswVectorIndexCombinedTest.java | 24 +-
.../segment/local/segment/index/JsonIndexTest.java | 30 +-
.../index/creator/LuceneTextIndexCreatorTest.java | 6 +-
.../MultiValueFixedByteRawIndexCreatorTest.java | 4 +-
.../segment/index/creator/RawIndexCreatorTest.java | 98 +-
.../SegmentGenerationWithBytesTypeTest.java | 4 +-
.../SegmentGenerationWithFilterRecordsTest.java | 4 +-
.../creator/SegmentGenerationWithMinMaxTest.java | 4 +-
.../SegmentGenerationWithMultipleRecordsTest.java | 4 +-
.../SegmentGenerationWithNoRecordsTest.java | 4 +-
.../SegmentGenerationWithTimeColumnTest.java | 12 +-
.../index/creator/SegmentPartitionTest.java | 59 +-
.../segment/index/creator/VarByteChunkV5Test.java | 6 +-
.../segment/index/creator/VarByteChunkV6Test.java | 6 +-
.../index/dictionary/DictionaryIndexTypeTest.java | 4 +-
.../forward/FixedByteChunkSVForwardIndexTest.java | 24 +-
.../forward/ForwardIndexCreatorFactoryTest.java | 6 +-
.../forward/VarByteChunkSVForwardIndexTest.java | 32 +-
.../mutable/CLPMutableForwardIndexTest.java | 8 +-
.../mutable/CLPMutableForwardIndexV2Test.java | 4 +-
.../index/loader/ForwardIndexHandlerTest.java | 76 +-
.../local/segment/index/loader/LoaderTest.java | 10 +-
.../index/loader/SegmentPreProcessorTest.java | 52 +-
.../loader/invertedindex/JsonIndexHandlerTest.java | 2 +-
.../invertedindex/RangeIndexHandlerTest.java | 31 +-
.../invertedindex/VectorIndexHandlerTest.java | 188 +--
.../segment/index/range/RangeIndexTypeTest.java | 26 +-
.../index/readers/ImmutableDictionaryTest.java | 14 +-
.../readers/vector/IvfFlatFilterAwareTest.java | 10 +-
.../readers/vector/IvfOnDiskFilterAwareTest.java | 4 +-
...ByteSingleValueMultiColumnReaderWriterTest.java | 4 +-
.../text/LuceneTextIndexConfigReloadTest.java | 40 +-
.../parsers/MinimumShouldMatchQueryParserTest.java | 14 +-
.../segment/index/vector/FlatQuantizerTest.java | 4 +-
.../index/vector/IvfDiskFormatInspectionTest.java | 34 +-
.../index/vector/IvfFlatVectorIndexTest.java | 14 +-
.../segment/index/vector/IvfPqIndexFormatTest.java | 4 +-
.../segment/index/vector/IvfPqVectorIndexTest.java | 4 +-
.../index/vector/IvfReaderFailurePathTest.java | 56 +-
.../segment/index/vector/ProductQuantizerTest.java | 4 +-
.../segment/index/vector/ScalarQuantizerTest.java | 4 +-
.../segment/index/vector/VectorIndexTypeTest.java | 46 +-
.../index/vector/VectorQuantizationUtilsTest.java | 4 +-
.../index/vector/VectorSearchBenchmark.java | 27 +-
.../segment/readers/InMemoryColumnReader.java | 4 +-
.../MultiplePinotSegmentRecordReaderTest.java | 4 +-
.../readers/PinotSegmentColumnReaderImplTest.java | 20 +-
...otSegmentColumnReaderRawWithDictionaryTest.java | 2 +-
.../readers/PinotSegmentRecordReaderTest.java | 6 +-
.../local/segment/readers/PinotSegmentUtil.java | 4 +-
.../readers/RecordReaderSampleDataTest.java | 22 +-
.../readers/sort/PinotSegmentSorterTest.java | 4 +-
.../segment/store/SegmentDirectoryPathsTest.java | 26 +-
.../local/segment/store/VectorIndexUtilsTest.java | 22 +-
.../v2/builder/MultipleTreesBuilderCloseTest.java | 6 +-
...ertMetadataManagerForConsistentDeletesTest.java | 14 +-
...rrentMapPartitionUpsertMetadataManagerTest.java | 50 +-
...oncurrentMapTableUpsertMetadataManagerTest.java | 8 +-
.../segment/local/upsert/UpsertUtilsTest.java | 4 +-
.../local/upsert/UpsertViewManagerTest.java | 2 +-
.../pinot/segment/local/utils/HashUtilsTest.java | 12 +-
.../utils/IndexCombinationValidationTest.java | 24 +-
.../segment/local/utils/IngestionUtilsTest.java | 8 +-
.../utils/SegmentOperationsThrottlerSetTest.java | 10 +-
.../utils/ServerReloadJobStatusCacheTest.java | 6 +-
.../segment/local/utils/TableConfigUtilsTest.java | 40 +-
.../pinot/segment/spi/AggregationFunctionType.java | 39 +-
.../org/apache/pinot/segment/spi/FetchContext.java | 40 +-
.../apache/pinot/segment/spi/ImmutableSegment.java | 46 +-
.../org/apache/pinot/segment/spi/IndexSegment.java | 146 +-
.../apache/pinot/segment/spi/MutableSegment.java | 24 +-
.../apache/pinot/segment/spi/SegmentContext.java | 4 +-
.../apache/pinot/segment/spi/SegmentMetadata.java | 52 +-
.../org/apache/pinot/segment/spi/V1Constants.java | 36 +-
.../segment/spi/compression/ChunkCompressor.java | 34 +-
.../segment/spi/compression/ChunkDecompressor.java | 32 +-
.../spi/compression/DictIdCompressionType.java | 4 +-
.../spi/converter/SegmentFormatConverter.java | 6 +-
.../spi/creator/SegmentCreationDataSource.java | 4 +-
.../pinot/segment/spi/creator/SegmentCreator.java | 64 +-
.../spi/creator/SegmentGeneratorConfig.java | 94 +-
.../spi/creator/SegmentGeneratorCustomConfigs.java | 4 +-
.../spi/creator/SegmentIndexCreationDriver.java | 38 +-
.../spi/creator/SegmentPreIndexStatsContainer.java | 4 +-
.../segment/spi/creator/StatsCollectorConfig.java | 14 +-
.../creator/name/FixedSegmentNameGenerator.java | 4 +-
.../name/InputFileSegmentNameGenerator.java | 9 +-
.../name/NormalizedDateSegmentNameGenerator.java | 14 +-
.../spi/creator/name/SegmentNameGenerator.java | 18 +-
.../creator/name/SegmentNameGeneratorFactory.java | 4 +-
.../segment/spi/creator/name/SegmentNameUtils.java | 12 +-
.../creator/name/SimpleSegmentNameGenerator.java | 21 +-
.../name/UploadedRealtimeSegmentNameGenerator.java | 30 +-
.../pinot/segment/spi/datasource/DataSource.java | 77 +-
.../segment/spi/datasource/DataSourceMetadata.java | 66 +-
.../spi/datasource/OpenStructDataSource.java | 4 +-
.../spi/index/ColumnConfigDeserializer.java | 16 +-
.../segment/spi/index/DictionaryIndexConfig.java | 4 +-
.../pinot/segment/spi/index/FieldIndexConfigs.java | 12 +-
.../segment/spi/index/FieldIndexConfigsUtil.java | 12 +-
.../segment/spi/index/IndexConfigDeserializer.java | 22 +-
.../pinot/segment/spi/index/IndexCreator.java | 59 +-
.../pinot/segment/spi/index/IndexHandler.java | 22 +-
.../pinot/segment/spi/index/IndexPlugin.java | 38 +-
.../segment/spi/index/IndexReaderFactory.java | 20 +-
.../pinot/segment/spi/index/IndexService.java | 115 +-
.../apache/pinot/segment/spi/index/IndexType.java | 114 +-
.../apache/pinot/segment/spi/index/IndexUtil.java | 14 +-
.../pinot/segment/spi/index/StandardIndexes.java | 35 +-
.../pinot/segment/spi/index/TextIndexConfig.java | 81 +-
.../spi/index/VectorIndexConfigProvider.java | 4 +-
.../spi/index/column/ColumnIndexContainer.java | 24 +-
.../spi/index/creator/BloomFilterCreator.java | 8 +-
.../creator/CombinedInvertedIndexCreator.java | 10 +-
.../DictionaryBasedInvertedIndexCreator.java | 75 +-
.../segment/spi/index/creator/FSTIndexCreator.java | 8 +-
.../spi/index/creator/ForwardIndexCreator.java | 170 +--
.../spi/index/creator/GeoSpatialIndexCreator.java | 12 +-
.../spi/index/creator/InvertedIndexCreator.java | 8 +-
.../spi/index/creator/JsonIndexCreator.java | 16 +-
.../creator/RawValueBasedInvertedIndexCreator.java | 32 +-
.../spi/index/creator/TextIndexCreator.java | 20 +-
.../index/creator/VectorBackendCapabilities.java | 70 +-
.../spi/index/creator/VectorBackendType.java | 138 +-
.../spi/index/creator/VectorExecutionMode.java | 103 +-
.../spi/index/creator/VectorIndexConfig.java | 38 +-
.../index/creator/VectorIndexConfigValidator.java | 124 +-
.../spi/index/creator/VectorQuantizerType.java | 84 +-
.../spi/index/metadata/ColumnMetadataImpl.java | 4 +-
.../spi/index/metadata/SegmentMetadataImpl.java | 71 +-
.../MultiColumnTextIndexConstants.java | 4 +-
.../multicolumntext/MultiColumnTextMetadata.java | 8 +-
.../spi/index/mutable/MutableDictionary.java | 20 +-
.../spi/index/mutable/MutableForwardIndex.java | 497 +++----
.../segment/spi/index/mutable/MutableIndex.java | 74 +-
.../spi/index/mutable/MutableInvertedIndex.java | 8 +-
.../spi/index/mutable/MutableJsonIndex.java | 6 +-
.../spi/index/mutable/MutableTextIndex.java | 12 +-
.../mutable/ThreadSafeMutableRoaringBitmap.java | 4 +-
.../reader/ApproximateRadiusVectorIndexReader.java | 34 +-
.../spi/index/reader/BloomFilterReader.java | 17 +-
.../pinot/segment/spi/index/reader/Dictionary.java | 143 +-
.../segment/spi/index/reader/EfSearchAware.java | 64 +-
.../index/reader/FilterAwareVectorIndexReader.java | 50 +-
.../spi/index/reader/ForwardIndexReader.java | 660 ++++-----
.../index/reader/ForwardIndexReaderContext.java | 11 +-
.../segment/spi/index/reader/H3IndexReader.java | 16 +-
.../spi/index/reader/H3IndexResolution.java | 20 +-
.../spi/index/reader/InvertedIndexReader.java | 4 +-
.../segment/spi/index/reader/JsonIndexReader.java | 70 +-
.../segment/spi/index/reader/MapIndexReader.java | 20 +-
.../index/reader/MultiColumnTextIndexReader.java | 20 +-
.../segment/spi/index/reader/NprobeAware.java | 38 +-
.../spi/index/reader/NullValueVectorReader.java | 22 +-
.../spi/index/reader/OpenStructIndexReader.java | 22 +-
.../segment/spi/index/reader/RangeIndexReader.java | 270 ++--
.../spi/index/reader/SortedIndexReader.java | 12 +-
.../segment/spi/index/reader/TextIndexReader.java | 50 +-
.../spi/index/reader/ValidDocIndexReader.java | 4 +-
.../spi/index/reader/VectorIndexReader.java | 24 +-
.../segment/spi/index/reader/VectorQuantizer.java | 78 +-
.../startree/AggregationFunctionColumnPair.java | 20 +-
.../spi/index/startree/AggregationSpec.java | 2 +-
.../pinot/segment/spi/index/startree/StarTree.java | 16 +-
.../segment/spi/index/startree/StarTreeNode.java | 46 +-
.../segment/spi/index/startree/StarTreeV2.java | 20 +-
.../spi/index/startree/StarTreeV2Constants.java | 4 +-
.../spi/index/startree/StarTreeV2Metadata.java | 4 +-
.../segment/spi/loader/SegmentDirectoryLoader.java | 26 +-
.../spi/loader/SegmentDirectoryLoaderContext.java | 4 +-
.../spi/loader/SegmentDirectoryLoaderRegistry.java | 16 +-
.../pinot/segment/spi/loader/SegmentLoader.java | 14 +-
.../pinot/segment/spi/memory/ByteBufferUtil.java | 14 +-
.../pinot/segment/spi/memory/CleanerUtil.java | 36 +-
.../segment/spi/memory/CompoundDataBuffer.java | 41 +-
.../pinot/segment/spi/memory/DataBuffer.java | 75 +-
.../spi/memory/DataBufferPinotInputStream.java | 4 +-
.../pinot/segment/spi/memory/EmptyIndexBuffer.java | 36 +-
.../segment/spi/memory/PagedPinotOutputStream.java | 62 +-
.../segment/spi/memory/PinotBufferFactory.java | 66 +-
.../pinot/segment/spi/memory/PinotDataBuffer.java | 223 ++-
.../spi/memory/PinotDataBufferMemoryManager.java | 26 +-
.../pinot/segment/spi/memory/PinotInputStream.java | 52 +-
.../segment/spi/memory/PinotOutputStream.java | 36 +-
.../SmallWithFallbackPinotBufferFactory.java | 16 +-
.../segment/spi/memory/unsafe/DirectMemory.java | 4 +-
.../pinot/segment/spi/memory/unsafe/Memory.java | 24 +-
.../segment/spi/memory/unsafe/MmapMemory.java | 102 +-
.../spi/memory/unsafe/MmapMemoryConfig.java | 16 +-
.../spi/memory/unsafe/UnsafePinotBuffer.java | 5 +-
.../metadata/ColumnPartitionMetadata.java | 58 +-
.../segment/spi/store/ColumnIndexDirectory.java | 77 +-
.../pinot/segment/spi/store/SegmentDirectory.java | 288 ++--
.../segment/spi/store/SegmentDirectoryPaths.java | 30 +-
.../apache/pinot/segment/spi/utils/CsvParser.java | 28 +-
.../pinot/segment/spi/utils/JavaVersion.java | 4 +-
.../spi/index/DictionaryIndexConfigTest.java | 8 +-
.../spi/index/column/ColumnIndexContainerTest.java | 4 +-
.../creator/VectorBackendCapabilitiesTest.java | 4 +-
.../spi/index/creator/VectorBackendTypeTest.java | 4 +-
.../spi/index/creator/VectorExecutionModeTest.java | 4 +-
.../spi/index/creator/VectorIndexConfigTest.java | 4 +-
.../creator/VectorIndexConfigValidatorTest.java | 10 +-
.../spi/index/metadata/ColumnMetadataImplTest.java | 42 +-
.../spi/memory/PagedPinotOutputStreamTest.java | 14 +-
.../memory/PinotDataBufferInstanceTestBase.java | 4 +-
.../spi/memory/PinotDataBufferTestBase.java | 4 +-
.../pinot/server/api/AdminApiApplication.java | 8 +-
.../pinot/server/api/resources/DebugResource.java | 4 +-
.../server/api/resources/DiskUtilization.java | 4 +-
.../server/api/resources/HealthCheckResource.java | 4 +-
.../server/api/resources/InstanceResource.java | 12 +-
.../server/api/resources/MmapDebugResource.java | 4 +-
.../api/resources/PinotServerAppConfigs.java | 6 +-
.../server/api/resources/PinotServerLogger.java | 4 +-
.../server/api/resources/PrimaryKeyCount.java | 4 +-
.../pinot/server/api/resources/QueryResource.java | 4 +-
.../api/resources/QueryWorkloadConfigResource.java | 88 +-
.../server/api/resources/ReingestionResource.java | 14 +-
.../api/resources/SegmentMetadataFetcher.java | 30 +-
.../server/api/resources/ServerResourceUtils.java | 4 +-
.../pinot/server/api/resources/ShutDownFilter.java | 6 +-
.../server/api/resources/TableSizeResource.java | 4 +-
.../server/api/resources/TableTierResource.java | 4 +-
.../pinot/server/api/resources/TablesResource.java | 96 +-
.../org/apache/pinot/server/conf/ServerConf.java | 10 +-
.../server/predownload/PredownloadZKClient.java | 32 +-
.../pinot/server/starter/ServerInstance.java | 6 +-
.../starter/ServerQueriesDisabledTracker.java | 4 +-
.../server/starter/helix/BaseServerStarter.java | 110 +-
.../FreshnessBasedConsumptionStatusChecker.java | 16 +-
.../starter/helix/HelixInstanceDataManager.java | 10 +-
.../helix/HelixInstanceDataManagerConfig.java | 4 +-
.../server/starter/helix/HelixServerStarter.java | 32 +-
.../IngestionBasedConsumptionStatusChecker.java | 6 +-
.../helix/OffsetBasedConsumptionStatusChecker.java | 12 +-
.../SegmentOnlineOfflineStateModelFactory.java | 42 +-
.../ServerGrpcChannelBackoffResetHandler.java | 39 +-
.../helix/StateTransitionThreadPoolManager.java | 36 +-
.../server/api/PinotServerAppConfigsTest.java | 12 +-
...FreshnessBasedConsumptionStatusCheckerTest.java | 8 +-
.../accounting/DefaultWorkloadBudgetManager.java | 24 +-
.../pinot/spi/accounting/MseCancelCallback.java | 6 +-
.../pinot/spi/accounting/ThreadAccountant.java | 2 +-
.../spi/accounting/ThreadResourceSnapshot.java | 24 +-
.../spi/accounting/WorkloadBudgetManager.java | 91 +-
.../accounting/WorkloadBudgetManagerFactory.java | 20 +-
.../pinot/spi/annotations/InterfaceAudience.java | 58 +-
.../pinot/spi/annotations/InterfaceStability.java | 61 +-
.../pinot/spi/annotations/ScalarFunction.java | 44 +-
.../WorkloadBudgetManagerAnnotation.java | 10 +-
.../spi/annotations/metrics/MetricsFactory.java | 14 +-
.../annotations/metrics/PinotMetricsFactory.java | 28 +-
.../annotations/minion/EventObserverFactory.java | 14 +-
.../annotations/minion/TaskExecutorFactory.java | 14 +-
.../spi/annotations/minion/TaskGenerator.java | 14 +-
.../tablesampler/TableSamplerProvider.java | 20 +-
.../apache/pinot/spi/audit/AuditTokenResolver.java | 41 +-
.../apache/pinot/spi/audit/AuditUserIdentity.java | 20 +-
.../org/apache/pinot/spi/auth/AuthProvider.java | 12 +-
.../apache/pinot/spi/auth/AuthorizationResult.java | 24 +-
.../spi/auth/BasicAuthorizationResultImpl.java | 48 +-
.../pinot/spi/auth/TableAuthorizationResult.java | 22 +-
.../pinot/spi/auth/TableRowColAccessResult.java | 10 +-
.../apache/pinot/spi/config/BaseJsonConfig.java | 4 +-
.../org/apache/pinot/spi/config/ConfigUtils.java | 20 +-
.../org/apache/pinot/spi/config/TableConfigs.java | 6 +-
.../apache/pinot/spi/config/instance/Instance.java | 31 +-
.../config/instance/InstanceConfigValidator.java | 24 +-
.../instance/InstanceConfigValidatorRegistry.java | 72 +-
.../provider/LogicalTableConfigChangeListener.java | 6 +-
.../provider/PinotClusterConfigChangeListener.java | 12 +-
.../provider/PinotClusterConfigProvider.java | 30 +-
.../spi/config/provider/PinotConfigProvider.java | 59 +-
.../spi/config/provider/SchemaChangeListener.java | 10 +-
.../config/provider/TableConfigChangeListener.java | 10 +-
.../spi/config/table/ColumnPartitionConfig.java | 24 +-
.../pinot/spi/config/table/CompletionConfig.java | 4 +-
.../apache/pinot/spi/config/table/DedupConfig.java | 4 +-
.../spi/config/table/DisasterRecoveryMode.java | 6 +-
.../apache/pinot/spi/config/table/FieldConfig.java | 22 +-
.../apache/pinot/spi/config/table/IndexConfig.java | 16 +-
.../pinot/spi/config/table/IndexingConfig.java | 55 +-
.../org/apache/pinot/spi/config/table/Intern.java | 4 +-
.../pinot/spi/config/table/JsonIndexConfig.java | 50 +-
.../config/table/MultiColumnTextIndexConfig.java | 6 +-
.../apache/pinot/spi/config/table/QueryConfig.java | 4 +-
.../apache/pinot/spi/config/table/QuotaConfig.java | 4 +-
.../config/table/ReplicaGroupStrategyConfig.java | 24 +-
.../spi/config/table/SegmentZKPropsConfig.java | 4 +-
.../SegmentsValidationAndRetentionConfig.java | 90 +-
.../apache/pinot/spi/config/table/TableConfig.java | 2 +-
.../spi/config/table/TableConfigDecorator.java | 22 +-
.../spi/config/table/TableConfigValidator.java | 24 +-
.../config/table/TableConfigValidatorRegistry.java | 74 +-
.../apache/pinot/spi/config/table/TableStatus.java | 6 +-
.../pinot/spi/config/table/TableTaskConfig.java | 24 +-
.../pinot/spi/config/table/TagOverrideConfig.java | 33 +-
.../apache/pinot/spi/config/table/TierConfig.java | 4 +-
.../config/table/TimestampIndexGranularity.java | 4 +-
.../apache/pinot/spi/config/table/TunerConfig.java | 8 +-
.../pinot/spi/config/table/UpsertConfig.java | 6 +-
.../table/assignment/InstancePartitionsType.java | 10 +-
.../table/ingestion/BatchIngestionConfig.java | 4 +-
.../config/table/ingestion/ComplexTypeConfig.java | 4 +-
.../spi/config/table/ingestion/FilterConfig.java | 4 +-
.../config/table/ingestion/IngestionConfig.java | 6 +-
.../ParallelSegmentConsumptionPolicy.java | 4 +-
.../table/ingestion/StreamIngestionConfig.java | 4 +-
.../config/table/ingestion/TransformConfig.java | 4 +-
.../config/table/sampler/TableSamplerConfig.java | 14 +-
.../pinot/spi/config/task/AdhocTaskConfig.java | 35 +-
.../apache/pinot/spi/config/user/UserConfig.java | 4 +-
.../spi/config/workload/EnforcementProfile.java | 43 +-
.../pinot/spi/config/workload/InstanceCost.java | 46 +-
.../pinot/spi/config/workload/NodeConfig.java | 51 +-
.../spi/config/workload/PropagationEntity.java | 21 +-
.../workload/PropagationEntityOverrides.java | 12 +-
.../spi/config/workload/PropagationScheme.java | 172 +--
.../spi/config/workload/QueryWorkloadConfig.java | 155 +-
.../pinot/spi/controller/ControllerJobType.java | 26 +-
.../apache/pinot/spi/crypt/NoOpPinotCrypter.java | 4 +-
.../org/apache/pinot/spi/crypt/PinotCrypter.java | 28 +-
.../pinot/spi/crypt/PinotCrypterFactory.java | 16 +-
.../apache/pinot/spi/cursors/ResponseStore.java | 98 +-
.../apache/pinot/spi/data/ComplexFieldSpec.java | 52 +-
.../apache/pinot/spi/data/DateTimeFieldSpec.java | 68 +-
.../pinot/spi/data/DateTimeFormatPatternSpec.java | 2 +-
.../apache/pinot/spi/data/DateTimeFormatSpec.java | 36 +-
.../pinot/spi/data/DateTimeFormatUnitSpec.java | 14 +-
.../pinot/spi/data/DateTimeGranularitySpec.java | 42 +-
.../java/org/apache/pinot/spi/data/FieldSpec.java | 172 +--
.../pinot/spi/data/IngestionSchemaValidator.java | 4 +-
.../apache/pinot/spi/data/LogicalTableConfig.java | 42 +-
.../org/apache/pinot/spi/data/MetricFieldSpec.java | 4 +-
.../pinot/spi/data/OpenStructTypeInference.java | 10 +-
.../apache/pinot/spi/data/PhysicalTableConfig.java | 6 +-
.../java/org/apache/pinot/spi/data/Schema.java | 241 ++-
.../java/org/apache/pinot/spi/data/SchemaInfo.java | 5 +-
.../pinot/spi/data/SchemaValidatorFactory.java | 10 +-
.../pinot/spi/data/SchemaValidatorResult.java | 4 +-
.../apache/pinot/spi/data/TimeGranularitySpec.java | 59 +-
.../pinot/spi/data/readers/ColumnarDataSource.java | 73 +-
.../apache/pinot/spi/data/readers/FileFormat.java | 14 +-
.../apache/pinot/spi/data/readers/GenericRow.java | 108 +-
.../pinot/spi/data/readers/MultiValueResult.java | 58 +-
.../apache/pinot/spi/data/readers/PrimaryKey.java | 4 +-
.../spi/data/readers/RecordExtractorConfig.java | 4 +-
.../spi/data/readers/RecordFetchException.java | 18 +-
.../pinot/spi/data/readers/RecordReader.java | 134 +-
.../spi/data/readers/RecordReaderFactory.java | 82 +-
.../spi/data/readers/RecordReaderFileConfig.java | 6 +-
.../pinot/spi/data/readers/RecordReaderUtils.java | 4 +-
.../pinot/spi/env/CommonsConfigurationUtils.java | 166 +--
.../apache/pinot/spi/env/PinotConfiguration.java | 383 ++---
.../apache/pinot/spi/env/VersionedIOFactory.java | 8 +-
.../pinot/spi/env/VersionedPropertyReader.java | 12 +-
.../pinot/spi/env/VersionedPropertyWriter.java | 8 +-
.../PinotEnvironmentProvider.java | 16 +-
.../PinotEnvironmentProviderFactory.java | 6 +-
.../query/BrokerQueryEventListenerFactory.java | 24 +-
.../spi/exception/ConfigValidationException.java | 8 +-
.../spi/exception/EarlyTerminationException.java | 6 +-
.../pinot/spi/exception/PinotRuntimeException.java | 11 +-
.../apache/pinot/spi/exception/QueryErrorCode.java | 20 +-
.../pinot/spi/exception/QueryErrorMessage.java | 32 +-
.../apache/pinot/spi/exception/QueryException.java | 22 +-
.../spi/executor/DecoratorExecutorService.java | 102 +-
.../pinot/spi/executor/ExecutorServicePlugin.java | 12 +-
.../spi/executor/ExecutorServiceProvider.java | 18 +-
.../pinot/spi/executor/ExecutorServiceUtils.java | 53 +-
.../pinot/spi/executor/HardLimitExecutor.java | 12 +-
.../org/apache/pinot/spi/executor/MdcExecutor.java | 49 +-
.../apache/pinot/spi/executor/MetricsExecutor.java | 4 +-
.../apache/pinot/spi/filesystem/BasePinotFS.java | 6 +-
.../apache/pinot/spi/filesystem/FileMetadata.java | 4 +-
.../apache/pinot/spi/filesystem/LocalPinotFS.java | 6 +-
.../org/apache/pinot/spi/filesystem/PinotFS.java | 305 ++--
.../pinot/spi/filesystem/PinotFSFactory.java | 4 +-
.../pinot/spi/function/FunctionEvaluator.java | 22 +-
.../pinot/spi/ingestion/batch/BatchConfig.java | 4 +-
.../spi/ingestion/batch/BatchConfigProperties.java | 4 +-
.../spi/ingestion/batch/IngestionJobLauncher.java | 4 +-
.../ingestion/batch/runner/IngestionJobRunner.java | 33 +-
.../pinot/spi/ingestion/batch/spec/Constants.java | 4 +-
.../batch/spec/ExecutionFrameworkSpec.java | 28 +-
.../spi/ingestion/batch/spec/PinotClusterSpec.java | 20 +-
.../spi/ingestion/batch/spec/PinotFSSpec.java | 53 +-
.../spi/ingestion/batch/spec/PushJobSpec.java | 83 +-
.../spi/ingestion/batch/spec/RecordReaderSpec.java | 90 +-
.../batch/spec/SegmentGenerationJobSpec.java | 145 +-
.../batch/spec/SegmentGenerationTaskSpec.java | 38 +-
.../batch/spec/SegmentNameGeneratorSpec.java | 12 +-
.../pinot/spi/ingestion/batch/spec/TableSpec.java | 32 +-
.../pinot/spi/ingestion/batch/spec/TlsSpec.java | 6 +-
.../segment/uploader/SegmentUploader.java | 34 +-
.../ingestion/segment/writer/SegmentWriter.java | 46 +-
...eporterMetricsRegistryRegistrationListener.java | 5 +-
.../MetricsRegistryRegistrationListener.java | 5 +-
.../org/apache/pinot/spi/metrics/PinotCounter.java | 4 +-
.../org/apache/pinot/spi/metrics/PinotGauge.java | 37 +-
.../apache/pinot/spi/metrics/PinotHistogram.java | 10 +-
.../apache/pinot/spi/metrics/PinotJmxReporter.java | 4 +-
.../org/apache/pinot/spi/metrics/PinotMeter.java | 30 +-
.../org/apache/pinot/spi/metrics/PinotMetered.java | 88 +-
.../org/apache/pinot/spi/metrics/PinotMetric.java | 8 +-
.../apache/pinot/spi/metrics/PinotMetricName.java | 28 +-
.../apache/pinot/spi/metrics/PinotMetricUtils.java | 54 +-
.../pinot/spi/metrics/PinotMetricsRegistry.java | 111 +-
.../spi/metrics/PinotMetricsRegistryListener.java | 8 +-
.../org/apache/pinot/spi/metrics/PinotTimer.java | 24 +-
.../apache/pinot/spi/metrics/SettableValue.java | 22 +-
.../pinot/spi/plugin/PinotPluginConfiguration.java | 20 +-
.../apache/pinot/spi/plugin/PluginClassLoader.java | 12 +-
.../org/apache/pinot/spi/plugin/PluginManager.java | 110 +-
.../pinot/spi/query/QueryExecutionContext.java | 18 +-
.../pinot/spi/query/QueryScanCostContext.java | 37 +-
.../apache/pinot/spi/query/QueryThreadContext.java | 2 +-
.../pinot/spi/query/QueryThreadExceedStrategy.java | 21 +-
.../spi/recordtransformer/RecordTransformer.java | 16 +-
.../recordtransformer/enricher/RecordEnricher.java | 4 +-
.../enricher/RecordEnricherFactory.java | 16 +-
.../enricher/RecordEnricherValidationConfig.java | 4 +-
.../org/apache/pinot/spi/services/ServiceRole.java | 4 +-
.../pinot/spi/services/ServiceStartable.java | 7 +-
.../pinot/spi/stream/ConsumerPartitionState.java | 4 +-
.../org/apache/pinot/spi/stream/MessageBatch.java | 52 +-
.../apache/pinot/spi/stream/OffsetCriteria.java | 92 +-
.../pinot/spi/stream/PartitionGroupConsumer.java | 74 +-
.../stream/PartitionGroupConsumptionStatus.java | 30 +-
.../pinot/spi/stream/PartitionGroupMetadata.java | 16 +-
.../spi/stream/PartitionGroupMetadataFetcher.java | 18 +-
.../apache/pinot/spi/stream/PartitionLagState.java | 22 +-
.../spi/stream/PermanentConsumerException.java | 6 +-
.../org/apache/pinot/spi/stream/StreamConfig.java | 8 +-
.../pinot/spi/stream/StreamConfigProperties.java | 136 +-
.../pinot/spi/stream/StreamConsumerFactory.java | 28 +-
.../spi/stream/StreamConsumerFactoryProvider.java | 14 +-
.../apache/pinot/spi/stream/StreamDataDecoder.java | 20 +-
.../pinot/spi/stream/StreamDataDecoderImpl.java | 8 +-
.../pinot/spi/stream/StreamDataDecoderResult.java | 6 +-
.../pinot/spi/stream/StreamDataProducer.java | 30 +-
.../pinot/spi/stream/StreamDataProvider.java | 9 +-
.../spi/stream/StreamDataServerStartable.java | 78 +-
.../org/apache/pinot/spi/stream/StreamMessage.java | 50 +-
.../pinot/spi/stream/StreamMessageDecoder.java | 64 +-
.../pinot/spi/stream/StreamMessageMetadata.java | 6 +-
.../apache/pinot/spi/stream/StreamMetadata.java | 24 +-
.../pinot/spi/stream/StreamMetadataProvider.java | 64 +-
.../pinot/spi/stream/StreamPartitionMsgOffset.java | 42 +-
.../stream/StreamPartitionMsgOffsetFactory.java | 18 +-
.../spi/stream/TransientConsumerException.java | 6 +-
.../spi/tasks/MinionTaskBaseObserverStats.java | 9 +-
.../tasks/MinionTaskObserverStorageManager.java | 8 +-
.../org/apache/pinot/spi/trace/BaseRecording.java | 8 +-
.../pinot/spi/trace/DefaultRequestContext.java | 8 +-
.../org/apache/pinot/spi/trace/FilterType.java | 12 +-
.../pinot/spi/trace/InvocationRecording.java | 104 +-
.../apache/pinot/spi/trace/InvocationScope.java | 4 +-
.../org/apache/pinot/spi/trace/NoOpRecording.java | 4 +-
.../org/apache/pinot/spi/trace/RequestContext.java | 12 +-
.../org/apache/pinot/spi/trace/RequestScope.java | 6 +-
.../java/org/apache/pinot/spi/trace/Scope.java | 6 +-
.../org/apache/pinot/spi/trace/TraceState.java | 29 +-
.../java/org/apache/pinot/spi/trace/Tracer.java | 33 +-
.../java/org/apache/pinot/spi/trace/Tracing.java | 16 +-
.../org/apache/pinot/spi/utils/ArrayCopyUtils.java | 4 +-
.../apache/pinot/spi/utils/BigDecimalUtils.java | 42 +-
.../org/apache/pinot/spi/utils/BooleanUtils.java | 45 +-
.../java/org/apache/pinot/spi/utils/ByteArray.java | 67 +-
.../org/apache/pinot/spi/utils/BytesUtils.java | 30 +-
.../apache/pinot/spi/utils/CommonConstants.java | 646 ++++----
.../ConsumingSegmentConsistencyModeListener.java | 32 +-
.../org/apache/pinot/spi/utils/DataSizeUtils.java | 12 +-
.../org/apache/pinot/spi/utils/Enablement.java | 6 +-
.../org/apache/pinot/spi/utils/EqualityUtils.java | 26 +-
.../org/apache/pinot/spi/utils/FALFInterner.java | 132 +-
.../org/apache/pinot/spi/utils/FixedIntArray.java | 18 +-
.../pinot/spi/utils/GroovyTemplateUtils.java | 8 +-
.../pinot/spi/utils/IngestionConfigUtils.java | 100 +-
.../java/org/apache/pinot/spi/utils/JsonUtils.java | 152 +-
.../java/org/apache/pinot/spi/utils/NetUtils.java | 50 +-
.../org/apache/pinot/spi/utils/Obfuscator.java | 90 +-
.../java/org/apache/pinot/spi/utils/Pairs.java | 80 +-
.../org/apache/pinot/spi/utils/PinotDataType.java | 90 +-
.../org/apache/pinot/spi/utils/PinotMd5Mode.java | 4 +-
.../pinot/spi/utils/PinotReflectionUtils.java | 14 +-
.../java/org/apache/pinot/spi/utils/ReadMode.java | 15 +-
.../org/apache/pinot/spi/utils/ResourceFinder.java | 44 +-
.../org/apache/pinot/spi/utils/StringUtil.java | 29 +-
.../spi/utils/TableConfigDecoratorRegistry.java | 28 +-
.../org/apache/pinot/spi/utils/TimeConverter.java | 6 +-
.../java/org/apache/pinot/spi/utils/TimeUtils.java | 102 +-
.../pinot/spi/utils/TimestampIndexUtils.java | 30 +-
.../org/apache/pinot/spi/utils/TimestampUtils.java | 36 +-
.../spi/utils/builder/TableConfigBuilder.java | 8 +-
.../pinot/spi/utils/builder/TableNameBuilder.java | 66 +-
.../pinot/spi/utils/hash/CityHashFunctions.java | 52 +-
.../pinot/spi/utils/hash/FnvHashFunctions.java | 20 +-
.../pinot/spi/utils/hash/MurmurHashFunctions.java | 90 +-
.../spi/utils/retry/AttemptFailureException.java | 10 +-
.../spi/utils/retry/AttemptsExceededException.java | 6 +-
.../pinot/spi/utils/retry/BaseRetryPolicy.java | 19 +-
.../utils/retry/ExponentialBackoffRetryPolicy.java | 9 +-
.../spi/utils/retry/FixedDelayRetryPolicy.java | 4 +-
.../pinot/spi/utils/retry/NoDelayRetryPolicy.java | 4 +-
.../spi/utils/retry/RandomDelayRetryPolicy.java | 4 +-
.../utils/retry/RetriableOperationException.java | 4 +-
.../pinot/spi/utils/retry/RetryPolicies.java | 54 +-
.../apache/pinot/spi/utils/retry/RetryPolicy.java | 20 +-
.../WorkloadBudgetManagerFactoryTest.java | 6 +-
.../spi/config/TableConfigsSerializationTest.java | 42 +-
.../provider/PinotClusterConfigProviderTest.java | 4 +-
.../org/apache/pinot/spi/data/FieldSpecTest.java | 40 +-
.../pinot/spi/data/SchemaSerializationTest.java | 56 +-
.../spi/data/readers/AbstractRecordReaderTest.java | 30 +-
.../spi/filesystem/PinotFSPaginatedListTest.java | 4 +-
.../apache/pinot/spi/filesystem/PinotFSTest.java | 4 +-
.../pinot/spi/ingestion/batch/BatchConfigTest.java | 4 +-
.../apache/pinot/spi/plugin/ClassLoaderTest.java | 18 +-
.../stream/PartitionGroupMetadataFetcherTest.java | 8 +-
.../spi/stream/StreamDataDecoderImplTest.java | 8 +-
.../pinot/spi/utils/IngestionConfigUtilsTest.java | 4 +-
.../org/apache/pinot/spi/utils/JsonUtilsTest.java | 76 +-
.../org/apache/pinot/spi/utils/NetUtilsTest.java | 4 +-
.../org/apache/pinot/spi/utils/UuidUtilsTest.java | 4 +-
.../spi/utils/builder/TableConfigBuilderTest.java | 4 +-
pinot-spi/src/test/resources/TestRecordReader.java | 4 +-
.../pinot/sql/ddl/compile/DdlCompileContext.java | 16 +-
.../apache/pinot/sql/ddl/compile/DdlCompiler.java | 10 +-
.../ddl/compile/MaterializedViewDdlHandler.java | 8 +-
.../inferer/MaterializedViewInferenceInput.java | 22 +-
.../ddl/inferer/MaterializedViewSchemaInferer.java | 18 +-
.../pinot/sql/ddl/reverse/CanonicalDdlEmitter.java | 6 +-
.../sql/ddl/compile/DdlCompileContextTest.java | 4 +-
.../DdlCompilerMaterializedViewInferenceTest.java | 6 +-
.../inferer/MaterializedViewSchemaInfererTest.java | 2 +-
.../pinot/tsdb/planner/TimeSeriesExchangeNode.java | 16 +-
.../tsdb/planner/TimeSeriesPlanFragmenter.java | 111 +-
.../planner/TimeSeriesTableMetadataProvider.java | 4 +-
.../tsdb/planner/physical/TableScanVisitor.java | 24 +-
.../java/org/apache/pinot/tsdb/spi/AggInfo.java | 56 +-
.../tsdb/spi/PinotTimeSeriesConfiguration.java | 23 +-
.../pinot/tsdb/spi/RangeTimeSeriesRequest.java | 64 +-
.../org/apache/pinot/tsdb/spi/TimeBuckets.java | 35 +-
.../tsdb/spi/TimeSeriesLogicalPlanResult.java | 4 +-
.../pinot/tsdb/spi/TimeSeriesLogicalPlanner.java | 24 +-
.../apache/pinot/tsdb/spi/TimeSeriesMetadata.java | 28 +-
.../tsdb/spi/operator/BaseTimeSeriesOperator.java | 26 +-
.../tsdb/spi/plan/BaseTimeSeriesPlanNode.java | 6 +-
.../tsdb/spi/plan/LeafTimeSeriesPlanNode.java | 11 +-
.../tsdb/spi/plan/serde/TimeSeriesPlanSerde.java | 15 +-
.../tsdb/spi/series/BaseTimeSeriesBuilder.java | 49 +-
.../apache/pinot/tsdb/spi/series/TimeSeries.java | 62 +-
.../pinot/tsdb/spi/series/TimeSeriesBlock.java | 24 +-
.../tsdb/spi/series/TimeSeriesBuilderFactory.java | 4 +-
.../series/TimeSeriesBuilderFactoryProvider.java | 4 +-
.../spi/series/builders/MaxTimeSeriesBuilder.java | 8 +-
.../spi/series/builders/MinTimeSeriesBuilder.java | 8 +-
.../series/builders/SummingTimeSeriesBuilder.java | 8 +-
.../apache/pinot/tools/ClusterStateVerifier.java | 28 +-
.../main/java/org/apache/pinot/tools/Command.java | 6 +-
.../org/apache/pinot/tools/GenericQuickstart.java | 23 +-
.../apache/pinot/tools/GitHubEventsQuickstart.java | 10 +-
.../apache/pinot/tools/LogicalTableQuickstart.java | 30 +-
.../pinot/tools/MaterializedViewQuickStart.java | 82 +-
.../apache/pinot/tools/MultiClusterQuickstart.java | 24 +-
.../org/apache/pinot/tools/MultiDirQuickstart.java | 4 +-
.../apache/pinot/tools/NullHandlingQuickstart.java | 6 +-
.../apache/pinot/tools/PinotTableRebalancer.java | 4 +-
.../org/apache/pinot/tools/PinotZKChanger.java | 18 +-
.../org/apache/pinot/tools/QuickStartBase.java | 25 +-
.../pinot/tools/RealtimeQuickStartWithMinion.java | 6 +-
.../java/org/apache/pinot/tools/SpeedTest.java | 6 +-
.../tools/TimeSeriesEngineAuthQuickStart.java | 10 +-
.../pinot/tools/TimeSeriesEngineQuickStart.java | 10 +-
.../pinot/tools/admin/PinotAdministrator.java | 29 +-
.../org/apache/pinot/tools/admin/PinotBroker.java | 4 +-
.../apache/pinot/tools/admin/PinotController.java | 4 +-
.../org/apache/pinot/tools/admin/PinotMinion.java | 4 +-
.../org/apache/pinot/tools/admin/PinotServer.java | 4 +-
.../tools/admin/PinotServiceManagerStarter.java | 4 +-
.../admin/command/AbstractBaseAdminCommand.java | 7 +-
.../pinot/tools/admin/command/AddTableCommand.java | 5 +-
.../admin/command/AvroSchemaToPinotSchema.java | 18 +-
.../tools/admin/command/BootstrapTableCommand.java | 64 +-
.../tools/admin/command/CreateSegmentCommand.java | 4 +-
.../admin/command/DataImportDryRunCommand.java | 6 +-
.../tools/admin/command/GenerateDataCommand.java | 5 +-
.../command/GitHubEventsQuickStartCommand.java | 4 +-
.../tools/admin/command/ImportDataCommand.java | 4 +-
.../tools/admin/command/JsonToPinotSchema.java | 18 +-
.../command/LaunchBackfillIngestionJobCommand.java | 12 +-
.../command/LaunchDataIngestionJobCommand.java | 5 +-
.../LaunchSparkDataIngestionJobCommand.java | 5 +-
.../tools/admin/command/MoveReplicaGroup.java | 8 +-
.../OfflineSegmentIntervalCheckerCommand.java | 10 +-
.../command/RealtimeProvisioningHelperCommand.java | 15 +-
.../tools/admin/command/RebalanceTableCommand.java | 4 +-
.../command/SegmentProcessorFrameworkCommand.java | 4 +-
.../tools/admin/command/StartBrokerCommand.java | 5 +-
.../admin/command/StartControllerCommand.java | 5 +-
.../tools/admin/command/StartKafkaCommand.java | 4 +-
.../tools/admin/command/StartMinionCommand.java | 5 +-
.../tools/admin/command/StartServerCommand.java | 5 +-
.../admin/command/StartServiceManagerCommand.java | 20 +-
.../tools/admin/command/StartZookeeperCommand.java | 6 +-
.../tools/admin/command/StopProcessCommand.java | 8 +-
.../admin/command/StreamAvroIntoKafkaCommand.java | 4 +-
.../admin/command/StreamGitHubEventsCommand.java | 4 +-
.../tools/admin/command/UploadSegmentCommand.java | 6 +-
.../tools/admin/command/ValidateConfigCommand.java | 14 +-
.../command/filesystem/BaseFileOperation.java | 4 +-
.../anonymizer/ArrayBasedGlobalDictionaries.java | 42 +-
.../anonymizer/MapBasedGlobalDictionaries.java | 54 +-
.../anonymizer/PinotDataAndQueryAnonymizer.java | 180 ++-
.../pinot/tools/perf/PerfBenchmarkDriver.java | 30 +-
.../pinot/tools/perf/PerfBenchmarkRunner.java | 10 +-
.../org/apache/pinot/tools/perf/QueryRunner.java | 192 +--
.../converter/DictionaryToRawIndexConverter.java | 134 +-
.../converter/PinotSegmentConvertCommand.java | 18 +-
.../segment/converter/PinotSegmentConverter.java | 8 +-
.../converter/PinotSegmentToAvroConverter.java | 4 +-
.../converter/PinotSegmentToCsvConverter.java | 4 +-
.../converter/PinotSegmentToJsonConverter.java | 4 +-
.../converter/PinotSegmentToParquetConverter.java | 4 +-
.../processor/SegmentProcessorFrameworkSpec.java | 4 +-
.../pinot/tools/service/PinotServiceManager.java | 5 +-
.../api/resources/PinotServiceManagerLogger.java | 4 +-
.../pinot/tools/streams/AirlineDataStream.java | 4 +-
.../tools/streams/AvroFileSourceGenerator.java | 30 +-
.../pinot/tools/streams/PinotRealtimeSource.java | 38 +-
.../tools/streams/PinotSourceDataGenerator.java | 22 +-
.../tools/streams/PinotStreamRateLimiter.java | 10 +-
.../pinot/tools/streams/RsvpSourceGenerator.java | 4 +-
.../streams/githubevents/GitHubAPICaller.java | 24 +-
.../GithubPullRequestSourceGenerator.java | 8 +-
.../githubevents/PullRequestMergedEvent.java | 50 +-
.../PullRequestMergedEventsStream.java | 20 +-
.../org/apache/pinot/tools/utils/JarUtils.java | 4 +-
3354 files changed, 43312 insertions(+), 66174 deletions(-)
diff --git a/config/checkstyle.xml b/config/checkstyle.xml
index 8e979ae97f7..5954306729f 100644
--- a/config/checkstyle.xml
+++ b/config/checkstyle.xml
@@ -209,7 +209,23 @@
<!-- JAVADOC COMMENTS -->
- <!-- If you have a Javadoc comment, make sure it is properly formed -->
+ <!-- Doc comments must use the /// markdown form (JEP 467), not /** */.
+ The pattern deliberately does not match:
+ - the ASF license header, identified by its text rather than its position, since a
+ handful of files place it below the package/import statements
+ - /*** ... ***/ decorative separators, which are not documentation
+ - /** appearing mid-line, e.g. inside a SQL string literal in a test -->
+ <module name="Regexp">
+ <property name="format"
+ value="(?m)^[ \t]*/\*\*(?!\*)(?![\s\S]{0,60}?Licensed to the Apache Software Foundation)"/>
+ <property name="illegalPattern" value="true"/>
+ <property name="message"
+ value="Use /// markdown doc comments (JEP 467) instead of /** */ Javadoc."/>
+ </module>
+
+ <!-- If you have a Javadoc comment, make sure it is properly formed.
+ NOTE: this only inspects /** */ comments, so it no longer applies to the /// doc
+ comments that the codebase now uses. -->
<module name="JavadocStyle">
<property name="checkFirstSentence" value="false"/>
</module>
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/api/AccessControl.java b/pinot-broker/src/main/java/org/apache/pinot/broker/api/AccessControl.java
index 45a7eafec41..4b20decec73 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/api/AccessControl.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/api/AccessControl.java
@@ -34,41 +34,35 @@ import org.apache.pinot.spi.auth.broker.RequesterIdentity;
@InterfaceAudience.Public
@InterfaceStability.Stable
public interface AccessControl extends FineGrainedAccessControl {
- /**
- * First-step access control when processing broker requests. Decides whether request is allowed to acquire resources
- * for further processing. Request may still be rejected at table-level later on.
- * The default implementation is kept to have backward compatibility with the existing implementations
- * @param requesterIdentity requester identity
- *
- * @return {@code true} if authorized, {@code false} otherwise
- */
+ /// First-step access control when processing broker requests. Decides whether request is allowed to acquire resources
+ /// for further processing. Request may still be rejected at table-level later on.
+ /// The default implementation is kept to have backward compatibility with the existing implementations
+ /// @param requesterIdentity requester identity
+ ///
+ /// @return `true` if authorized, `false` otherwise
@Deprecated
default boolean hasAccess(RequesterIdentity requesterIdentity) {
return true;
}
- /**
- * First-step access control when processing broker requests. Decides whether request is allowed to acquire resources
- * for further processing. Request may still be rejected at table-level later on.
- * The default implementation returns a {@link BasicAuthorizationResultImpl} with the result of the hasAccess() of
- * the implementation
- *
- * @param requesterIdentity requester identity
- *
- * @return {@code AuthorizationResult} with the result of the access control check
- */
+ /// First-step access control when processing broker requests. Decides whether request is allowed to acquire resources
+ /// for further processing. Request may still be rejected at table-level later on.
+ /// The default implementation returns a [BasicAuthorizationResultImpl] with the result of the hasAccess() of
+ /// the implementation
+ ///
+ /// @param requesterIdentity requester identity
+ ///
+ /// @return `AuthorizationResult` with the result of the access control check
default AuthorizationResult authorize(RequesterIdentity requesterIdentity) {
return new BasicAuthorizationResultImpl(hasAccess(requesterIdentity));
}
- /**
- * Fine-grained access control on parsed broker request. May check table, column, permissions, etc.
- * The default implementation is kept to have backward compatibility with the existing implementations
- * @param requesterIdentity requester identity
- * @param brokerRequest broker request (incl query)
- *
- * @return {@code true} if authorized, {@code false} otherwise
- */
+ /// Fine-grained access control on parsed broker request. May check table, column, permissions, etc.
+ /// The default implementation is kept to have backward compatibility with the existing implementations
+ /// @param requesterIdentity requester identity
+ /// @param brokerRequest broker request (incl query)
+ ///
+ /// @return `true` if authorized, `false` otherwise
@Deprecated
default boolean hasAccess(RequesterIdentity requesterIdentity, BrokerRequest brokerRequest) {
throw new UnsupportedOperationException(
@@ -76,29 +70,25 @@ public interface AccessControl extends FineGrainedAccessControl {
+ "implementations.");
}
- /**
- * Verify access control on parsed broker request. May check table, column, permissions, etc.
- * The default implementation returns a {@link BasicAuthorizationResultImpl} with the result of the hasAccess() of
- * the implementation
- *
- * @param requesterIdentity requester identity
- * @param brokerRequest broker request (incl query)
- *
- * @return {@code AuthorizationResult} with the result of the access control check
- */
+ /// Verify access control on parsed broker request. May check table, column, permissions, etc.
+ /// The default implementation returns a [BasicAuthorizationResultImpl] with the result of the hasAccess() of
+ /// the implementation
+ ///
+ /// @param requesterIdentity requester identity
+ /// @param brokerRequest broker request (incl query)
+ ///
+ /// @return `AuthorizationResult` with the result of the access control check
default AuthorizationResult authorize(RequesterIdentity requesterIdentity, BrokerRequest brokerRequest) {
return new BasicAuthorizationResultImpl(hasAccess(requesterIdentity, brokerRequest));
}
- /**
- * Fine-grained access control on pinot tables.
- * The default implementation is kept to have backward compatibility with the existing implementations
- *
- * @param requesterIdentity requester identity
- * @param tables Set of pinot tables used in the query. Table name can be with or without tableType.
- *
- * @return {@code true} if authorized, {@code false} otherwise
- */
+ /// Fine-grained access control on pinot tables.
+ /// The default implementation is kept to have backward compatibility with the existing implementations
+ ///
+ /// @param requesterIdentity requester identity
+ /// @param tables Set of pinot tables used in the query. Table name can be with or without tableType.
+ ///
+ /// @return `true` if authorized, `false` otherwise
@Deprecated
default boolean hasAccess(RequesterIdentity requesterIdentity, Set<String> tables) {
throw new UnsupportedOperationException(
@@ -106,16 +96,14 @@ public interface AccessControl extends FineGrainedAccessControl {
+ "implementations.");
}
- /**
- * Verify access control on pinot tables.
- * The default implementation returns a {@link TableAuthorizationResult} with the result of the hasAccess() of the
- * implementation
- *
- * @param requesterIdentity requester identity
- * @param tables Set of pinot tables used in the query. Table name can be with or without tableType.
- *
- * @return {@code TableAuthorizationResult} with the result of the access control check
- */
+ /// Verify access control on pinot tables.
+ /// The default implementation returns a [TableAuthorizationResult] with the result of the hasAccess() of the
+ /// implementation
+ ///
+ /// @param requesterIdentity requester identity
+ /// @param tables Set of pinot tables used in the query. Table name can be with or without tableType.
+ ///
+ /// @return `TableAuthorizationResult` with the result of the access control check
default TableAuthorizationResult authorize(RequesterIdentity requesterIdentity, Set<String> tables) {
// Taking all tables when hasAccess Failed , to not break existing implementations
// It will say all tables names failed AuthZ even only some failed AuthZ - which is same as just boolean output
@@ -124,12 +112,10 @@ public interface AccessControl extends FineGrainedAccessControl {
}
- /**
- * Returns RLS/CLS filters for a particular table. By default, there are no RLS/CLS filters on any table.
- * @param requesterIdentity requested identity
- * @param table Table used in the query. Table name can be with or without tableType.
- * @return {@link TableRowColAccessResult} with the result of the access control check
- */
+ /// Returns RLS/CLS filters for a particular table. By default, there are no RLS/CLS filters on any table.
+ /// @param requesterIdentity requested identity
+ /// @param table Table used in the query. Table name can be with or without tableType.
+ /// @return [TableRowColAccessResult] with the result of the access control check
default TableRowColAccessResult getRowColFilters(RequesterIdentity requesterIdentity, String table) {
return TableRowColAccessResultImpl.unrestricted();
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/api/HttpRequesterIdentity.java b/pinot-broker/src/main/java/org/apache/pinot/broker/api/HttpRequesterIdentity.java
index 97bd23c14ab..8b4452d1190 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/api/HttpRequesterIdentity.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/api/HttpRequesterIdentity.java
@@ -26,9 +26,7 @@ import org.apache.pinot.spi.utils.CommonConstants;
import org.glassfish.grizzly.http.server.Request;
-/**
- * Identity container for HTTP requests with (optional) authorization headers
- */
+/// Identity container for HTTP requests with (optional) authorization headers
public class HttpRequesterIdentity extends RequesterIdentity {
private Multimap<String, String> _httpHeaders;
private String _endpointUrl;
@@ -59,12 +57,10 @@ public class HttpRequesterIdentity extends RequesterIdentity {
_endpointUrl = endpointUrl;
}
- /**
- * If reverse proxy is used X-Forwarded-For will be populated
- * If X-Forwarded-For is not present, check if x-real-ip is present
- * Since X-Forwarded-For can contain comma separated list of values, we convert it to ";" delimiter to avoid
- * downstream parsing errors for other fields where "," is being used
- */
+ /// If reverse proxy is used X-Forwarded-For will be populated
+ /// If X-Forwarded-For is not present, check if x-real-ip is present
+ /// Since X-Forwarded-For can contain comma separated list of values, we convert it to ";" delimiter to avoid
+ /// downstream parsing errors for other fields where "," is being used
@Override
public String getClientIp() {
if (_httpHeaders != null) {
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/InstanceResource.java b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/InstanceResource.java
index 1ae496a491a..9727d011302 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/InstanceResource.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/InstanceResource.java
@@ -45,9 +45,7 @@ import org.apache.pinot.core.auth.TargetType;
import static org.apache.pinot.spi.utils.CommonConstants.SWAGGER_AUTHORIZATION_KEY;
-/**
- * This resource API can be used to retrieve instance level information like instance tags.
- */
+/// This resource API can be used to retrieve instance level information like instance tags.
@Api(tags = "Instance", authorizations = {@Authorization(value = SWAGGER_AUTHORIZATION_KEY)})
@SwaggerDefinition(securityDefinition = @SecurityDefinition(apiKeyAuthDefinitions = @ApiKeyAuthDefinition(name =
HttpHeaders.AUTHORIZATION, in = ApiKeyAuthDefinition.ApiKeyLocation.HEADER, key = SWAGGER_AUTHORIZATION_KEY,
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerAppConfigs.java b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerAppConfigs.java
index e389c0e64c8..462abdd2e2c 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerAppConfigs.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerAppConfigs.java
@@ -40,10 +40,8 @@ import org.apache.pinot.spi.env.PinotConfiguration;
import static org.apache.pinot.spi.utils.CommonConstants.SWAGGER_AUTHORIZATION_KEY;
-/**
- * Resource to get the app configs {@link PinotAppConfigs} for
- * the broker.
- */
+/// Resource to get the app configs [PinotAppConfigs] for
+/// the broker.
@Api(tags = "AppConfig", authorizations = {@Authorization(value = SWAGGER_AUTHORIZATION_KEY)})
@SwaggerDefinition(securityDefinition = @SecurityDefinition(apiKeyAuthDefinitions = @ApiKeyAuthDefinition(name =
HttpHeaders.AUTHORIZATION, in = ApiKeyAuthDefinition.ApiKeyLocation.HEADER, key = SWAGGER_AUTHORIZATION_KEY,
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerDebug.java b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerDebug.java
index 0e33145ba40..533f879ffd7 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerDebug.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerDebug.java
@@ -264,10 +264,8 @@ public class PinotBrokerDebug {
}
}
- /**
- * API to get a snapshot of ServerRoutingStatsEntry for all the servers.
- * @return String containing server name and the associated routing stats.
- */
+ /// API to get a snapshot of ServerRoutingStatsEntry for all the servers.
+ /// @return String containing server name and the associated routing stats.
@GET
@Produces(MediaType.APPLICATION_JSON)
@Path("/debug/serverRoutingStats")
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerLogger.java b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerLogger.java
index b1dbff59c78..01f3404dbd2 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerLogger.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerLogger.java
@@ -50,9 +50,7 @@ import org.apache.pinot.core.auth.TargetType;
import static org.apache.pinot.spi.utils.CommonConstants.SWAGGER_AUTHORIZATION_KEY;
-/**
- * Logger resource.
- */
+/// Logger resource.
@Api(tags = "Logger", authorizations = {@Authorization(value = SWAGGER_AUTHORIZATION_KEY)})
@SwaggerDefinition(securityDefinition = @SecurityDefinition(apiKeyAuthDefinitions = @ApiKeyAuthDefinition(name =
HttpHeaders.AUTHORIZATION, in = ApiKeyAuthDefinition.ApiKeyLocation.HEADER, key = SWAGGER_AUTHORIZATION_KEY,
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotClientRequest.java b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotClientRequest.java
index 445eb946e9b..729055c9c4e 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotClientRequest.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotClientRequest.java
@@ -767,21 +767,19 @@ public class PinotClientRequest {
return identity;
}
- /**
- * Generate Response object from the BrokerResponse object with 'X-Pinot-Error-Code' header value
- *
- * If the query is successful the 'X-Pinot-Error-Code' header value is set to -1
- * otherwise, the first error code of the broker response exception array will become the header value.
- *
- * By default, returns HTTP 200 OK even for errors. If the request header
- * 'Pinot-Use-Http-Status-For-Errors' is set to 'true', returns appropriate HTTP status
- * codes based on the error type from QueryErrorCode.getHttpResponseStatus().
- *
- * @param brokerResponse The broker response containing query results or errors
- * @param httpHeaders The HTTP headers from the request
- * @return Response
- * @throws Exception
- */
+ /// Generate Response object from the BrokerResponse object with 'X-Pinot-Error-Code' header value
+ ///
+ /// If the query is successful the 'X-Pinot-Error-Code' header value is set to -1
+ /// otherwise, the first error code of the broker response exception array will become the header value.
+ ///
+ /// By default, returns HTTP 200 OK even for errors. If the request header
+ /// 'Pinot-Use-Http-Status-For-Errors' is set to 'true', returns appropriate HTTP status
+ /// codes based on the error type from QueryErrorCode.getHttpResponseStatus().
+ ///
+ /// @param brokerResponse The broker response containing query results or errors
+ /// @param httpHeaders The HTTP headers from the request
+ /// @return Response
+ /// @throws Exception
@VisibleForTesting
public static Response getPinotQueryResponse(BrokerResponse brokerResponse, HttpHeaders httpHeaders,
BrokerMetrics brokerMetrics)
@@ -838,14 +836,12 @@ public class PinotClientRequest {
.build();
}
- /**
- * Given a query and the responses from the single-stage and multi-stage query engines, analyzes the differences
- * between the responses and returns a list of differences. Currently, the method only compares the column names,
- * column types, number of rows in the result set, and the aggregation values for aggregation-only queries.
- *
- * TODO: Add more comparison logic for different query types. This would require handling edge cases with group
- * trimming, non-deterministic results for order by queries with limits etc.
- */
+ /// Given a query and the responses from the single-stage and multi-stage query engines, analyzes the differences
+ /// between the responses and returns a list of differences. Currently, the method only compares the column names,
+ /// column types, number of rows in the result set, and the aggregation values for aggregation-only queries.
+ ///
+ /// TODO: Add more comparison logic for different query types. This would require handling edge cases with group
+ /// trimming, non-deterministic results for order by queries with limits etc.
private static List<String> analyzeQueryResultDifferences(String query, BrokerResponse v1Response,
BrokerResponse v2Response) {
List<String> differences = new ArrayList<>();
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/QueryWorkloadConfigResource.java b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/QueryWorkloadConfigResource.java
index 532219de258..c11b02241ae 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/QueryWorkloadConfigResource.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/QueryWorkloadConfigResource.java
@@ -36,9 +36,7 @@ import javax.ws.rs.core.Response;
import org.apache.pinot.broker.broker.BrokerAdminApiApplication;
import org.apache.pinot.common.utils.WorkloadBudgetUtils;
-/**
- * This resource handles workload budget updates sent from the controller via direct HTTP calls,
- */
+/// This resource handles workload budget updates sent from the controller via direct HTTP calls,
@Api(tags = "Workload")
@Path("/")
public class QueryWorkloadConfigResource {
@@ -46,26 +44,24 @@ public class QueryWorkloadConfigResource {
@Named(BrokerAdminApiApplication.BROKER_INSTANCE_ID)
private String _instanceId;
- /**
- * Refreshes query workload configurations on this instance.
- * <p>
- * This endpoint adds or updates workload budgets sent from the controller.
- * It supports batch updates of multiple workloads in a single request.
- * This method enforces strict error handling - any update failure will cause the entire
- * operation to fail immediately without continuing to update remaining workloads.
- * </p>
- *
- * <p><b>Request Body Example:</b></p>
- * <pre>{@code
- {
- * "foo": {"cpuCostNs": 1000000, "memoryCostBytes": 1000000},
- * "bar": {"cpuCostNs": 500000, "memoryCostBytes": 500000}
- *}
- * }</pre>
- *
- * @param requestString JSON request containing workload-to-cost map
- * @return HTTP 200 (success), 400 (bad request), or 500 (error)
- */
+ /// Refreshes query workload configurations on this instance.
+ ///
+ /// This endpoint adds or updates workload budgets sent from the controller.
+ /// It supports batch updates of multiple workloads in a single request.
+ /// This method enforces strict error handling - any update failure will cause the entire
+ /// operation to fail immediately without continuing to update remaining workloads.
+ ///
+ /// **Request Body Example:**
+ ///
+ /// ```
+ /// {
+ /// "foo": {"cpuCostNs": 1000000, "memoryCostBytes": 1000000},
+ /// "bar": {"cpuCostNs": 500000, "memoryCostBytes": 500000}
+ /// }
+ /// ```
+ ///
+ /// @param requestString JSON request containing workload-to-cost map
+ /// @return HTTP 200 (success), 400 (bad request), or 500 (error)
@POST
@Path("/queryWorkloadConfigs")
@Produces(MediaType.APPLICATION_JSON)
@@ -80,21 +76,17 @@ public class QueryWorkloadConfigResource {
return WorkloadBudgetUtils.handleRefreshRequest(requestString, _instanceId);
}
- /**
- * Gets budget statistics for workloads on this instance.
- * <p>
- * If workloadNames query parameter is not provided, returns budget information for all workloads.
- * If workloadNames is provided as a comma-separated list, returns budget information for those specific workloads.
- * This method enforces strict error handling - any retrieval failure will cause the entire
- * operation to fail immediately without returning partial results.
- * </p>
- * <p>
- * Returns a single object if exactly one workload is requested, otherwise returns an array.
- * </p>
- *
- * @param workloadNames Optional comma-separated list of workload names to query
- * @return JSON string with workload budget statistics (single object or array)
- */
+ /// Gets budget statistics for workloads on this instance.
+ ///
+ /// If workloadNames query parameter is not provided, returns budget information for all workloads.
+ /// If workloadNames is provided as a comma-separated list, returns budget information for those specific workloads.
+ /// This method enforces strict error handling - any retrieval failure will cause the entire
+ /// operation to fail immediately without returning partial results.
+ ///
+ /// Returns a single object if exactly one workload is requested, otherwise returns an array.
+ ///
+ /// @param workloadNames Optional comma-separated list of workload names to query
+ /// @return JSON string with workload budget statistics (single object or array)
@GET
@Path("/queryWorkloadConfigs")
@Produces(MediaType.APPLICATION_JSON)
@@ -112,23 +104,21 @@ public class QueryWorkloadConfigResource {
return WorkloadBudgetUtils.getWorkloadBudgetStats(workloadNames, _instanceId);
}
- /**
- * Deletes query workload configurations from this instance.
- * <p>
- * This endpoint removes workload budgets sent from the controller.
- * It supports batch deletion of multiple workloads via comma-separated query parameter.
- * This method enforces strict error handling - any deletion failure will cause the entire
- * operation to fail immediately without continuing to delete remaining workloads.
- * </p>
- *
- * <p><b>Example:</b></p>
- * <pre>{@code
- * DELETE /queryWorkloadConfigs?workloadNames=foo,bar,baz
- * }</pre>
- *
- * @param workloadNamesParam Comma-separated list of workload names to delete
- * @return HTTP 200 (success), 400 (bad request), or 500 (error)
- */
+ /// Deletes query workload configurations from this instance.
+ ///
+ /// This endpoint removes workload budgets sent from the controller.
+ /// It supports batch deletion of multiple workloads via comma-separated query parameter.
+ /// This method enforces strict error handling - any deletion failure will cause the entire
+ /// operation to fail immediately without continuing to delete remaining workloads.
+ ///
+ /// **Example:**
+ ///
+ /// ```
+ /// DELETE /queryWorkloadConfigs?workloadNames=foo,bar,baz
+ /// ```
+ ///
+ /// @param workloadNamesParam Comma-separated list of workload names to delete
+ /// @return HTTP 200 (success), 400 (bad request), or 500 (error)
@DELETE
@Path("/queryWorkloadConfigs")
@Produces(MediaType.APPLICATION_JSON)
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/ResponseStoreResource.java b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/ResponseStoreResource.java
index 6b4f704ca02..560f50f4ec7 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/ResponseStoreResource.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/ResponseStoreResource.java
@@ -64,10 +64,8 @@ import org.slf4j.LoggerFactory;
import static org.apache.pinot.spi.utils.CommonConstants.SWAGGER_AUTHORIZATION_KEY;
-/**
- * This resource API provides API to read cursors as well as admin function such as list, read and delete response
- * stores
- */
+/// This resource API provides API to read cursors as well as admin function such as list, read and delete response
+/// stores
@Api(tags = "ResponseStore", authorizations = {@Authorization(value = SWAGGER_AUTHORIZATION_KEY)})
@SwaggerDefinition(securityDefinition = @SecurityDefinition(apiKeyAuthDefinitions = @ApiKeyAuthDefinition(name =
HttpHeaders.AUTHORIZATION, in = ApiKeyAuthDefinition.ApiKeyLocation.HEADER, key = SWAGGER_AUTHORIZATION_KEY,
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/SqlSyntaxValidationResponse.java b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/SqlSyntaxValidationResponse.java
index 7eb8ce298c1..7720017adcd 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/SqlSyntaxValidationResponse.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/SqlSyntaxValidationResponse.java
@@ -21,11 +21,9 @@ package org.apache.pinot.broker.api.resources;
import com.fasterxml.jackson.annotation.JsonInclude;
-/**
- * Response for the {@code POST /query/sql/validateSyntax} broker endpoint. Reports whether a SQL
- * query was accepted by Pinot's Calcite-based parser, along with an error message when parsing
- * failed.
- */
+/// Response for the `POST /query/sql/validateSyntax` broker endpoint. Reports whether a SQL
+/// query was accepted by Pinot's Calcite-based parser, along with an error message when parsing
+/// failed.
@JsonInclude(JsonInclude.Include.NON_NULL)
public class SqlSyntaxValidationResponse {
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/AccessControlFactory.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/AccessControlFactory.java
index 7f2cb116f42..9ddf376c7c4 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/AccessControlFactory.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/AccessControlFactory.java
@@ -40,13 +40,11 @@ public abstract class AccessControlFactory {
public void init(PinotConfiguration configuration) {
}
- /**
- * Extend original init method inorder to support Zookeeper BasicAuthAccessControlFactory
- * Because ZKBasicAuthAccessControlFactory need to acquire users info from HelixPropertyStore
- *
- * @param configuration pinot configuration
- * @param propertyStore Helix PropertyStore
- */
+ /// Extend original init method inorder to support Zookeeper BasicAuthAccessControlFactory
+ /// Because ZKBasicAuthAccessControlFactory need to acquire users info from HelixPropertyStore
+ ///
+ /// @param configuration pinot configuration
+ /// @param propertyStore Helix PropertyStore
public void init(PinotConfiguration configuration, ZkHelixPropertyStore<ZNRecord> propertyStore) {
init(configuration);
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/AuthenticationFilter.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/AuthenticationFilter.java
index 27c93e32b41..ffabdf038c6 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/AuthenticationFilter.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/AuthenticationFilter.java
@@ -44,10 +44,8 @@ import org.apache.pinot.spi.auth.AuthorizationResult;
import org.glassfish.grizzly.http.server.Request;
-/**
- * A container filter class responsible for automatic authentication of REST endpoints. Any rest endpoints not annotated
- * with {@link org.apache.pinot.core.auth.ManualAuthorization} annotation, will go through authentication.
- */
+/// A container filter class responsible for automatic authentication of REST endpoints. Any rest endpoints not
+/// annotated with [org.apache.pinot.core.auth.ManualAuthorization] annotation, will go through authentication.
@javax.ws.rs.ext.Provider
public class AuthenticationFilter implements ContainerRequestFilter {
private static final Set<String> UNPROTECTED_PATHS =
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BasicAuthAccessControlFactory.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BasicAuthAccessControlFactory.java
index e375a8ee2fe..e9c4cf052c0 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BasicAuthAccessControlFactory.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BasicAuthAccessControlFactory.java
@@ -41,17 +41,15 @@ import org.apache.pinot.spi.auth.broker.RequesterIdentity;
import org.apache.pinot.spi.env.PinotConfiguration;
-/**
- * Basic Authentication based on http headers. Configured via the "pinot.broker.access.control" family of properties.
- *
- * <pre>
- * Example:
- * pinot.broker.access.control.principals=admin123,user456
- * pinot.broker.access.control.principals.admin123.password=verysecret
- * pinot.broker.access.control.principals.user456.password=kindasecret
- * pinot.broker.access.control.principals.user456.tables=stuff,lessImportantStuff
- * </pre>
- */
+/// Basic Authentication based on http headers. Configured via the "pinot.broker.access.control" family of properties.
+///
+/// ```
+/// Example:
+/// pinot.broker.access.control.principals=admin123,user456
+/// pinot.broker.access.control.principals.admin123.password=verysecret
+/// pinot.broker.access.control.principals.user456.password=kindasecret
+/// pinot.broker.access.control.principals.user456.tables=stuff,lessImportantStuff
+/// ```
public class BasicAuthAccessControlFactory extends AccessControlFactory {
private static final String PREFIX = "principals";
@@ -72,9 +70,7 @@ public class BasicAuthAccessControlFactory extends AccessControlFactory {
return _accessControl;
}
- /**
- * Access Control using header-based basic http authentication
- */
+ /// Access Control using header-based basic http authentication
private static class BasicAuthAccessControl implements AccessControl {
private final Map<String, BasicAuthPrincipal> _token2principal;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BrokerManagedAsyncExecutorProvider.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BrokerManagedAsyncExecutorProvider.java
index 8d6823be84e..8cc375b12ec 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BrokerManagedAsyncExecutorProvider.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/BrokerManagedAsyncExecutorProvider.java
@@ -33,9 +33,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * BrokerManagedAsyncExecutorProvider provides a bounded thread pool.
- */
+/// BrokerManagedAsyncExecutorProvider provides a bounded thread pool.
@ManagedAsyncExecutor
public class BrokerManagedAsyncExecutorProvider extends ThreadPoolExecutorProvider {
private static final Logger LOGGER = LoggerFactory.getLogger(BrokerManagedAsyncExecutorProvider.class);
@@ -87,14 +85,12 @@ public class BrokerManagedAsyncExecutorProvider extends ThreadPoolExecutorProvid
_brokerMetrics = brokerMetrics;
}
- /**
- * Reject the runnable if it can’t be accommodated by the thread pool.
- *
- * <p> Response returned will have SERVICE_UNAVAILABLE(503) error code with error msg.
- *
- * @param r Runnable
- * @param executor ThreadPoolExecutor
- */
+ /// Reject the runnable if it can’t be accommodated by the thread pool.
+ ///
+ /// Response returned will have SERVICE_UNAVAILABLE(503) error code with error msg.
+ ///
+ /// @param r Runnable
+ /// @param executor ThreadPoolExecutor
@Override
public void rejectedExecution(Runnable r, ThreadPoolExecutor executor) {
_brokerMetrics.addMeteredGlobalValue(BrokerMeter.QUERY_REJECTED_EXCEPTIONS, 1L);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/ZkBasicAuthAccessControlFactory.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/ZkBasicAuthAccessControlFactory.java
index 8fe4c528eb0..128e49646e0 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/ZkBasicAuthAccessControlFactory.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/ZkBasicAuthAccessControlFactory.java
@@ -43,15 +43,12 @@ import org.apache.pinot.spi.env.PinotConfiguration;
import org.apache.pinot.spi.utils.builder.TableNameBuilder;
-/**
- * Zookeeper Basic Authentication based on Pinot Controller UI.
- * The user role has been distinguished by user and admin. Only admin can have access to the
- * user console page in Pinot controller UI. And admin can change user info (table permission/
- * number of tables/password etc.) or add/delete user without restarting your Pinot clusters,
- * and these changes happen immediately.
- * Users Configuration store in Helix Zookeeper and encrypted user password via Bcrypt Encryption Algorithm.
- *
- */
+/// Zookeeper Basic Authentication based on Pinot Controller UI.
+/// The user role has been distinguished by user and admin. Only admin can have access to the
+/// user console page in Pinot controller UI. And admin can change user info (table permission/
+/// number of tables/password etc.) or add/delete user without restarting your Pinot clusters,
+/// and these changes happen immediately.
+/// Users Configuration store in Helix Zookeeper and encrypted user password via Bcrypt Encryption Algorithm.
public class ZkBasicAuthAccessControlFactory extends AccessControlFactory {
private AccessControl _accessControl;
@@ -70,9 +67,7 @@ public class ZkBasicAuthAccessControlFactory extends AccessControlFactory {
return _accessControl;
}
- /**
- * Access Control using header-based basic http authentication
- */
+ /// Access Control using header-based basic http authentication
private static class BasicAuthAccessControl implements AccessControl {
private Map<String, ZkBasicAuthPrincipal> _name2principal;
private final AccessControlUserCache _userCache;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BaseBrokerStarter.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BaseBrokerStarter.java
index d757d5846e8..5ed947953e3 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BaseBrokerStarter.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BaseBrokerStarter.java
@@ -132,18 +132,14 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Base class for broker startable implementations
- */
+/// Base class for broker startable implementations
@SuppressWarnings("unused")
public abstract class BaseBrokerStarter implements ServiceStartable {
private static final Logger LOGGER = LoggerFactory.getLogger(BaseBrokerStarter.class);
- /**
- * When {@link CommonConstants.CursorConfigs#RESPONSE_STORE_CLEANER_INITIAL_DELAY} is unset, the first cleanup run
- * is scheduled after one full frequency period plus jitter in {@code [0, frequencyMs / this value)}, to
- * desynchronize brokers on shared storage.
- */
+ /// When [CommonConstants.CursorConfigs#RESPONSE_STORE_CLEANER_INITIAL_DELAY] is unset, the first cleanup run
+ /// is scheduled after one full frequency period plus jitter in `[0, frequencyMs / this value)`, to
+ /// desynchronize brokers on shared storage.
private static final int RESPONSE_STORE_CLEANUP_INITIAL_DELAY_JITTER_DIVISOR = 4;
protected PinotConfiguration _brokerConf;
@@ -251,26 +247,20 @@ public abstract class BaseBrokerStarter implements ServiceStartable {
protected void applyCustomConfigs(PinotConfiguration brokerConf) {
}
- /**
- * Override to customize the query operator factory provider used by the broker multi-stage engine.
- */
+ /// Override to customize the query operator factory provider used by the broker multi-stage engine.
protected QueryOperatorFactoryProvider createQueryOperatorFactoryProvider(PinotConfiguration brokerConf) {
return DefaultQueryOperatorFactoryProvider.INSTANCE;
}
- /**
- * Override to customize the {@link WorkerManager} used for multi-stage query engine worker assignment.
- */
+ /// Override to customize the [WorkerManager] used for multi-stage query engine worker assignment.
protected WorkerManager createWorkerManager(String brokerId, String hostname, int port,
RoutingManager routingManager) {
return new WorkerManager(brokerId, hostname, port, routingManager);
}
- /**
- * Override to supply a custom {@link SingleConnectionBrokerRequestHandler} subclass (e.g. one
- * that overrides {@code onQueryCompletion(RequestContext, BrokerResponse)} for async query
- * logging). Pass {@code null} for {@code materializedViewHandler} to skip MV rewrite.
- */
+ /// Override to supply a custom [SingleConnectionBrokerRequestHandler] subclass (e.g. one
+ /// that overrides `onQueryCompletion(RequestContext, BrokerResponse)` for async query
+ /// logging). Pass `null` for `materializedViewHandler` to skip MV rewrite.
protected SingleConnectionBrokerRequestHandler createSingleStageBrokerRequestHandler(
PinotConfiguration config, String brokerId, BrokerRequestIdGenerator requestIdGenerator,
RoutingManager routingManager, AccessControlFactory accessControlFactory,
@@ -285,10 +275,8 @@ public abstract class BaseBrokerStarter implements ServiceStartable {
materializedViewHandler);
}
- /**
- * Override to supply a custom {@link GrpcBrokerRequestHandler} subclass. Pass {@code null} for
- * {@code materializedViewHandler} to skip MV rewrite.
- */
+ /// Override to supply a custom [GrpcBrokerRequestHandler] subclass. Pass `null` for
+ /// `materializedViewHandler` to skip MV rewrite.
protected GrpcBrokerRequestHandler createGrpcBrokerRequestHandler(
PinotConfiguration config, String brokerId, BrokerRequestIdGenerator requestIdGenerator,
RoutingManager routingManager, AccessControlFactory accessControlFactory,
@@ -300,11 +288,9 @@ public abstract class BaseBrokerStarter implements ServiceStartable {
multiClusterRoutingContext, materializedViewHandler);
}
- /**
- * Override to supply a custom {@link MultiStageBrokerRequestHandler} subclass (e.g. one that
- * overrides {@code onQueryCompletion(RequestContext, BrokerResponse)} for async query logging).
- * The default implementation returns a plain {@link MultiStageBrokerRequestHandler}.
- */
+ /// Override to supply a custom [MultiStageBrokerRequestHandler] subclass (e.g. one that
+ /// overrides `onQueryCompletion(RequestContext, BrokerResponse)` for async query logging).
+ /// The default implementation returns a plain [MultiStageBrokerRequestHandler].
protected MultiStageBrokerRequestHandler createMultiStageBrokerRequestHandler(
PinotConfiguration config, String brokerId, BrokerRequestIdGenerator requestIdGenerator,
RoutingManager routingManager, AccessControlFactory accessControlFactory,
@@ -331,47 +317,42 @@ public abstract class BaseBrokerStarter implements ServiceStartable {
return _port;
}
- /**
- * Adds an ideal state change handler to handle Helix ideal state change callbacks.
- * <p>NOTE: all change handlers will be run in a single thread, so any slow change handler can block other change
- * handlers from running. For slow change handler, make it asynchronous.
- */
+ /// Adds an ideal state change handler to handle Helix ideal state change callbacks.
+ ///
+ /// NOTE: all change handlers will be run in a single thread, so any slow change handler can block other change
+ /// handlers from running. For slow change handler, make it asynchronous.
public void addIdealStateChangeHandler(ClusterChangeHandler idealStateChangeHandler) {
_idealStateChangeHandlers.add(idealStateChangeHandler);
}
- /**
- * Adds an external view change handler to handle Helix external view change callbacks.
- * <p>NOTE: all change handlers will be run in a single thread, so any slow change handler can block other change
- * handlers from running. For slow change handler, make it asynchronous.
- */
+ /// Adds an external view change handler to handle Helix external view change callbacks.
+ ///
+ /// NOTE: all change handlers will be run in a single thread, so any slow change handler can block other change
+ /// handlers from running. For slow change handler, make it asynchronous.
public void addExternalViewChangeHandler(ClusterChangeHandler externalViewChangeHandler) {
_externalViewChangeHandlers.add(externalViewChangeHandler);
}
- /**
- * Adds an instance config change handler to handle Helix instance config change callbacks.
- * <p>NOTE: all change handlers will be run in a single thread, so any slow change handler can block other change
- * handlers from running. For slow change handler, make it asynchronous.
- */
+ /// Adds an instance config change handler to handle Helix instance config change callbacks.
+ ///
+ /// NOTE: all change handlers will be run in a single thread, so any slow change handler can block other change
+ /// handlers from running. For slow change handler, make it asynchronous.
public void addInstanceConfigChangeHandler(ClusterChangeHandler instanceConfigChangeHandler) {
_instanceConfigChangeHandlers.add(instanceConfigChangeHandler);
}
- /**
- * Adds a cluster config change handler to handle Helix cluster config change callbacks.
- * <p>NOTE: all change handlers will be run in a single thread, so any slow change handler can block other change
- * handlers from running. For slow change handler, make it asynchronous.
- */
+ /// Adds a cluster config change handler to handle Helix cluster config change callbacks.
+ ///
+ /// NOTE: all change handlers will be run in a single thread, so any slow change handler can block other change
+ /// handlers from running. For slow change handler, make it asynchronous.
public void addClusterConfigChangeHandler(ClusterChangeHandler clusterConfigChangeHandler) {
_clusterConfigChangeHandlers.add(clusterConfigChangeHandler);
}
- /**
- * Adds a live instance change handler to handle Helix live instance change callbacks.
- * <p>NOTE: all change handlers will be run in a single thread, so any slow change handler can block other change
- * handlers from running. For slow change handler, make it asynchronous.
- */
+ /// Adds a live instance change handler to handle Helix live instance change callbacks.
+ ///
+ /// NOTE: all change handlers will be run in a single thread, so any slow change handler can block other change
+ /// handlers from running. For slow change handler, make it asynchronous.
public void addLiveInstanceChangeHandler(ClusterChangeHandler liveInstanceChangeHandler) {
_liveInstanceChangeHandlers.add(liveInstanceChangeHandler);
}
@@ -764,20 +745,16 @@ public abstract class BaseBrokerStarter implements ServiceStartable {
_helixDataAccessor = _spectatorHelixManager.getHelixDataAccessor();
}
- /**
- * Can be overridden to inject a custom MultiClusterRoutingContext from MultiClusterBrokerStarter.
- */
+ /// Can be overridden to inject a custom MultiClusterRoutingContext from MultiClusterBrokerStarter.
protected MultiClusterRoutingContext getMultiClusterRoutingContext() {
return null;
}
- /**
- * @deprecated Use {@link #createBrokerAdminApp()} instead.
- * This method is called after initialization of BrokerAdminApiApplication object
- * and before calling start to allow custom broker starters to register additional
- * components.
- * @param brokerAdminApplication is the application
- */
+ /// @deprecated Use [#createBrokerAdminApp()] instead.
+ /// This method is called after initialization of BrokerAdminApiApplication object
+ /// and before calling start to allow custom broker starters to register additional
+ /// components.
+ /// @param brokerAdminApplication is the application
protected void registerExtraComponents(BrokerAdminApiApplication brokerAdminApplication) {
}
@@ -855,10 +832,8 @@ public abstract class BaseBrokerStarter implements ServiceStartable {
}
}
- /**
- * Fetches the resources to monitor and registers the
- * {@link org.apache.pinot.common.utils.ServiceStatus.ServiceStatusCallback}s
- */
+ /// Fetches the resources to monitor and registers the
+ /// [org.apache.pinot.common.utils.ServiceStatus.ServiceStatusCallback]s
private void registerServiceStatusHandler() {
List<String> resourcesToMonitor = new ArrayList<>(1);
IdealState brokerResourceIdealState =
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BrokerResourceOnlineOfflineStateModelFactory.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BrokerResourceOnlineOfflineStateModelFactory.java
index dfe3bc3c1e3..9151f5c126b 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BrokerResourceOnlineOfflineStateModelFactory.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BrokerResourceOnlineOfflineStateModelFactory.java
@@ -41,12 +41,8 @@ import org.slf4j.LoggerFactory;
import static org.apache.pinot.spi.utils.CommonConstants.Helix.BROKER_RESOURCE_INSTANCE;
-/**
- * Broker Resource layer state model to take over how to operate on:
- * Adding an external view to routing table.
- *
- *
- */
+/// Broker Resource layer state model to take over how to operate on:
+/// Adding an external view to routing table.
public class BrokerResourceOnlineOfflineStateModelFactory extends StateModelFactory<StateModel> {
private static final Logger LOGGER = LoggerFactory.getLogger(BrokerResourceOnlineOfflineStateModelFactory.class);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BrokerUserDefinedMessageHandlerFactory.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BrokerUserDefinedMessageHandlerFactory.java
index 1bb683d9911..50193eb3cac 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BrokerUserDefinedMessageHandlerFactory.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/BrokerUserDefinedMessageHandlerFactory.java
@@ -36,13 +36,11 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Broker message handler factory for Helix user-define messages.
- * <p>The following message sub-types are supported:
- * <ul>
- * <li>Refresh segment message: Refresh the routing properties for a given segment</li>
- * </ul>
- */
+/// Broker message handler factory for Helix user-define messages.
+///
+/// The following message sub-types are supported:
+///
+/// - Refresh segment message: Refresh the routing properties for a given segment
public class BrokerUserDefinedMessageHandlerFactory implements MessageHandlerFactory {
private static final Logger LOGGER = LoggerFactory.getLogger(BrokerUserDefinedMessageHandlerFactory.class);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/ClusterChangeHandler.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/ClusterChangeHandler.java
index fff67beaaf4..360dae64878 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/ClusterChangeHandler.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/ClusterChangeHandler.java
@@ -24,20 +24,14 @@ import org.apache.pinot.spi.annotations.InterfaceAudience;
import org.apache.pinot.spi.annotations.InterfaceStability;
-/**
- * Handles cluster changes such as external view changes, instance config changes, live instance changes etc.
- */
+/// Handles cluster changes such as external view changes, instance config changes, live instance changes etc.
@InterfaceAudience.Public
@InterfaceStability.Evolving
public interface ClusterChangeHandler {
- /**
- * Initializes the cluster change handler with the given connected Helix manager.
- */
+ /// Initializes the cluster change handler with the given connected Helix manager.
void init(HelixManager helixManager);
- /**
- * Processes the cluster change of the given type (e.g. EXTERNAL_VIEW, INSTANCE_CONFIG, LIVE_INSTANCE).
- */
+ /// Processes the cluster change of the given type (e.g. EXTERNAL_VIEW, INSTANCE_CONFIG, LIVE_INSTANCE).
void processClusterChange(HelixConstants.ChangeType changeType);
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/ClusterChangeMediator.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/ClusterChangeMediator.java
index f1e25804bfd..0cd2e38437c 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/ClusterChangeMediator.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/ClusterChangeMediator.java
@@ -44,15 +44,15 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * The {@code ClusterChangeMediator} handles the changes from Helix cluster.
- * <p>
- * <p>If there is no change callback in 1 hour, proactively check changes so that the changes are getting processed even
- * when callbacks stop working.
- * <p>NOTE: disable Helix batch-mode and perform deduplication in this class. This can save us the extra threads for
- * handling Helix batch-mode, and let us track the cluster change queue time.
- * <p>NOTE: disable Helix pre-fetch to reduce the ZK accesses.
- */
+/// The `ClusterChangeMediator` handles the changes from Helix cluster.
+///
+/// If there is no change callback in 1 hour, proactively check changes so that the changes are getting processed even
+/// when callbacks stop working.
+///
+/// NOTE: disable Helix batch-mode and perform deduplication in this class. This can save us the extra threads for
+/// handling Helix batch-mode, and let us track the cluster change queue time.
+///
+/// NOTE: disable Helix pre-fetch to reduce the ZK accesses.
@BatchMode(enabled = false)
@PreFetch(enabled = false)
public class ClusterChangeMediator
@@ -146,18 +146,14 @@ public class ClusterChangeMediator
_lastProcessTimeMap.put(changeType, endTime);
}
- /**
- * Starts the cluster change mediator.
- */
+ /// Starts the cluster change mediator.
public void start() {
LOGGER.info("Starting ClusterChangeMediator");
_running = true;
_clusterChangeHandlingThread.start();
}
- /**
- * Stops the cluster change mediator.
- */
+ /// Stops the cluster change mediator.
public void stop() {
LOGGER.info("Stopping ClusterChangeMediator");
_running = false;
@@ -210,12 +206,10 @@ public class ClusterChangeMediator
enqueueChange(ChangeType.LIVE_INSTANCE);
}
- /**
- * Helper method to enqueue a change from the Helix callback to be processed by the cluster change handling thread. If
- * the handling thread is dead, directly process the change.
- *
- * @param changeType Type of the change
- */
+ /// Helper method to enqueue a change from the Helix callback to be processed by the cluster change handling
+ /// thread. If the handling thread is dead, directly process the change.
+ ///
+ /// @param changeType Type of the change
private void enqueueChange(ChangeType changeType) {
// Do not enqueue or process changes if already stopped
if (!_running) {
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/HelixBrokerStarter.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/HelixBrokerStarter.java
index 0de727f44e2..b051842c605 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/HelixBrokerStarter.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/HelixBrokerStarter.java
@@ -26,10 +26,8 @@ import org.apache.pinot.spi.utils.CommonConstants.Broker;
import org.apache.pinot.spi.utils.CommonConstants.Helix;
-/**
- * Startable implementation for Pinot broker.
- * Contains methods to start and stop a Pinot broker
- */
+/// Startable implementation for Pinot broker.
+/// Contains methods to start and stop a Pinot broker
@SuppressWarnings("unused")
public class HelixBrokerStarter extends BaseBrokerStarter {
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/MultiClusterHelixBrokerStarter.java b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/MultiClusterHelixBrokerStarter.java
index 593a8f14923..661c640b520 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/MultiClusterHelixBrokerStarter.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/broker/helix/MultiClusterHelixBrokerStarter.java
@@ -41,16 +41,14 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Multi-cluster broker starter that extends the base Helix broker functionality
- * to support federation across multiple Pinot clusters.
- *
- * This class handles:
- * - Connection to remote clusters via separate ZooKeeper instances
- * - Federated routing across primary and remote clusters
- * - Cross-cluster query federation
- * - Cluster change monitoring for remote clusters
- */
+/// Multi-cluster broker starter that extends the base Helix broker functionality
+/// to support federation across multiple Pinot clusters.
+///
+/// This class handles:
+/// - Connection to remote clusters via separate ZooKeeper instances
+/// - Federated routing across primary and remote clusters
+/// - Cross-cluster query federation
+/// - Cluster change monitoring for remote clusters
@SuppressWarnings("unused")
public class MultiClusterHelixBrokerStarter extends BaseBrokerStarter {
private static final Logger LOGGER = LoggerFactory.getLogger(MultiClusterHelixBrokerStarter.class);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/cursors/FsResponseStore.java b/pinot-broker/src/main/java/org/apache/pinot/broker/cursors/FsResponseStore.java
index ddac3801ad2..b9cdfd6e973 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/cursors/FsResponseStore.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/cursors/FsResponseStore.java
@@ -44,15 +44,12 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Stores responses in a file system. All storage schemes supported by PinotFS can be used.
- * Responses are stored in "data.dir" directory with the following structure:
- * - A directory is created for every request id.
- * - Response metadata is stored with filename "response"
- * - Results are stored with filename "resultTable"
- * The extension of the file is determined by the config "extension"
- *
- */
+/// Stores responses in a file system. All storage schemes supported by PinotFS can be used.
+/// Responses are stored in "data.dir" directory with the following structure:
+/// - A directory is created for every request id.
+/// - Response metadata is stored with filename "response"
+/// - Results are stored with filename "resultTable"
+/// The extension of the file is determined by the config "extension"
@AutoService(ResponseStore.class)
public class FsResponseStore extends AbstractResponseStore {
private static final Logger LOGGER = LoggerFactory.getLogger(FsResponseStore.class);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/grpc/BrokerGrpcServer.java b/pinot-broker/src/main/java/org/apache/pinot/broker/grpc/BrokerGrpcServer.java
index 639bfab917a..6d6f4fce789 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/grpc/BrokerGrpcServer.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/grpc/BrokerGrpcServer.java
@@ -156,9 +156,7 @@ public class BrokerGrpcServer extends PinotQueryBrokerGrpc.PinotQueryBrokerImplB
LOGGER.info("Initialized BrokerGrpcServer on port: {}", portToUse);
}
- /**
- * Registers buffer metrics for the given allocator.
- */
+ /// Registers buffer metrics for the given allocator.
private void registerBufferMetrics(PooledByteBufAllocator bufAllocator, BrokerMetrics brokerMetrics) {
PooledByteBufAllocatorMetric metric = bufAllocator.metric();
brokerMetrics.setOrUpdateGlobalGauge(BrokerGauge.GRPC_NETTY_POOLED_USED_DIRECT_MEMORY, metric::usedDirectMemory);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/grpc/GrpcRequesterIdentity.java b/pinot-broker/src/main/java/org/apache/pinot/broker/grpc/GrpcRequesterIdentity.java
index 8748bf562dc..2567d700169 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/grpc/GrpcRequesterIdentity.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/grpc/GrpcRequesterIdentity.java
@@ -58,15 +58,13 @@ public class GrpcRequesterIdentity extends RequesterIdentity {
_metadata = metadata;
}
- /**
- * Following the same logic of
- * {@link org.apache.pinot.broker.api.HttpRequesterIdentity} to get client IP
- * If reverse proxy is used X-Forwarded-For will be populated
- * If X-Forwarded-For is not present, check if x-real-ip is present
- * Since X-Forwarded-For can contain comma separated list of values,
- * we convert it to ";" delimiter to avoid
- * downstream parsing errors for other fields where "," is being used
- */
+ /// Following the same logic of
+ /// [org.apache.pinot.broker.api.HttpRequesterIdentity] to get client IP
+ /// If reverse proxy is used X-Forwarded-For will be populated
+ /// If X-Forwarded-For is not present, check if x-real-ip is present
+ /// Since X-Forwarded-For can contain comma separated list of values,
+ /// we convert it to ";" delimiter to avoid
+ /// downstream parsing errors for other fields where "," is being used
@Override
public String getClientIp() {
if (_metadata != null) {
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/querylog/QueryLogger.java b/pinot-broker/src/main/java/org/apache/pinot/broker/querylog/QueryLogger.java
index c01e954b4af..2e30a87108e 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/querylog/QueryLogger.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/querylog/QueryLogger.java
@@ -37,11 +37,9 @@ import org.slf4j.LoggerFactory;
import static org.apache.pinot.spi.utils.CommonConstants.Broker;
-/**
- * {@code QueryLogger} is responsible for logging query responses in a configurable
- * fashion. Query logging can be useful to capture production traffic to assist with
- * debugging or regression testing.
- */
+/// `QueryLogger` is responsible for logging query responses in a configurable
+/// fashion. Query logging can be useful to capture production traffic to assist with
+/// debugging or regression testing.
@SuppressWarnings("UnstableApiUsage")
public class QueryLogger {
@@ -111,16 +109,14 @@ public class QueryLogger {
_sqlRedactionMode = sqlRedactionMode;
}
- /**
- * Logs the query received message before processing begins.
- * This method checks the rate limiter and returns whether logging was allowed.
- * The return value should be passed to logQueryCompleted.
- *
- * @param requestId the request ID
- * @param query the SQL query
- * @param queryFingerprint the query fingerprint (used when redaction is enabled)
- * @return true if the rate limiter allowed this query (not rate-limited), false if rate-limited
- */
+ /// Logs the query received message before processing begins.
+ /// This method checks the rate limiter and returns whether logging was allowed.
+ /// The return value should be passed to logQueryCompleted.
+ ///
+ /// @param requestId the request ID
+ /// @param query the SQL query
+ /// @param queryFingerprint the query fingerprint (used when redaction is enabled)
+ /// @return true if the rate limiter allowed this query (not rate-limited), false if rate-limited
public boolean logQueryReceived(long requestId, String query, @Nullable QueryFingerprint queryFingerprint) {
if (!checkRateLimiter()) {
return false;
@@ -134,14 +130,12 @@ public class QueryLogger {
return true;
}
- /**
- * Logs the query completion stats after processing completes.
- *
- * @param params the query log parameters
- * @param wasLogged true if logQueryReceived returned true, false otherwise.
- * When false, the completion log will only be emitted if force-log
- * conditions are met (exceptions, slow queries).
- */
+ /// Logs the query completion stats after processing completes.
+ ///
+ /// @param params the query log parameters
+ /// @param wasLogged true if logQueryReceived returned true, false otherwise.
+ /// When false, the completion log will only be emitted if force-log
+ /// conditions are met (exceptions, slow queries).
public void logQueryCompleted(QueryLogParams params, boolean wasLogged) {
_logger.debug("Broker Response: {}", params._response);
@@ -258,10 +252,8 @@ public class QueryLogger {
}
}
- /**
- * NOTE: please maintain the order of this query log entry enum. If you want to add a new
- * entry, add it to the end of the existing list.
- */
+ /// NOTE: please maintain the order of this query log entry enum. If you want to add a new
+ /// entry, add it to the end of the existing list.
private enum QueryLogEntry {
REQUEST_ID("requestId") {
@Override
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/HelixExternalViewBasedQueryQuotaManager.java b/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/HelixExternalViewBasedQueryQuotaManager.java
index 650c11b12e6..ad0f8b31acd 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/HelixExternalViewBasedQueryQuotaManager.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/HelixExternalViewBasedQueryQuotaManager.java
@@ -57,23 +57,21 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * This class is to support the qps quota feature.
- * It allows performing qps quota check at table level, database and application level.
- * For table level check it depends on the broker source change to update the dynamic rate limit,
- * which means it gets updated when a new table added or a broker restarted.
- * For database level check it depends on the broker as well as cluster config and database config change
- * to update the dynamic rate limit, which means it gets updated when
- * - the default query quota at cluster config is updated
- * - the database config is updated
- * - new table is assigned to the broker (rate limiter is created if not present)
- * - broker added or removed from cluster
- * For application level check it depends on the broker as well as cluster config and application quota change
- * to update the dynamic rate limit, which means it gets updated when
- * - the default query quota at cluster config is updated
- * - the application quota is updated (e.g. via rest api)
- * - broker added or removed from cluster
- */
+/// This class is to support the qps quota feature.
+/// It allows performing qps quota check at table level, database and application level.
+/// For table level check it depends on the broker source change to update the dynamic rate limit,
+/// which means it gets updated when a new table added or a broker restarted.
+/// For database level check it depends on the broker as well as cluster config and database config change
+/// to update the dynamic rate limit, which means it gets updated when
+/// - the default query quota at cluster config is updated
+/// - the database config is updated
+/// - new table is assigned to the broker (rate limiter is created if not present)
+/// - broker added or removed from cluster
+/// For application level check it depends on the broker as well as cluster config and application quota change
+/// to update the dynamic rate limit, which means it gets updated when
+/// - the default query quota at cluster config is updated
+/// - the application quota is updated (e.g. via rest api)
+/// - broker added or removed from cluster
public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHandler, QueryQuotaManager {
// Maximum 'disabled' value for app quota. If actual value is equal or less than this, it is considered as
@@ -196,11 +194,9 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
initOrUpdateTableQueryQuota(tableConfig, brokerResourceEV);
}
- /**
- * Initialize or update dynamic rate limiter with table query quota.
- * @param tableConfig table config.
- * @param brokerResourceEV broker resource which stores all the broker states of each table.
- */
+ /// Initialize or update dynamic rate limiter with table query quota.
+ /// @param tableConfig table config.
+ /// @param brokerResourceEV broker resource which stores all the broker states of each table.
public void initOrUpdateTableQueryQuota(TableConfig tableConfig, ExternalView brokerResourceEV) {
if (tableConfig == null) {
LOGGER.info("No query quota to update since table config is null");
@@ -214,28 +210,23 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
createOrUpdateRateLimiter(tableNameWithType, brokerResourceEV, tableConfig.getQuotaConfig(), stat);
}
- /**
- * Drop table query quota.
- * @param physicalOrLogicalTable physical or logical table name.
- */
+ /// Drop table query quota.
+ /// @param physicalOrLogicalTable physical or logical table name.
public void dropTableQueryQuota(String physicalOrLogicalTable) {
LOGGER.info("Dropping rate limiter for table {}", physicalOrLogicalTable);
removeRateLimiter(physicalOrLogicalTable);
}
- /** Remove or update rate limiter if another table with the same raw table name but different type is still using
- * the quota config.
- * @param physicalOrLogicalTable physical or logical table name.
- */
+ /// Remove or update rate limiter if another table with the same raw table name but different type is still using
+ /// the quota config.
+ /// @param physicalOrLogicalTable physical or logical table name.
private void removeRateLimiter(String physicalOrLogicalTable) {
_rateLimiterMap.remove(physicalOrLogicalTable);
}
- /**
- * Get QuotaConfig from property store.
- * @param tableNameWithType table name with table type.
- * @return QuotaConfig, which could be null.
- */
+ /// Get QuotaConfig from property store.
+ /// @param tableNameWithType table name with table type.
+ /// @return QuotaConfig, which could be null.
private QuotaConfig getQuotaConfigFromPropertyStore(String tableNameWithType) {
TableConfig tableConfig = ZKMetadataProvider.getTableConfig(_propertyStore, tableNameWithType);
if (tableConfig == null) {
@@ -244,13 +235,11 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
return tableConfig.getQuotaConfig();
}
- /**
- * Create or update a rate limiter for a table.
- * @param physicalOrLogicalTableName physical or logical table name.
- * @param brokerResource broker resource which stores all the broker states of each table.
- * @param quotaConfig quota config of the table.
- * @param tableStat stat of the table config.
- */
+ /// Create or update a rate limiter for a table.
+ /// @param physicalOrLogicalTableName physical or logical table name.
+ /// @param brokerResource broker resource which stores all the broker states of each table.
+ /// @param quotaConfig quota config of the table.
+ /// @param tableStat stat of the table config.
private void createOrUpdateRateLimiter(String physicalOrLogicalTableName, ExternalView brokerResource,
QuotaConfig quotaConfig, Stat tableStat) {
if (quotaConfig == null || quotaConfig.getMaxQueriesPerSecond() == null) {
@@ -323,10 +312,8 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
}
}
- /**
- * Updates the database rate limiter if it already exists. Will not create a new database rate limiter.
- * @param databaseName database name for which rate limiter needs to be updated
- */
+ /// Updates the database rate limiter if it already exists. Will not create a new database rate limiter.
+ /// @param databaseName database name for which rate limiter needs to be updated
public void updateDatabaseRateLimiter(String databaseName) {
if (!_databaseRateLimiterMap.containsKey(databaseName)) {
return;
@@ -334,11 +321,9 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
createOrUpdateDatabaseRateLimiter(List.of(databaseName));
}
- /**
- * Updates the application rate limiter if it already exists. It won't create a new rate limiter.
- *
- * @param applicationName application name for which rate limiter needs to be updated
- */
+ /// Updates the application rate limiter if it already exists. It won't create a new rate limiter.
+ ///
+ /// @param applicationName application name for which rate limiter needs to be updated
public void updateApplicationRateLimiter(String applicationName) {
if (!_applicationRateLimiterMap.containsKey(applicationName)) {
return;
@@ -385,12 +370,10 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
createOrUpdateApplicationRateLimiter(applicationNames, DISABLED_APP_QUOTA);
}
- /**
- * Caller method need not worry about getting lock on _applicationRateLimiterMap
- * as this method will do idempotent updates to the application rate limiters
- * @param applicationNames application names for which to update the rate limiter
- * @param newQps - if > 0, fixed value to use for rate limiter(s), otherwise value is fetched from ZK.
- */
+ /// Caller method need not worry about getting lock on \_applicationRateLimiterMap
+ /// as this method will do idempotent updates to the application rate limiters
+ /// @param applicationNames application names for which to update the rate limiter
+ /// @param newQps - if > 0, fixed value to use for rate limiter(s), otherwise value is fetched from ZK.
private synchronized void createOrUpdateApplicationRateLimiter(List<String> applicationNames, double newQps) {
ExternalView brokerResource = getBrokerResource();
Map<String, Double> quotas = null;
@@ -472,12 +455,10 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
return HelixHelper.getOnlineInstanceFromExternalView(brokerResource).size();
}
- /**
- * Utility to get the effective query quota being imposed on a database.
- * It is computed based on the default quota set at cluster config and override set at database config
- * @param databaseName database name to get the query quota on.
- * @return effective query quota limit being applied
- */
+ /// Utility to get the effective query quota being imposed on a database.
+ /// It is computed based on the default quota set at cluster config and override set at database config
+ /// @param databaseName database name to get the query quota on.
+ /// @return effective query quota limit being applied
private double getEffectiveQueryQuotaOnDatabase(String databaseName) {
DatabaseConfig databaseConfig =
ZKMetadataProvider.getDatabaseConfig(_helixManager.getHelixPropertyStore(), databaseName);
@@ -488,10 +469,8 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
return _defaultQpsQuotaForDatabase;
}
- /**
- * Creates a new database rate limiter. Will not update the database rate limiter if it already exists.
- * @param databaseName database name for which rate limiter needs to be created
- */
+ /// Creates a new database rate limiter. Will not update the database rate limiter if it already exists.
+ /// @param databaseName database name for which rate limiter needs to be created
public void createDatabaseRateLimiter(String databaseName) {
if (_databaseRateLimiterMap.containsKey(databaseName)) {
return;
@@ -499,11 +478,9 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
createOrUpdateDatabaseRateLimiter(List.of(databaseName));
}
- /**
- * Creates a new database rate limiter. Will not update the database rate limiter if it already exists.
- *
- * @param applicationName database name for which rate limiter needs to be created
- */
+ /// Creates a new database rate limiter. Will not update the database rate limiter if it already exists.
+ ///
+ /// @param applicationName database name for which rate limiter needs to be created
public void createApplicationRateLimiter(String applicationName) {
if (_applicationRateLimiterMap.containsKey(applicationName)) {
return;
@@ -511,10 +488,8 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
createOrUpdateApplicationRateLimiter(applicationName);
}
- /**
- * Build an empty rate limiter in the new query quota entity, or set the rate limiter to null in an existing query
- * quota entity.
- */
+ /// Build an empty rate limiter in the new query quota entity, or set the rate limiter to null in an existing query
+ /// quota entity.
private void buildEmptyOrResetDatabaseRateLimiter(String databaseName) {
QueryQuotaEntity queryQuotaEntity = _databaseRateLimiterMap.get(databaseName);
if (queryQuotaEntity == null) {
@@ -528,10 +503,8 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
}
}
- /**
- * Build an empty rate limiter in the new query quota entity, or set the rate limiter to null in an existing query
- * quota entity.
- */
+ /// Build an empty rate limiter in the new query quota entity, or set the rate limiter to null in an existing query
+ /// quota entity.
private void buildEmptyOrResetApplicationRateLimiter(String applicationName) {
QueryQuotaEntity quotaEntity = _applicationRateLimiterMap.get(applicationName);
if (quotaEntity == null) {
@@ -545,10 +518,8 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
}
}
- /**
- * Build an empty rate limiter in the new query quota entity, or set the rate limiter to null in an existing query
- * quota entity.
- */
+ /// Build an empty rate limiter in the new query quota entity, or set the rate limiter to null in an existing query
+ /// quota entity.
private void buildEmptyOrResetRateLimiterInQueryQuotaEntity(String physicalOrLogicalTableName) {
QueryQuotaEntity queryQuotaEntity = _rateLimiterMap.get(physicalOrLogicalTableName);
if (queryQuotaEntity == null) {
@@ -564,18 +535,14 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
addQueryQuotaCapacityUtilizationRateTableGaugeIfNeeded(physicalOrLogicalTableName, queryQuotaEntity);
}
- /**
- * Add the max burst QPS callback table gauge to the metric system if it doesn't exist.
- */
+ /// Add the max burst QPS callback table gauge to the metric system if it doesn't exist.
private void addMaxBurstQPSCallbackTableGaugeIfNeeded(String tableNameWithType, QueryQuotaEntity queryQuotaEntity) {
final QueryQuotaEntity finalQueryQuotaEntity = queryQuotaEntity;
_brokerMetrics.addCallbackTableGaugeIfNeeded(tableNameWithType, BrokerGauge.MAX_BURST_QPS,
() -> (long) finalQueryQuotaEntity.getMaxQpsTracker().getMaxCountPerBucket());
}
- /**
- * Add the query quota capacity utilization rate table gauge to the metric system if the qps quota is specified.
- */
+ /// Add the query quota capacity utilization rate table gauge to the metric system if the qps quota is specified.
private void addQueryQuotaCapacityUtilizationRateTableGaugeIfNeeded(String tableNameWithType,
QueryQuotaEntity queryQuotaEntity) {
if (queryQuotaEntity.getRateLimiter() != null) {
@@ -648,12 +615,12 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
return quotaEntity == null || quotaEntity.getRateLimiter() == null ? 0 : quotaEntity.getRateLimiter().getRate();
}
- /**
- * {@inheritDoc}
- * <p>Acquires a token from rate limiter based on the table name.
- *
- * @return true if there is no query quota specified for the table or a token can be acquired, otherwise return false.
- */
+ /// {@inheritDoc}
+ ///
+ /// Acquires a token from rate limiter based on the table name.
+ ///
+ /// @return true if there is no query quota specified for the table or a token can be acquired, otherwise return
+ /// false.
@Override
public boolean acquire(String tableName) {
// Return true if query quota is disabled in the current broker.
@@ -703,12 +670,10 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
return true;
}
- /**
- * Try to acquire token from rate limiter. Emit the utilization of the qps quota if broker metric isn't null.
- * @param resourceName resource name to acquire.
- * @param queryQuotaEntity query quota entity for type-specific table.
- * @return true if there's no qps quota for that table, or a token is acquired successfully.
- */
+ /// Try to acquire token from rate limiter. Emit the utilization of the qps quota if broker metric isn't null.
+ /// @param resourceName resource name to acquire.
+ /// @param queryQuotaEntity query quota entity for type-specific table.
+ /// @return true if there's no qps quota for that table, or a token is acquired successfully.
private boolean tryAcquireToken(String resourceName, QueryQuotaEntity queryQuotaEntity) {
// Use hit counter to count the number of hits.
queryQuotaEntity.getQpsTracker().hit();
@@ -752,9 +717,7 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
_rateLimiterMap.clear();
}
- /**
- * Process query quota change when number of online brokers has changed.
- */
+ /// Process query quota change when number of online brokers has changed.
public void processQueryRateLimitingExternalViewChange(ExternalView currentBrokerResourceEV) {
LOGGER.info("Start processing qps quota change.");
long startTime = System.currentTimeMillis();
@@ -879,9 +842,7 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
(endTime - startTime), numRebuilt, _rateLimiterMap.size());
}
- /**
- * Process query quota state change when cluster config gets changed
- */
+ /// Process query quota state change when cluster config gets changed
public void processQueryRateLimitingClusterConfigChange() {
double oldDatabaseQpsQuota = _defaultQpsQuotaForDatabase;
_defaultQpsQuotaForDatabase = getDefaultQueryQuotaForDatabase();
@@ -923,9 +884,7 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
}
}
- /**
- * Process query quota state change when instance config gets changed
- */
+ /// Process query quota state change when instance config gets changed
public void processQueryRateLimitingInstanceConfigChange() {
getQueryQuotaEnabledFlagFromInstanceConfig();
}
@@ -951,10 +910,8 @@ public class HelixExternalViewBasedQueryQuotaManager implements ClusterChangeHan
return _queryRateLimitDisabled;
}
- /**
- * Construct table config path
- * @param tableNameWithType table name with table type
- */
+ /// Construct table config path
+ /// @param tableNameWithType table name with table type
private String constructTableConfigPath(String tableNameWithType) {
return "/CONFIGS/TABLE/" + tableNameWithType;
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/HitCounter.java b/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/HitCounter.java
index b656c023444..f7080990b2c 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/HitCounter.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/HitCounter.java
@@ -23,14 +23,12 @@ import java.util.concurrent.atomic.AtomicIntegerArray;
import java.util.concurrent.atomic.AtomicLongArray;
-/**
- * This hit counter is for counting the number of hits within a range of time. Right now the granularity we use is
- * second.
- * In order to save the space and time, we store the number of hits over the last 100 time buckets. When the method hit
- * gets called, we put the timestamp to the specified bucket. When the method getHitCount gets called, we sum all the
- * number
- * of hits within the last 100 time buckets.
- */
+/// This hit counter is for counting the number of hits within a range of time. Right now the granularity we use is
+/// second.
+/// In order to save the space and time, we store the number of hits over the last 100 time buckets. When the method hit
+/// gets called, we put the timestamp to the specified bucket. When the method getHitCount gets called, we sum all the
+/// number
+/// of hits within the last 100 time buckets.
public class HitCounter {
private static final int DEFAULT_BUCKET_COUNT = 100;
final int _timeBucketWidthMs;
@@ -49,9 +47,7 @@ public class HitCounter {
_bucketHitCount = new AtomicIntegerArray(_bucketCount);
}
- /**
- * Increase the hit count in the current bucket.
- */
+ /// Increase the hit count in the current bucket.
public void hit() {
hit(System.currentTimeMillis());
}
@@ -74,9 +70,7 @@ public class HitCounter {
}
}
- /**
- * Get the total hit count within a time range.
- */
+ /// Get the total hit count within a time range.
public int getHitCount() {
return getHitCount(System.currentTimeMillis());
}
@@ -86,12 +80,10 @@ public class HitCounter {
return getHitCount(timestamp, _bucketCount);
}
- /**
- * Get the hit count within the valid number of buckets.
- * @param timestamp the current timestamp
- * @param validBucketCount the valid number of buckets
- * @return the number of hits within the valid bucket count
- */
+ /// Get the hit count within the valid number of buckets.
+ /// @param timestamp the current timestamp
+ /// @param validBucketCount the valid number of buckets
+ /// @return the number of hits within the valid bucket count
int getHitCount(long timestamp, int validBucketCount) {
long numTimeUnits = timestamp / _timeBucketWidthMs;
int count = 0;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/MaxHitRateTracker.java b/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/MaxHitRateTracker.java
index b0cbd88b0be..1dfa56ba50e 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/MaxHitRateTracker.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/MaxHitRateTracker.java
@@ -21,15 +21,13 @@ package org.apache.pinot.broker.queryquota;
import com.google.common.annotations.VisibleForTesting;
-/**
- * A stateful version of hit counter. Similar to the default hit counter, it maintains a list of buckets.
- * Whereas it maintains an extra variable called _lastAccessTimestamp which tracks the last access time.
- * If the stateful hit counter gets queried, it firstly compares the current timestamp and the last access timestamp,
- * calculating the start index and end index among the buckets. Then, it traverses through all the valid candidate
- * buckets.
- * If the current timestamp has exceeded the current time range of all the buckets, this hit counter will use
- * the current timestamp minus the default time queried time range to calculate the start time index.
- */
+/// A stateful version of hit counter. Similar to the default hit counter, it maintains a list of buckets.
+/// Whereas it maintains an extra variable called \_lastAccessTimestamp which tracks the last access time.
+/// If the stateful hit counter gets queried, it firstly compares the current timestamp and the last access timestamp,
+/// calculating the start index and end index among the buckets. Then, it traverses through all the valid candidate
+/// buckets.
+/// If the current timestamp has exceeded the current time range of all the buckets, this hit counter will use
+/// the current timestamp minus the default time queried time range to calculate the start time index.
public class MaxHitRateTracker extends HitCounter {
private static final int ONE_SECOND_BUCKET_WIDTH_MS = 1000;
private static final int MAX_TIME_RANGE_FACTOR = 2;
@@ -50,9 +48,7 @@ public class MaxHitRateTracker extends HitCounter {
_maxTimeRangeMs = maxTimeRangeInSeconds * 1000L;
}
- /**
- * Get the maximum count among the buckets
- */
+ /// Get the maximum count among the buckets
public int getMaxCountPerBucket() {
return getMaxCountPerBucket(System.currentTimeMillis());
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/QueryQuotaManager.java b/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/QueryQuotaManager.java
index eb3de472d95..2ce3a332e52 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/QueryQuotaManager.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/queryquota/QueryQuotaManager.java
@@ -20,52 +20,38 @@ package org.apache.pinot.broker.queryquota;
public interface QueryQuotaManager {
- /**
- * Try to acquire a quota for the given table.
- * @param tableName Table name with or without type suffix
- * @return {@code true} if the table quota has not been reached, {@code false} otherwise
- */
+ /// Try to acquire a quota for the given table.
+ /// @param tableName Table name with or without type suffix
+ /// @return `true` if the table quota has not been reached, `false` otherwise
boolean acquire(String tableName);
- /**
- * Try to acquire a quota for the given logical table.
- * @param logicalTableName Logical table name
- * @return {@code true} if the table quota has not been reached, {@code false} otherwise
- */
+ /// Try to acquire a quota for the given logical table.
+ /// @param logicalTableName Logical table name
+ /// @return `true` if the table quota has not been reached, `false` otherwise
boolean acquireLogicalTable(String logicalTableName);
- /**
- * Try to acquire a quota for the given database.
- * @param databaseName database name
- * @return {@code true} if the database quota has not been reached, {@code false} otherwise
- */
+ /// Try to acquire a quota for the given database.
+ /// @param databaseName database name
+ /// @return `true` if the database quota has not been reached, `false` otherwise
boolean acquireDatabase(String databaseName);
- /**
- * Try to acquire a quota for the given application.
- * @param applicationName application name
- * @return {@code true} if the application quota has not been reached, {@code false} otherwise
- */
+ /// Try to acquire a quota for the given application.
+ /// @param applicationName application name
+ /// @return `true` if the application quota has not been reached, `false` otherwise
boolean acquireApplication(String applicationName);
- /**
- * Get the QPS quota in effect for the table
- * @param tableNameWithType table name with type
- * @return effective quota qps. 0 if no qps quota is set.
- */
+ /// Get the QPS quota in effect for the table
+ /// @param tableNameWithType table name with type
+ /// @return effective quota qps. 0 if no qps quota is set.
double getTableQueryQuota(String tableNameWithType);
- /**
- * Get the QPS quota in effect for the database
- * @param databaseName table name with type
- * @return effective quota qps. 0 if no qps quota is set.
- */
+ /// Get the QPS quota in effect for the database
+ /// @param databaseName table name with type
+ /// @return effective quota qps. 0 if no qps quota is set.
double getDatabaseQueryQuota(String databaseName);
- /**
- * Get the QPS quota in effect for the application
- * @param applicationName table name with type
- * @return effective quota qps. 0 if no qps quota is set.
- */
+ /// Get the QPS quota in effect for the application
+ /// @param applicationName table name with type
+ /// @return effective quota qps. 0 if no qps quota is set.
double getApplicationQueryQuota(String applicationName);
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BaseBrokerRequestHandler.java b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BaseBrokerRequestHandler.java
index dc8e1cbba57..50ef569cf21 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BaseBrokerRequestHandler.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BaseBrokerRequestHandler.java
@@ -63,7 +63,6 @@ import org.apache.pinot.spi.eventlistener.query.BrokerQueryEventListener;
import org.apache.pinot.spi.eventlistener.query.BrokerQueryEventListenerFactory;
import org.apache.pinot.spi.exception.BadQueryRequestException;
import org.apache.pinot.spi.exception.QueryErrorCode;
-import org.apache.pinot.spi.exception.QueryException;
import org.apache.pinot.spi.trace.RequestContext;
import org.apache.pinot.spi.utils.CommonConstants.Broker;
import org.apache.pinot.spi.utils.CommonConstants.Broker.Request.QueryOptionKey;
@@ -100,13 +99,9 @@ public abstract class BaseBrokerRequestHandler implements BrokerRequestHandler {
@Nullable
protected final MultiClusterRoutingContext _multiClusterRoutingContext;
- /**
- * Maps broker-generated query id to the query string.
- */
+ /// Maps broker-generated query id to the query string.
protected final Map<Long, String> _queriesById;
- /**
- * Maps broker-generated query id to client-provided query id.
- */
+ /// Maps broker-generated query id to client-provided query id.
protected final Map<Long, String> _clientQueryIds;
public BaseBrokerRequestHandler(PinotConfiguration config, String brokerId,
@@ -224,13 +219,11 @@ public abstract class BaseBrokerRequestHandler implements BrokerRequestHandler {
return brokerResponse;
}
- /**
- * Called after every successfully executed query with the fully-populated {@link RequestContext}
- * and {@link BrokerResponse}. The default implementation fires the configured
- * {@link org.apache.pinot.spi.eventlistener.query.BrokerQueryEventListener}. Subclasses may
- * override to intercept the complete response (e.g. for async query-log pipelines) while still
- * calling {@code super} to preserve the SPI listener behaviour.
- */
+ /// Called after every successfully executed query with the fully-populated [RequestContext]
+ /// and [BrokerResponse]. The default implementation fires the configured
+ /// [org.apache.pinot.spi.eventlistener.query.BrokerQueryEventListener]. Subclasses may
+ /// override to intercept the complete response (e.g. for async query-log pipelines) while still
+ /// calling `super` to preserve the SPI listener behaviour.
protected void onQueryCompletion(RequestContext requestContext, BrokerResponse brokerResponse) {
_brokerQueryEventListener.onQueryCompletion(requestContext);
}
@@ -240,9 +233,7 @@ public abstract class BaseBrokerRequestHandler implements BrokerRequestHandler {
@Nullable HttpHeaders httpHeaders, AccessControl accessControl)
throws Exception;
- /**
- * Validates whether the requester has access to all the tables.
- */
+ /// Validates whether the requester has access to all the tables.
protected TableAuthorizationResult hasTableAccess(RequesterIdentity requesterIdentity, Set<String> tableNames,
RequestContext requestContext, HttpHeaders httpHeaders) {
final long startTimeNs = System.nanoTime();
@@ -273,15 +264,14 @@ public abstract class BaseBrokerRequestHandler implements BrokerRequestHandler {
return tableAuthorizationResult;
}
- /**
- * Validates that tables can be queried with enableMultiClusterRouting if and only if they are logical tables.
- * Physical tables are cluster-specific and cannot be federated across clusters.
- * Multi-cluster routing is only supported for logical tables.
- *
- * @param tableNames Set of table names to validate
- * @param queryOptions Map of query options
- * @throws QueryException if any physical table is queried with enableMultiClusterRouting=true
- */
+ /// Validates that tables can be queried with enableMultiClusterRouting if and only if they are logical tables.
+ /// Physical tables are cluster-specific and cannot be federated across clusters.
+ /// Multi-cluster routing is only supported for logical tables.
+ ///
+ /// @param tableNames Set of table names to validate
+ /// @param queryOptions Map of query options
+ /// @throws org.apache.pinot.spi.exception.QueryException if any physical table is queried with
+ /// enableMultiClusterRouting=true
protected void validatePhysicalTablesWithMultiClusterRouting(Set<String> tableNames,
Map<String, String> queryOptions) {
Preconditions.checkNotNull(tableNames, "Table names cannot be null when validating multi-cluster routing");
@@ -301,9 +291,7 @@ public abstract class BaseBrokerRequestHandler implements BrokerRequestHandler {
}
}
- /**
- * Returns true if the QPS quota of query tables, database or application has been exceeded.
- */
+ /// Returns true if the QPS quota of query tables, database or application has been exceeded.
protected boolean hasExceededQPSQuota(@Nullable String database, Set<String> tableNames,
RequestContext requestContext) {
if (database != null && !_queryQuotaManager.acquireDatabase(database)) {
@@ -330,10 +318,8 @@ public abstract class BaseBrokerRequestHandler implements BrokerRequestHandler {
}
}
- /**
- * Attempts to cancel an ongoing query identified by its broker-generated id.
- * @return true if the query was successfully cancelled, false otherwise.
- */
+ /// Attempts to cancel an ongoing query identified by its broker-generated id.
+ /// @return true if the query was successfully cancelled, false otherwise.
protected abstract boolean handleCancel(long queryId, int timeoutMs, Executor executor,
HttpClientConnectionManager connMgr, Map<String, Integer> serverResponses)
throws Exception;
@@ -451,12 +437,10 @@ public abstract class BaseBrokerRequestHandler implements BrokerRequestHandler {
return sqlNodeAndOptions.getOptions().get(QueryOptionKey.CLIENT_QUERY_ID);
}
- /**
- * Called when a query starts
- * TODO: This method was created to keep track of running queries for cancellation, but it is useful for other uses.
- * But right now the semantics are not clear. For example, while MSE calls this method once, SSE calls it once per
- * query AND subquery, which means this method is called multiple times for the same query.
- */
+ /// Called when a query starts
+ /// TODO: This method was created to keep track of running queries for cancellation, but it is useful for other uses.
+ /// But right now the semantics are not clear. For example, while MSE calls this method once, SSE calls it once per
+ /// query AND subquery, which means this method is called multiple times for the same query.
protected void onQueryStart(long requestId, @Nullable String clientRequestId, String query, Object... extras) {
if (isQueryCancellationEnabled()) {
_queriesById.put(requestId, query);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BaseSingleStageBrokerRequestHandler.java b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BaseSingleStageBrokerRequestHandler.java
index d1c9bc04180..b7603747389 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BaseSingleStageBrokerRequestHandler.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BaseSingleStageBrokerRequestHandler.java
@@ -387,13 +387,11 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * CompileResult holds the result of the compilation phase. Compilation may or may not be successful. If compilation
- * is successful then all member variables other than BrokerResponse will be available. If compilation is not
- * successful, then only the BrokerResponse is set. This is done to keep the current behaviour as is.
- * It became hard to keep the current behaviour if we were to throw an exception from the compileRequest method.
- * The only exception is that a BrokerResponse is returned for a literal-only query.
- */
+ /// CompileResult holds the result of the compilation phase. Compilation may or may not be successful. If compilation
+ /// is successful then all member variables other than BrokerResponse will be available. If compilation is not
+ /// successful, then only the BrokerResponse is set. This is done to keep the current behaviour as is.
+ /// It became hard to keep the current behaviour if we were to throw an exception from the compileRequest method.
+ /// The only exception is that a BrokerResponse is returned for a literal-only query.
private static class CompileResult {
final PinotQuery _pinotQuery;
final PinotQuery _serverPinotQuery;
@@ -1551,10 +1549,9 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
return tableConfig.getTenantConfig().getServer();
}
- /**
- * Handles the subquery in the given query.
- * <p>Currently only supports subquery within the filter.
- */
+ /// Handles the subquery in the given query.
+ ///
+ /// Currently only supports subquery within the filter.
private void handleSubquery(PinotQuery pinotQuery, long requestId, JsonNode jsonRequest,
@Nullable RequesterIdentity requesterIdentity, RequestContext requestContext, @Nullable HttpHeaders httpHeaders,
AccessControl accessControl)
@@ -1566,13 +1563,13 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Handles the subquery in the given expression.
- * <p>When subquery is detected, first executes the subquery and gets the response, then rewrites the expression with
- * the subquery response.
- * <p>Currently only supports ID_SET subquery within the IN_SUBQUERY transform function, which will be rewritten to an
- * IN_ID_SET transform function.
- */
+ /// Handles the subquery in the given expression.
+ ///
+ /// When subquery is detected, first executes the subquery and gets the response, then rewrites the expression with
+ /// the subquery response.
+ ///
+ /// Currently only supports ID_SET subquery within the IN_SUBQUERY transform function, which will be rewritten to an
+ /// IN_ID_SET transform function.
private void handleSubquery(Expression expression, long requestId, JsonNode jsonRequest,
@Nullable RequesterIdentity requesterIdentity, RequestContext requestContext, @Nullable HttpHeaders httpHeaders,
AccessControl accessControl)
@@ -1630,14 +1627,12 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Resolves the actual table name for:
- * - Case-insensitive cluster
- *
- * @param tableName the table name in the query
- * @param tableCache the table case-sensitive cache
- * @return table name if the table name is found in Pinot registry.
- */
+ /// Resolves the actual table name for:
+ /// - Case-insensitive cluster
+ ///
+ /// @param tableName the table name in the query
+ /// @param tableCache the table case-sensitive cache
+ /// @return table name if the table name is found in Pinot registry.
@VisibleForTesting
static String getActualTableName(String tableName, TableCache tableCache) {
String actualTableName = tableCache.getActualTableName(tableName);
@@ -1648,14 +1643,12 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
return actualTableName != null ? actualTableName : tableName;
}
- /**
- * Retrieve segment partitioned columns for a table.
- * For a hybrid table, a segment partitioned column has to be the intersection of both offline and realtime tables.
- *
- * @param tableCache
- * @param tableName
- * @return segment partitioned columns belong to both offline and realtime tables.
- */
+ /// Retrieve segment partitioned columns for a table.
+ /// For a hybrid table, a segment partitioned column has to be the intersection of both offline and realtime tables.
+ ///
+ /// @param tableCache
+ /// @param tableName
+ /// @return segment partitioned columns belong to both offline and realtime tables.
private static Set<String> getSegmentPartitionedColumns(TableCache tableCache, String tableName) {
final TableConfig offlineTableConfig =
tableCache.getTableConfig(TableNameBuilder.OFFLINE.tableNameWithType(tableName));
@@ -1689,18 +1682,14 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
return segmentPartitionedColumns;
}
- /**
- * Sets the table name in the given broker request.
- * NOTE: Set table name in broker request because it is used for access control, query routing etc.
- */
+ /// Sets the table name in the given broker request.
+ /// NOTE: Set table name in broker request because it is used for access control, query routing etc.
private void setTableName(BrokerRequest brokerRequest, String tableName) {
brokerRequest.getQuerySource().setTableName(tableName);
brokerRequest.getPinotQuery().getDataSource().setTableName(tableName);
}
- /**
- * Sets HyperLogLog log2m for DistinctCountHLL functions if not explicitly set for the given query.
- */
+ /// Sets HyperLogLog log2m for DistinctCountHLL functions if not explicitly set for the given query.
private static void handleHLLLog2mOverride(PinotQuery pinotQuery, int hllLog2mOverride) {
List<Expression> selectList = pinotQuery.getSelectList();
for (Expression expression : selectList) {
@@ -1719,9 +1708,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Sets HyperLogLog log2m for DistinctCountHLL functions if not explicitly set for the given expression.
- */
+ /// Sets HyperLogLog log2m for DistinctCountHLL functions if not explicitly set for the given expression.
private static void handleHLLLog2mOverride(Expression expression, int hllLog2mOverride) {
Function function = expression.getFunctionCall();
if (function == null) {
@@ -1744,9 +1731,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Overrides the LIMIT of the given query if it exceeds the query limit.
- */
+ /// Overrides the LIMIT of the given query if it exceeds the query limit.
@VisibleForTesting
static void handleQueryLimitOverride(PinotQuery pinotQuery, int queryLimit) {
if (queryLimit > 0 && pinotQuery.getLimit() > queryLimit) {
@@ -1754,9 +1739,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Rewrites 'DistinctCount' to 'SegmentPartitionDistinctCount' for the given query.
- */
+ /// Rewrites 'DistinctCount' to 'SegmentPartitionDistinctCount' for the given query.
@VisibleForTesting
static void handleSegmentPartitionedDistinctCountOverride(PinotQuery pinotQuery,
Set<String> segmentPartitionedColumns) {
@@ -1780,9 +1763,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Rewrites 'DistinctCount' to 'SegmentPartitionDistinctCount' for the given expression.
- */
+ /// Rewrites 'DistinctCount' to 'SegmentPartitionDistinctCount' for the given expression.
private static void handleSegmentPartitionedDistinctCountOverride(Expression expression,
Set<String> segmentPartitionedColumns) {
Function function = expression.getFunctionCall();
@@ -1802,9 +1783,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Rewrites 'DistinctCount' to 'DistinctCountBitmap' for the given query.
- */
+ /// Rewrites 'DistinctCount' to 'DistinctCountBitmap' for the given query.
private static void handleDistinctCountBitmapOverride(PinotQuery pinotQuery) {
for (Expression expression : pinotQuery.getSelectList()) {
handleDistinctCountBitmapOverride(expression);
@@ -1822,9 +1801,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Rewrites 'DistinctCount' to 'DistinctCountBitmap' for the given expression.
- */
+ /// Rewrites 'DistinctCount' to 'DistinctCountBitmap' for the given expression.
private static void handleDistinctCountBitmapOverride(Expression expression) {
Function function = expression.getFunctionCall();
if (function == null) {
@@ -1890,9 +1867,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Verifies that no groovy is present in the PinotQuery when disabled.
- */
+ /// Verifies that no groovy is present in the PinotQuery when disabled.
@VisibleForTesting
static void validateGroovyScript(PinotQuery pinotQuery, boolean disableGroovy) {
List<Expression> selectList = pinotQuery.getSelectList();
@@ -1949,11 +1924,9 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
GroovyFunctionEvaluator.parseGroovyScript(String.format("groovy({%s})", script));
}
- /**
- * Rewrites potential expensive functions to their approximation counterparts.
- * - DISTINCT_COUNT -> DISTINCT_COUNT_SMART_HLL
- * - PERCENTILE -> PERCENTILE_SMART_TDIGEST
- */
+ /// Rewrites potential expensive functions to their approximation counterparts.
+ /// - DISTINCT_COUNT -> DISTINCT_COUNT_SMART_HLL
+ /// - PERCENTILE -> PERCENTILE_SMART_TDIGEST
@VisibleForTesting
static void handleApproximateFunctionOverride(PinotQuery pinotQuery) {
for (Expression expression : pinotQuery.getSelectList()) {
@@ -2048,9 +2021,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
return expression;
}
- /**
- * Returns {@code true} if the given query only contains literals, {@code false} otherwise.
- */
+ /// Returns `true` if the given query only contains literals, `false` otherwise.
@VisibleForTesting
static boolean isLiteralOnlyQuery(PinotQuery pinotQuery) {
for (Expression expression : pinotQuery.getSelectList()) {
@@ -2061,9 +2032,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
return true;
}
- /**
- * Processes the literal only query.
- */
+ /// Processes the literal only query.
private BrokerResponseNative processLiteralOnlyQuery(long requestId, PinotQuery pinotQuery,
RequestContext requestContext) {
BrokerResponseNative brokerResponse = new BrokerResponseNative();
@@ -2116,9 +2085,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
values[index] = typeAndValue.getRight();
}
- /**
- * Fixes the column names to the actual column names in the given query.
- */
+ /// Fixes the column names to the actual column names in the given query.
@VisibleForTesting
static void updateColumnNames(String rawTableName, PinotQuery pinotQuery, boolean isCaseInsensitive,
Map<String, String> columnNameMap) {
@@ -2185,9 +2152,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
pinotQuery.setSelectList(newSelections);
}
- /**
- * Fixes the column names to the actual column names in the given expression.
- */
+ /// Fixes the column names to the actual column names in the given expression.
private static void fixColumnName(String rawTableName, Expression expression, Map<String, String> columnNameMap,
boolean ignoreCase) {
ExpressionType expressionType = expression.getType();
@@ -2212,12 +2177,10 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Returns the actual column name for the given column name for:
- * - Case-insensitive cluster
- * - Column name in the format of [{@code rawTableName}].[column_name]
- * - Column name in the format of [logical_table_name].[column_name] while {@code rawTableName} is a translated name
- */
+ /// Returns the actual column name for the given column name for:
+ /// - Case-insensitive cluster
+ /// - Column name in the format of [`rawTableName`].\[column_name\]
+ /// - Column name in the format of \[logical_table_name\].\[column_name\] while `rawTableName` is a translated name
@VisibleForTesting
static String getActualColumnName(String rawTableName, String columnName, @Nullable Map<String, String> columnNameMap,
boolean ignoreCase) {
@@ -2260,12 +2223,11 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
return columnName;
}
- /**
- * Sets the query timeout (remaining time in milliseconds) into the query options, and returns the remaining time in
- * milliseconds.
- * <p>For the overall query timeout, use query-level timeout (in the query options) if exists, or use table-level
- * timeout (in the table config) if exists, or use instance-level timeout (in the broker config).
- */
+ /// Sets the query timeout (remaining time in milliseconds) into the query options, and returns the remaining time in
+ /// milliseconds.
+ ///
+ /// For the overall query timeout, use query-level timeout (in the query options) if exists, or use table-level
+ /// timeout (in the table config) if exists, or use instance-level timeout (in the broker config).
private long setQueryTimeout(String tableNameWithType, Long logicalTableQueryTimeout,
Map<String, String> queryOptions, long timeSpentMs)
throws TimeoutException {
@@ -2300,18 +2262,16 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
return remainingTimeMs;
}
- /**
- * Sets a query option indicating the maximum response size that can be sent from a server to the broker. This size
- * is measured for the serialized response.
- *
- * The overriding order of priority is:
- * 1. QueryOption -> maxServerResponseSizeBytes
- * 2. QueryOption -> maxQueryResponseSizeBytes
- * 3. TableConfig -> maxServerResponseSizeBytes
- * 4. TableConfig -> maxQueryResponseSizeBytes
- * 5. BrokerConfig -> maxServerResponseSizeBytes
- * 6. BrokerConfig -> maxServerResponseSizeBytes
- */
+ /// Sets a query option indicating the maximum response size that can be sent from a server to the broker. This size
+ /// is measured for the serialized response.
+ ///
+ /// The overriding order of priority is:
+ /// 1. QueryOption -> maxServerResponseSizeBytes
+ /// 2. QueryOption -> maxQueryResponseSizeBytes
+ /// 3. TableConfig -> maxServerResponseSizeBytes
+ /// 4. TableConfig -> maxQueryResponseSizeBytes
+ /// 5. BrokerConfig -> maxServerResponseSizeBytes
+ /// 6. BrokerConfig -> maxServerResponseSizeBytes
private void setMaxServerResponseSizeBytes(int numServers, Map<String, String> queryOptions,
@Nullable QueryConfig queryConfig) {
// QueryOption
@@ -2354,16 +2314,15 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Broker side validation on the query.
- * <p>Throw exception if query does not pass validation.
- * <p>Current validations are:
- * <ul>
- * <li>Value for 'LIMIT' <= configured value</li>
- * <li>Query options must be set to SQL mode</li>
- * <li>Check if numReplicaGroupsToQuery option provided is valid</li>
- * </ul>
- */
+ /// Broker side validation on the query.
+ ///
+ /// Throw exception if query does not pass validation.
+ ///
+ /// Current validations are:
+ ///
+ /// - Value for 'LIMIT' <= configured value
+ /// - Query options must be set to SQL mode
+ /// - Check if numReplicaGroupsToQuery option provided is valid
@VisibleForTesting
static void validateRequest(PinotQuery pinotQuery, int queryResponseLimit) {
// Verify LIMIT
@@ -2561,16 +2520,14 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
return union;
}
- /**
- * Prepares the offline/realtime broker requests for the base table route based on
- * whether the base table is hybrid, offline-only, or realtime-only.
- * This mirrors the logic in the main doHandleRequest flow but operates on a pre-existing
- * routeInfo for the base table. Per-branch `handleExpressionOverride` /
- * `handleTimestampIndexOverride` are applied so the SPLIT base-table branches receive the
- * same expression-override and `$ts$DAY` timestamp-index hints as the non-split path —
- * without these, table-level overrides configured on the base table would be silently
- * dropped on the SPLIT path, producing divergent results vs. the base fallback path.
- */
+ /// Prepares the offline/realtime broker requests for the base table route based on
+ /// whether the base table is hybrid, offline-only, or realtime-only.
+ /// This mirrors the logic in the main doHandleRequest flow but operates on a pre-existing
+ /// routeInfo for the base table. Per-branch `handleExpressionOverride` /
+ /// `handleTimestampIndexOverride` are applied so the SPLIT base-table branches receive the
+ /// same expression-override and `$ts$DAY` timestamp-index hints as the non-split path —
+ /// without these, table-level overrides configured on the base table would be silently
+ /// dropped on the SPLIT path, producing divergent results vs. the base fallback path.
private ImplicitHybridTableRouteInfo prepareBaseTableHybridRoute(BrokerRequest baseBrokerRequest,
TableRouteInfo baseRouteInfo, Schema schema) {
Preconditions.checkState(baseRouteInfo instanceof ImplicitHybridTableRouteInfo,
@@ -2647,20 +2604,16 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
- /**
- * Processes the optimized broker requests for both OFFLINE and REALTIME table.
- * TODO: Directly take PinotQuery
- */
+ /// Processes the optimized broker requests for both OFFLINE and REALTIME table.
+ /// TODO: Directly take PinotQuery
protected abstract BrokerResponseNative processBrokerRequest(long requestId, BrokerRequest originalBrokerRequest,
BrokerRequest serverBrokerRequest, TableRouteInfo route, long timeoutMs,
ServerStats serverStats, RequestContext requestContext)
throws Exception;
- /**
- * Returns the segments to report as unavailable for this query. The default returns the route's unavailable
- * segments unchanged. A subclass may narrow the set, e.g. to the segments the query will actually read after
- * routing-level pruning, so the "segments unavailable" warning does not include segments the query never touches.
- */
+ /// Returns the segments to report as unavailable for this query. The default returns the route's unavailable
+ /// segments unchanged. A subclass may narrow the set, e.g. to the segments the query will actually read after
+ /// routing-level pruning, so the "segments unavailable" warning does not include segments the query never touches.
protected List<String> getUnavailableSegments(BrokerRequest serverBrokerRequest, TableRouteInfo routeInfo) {
return routeInfo.getUnavailableSegments();
}
@@ -2707,9 +2660,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Helper class to pass the per server statistics.
- */
+ /// Helper class to pass the per server statistics.
public static class ServerStats {
private String _serverStats;
@@ -2722,9 +2673,7 @@ public abstract class BaseSingleStageBrokerRequestHandler extends BaseBrokerRequ
}
}
- /**
- * Helper class to track the query plaintext and the requested servers.
- */
+ /// Helper class to track the query plaintext and the requested servers.
private static class QueryServers {
final String _query;
final Set<ServerInstance> _servers = new HashSet<>();
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BrokerRequestHandler.java b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BrokerRequestHandler.java
index 8d949de3eaf..dc4a5624f42 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BrokerRequestHandler.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BrokerRequestHandler.java
@@ -62,19 +62,15 @@ public interface BrokerRequestHandler {
}
}
- /**
- * Run a query and use the time-series engine.
- */
+ /// Run a query and use the time-series engine.
default TimeSeriesBlock handleTimeSeriesRequest(String lang, String rawQueryParamString,
Map<String, String> queryParams, RequestContext requestContext, @Nullable RequesterIdentity requesterIdentity,
HttpHeaders httpHeaders) throws QueryException {
throw new UnsupportedOperationException("Handler does not support Time Series requests");
}
- /**
- * Handle an explain request for time-series queries.
- * Returns a BrokerResponse containing the logical explain plan.
- */
+ /// Handle an explain request for time-series queries.
+ /// Returns a BrokerResponse containing the logical explain plan.
default BrokerResponse handleExplainTimeSeriesRequest(String lang, String rawQueryParamString,
Map<String, String> queryParams) {
throw new UnsupportedOperationException("Handler does not support Time Series explain requests");
@@ -82,30 +78,26 @@ public interface BrokerRequestHandler {
Map<Long, String> getRunningQueries();
- /**
- * Cancel a query as identified by the queryId. This method is non-blocking so the query may still run for a while
- * after calling this method. This cancel method can be called multiple times.
- * @param queryId the unique Id assigned to the query by the broker
- * @param timeoutMs timeout to wait for servers to respond the cancel requests
- * @param executor to send cancel requests to servers in parallel
- * @param connMgr to provide the http connections
- * @param serverResponses to collect cancel responses from all servers if a map is provided
- * @return true if there is a running query for the given queryId.
- */
+ /// Cancel a query as identified by the queryId. This method is non-blocking so the query may still run for a while
+ /// after calling this method. This cancel method can be called multiple times.
+ /// @param queryId the unique Id assigned to the query by the broker
+ /// @param timeoutMs timeout to wait for servers to respond the cancel requests
+ /// @param executor to send cancel requests to servers in parallel
+ /// @param connMgr to provide the http connections
+ /// @param serverResponses to collect cancel responses from all servers if a map is provided
+ /// @return true if there is a running query for the given queryId.
boolean cancelQuery(long queryId, int timeoutMs, Executor executor, HttpClientConnectionManager connMgr,
Map<String, Integer> serverResponses)
throws Exception;
- /**
- * Cancel a query as identified by the clientQueryId provided externally. This method is non-blocking so the query may
- * still run for a while after calling this method. This cancel method can be called multiple times.
- * @param clientQueryId the Id assigned to the query by the client
- * @param timeoutMs timeout to wait for servers to respond the cancel requests
- * @param executor to send cancel requests to servers in parallel
- * @param connMgr to provide the http connections
- * @param serverResponses to collect cancel responses from all servers if a map is provided
- * @return true if there is a running query for the given clientQueryId.
- */
+ /// Cancel a query as identified by the clientQueryId provided externally. This method is non-blocking so the query
+ /// may still run for a while after calling this method. This cancel method can be called multiple times.
+ /// @param clientQueryId the Id assigned to the query by the client
+ /// @param timeoutMs timeout to wait for servers to respond the cancel requests
+ /// @param executor to send cancel requests to servers in parallel
+ /// @param connMgr to provide the http connections
+ /// @param serverResponses to collect cancel responses from all servers if a map is provided
+ /// @return true if there is a running query for the given clientQueryId.
boolean cancelQueryByClientId(String clientQueryId, int timeoutMs, Executor executor,
HttpClientConnectionManager connMgr,
Map<String, Integer> serverResponses)
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BrokerRequestHandlerDelegate.java b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BrokerRequestHandlerDelegate.java
index f4d2aaf6220..1835030436e 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BrokerRequestHandlerDelegate.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/BrokerRequestHandlerDelegate.java
@@ -41,12 +41,10 @@ import org.apache.pinot.sql.parsers.SqlNodeAndOptions;
import org.apache.pinot.tsdb.spi.series.TimeSeriesBlock;
-/**
- * {@code BrokerRequestHandlerDelegate} delegates the inbound broker request to one of the enabled
- * {@link BrokerRequestHandler} based on the requested handle type.
- *
- * {@see: @CommonConstant
- */
+/// `BrokerRequestHandlerDelegate` delegates the inbound broker request to one of the enabled
+/// [BrokerRequestHandler] based on the requested handle type.
+///
+/// {@see: @CommonConstant
public class BrokerRequestHandlerDelegate implements BrokerRequestHandler {
private final BaseSingleStageBrokerRequestHandler _singleStageBrokerRequestHandler;
private final MultiStageBrokerRequestHandler _multiStageBrokerRequestHandler;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/GrpcBrokerRequestHandler.java b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/GrpcBrokerRequestHandler.java
index 1f3a6d378b1..59a2bd4a584 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/GrpcBrokerRequestHandler.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/GrpcBrokerRequestHandler.java
@@ -54,9 +54,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * The <code>GrpcBrokerRequestHandler</code> class communicates query request via GRPC.
- */
+/// The `GrpcBrokerRequestHandler` class communicates query request via GRPC.
@ThreadSafe
public class GrpcBrokerRequestHandler extends BaseSingleStageBrokerRequestHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(GrpcBrokerRequestHandler.class);
@@ -115,10 +113,8 @@ public class GrpcBrokerRequestHandler extends BaseSingleStageBrokerRequestHandle
return doReduce(originalBrokerRequest, responseMap, timeoutMs);
}
- /**
- * Executes scatter: sends the query to servers and collects per-server streaming response iterators.
- * Subclasses may override to replace or augment the scatter step.
- */
+ /// Executes scatter: sends the query to servers and collects per-server streaming response iterators.
+ /// Subclasses may override to replace or augment the scatter step.
protected Map<ServerRoutingInstance, Iterator<Server.ServerResponse>> doScatter(long requestId, TableRouteInfo route,
RequestContext requestContext) {
BrokerRequest offlineBrokerRequest = route.getOfflineBrokerRequest();
@@ -141,10 +137,8 @@ public class GrpcBrokerRequestHandler extends BaseSingleStageBrokerRequestHandle
return responseMap;
}
- /**
- * Executes the reduce step on the given responseMap.
- * Subclasses may override to perform custom reduce logic or augment the responseMap.
- */
+ /// Executes the reduce step on the given responseMap.
+ /// Subclasses may override to perform custom reduce logic or augment the responseMap.
protected BrokerResponseNative doReduce(BrokerRequest originalBrokerRequest,
Map<ServerRoutingInstance, Iterator<Server.ServerResponse>> responseMap, long timeoutMs)
throws Exception {
@@ -155,9 +149,7 @@ public class GrpcBrokerRequestHandler extends BaseSingleStageBrokerRequestHandle
return brokerResponse;
}
- /**
- * Query pinot server for data table.
- */
+ /// Query pinot server for data table.
private void sendRequest(long requestId, TableType tableType, BrokerRequest brokerRequest,
Map<ServerInstance, SegmentsToQuery> routingTable,
Map<ServerRoutingInstance, Iterator<Server.ServerResponse>> responseMap, boolean trace) {
@@ -212,9 +204,7 @@ public class GrpcBrokerRequestHandler extends BaseSingleStageBrokerRequestHandle
}
}
- /**
- * Check if a server that was previously detected as unhealthy is now healthy.
- */
+ /// Check if a server that was previously detected as unhealthy is now healthy.
private FailureDetector.ServerState retryUnhealthyServer(String instanceId) {
LOGGER.info("Checking gRPC connection to unhealthy server: {}", instanceId);
ServerInstance serverInstance = _routingManager.getEnabledServerInstanceMap().get(instanceId);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/MultiStageBrokerRequestHandler.java b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/MultiStageBrokerRequestHandler.java
index 91e2d2c2c9a..34562d457fb 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/MultiStageBrokerRequestHandler.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/MultiStageBrokerRequestHandler.java
@@ -112,14 +112,12 @@ import org.slf4j.Marker;
import org.slf4j.MarkerFactory;
-/**
- * This class serves as the broker entry-point for handling incoming multi-stage query requests and dispatching them
- * to servers.
- */
+/// This class serves as the broker entry-point for handling incoming multi-stage query requests and dispatching them
+/// to servers.
public class MultiStageBrokerRequestHandler extends BaseBrokerRequestHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(MultiStageBrokerRequestHandler.class);
/// Disabled by default, but can be enabled with
- ///```xml
+ /// ```xml
/// <MarkerFilter marker="MSE_STATS_MARKER" onMatch="ACCEPT" onMismatch="NEUTRAL"/>
/// ...
/// <Loggers>
@@ -129,7 +127,7 @@ public class MultiStageBrokerRequestHandler extends BaseBrokerRequestHandler {
/// </AppenderRef>
/// </Logger>
/// </Loggers>
- ///```
+ /// ```
private static final Marker MSE_STATS_MARKER = MarkerFactory.getMarker("MSE_STATS_MARKER");
private static final int NUM_UNAVAILABLE_SEGMENTS_TO_LOG = 10;
@@ -256,12 +254,10 @@ public class MultiStageBrokerRequestHandler extends BaseBrokerRequestHandler {
warmupCompile();
}
- /**
- * Best-effort warmup of the Calcite compile pipeline at broker startup. Running a trivial compile
- * early ensures that JVM class-loading and Calcite initialization costs are paid before real
- * queries arrive, so that the first MSE queries do not fail due to tight per-query timeout
- * constraints.
- */
+ /// Best-effort warmup of the Calcite compile pipeline at broker startup. Running a trivial compile
+ /// early ensures that JVM class-loading and Calcite initialization costs are paid before real
+ /// queries arrive, so that the first MSE queries do not fail due to tight per-query timeout
+ /// constraints.
private void warmupCompile() {
// TODO: extend warmup to exercise the full query execution path (planning + dispatch + execution),
// not just compilation, to amortize all cold-start costs before serving traffic.
@@ -599,11 +595,9 @@ public class MultiStageBrokerRequestHandler extends BaseBrokerRequestHandler {
.build();
}
- /**
- * Applies broker-level defaults for MSE query options. Per-query overrides (i.e. {@code SET option = value} in the
- * SQL text) always win because we use {@link Map#putIfAbsent} — a user can set the option to {@code 0} to opt out of
- * a streaming default that the cluster has enabled.
- */
+ /// Applies broker-level defaults for MSE query options. Per-query overrides (i.e. `SET option = value` in the
+ /// SQL text) always win because we use [Map#putIfAbsent] — a user can set the option to `0` to opt out of
+ /// a streaming default that the cluster has enabled.
@VisibleForTesting
void applyBrokerDefaultQueryOptions(Map<String, String> queryOptions) {
if (_defaultStreamingGroupByFlushThreshold != null) {
@@ -612,20 +606,16 @@ public class MultiStageBrokerRequestHandler extends BaseBrokerRequestHandler {
}
}
- /**
- * Extension hook for preparing a compiled query's planner-visible options after compilation, authorization and
- * broker defaults, but before planning/explain. Subclasses can use the validated table set from
- * {@link QueryEnvironment.CompiledQuery#getTableNames()} without re-parsing SQL.
- */
+ /// Extension hook for preparing a compiled query's planner-visible options after compilation, authorization and
+ /// broker defaults, but before planning/explain. Subclasses can use the validated table set from
+ /// [QueryEnvironment.CompiledQuery#getTableNames()] without re-parsing SQL.
protected void prepareCompiledQueryForPlanning(QueryEnvironment.CompiledQuery compiledQuery, long requestId,
RequestContext requestContext, HttpHeaders httpHeaders) {
}
- /**
- * Estimates the total number of server query threads the given plan will consume; used to acquire permits from the
- * multi-stage query throttler before dispatch. Subclasses can override to accurately
- * estimate the real per-server work.
- */
+ /// Estimates the total number of server query threads the given plan will consume; used to acquire permits from the
+ /// multi-stage query throttler before dispatch. Subclasses can override to accurately
+ /// estimate the real per-server work.
protected int getEstimatedNumQueryThreads(DispatchableSubPlan dispatchableSubPlan) {
return dispatchableSubPlan.getEstimatedNumQueryThreads();
}
@@ -640,11 +630,9 @@ public class MultiStageBrokerRequestHandler extends BaseBrokerRequestHandler {
return extraPassiveTimeoutMsFromQueryOption != null ? extraPassiveTimeoutMsFromQueryOption : _extraPassiveTimeoutMs;
}
- /**
- * Explains the query and returns the broker response.
- *
- * Throws using the same conventions as handleRequestThrowing.
- */
+ /// Explains the query and returns the broker response.
+ ///
+ /// Throws using the same conventions as handleRequestThrowing.
private BrokerResponse explain(QueryEnvironment.CompiledQuery query, long requestId, RequestContext requestContext,
Timer timer)
throws WebApplicationException, QueryException {
@@ -923,13 +911,11 @@ public class MultiStageBrokerRequestHandler extends BaseBrokerRequestHandler {
throw new WebApplicationException("Permission denied." + failureMessage, Response.Status.FORBIDDEN);
}
- /**
- * Calls the given callable in a separate thread and enforces a timeout on it.
- *
- * The only exception that can be thrown by this method is a QueryException. All other exceptions are caught and
- * wrapped in a QueryException. Specifically, {@link TimeoutException} is caught and wrapped in a QueryException with
- * the error code {@link QueryErrorCode#BROKER_TIMEOUT} and other exceptions are treated as internal errors.
- */
+ /// Calls the given callable in a separate thread and enforces a timeout on it.
+ ///
+ /// The only exception that can be thrown by this method is a QueryException. All other exceptions are caught and
+ /// wrapped in a QueryException. Specifically, [TimeoutException] is caught and wrapped in a QueryException with
+ /// the error code [QueryErrorCode#BROKER_TIMEOUT] and other exceptions are treated as internal errors.
private <E> E callAsync(long requestId, String query, Callable<E> queryPlannerResultCallable, Timer timer)
throws QueryException {
Future<E> queryPlanResultFuture = _queryCompileExecutor.submit(queryPlannerResultCallable);
@@ -1042,20 +1028,16 @@ public class MultiStageBrokerRequestHandler extends BaseBrokerRequestHandler {
return _queryDispatcher.cancel(queryId);
}
- /**
- * Returns the string representation of the Set of Strings with a limit on the number of elements.
- * @param setOfStrings Set of strings
- * @param limit Limit on the number of elements
- * @return String representation of the set of the form [a,b,c...].
- */
+ /// Returns the string representation of the Set of Strings with a limit on the number of elements.
+ /// @param setOfStrings Set of strings
+ /// @param limit Limit on the number of elements
+ /// @return String representation of the set of the form \[a,b,c...\].
private static String toSizeLimitedString(Set<String> setOfStrings, int limit) {
return setOfStrings.stream().limit(limit)
.collect(Collectors.joining(", ", "[", setOfStrings.size() > limit ? "...]" : "]"));
}
- /**
- * Check if a server that was previously detected as unhealthy is now healthy.
- */
+ /// Check if a server that was previously detected as unhealthy is now healthy.
public FailureDetector.ServerState retryUnhealthyServer(String instanceId) {
LOGGER.info("Checking gRPC connection to unhealthy server: {}", instanceId);
ServerInstance serverInstance = _routingManager.getEnabledServerInstanceMap().get(instanceId);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/MultiStageQueryThrottler.java b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/MultiStageQueryThrottler.java
index a776d0efdfd..ab7a2ac4ae9 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/MultiStageQueryThrottler.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/MultiStageQueryThrottler.java
@@ -37,17 +37,15 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * This class helps limit the number of multi-stage queries being executed concurrently. Note that the cluster
- * configuration is a "per server" value and the broker currently computes the max server query threads as
- * <em>CONFIG_OF_MULTI_STAGE_ENGINE_MAX_SERVER_QUERY_THREADS * numServers / numBrokers</em>. Note that the config value,
- * number of servers, and number of brokers are all dynamically updated here.
- * <p>
- * Another assumption made here is that queries are evenly distributed across brokers.
- * <p>
- * This is designed to limit the number of multi-stage queries being concurrently executed across a cluster and is not
- * intended to prevent individual large queries from being executed.
- */
+/// This class helps limit the number of multi-stage queries being executed concurrently. Note that the cluster
+/// configuration is a "per server" value and the broker currently computes the max server query threads as
+/// _CONFIG_OF_MULTI_STAGE_ENGINE_MAX_SERVER_QUERY_THREADS \* numServers / numBrokers_. Note that the config
+/// value, number of servers, and number of brokers are all dynamically updated here.
+///
+/// Another assumption made here is that queries are evenly distributed across brokers.
+///
+/// This is designed to limit the number of multi-stage queries being concurrently executed across a cluster and is not
+/// intended to prevent individual large queries from being executed.
public class MultiStageQueryThrottler implements ClusterChangeHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(MultiStageQueryThrottler.class);
@@ -55,10 +53,8 @@ public class MultiStageQueryThrottler implements ClusterChangeHandler {
private final int _maxServerQueryThreadsFromBrokerConfig;
private final QueryThreadExceedStrategy _exceedStrategy;
private final AtomicInteger _currentQueryServerThreads = new AtomicInteger();
- /**
- * If _maxServerQueryThreads is <= 0, it means that the cluster is not configured to limit the number of multi-stage
- * queries that can be executed concurrently. In this case, we should not block the query.
- */
+ /// If \_maxServerQueryThreads is <= 0, it means that the cluster is not configured to limit the number of multi-stage
+ /// queries that can be executed concurrently. In this case, we should not block the query.
private int _maxServerQueryThreads;
private int _numBrokers;
private int _numServers;
@@ -110,21 +106,19 @@ public class MultiStageQueryThrottler implements ClusterChangeHandler {
}
}
- /**
- * Returns true if the query can be executed (waiting until it can be executed if necessary), false otherwise.
- * <p>
- * {@link #release(int)} should be called after the query is done executing. It is the responsibility of the caller to
- * ensure that {@link #release(int)} is called exactly once for each call to this method.
- *
- * @param numQueryThreads the estimated number of query server threads
- * @param timeout the maximum time to wait
- * @param unit the time unit of the timeout argument
- *
- * @throws InterruptedException if the current thread is interrupted
- * @throws RuntimeException if the query can never be dispatched due to the number of estimated query server threads
- * being greater than the maximum number of server query threads calculated on the basis of
- * <em>CONFIG_OF_MULTI_STAGE_ENGINE_MAX_SERVER_QUERY_THREADS * numServers / numBrokers</em>
- */
+ /// Returns true if the query can be executed (waiting until it can be executed if necessary), false otherwise.
+ ///
+ /// [#release(int)] should be called after the query is done executing. It is the responsibility of the caller
+ /// to ensure that [#release(int)] is called exactly once for each call to this method.
+ ///
+ /// @param numQueryThreads the estimated number of query server threads
+ /// @param timeout the maximum time to wait
+ /// @param unit the time unit of the timeout argument
+ ///
+ /// @throws InterruptedException if the current thread is interrupted
+ /// @throws RuntimeException if the query can never be dispatched due to the number of estimated query server threads
+ /// being greater than the maximum number of server query threads calculated on the basis of
+ /// _CONFIG_OF_MULTI_STAGE_ENGINE_MAX_SERVER_QUERY_THREADS \* numServers / numBrokers_
public boolean tryAcquire(int numQueryThreads, long timeout, TimeUnit unit)
throws InterruptedException {
if (_maxServerQueryThreads <= 0) {
@@ -162,10 +156,8 @@ public class MultiStageQueryThrottler implements ClusterChangeHandler {
}
}
- /**
- * Should be called after the query is done executing. It is the responsibility of the caller to ensure that this
- * method is called exactly once for each call to {@link #tryAcquire(int, long, TimeUnit)}.
- */
+ /// Should be called after the query is done executing. It is the responsibility of the caller to ensure that this
+ /// method is called exactly once for each call to [#tryAcquire(int, long, TimeUnit)].
public void release(int numQueryThreads) {
_currentQueryServerThreads.addAndGet(-1 * numQueryThreads);
if (_maxServerQueryThreads > 0 && _exceedStrategy == QueryThreadExceedStrategy.WAIT) {
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/SingleConnectionBrokerRequestHandler.java b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/SingleConnectionBrokerRequestHandler.java
index 6e2e21f5043..b8e0cbd3af5 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/SingleConnectionBrokerRequestHandler.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/SingleConnectionBrokerRequestHandler.java
@@ -63,10 +63,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * The <code>SingleConnectionBrokerRequestHandler</code> class is a thread-safe broker request handler using a single
- * connection per server to route the queries.
- */
+/// The `SingleConnectionBrokerRequestHandler` class is a thread-safe broker request handler using a single
+/// connection per server to route the queries.
@ThreadSafe
public class SingleConnectionBrokerRequestHandler extends BaseSingleStageBrokerRequestHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(SingleConnectionBrokerRequestHandler.class);
@@ -131,10 +129,8 @@ public class SingleConnectionBrokerRequestHandler extends BaseSingleStageBrokerR
rawTableName);
}
- /**
- * Executes scatter-gather: sends the query to servers and collects per-server DataTables.
- * Subclasses may override to replace or augment the scatter step.
- */
+ /// Executes scatter-gather: sends the query to servers and collects per-server DataTables.
+ /// Subclasses may override to replace or augment the scatter step.
protected ScatterResult doScatter(long requestId, String rawTableName, TableRouteInfo route, long timeoutMs,
ServerStats serverStats)
throws Exception {
@@ -166,11 +162,9 @@ public class SingleConnectionBrokerRequestHandler extends BaseSingleStageBrokerR
return new ScatterResult(dataTableMap, serversNotResponded, stats, timedOut, asyncQueryResponse.getException());
}
- /**
- * Executes the reduce step on the scatter result and populates the response with server stats.
- * Subclasses may override to perform custom reduce logic, or construct a {@link ScatterResult}
- * with a substituted data table map using {@link ScatterResultStats} to preserve server stats.
- */
+ /// Executes the reduce step on the scatter result and populates the response with server stats.
+ /// Subclasses may override to perform custom reduce logic, or construct a [ScatterResult]
+ /// with a substituted data table map using [ScatterResultStats] to preserve server stats.
protected BrokerResponseNative doReduce(BrokerRequest originalBrokerRequest, BrokerRequest serverBrokerRequest,
ScatterResult scatterResult, long scatterGatherStartTimeNs, long timeoutMs, String rawTableName)
throws Exception {
@@ -346,11 +340,9 @@ public class SingleConnectionBrokerRequestHandler extends BaseSingleStageBrokerR
return brokerResponse;
}
- /**
- * Snapshot of server-side scatter statistics. Passed to {@link ScatterResult} so that server
- * counts are always derived from the live scatter, not from a data table map that may have been
- * augmented by a subclass.
- */
+ /// Snapshot of server-side scatter statistics. Passed to [ScatterResult] so that server
+ /// counts are always derived from the live scatter, not from a data table map that may have been
+ /// augmented by a subclass.
public static final class ScatterResultStats {
private final int _numServersQueried;
private final int _numServersResponded;
@@ -375,9 +367,7 @@ public class SingleConnectionBrokerRequestHandler extends BaseSingleStageBrokerR
}
}
- /**
- * Carries the scatter-gather result before the reduce step.
- */
+ /// Carries the scatter-gather result before the reduce step.
public static final class ScatterResult {
private final Map<ServerRoutingInstance, DataTable> _dataTableMap;
private final List<ServerRoutingInstance> _serversNotResponded;
@@ -428,9 +418,7 @@ public class SingleConnectionBrokerRequestHandler extends BaseSingleStageBrokerR
}
}
- /**
- * Check if a server that was previously detected as unhealthy is now healthy.
- */
+ /// Check if a server that was previously detected as unhealthy is now healthy.
public FailureDetector.ServerState retryUnhealthyServer(String instanceId) {
LOGGER.info("Retrying unhealthy server: {}", instanceId);
ServerInstance serverInstance = _routingManager.getEnabledServerInstanceMap().get(instanceId);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/TimeSeriesRequestHandler.java b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/TimeSeriesRequestHandler.java
index 6a16d471e8c..06f835950e7 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/TimeSeriesRequestHandler.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/requesthandler/TimeSeriesRequestHandler.java
@@ -283,14 +283,12 @@ public class TimeSeriesRequestHandler extends BaseBrokerRequestHandler {
return HumanReadableDuration.from(step).getSeconds();
}
- /**
- * First-stage access control check for the request.
- * This method checks if the requester has access to the broker to prevent unauthenticated requests from
- * using up resources.
- * Secondary table-level access control checks will be performed later.
- *
- * @param requesterIdentity The identity of the requester.
- */
+ /// First-stage access control check for the request.
+ /// This method checks if the requester has access to the broker to prevent unauthenticated requests from
+ /// using up resources.
+ /// Secondary table-level access control checks will be performed later.
+ ///
+ /// @param requesterIdentity The identity of the requester.
private void firstStageAccessControlCheck(RequesterIdentity requesterIdentity) {
AccessControl accessControl = _accessControlFactory.create();
AuthorizationResult authorizationResult = accessControl.authorize(requesterIdentity);
@@ -333,11 +331,9 @@ public class TimeSeriesRequestHandler extends BaseBrokerRequestHandler {
}
}
- /**
- * Helper function that takes a @Code{LeafTimeSeriesPlanNode} and validates the column names used
- * in the filter, groupBy, value etc. expressions
- * @param leafNode
- */
+ /// Helper function that takes a @Code{LeafTimeSeriesPlanNode} and validates the column names used
+ /// in the filter, groupBy, value etc. expressions
+ /// @param leafNode
static void validateColumnNames(LeafTimeSeriesPlanNode leafNode, Schema tableSchema) {
String tableName = TableNameBuilder.extractRawTableName(leafNode.getTableName());
Preconditions.checkNotNull(tableSchema, "Schema for Table " + tableName + " not found");
@@ -385,13 +381,11 @@ public class TimeSeriesRequestHandler extends BaseBrokerRequestHandler {
}
}
- /**
- * Table-level access control check for the request.
- * This method checks if the requester has access to the tables in the request.
- *
- * @param httpHeaders The HTTP headers of the request.
- * @param tableNames The list of table to check access for.
- */
+ /// Table-level access control check for the request.
+ /// This method checks if the requester has access to the tables in the request.
+ ///
+ /// @param httpHeaders The HTTP headers of the request.
+ /// @param tableNames The list of table to check access for.
private void tableLevelAccessControlCheck(HttpHeaders httpHeaders, List<String> tableNames) {
AccessControl accessControl = _accessControlFactory.create();
for (String tableName : tableNames) {
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/AdaptiveServerSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/AdaptiveServerSelector.java
index 0f38ee92b11..57ab9e6185e 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/AdaptiveServerSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/AdaptiveServerSelector.java
@@ -22,37 +22,29 @@ import java.util.List;
import org.apache.commons.lang3.tuple.Pair;
-/**
- * The {@code AdaptiveServerSelector} intelligently selects the best available server for a segment during query
- * processing. The decision is made based on stats recorded for each server during query processing.
- */
+/// The `AdaptiveServerSelector` intelligently selects the best available server for a segment during query
+/// processing. The decision is made based on stats recorded for each server during query processing.
public interface AdaptiveServerSelector {
- /**
- * Picks the best server to route a query from the list of candidate servers.
- *
- * @param serverCandidates Candidate servers from which the best server should be chosen.
- * @return server identifier
- */
+ /// Picks the best server to route a query from the list of candidate servers.
+ ///
+ /// @param serverCandidates Candidate servers from which the best server should be chosen.
+ /// @return server identifier
String select(List<String> serverCandidates);
- /**
- * Returns the ranking of servers ordered from best to worst along with the absolute scores based on which the
- * servers are ranked. Based on the implementation of the interface, the score could refer to different things. For
- * NumInFlightReqSelector, score is the number of inflight requests. For LatencySelector, score is the EMA latency.
- * For HybridSelector, score is the hybridScore which is computed by combining latency and # inflight requests.
- *
- * @return List of servers along with their values ranked from best to worst.
- */
+ /// Returns the ranking of servers ordered from best to worst along with the absolute scores based on which the
+ /// servers are ranked. Based on the implementation of the interface, the score could refer to different things. For
+ /// NumInFlightReqSelector, score is the number of inflight requests. For LatencySelector, score is the EMA latency.
+ /// For HybridSelector, score is the hybridScore which is computed by combining latency and # inflight requests.
+ ///
+ /// @return List of servers along with their values ranked from best to worst.
List<Pair<String, Double>> fetchAllServerRankingsWithScores();
- /**
- * Same as above but fetches ranking only for the list of serverCandidates provided in the parameter. If a server
- * doesn't have an entry, it's ranked better than other serverCandidates and a value of -1.0 is returned. With the
- * above "fetchAllServerRankingsWithScores" API, ranking for all the servers are fetched. This can become
- * problematic if a broker is routing to multiple server tenants but a query needs to touch only a single server
- * tenant. This API helps fetch ranking only for a subset of servers.
- * @return List of servers along with their values ranked from best to worst.
- */
+ /// Same as above but fetches ranking only for the list of serverCandidates provided in the parameter. If a server
+ /// doesn't have an entry, it's ranked better than other serverCandidates and a value of -1.0 is returned. With the
+ /// above "fetchAllServerRankingsWithScores" API, ranking for all the servers are fetched. This can become
+ /// problematic if a broker is routing to multiple server tenants but a query needs to touch only a single server
+ /// tenant. This API helps fetch ranking only for a subset of servers.
+ /// @return List of servers along with their values ranked from best to worst.
List<Pair<String, Double>> fetchServerRankingsWithScores(List<String> serverCandidates);
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/AdaptiveServerSelectorFactory.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/AdaptiveServerSelectorFactory.java
index ae83cfca695..454d7ef110d 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/AdaptiveServerSelectorFactory.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/AdaptiveServerSelectorFactory.java
@@ -26,10 +26,8 @@ import org.apache.pinot.spi.utils.CommonConstants.Broker;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * The {@code AdaptiveServerSelectorFactory} determines the adaptive server selection strategy to use. The choice is
- * made based on broker instance configs.
- */
+/// The `AdaptiveServerSelectorFactory` determines the adaptive server selection strategy to use. The choice is
+/// made based on broker instance configs.
public class AdaptiveServerSelectorFactory {
private static final Logger LOGGER = LoggerFactory.getLogger(AdaptiveServerSelectorFactory.class);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/HybridSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/HybridSelector.java
index f7383ceb43b..a8ea68dc556 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/HybridSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/HybridSelector.java
@@ -27,21 +27,19 @@ import org.apache.commons.lang3.tuple.Pair;
import org.apache.pinot.core.transport.server.routing.stats.ServerRoutingStatsManager;
-/**
- * The {@code HybridSelector} is an AdaptiveServerSelector implementation that picks the best server based on the
- * following parameters:
- * 1. Num of in-flight requests (A)
- * 2. EMA of in-flight requests (B)
- * 3. EMA of latencies (C)
- * This selector implementation is based on the ideas suggested in the paper -
- * https://www.usenix.org/system/files/conference/nsdi15/nsdi15-paper-suresh.pdf
- *
- * The Hybrid score for each server is calculated as follows. The server with the lowest Hybrid score is picked.
- * HybridScore = Math.pow(F+A+B, N) * C
- * N -> Configurable exponent with default value of 3.
- * F -> Configurable queue size floor with default value of 0. Setting F=1 matches the original paper formulation and
- * prevents the score from collapsing to 0 when all servers are idle, ensuring latency is still used for routing.
- */
+/// The `HybridSelector` is an AdaptiveServerSelector implementation that picks the best server based on the
+/// following parameters:
+/// 1. Num of in-flight requests (A)
+/// 2. EMA of in-flight requests (B)
+/// 3. EMA of latencies (C)
+/// This selector implementation is based on the ideas suggested in the paper -
+/// https://www.usenix.org/system/files/conference/nsdi15/nsdi15-paper-suresh.pdf
+///
+/// The Hybrid score for each server is calculated as follows. The server with the lowest Hybrid score is picked.
+/// HybridScore = Math.pow(F+A+B, N) \* C
+/// N -> Configurable exponent with default value of 3.
+/// F -> Configurable queue size floor with default value of 0. Setting F=1 matches the original paper formulation and
+/// prevents the score from collapsing to 0 when all servers are idle, ensuring latency is still used for routing.
public class HybridSelector implements AdaptiveServerSelector {
private final ServerRoutingStatsManager _serverRoutingStatsManager;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/LatencySelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/LatencySelector.java
index 3e35af8246f..35d4afda028 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/LatencySelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/LatencySelector.java
@@ -27,13 +27,11 @@ import org.apache.commons.lang3.tuple.Pair;
import org.apache.pinot.core.transport.server.routing.stats.ServerRoutingStatsManager;
-/**
- * The {@code LatencySelector} is an AdaptiveServerSelector implementation that picks the best server based on
- * the exponential weighted moving average (EMA) of query latencies seen by the server. The EMA latencies are
- * updated when the broker receives the query responses from the respective servers. It is a reactive algorithm and
- * will be useful only for a selective usecases. Please perform usecase testing before enabling this method of
- * server selection.
- */
+/// The `LatencySelector` is an AdaptiveServerSelector implementation that picks the best server based on
+/// the exponential weighted moving average (EMA) of query latencies seen by the server. The EMA latencies are
+/// updated when the broker receives the query responses from the respective servers. It is a reactive algorithm and
+/// will be useful only for a selective usecases. Please perform usecase testing before enabling this method of
+/// server selection.
public class LatencySelector implements AdaptiveServerSelector {
private final ServerRoutingStatsManager _serverRoutingStatsManager;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/NumInFlightReqSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/NumInFlightReqSelector.java
index 21a87cf54b4..b65d9ec09d7 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/NumInFlightReqSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/NumInFlightReqSelector.java
@@ -27,11 +27,9 @@ import org.apache.commons.lang3.tuple.Pair;
import org.apache.pinot.core.transport.server.routing.stats.ServerRoutingStatsManager;
-/**
- * The {@code NumInFlightReqSelector} is an AdaptiveServerSelector implementation that picks the best server based on
- * the number of in-flight queries being processed by the server. The server with the lowest number of in-flight
- * queries is picked.
- */
+/// The `NumInFlightReqSelector` is an AdaptiveServerSelector implementation that picks the best server based on
+/// the number of in-flight queries being processed by the server. The server with the lowest number of in-flight
+/// queries is picked.
public class NumInFlightReqSelector implements AdaptiveServerSelector {
private final ServerRoutingStatsManager _serverRoutingStatsManager;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/PriorityPoolInstanceSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/PriorityPoolInstanceSelector.java
index ef15f8ad17d..b0c0ebfb5fd 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/PriorityPoolInstanceSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/PriorityPoolInstanceSelector.java
@@ -31,84 +31,78 @@ import org.apache.commons.lang3.tuple.Pair;
import org.apache.pinot.broker.routing.instanceselector.SegmentInstanceCandidate;
-/**
- * A server selector that implements priority-based server selection based on pools.
- * This selector works in conjunction with an {@link AdaptiveServerSelector} to provide
- * a two-level selection strategy:
- * <ol>
- * <li>First level: Select servers based on pool priorities</li>
- * <li>Second level: Use adaptive selection within the chosen pool</li>
- * </ol>
- *
- * <p>The selector maintains the following invariants:</p>
- * <ul>
- * <li>Servers from preferred pools are always selected before non-preferred pools</li>
- * <li>Within each pools, servers are selected using adaptive selection criteria</li>
- * <li>When no preferred pools are available, falls back to non-preferred pools</li>
- * </ul>
- */
+/// A server selector that implements priority-based server selection based on pools.
+/// This selector works in conjunction with an [AdaptiveServerSelector] to provide
+/// a two-level selection strategy:
+///
+/// 1. First level: Select servers based on pool priorities
+/// 2. Second level: Use adaptive selection within the chosen pool
+///
+/// The selector maintains the following invariants:
+///
+/// - Servers from preferred pools are always selected before non-preferred pools
+/// - Within each pools, servers are selected using adaptive selection criteria
+/// - When no preferred pools are available, falls back to non-preferred pools
public class PriorityPoolInstanceSelector {
- /** The underlying adaptive server selector used for selection within pools */
+ /// The underlying adaptive server selector used for selection within pools
private final AdaptiveServerSelector _adaptiveServerSelector;
- /** Sentinel value used to pool all non-preferred servers together */
+ /// Sentinel value used to pool all non-preferred servers together
private static final int SENTINEL_POOL_OF_NON_PREFERRED_SERVERS = Integer.MAX_VALUE;
- /**
- * Creates a new priority pool instance selector with the given adaptive server selector.
- *
- * @param adaptiveServerSelector the adaptive server selector to use for selection within pools
- * @throws IllegalArgumentException if adaptiveServerSelector is null
- */
+ /// Creates a new priority pool instance selector with the given adaptive server selector.
+ ///
+ /// @param adaptiveServerSelector the adaptive server selector to use for selection within pools
+ /// @throws IllegalArgumentException if adaptiveServerSelector is null
public PriorityPoolInstanceSelector(AdaptiveServerSelector adaptiveServerSelector) {
assert adaptiveServerSelector != null;
_adaptiveServerSelector = adaptiveServerSelector;
}
- /**
- * Selects a server instance from the given candidates based on pool preferences.
- * The selection process follows these steps:
- * <ol>
- * <li>pools all candidates by their pool</li>
- * <li>Iterates through the ordered preferred pools in priority order</li>
- * <li>For the first pool that has available servers, uses adaptiveServerSelector to choose one</li>
- * <li>If no preferred pools have servers, falls back to selecting from remaining servers</li>
- * </ol>
- *
- * <p>Example 1 - Preferred pool has servers:</p>
- * <pre>
- * Candidates:
- * - server1 (pool 1)
- * - server2 (pool 2)
- * - server3 (pool 1)
- * Preferred pools: [2, 1]
- * Result: server2 is selected (from pool 2, highest priority)
- * </pre>
- *
- * <p>Example 2 - Fallback to second preferred pool:</p>
- * <pre>
- * Candidates:
- * - server1 (pool 1)
- * - server3 (pool 1)
- * - server4 (pool 3)
- * Preferred pools: [2, 1]
- * Result: adaptiveServerSelector chooses between server1 and server3 (from pool 1)
- * </pre>
- *
- * <p>Example 3 - Fallback to non-preferred pool:</p>
- * <pre>
- * Candidates:
- * - server4 (pool 3)
- * - server5 (pool 3)
- * Preferred pools: [2, 1]
- * Result: adaptiveServerSelector chooses between server4 and server5 (from pool 3)
- * </pre>
- *
- * @param ctx the server selection context containing ordered preferred pools
- * @param candidates the list of server candidates to choose from
- * @return the selected server instance as a SegmentInstanceCandidate, or null if no candidates are available
- */
+ /// Selects a server instance from the given candidates based on pool preferences.
+ /// The selection process follows these steps:
+ ///
+ /// 1. pools all candidates by their pool
+ /// 2. Iterates through the ordered preferred pools in priority order
+ /// 3. For the first pool that has available servers, uses adaptiveServerSelector to choose one
+ /// 4. If no preferred pools have servers, falls back to selecting from remaining servers
+ ///
+ /// Example 1 - Preferred pool has servers:
+ ///
+ /// ```
+ /// Candidates:
+ /// - server1 (pool 1)
+ /// - server2 (pool 2)
+ /// - server3 (pool 1)
+ /// Preferred pools: [2, 1]
+ /// Result: server2 is selected (from pool 2, highest priority)
+ /// ```
+ ///
+ /// Example 2 - Fallback to second preferred pool:
+ ///
+ /// ```
+ /// Candidates:
+ /// - server1 (pool 1)
+ /// - server3 (pool 1)
+ /// - server4 (pool 3)
+ /// Preferred pools: [2, 1]
+ /// Result: adaptiveServerSelector chooses between server1 and server3 (from pool 1)
+ /// ```
+ ///
+ /// Example 3 - Fallback to non-preferred pool:
+ ///
+ /// ```
+ /// Candidates:
+ /// - server4 (pool 3)
+ /// - server5 (pool 3)
+ /// Preferred pools: [2, 1]
+ /// Result: adaptiveServerSelector chooses between server4 and server5 (from pool 3)
+ /// ```
+ ///
+ /// @param ctx the server selection context containing ordered preferred pools
+ /// @param candidates the list of server candidates to choose from
+ /// @return the selected server instance as a SegmentInstanceCandidate, or null if no candidates are available
@Nullable
public SegmentInstanceCandidate select(ServerSelectionContext ctx,
@Nullable List<SegmentInstanceCandidate> candidates) {
@@ -148,33 +142,32 @@ public class PriorityPoolInstanceSelector {
return null;
}
- /**
- * Invoke adaptiveServerSelector to get the original ranking the servers (min first). Reorder the servers based on
- * the pool preference. The head of the OrderedPreferredPools list is the most preferred pool.
- * The servers in the same pool are ranked by the original ranking.
- *
- * <p>Example:</p>
- * <pre>
- * Given:
- * - Server candidates:
- * - server1 (pool 1, score 80)
- * - server2 (pool 2, score 70)
- * - server3 (pool 1, score 90)
- * - server4 (pool 3, score 60)
- * - Ordered preferred pools: [2, 1]
- *
- * Original ranking by score would be: [server4, server2, server1, server3]
- * Final ranking after pool preference: [server2, server1, server3, server4]
- * Because:
- * 1. pool 2 servers come first (server2)
- * 2. pool 1 servers come next, maintaining their relative order (server1, server3)
- * 3. Remaining servers come last (server4)
- * </pre>
- *
- * @param ctx the server selection context containing ordered preferred pools
- * @param serverCandidates the server candidates to be ranked
- * @return the ranked servers, ordered by pool preference and then by original ranking within each pool
- */
+ /// Invoke adaptiveServerSelector to get the original ranking the servers (min first). Reorder the servers based on
+ /// the pool preference. The head of the OrderedPreferredPools list is the most preferred pool.
+ /// The servers in the same pool are ranked by the original ranking.
+ ///
+ /// Example:
+ ///
+ /// ```
+ /// Given:
+ /// - Server candidates:
+ /// - server1 (pool 1, score 80)
+ /// - server2 (pool 2, score 70)
+ /// - server3 (pool 1, score 90)
+ /// - server4 (pool 3, score 60)
+ /// - Ordered preferred pools: [2, 1]
+ ///
+ /// Original ranking by score would be: [server4, server2, server1, server3]
+ /// Final ranking after pool preference: [server2, server1, server3, server4]
+ /// Because:
+ /// 1. pool 2 servers come first (server2)
+ /// 2. pool 1 servers come next, maintaining their relative order (server1, server3)
+ /// 3. Remaining servers come last (server4)
+ /// ```
+ ///
+ /// @param ctx the server selection context containing ordered preferred pools
+ /// @param serverCandidates the server candidates to be ranked
+ /// @return the ranked servers, ordered by pool preference and then by original ranking within each pool
public List<String> rank(ServerSelectionContext ctx, List<SegmentInstanceCandidate> serverCandidates) {
if (serverCandidates == null || serverCandidates.isEmpty()) {
return List.of();
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/ServerSelectionContext.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/ServerSelectionContext.java
index 97766e169a0..8e82e653280 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/ServerSelectionContext.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/adaptiveserverselector/ServerSelectionContext.java
@@ -24,36 +24,30 @@ import org.apache.pinot.broker.routing.instanceselector.InstanceSelectorConfig;
import org.apache.pinot.common.utils.config.QueryOptionsUtils;
-/**
- * This class encapsulates query options and ordered preferred pools that influence how
- * servers are selected for query execution.
- */
+/// This class encapsulates query options and ordered preferred pools that influence how
+/// servers are selected for query execution.
public class ServerSelectionContext {
private final InstanceSelectorConfig _config;
- /**
- * Map of query options that can influence server selection behavior.
- * These options are passed into the context class to avoid endless constructor argument changes
- * as new server selection preferences are added. Examples of such options include:
- * <ul>
- * <li>Preferred pools for routing</li>
- * <li>Boolean fixedReplicaGroup</li>
- * <li>Other server selection related configurations in the future</li>
- * </ul>
- * The options are processed once during construction to extract relevant information
- * (like ordered preferred pools) to avoid repeated parsing.
- */
+ /// Map of query options that can influence server selection behavior.
+ /// These options are passed into the context class to avoid endless constructor argument changes
+ /// as new server selection preferences are added. Examples of such options include:
+ ///
+ /// - Preferred pools for routing
+ /// - Boolean fixedReplicaGroup
+ /// - Other server selection related configurations in the future
+ ///
+ /// The options are processed once during construction to extract relevant information
+ /// (like ordered preferred pools) to avoid repeated parsing.
private final Map<String, String> _queryOptions;
// If some query options need further processing, store the parsing result below to avoid duplicate parsing.
private final List<Integer> _orderedPreferredPools;
private final boolean _isUseFixedReplica;
- /**
- * Creates a new server selection context with the given query options.
- * The ordered preferred pools are extracted from the query options using
- * {@link QueryOptionsUtils#getOrderedPreferredPools(Map)}.
- *
- * @param queryOptions map of query options that may contain server selection preferences
- */
+ /// Creates a new server selection context with the given query options.
+ /// The ordered preferred pools are extracted from the query options using
+ /// [QueryOptionsUtils#getOrderedPreferredPools(Map)].
+ ///
+ /// @param queryOptions map of query options that may contain server selection preferences
public ServerSelectionContext(Map<String, String> queryOptions, InstanceSelectorConfig instanceSelectorConfig) {
_queryOptions = queryOptions == null ? Map.of() : queryOptions;
_config = instanceSelectorConfig;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/BalancedInstanceSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/BalancedInstanceSelector.java
index 13c5c0668d9..7707366ee22 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/BalancedInstanceSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/BalancedInstanceSelector.java
@@ -41,7 +41,6 @@ import org.apache.pinot.common.utils.HashUtil;
/// If AdaptiveServerSelection is disabled, the selection algorithm will always evenly distribute the traffic to all
/// replicas of each segment, and will try to select different replica id for each segment. The algorithm is very
/// light-weight and will do best effort to balance the number of segments served by each selected server instance.
-///
public class BalancedInstanceSelector extends BaseInstanceSelector {
@Override
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/BaseInstanceSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/BaseInstanceSelector.java
index 3108e7e6b84..6fe60b5411b 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/BaseInstanceSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/BaseInstanceSelector.java
@@ -80,7 +80,6 @@ import static org.apache.pinot.spi.utils.CommonConstants.Broker.FALLBACK_POOL_ID
/// 2) When there is no state update from helix, new segments won't be retired because of the time passing (those with
/// creation time more than 5 minutes ago).
/// TODO: refresh new/old segment state where there is no update from helix for long time.
-///
public abstract class BaseInstanceSelector implements InstanceSelector {
private static final Logger LOGGER = LoggerFactory.getLogger(BaseInstanceSelector.class);
// To prevent int overflow, reset the request id once it reaches this value
@@ -144,16 +143,12 @@ public abstract class BaseInstanceSelector implements InstanceSelector {
refreshSegmentStates();
}
- /**
- * Returns whether the instance state is online for routing purpose (ONLINE/CONSUMING).
- */
+ /// Returns whether the instance state is online for routing purpose (ONLINE/CONSUMING).
static boolean isOnlineForRouting(@Nullable String state) {
return SegmentStateModel.ONLINE.equals(state) || SegmentStateModel.CONSUMING.equals(state);
}
- /**
- * Returns a map from new segment to their creation time based on the ZK metadata.
- */
+ /// Returns a map from new segment to their creation time based on the ZK metadata.
Map<String, Long> getNewSegmentCreationTimeMapFromZK(IdealState idealState, ExternalView externalView,
Set<String> onlineSegments) {
List<String> potentialNewSegments = new ArrayList<>();
@@ -190,12 +185,10 @@ public abstract class BaseInstanceSelector implements InstanceSelector {
return newSegmentCreationTimeMap;
}
- /**
- * Returns whether a segment is qualified as a new segment.
- * A segment is count as old when:
- * - Any instance for the segment is in ERROR state
- * - External view for the segment converges with ideal state
- */
+ /// Returns whether a segment is qualified as a new segment.
+ /// A segment is count as old when:
+ /// - Any instance for the segment is in ERROR state
+ /// - External view for the segment converges with ideal state
static boolean isPotentialNewSegment(Map<String, String> idealStateInstanceStateMap,
@Nullable Map<String, String> externalViewInstanceStateMap) {
if (externalViewInstanceStateMap == null) {
@@ -216,9 +209,7 @@ public abstract class BaseInstanceSelector implements InstanceSelector {
return !hasConverged;
}
- /**
- * Returns the online instances for routing purpose.
- */
+ /// Returns the online instances for routing purpose.
static TreeSet<String> getOnlineInstances(Map<String, String> idealStateInstanceStateMap,
Map<String, String> externalViewInstanceStateMap) {
TreeSet<String> onlineInstances = new TreeSet<>();
@@ -233,9 +224,7 @@ public abstract class BaseInstanceSelector implements InstanceSelector {
return onlineInstances;
}
- /**
- * Converts the given map into a sorted map if needed.
- */
+ /// Converts the given map into a sorted map if needed.
static SortedMap<String, String> convertToSortedMap(Map<String, String> map) {
if (map instanceof SortedMap) {
return (SortedMap<String, String>) map;
@@ -245,7 +234,7 @@ public abstract class BaseInstanceSelector implements InstanceSelector {
}
/// Updates the segment maps based on the given ideal state, external view, online segments (segments with
- /// ONLINE/CONSUMING instances in the ideal state and pre-selected by the {@code SegmentPreSelector}) and new
+ /// ONLINE/CONSUMING instances in the ideal state and pre-selected by the `SegmentPreSelector`) and new
/// segments. After this update:
/// - Old segments' online instances should be tracked in _oldSegmentCandidatesMap
/// - New segments' state (creation time and candidate instances) should be tracked in _newSegmentStateMap
@@ -330,10 +319,8 @@ public abstract class BaseInstanceSelector implements InstanceSelector {
}
}
- /**
- * Refreshes the _segmentStates based on the in-memory states.
- * Note that the whole _segmentStates has to be updated together to avoid partial state update.
- **/
+ /// Refreshes the \_segmentStates based on the in-memory states.
+ /// Note that the whole \_segmentStates has to be updated together to avoid partial state update.
void refreshSegmentStates() {
Map<String, List<SegmentInstanceCandidate>> instanceCandidatesMap =
new HashMap<>(HashUtil.getHashMapCapacity(_oldSegmentCandidatesMap.size() + _newSegmentStateMap.size()));
@@ -396,23 +383,19 @@ public abstract class BaseInstanceSelector implements InstanceSelector {
return enabledCandidates;
}
- /**
- * {@inheritDoc}
- *
- * <p>Updates the cached enabled instances and re-calculates {@link #_segmentStates}.
- */
+ /// {@inheritDoc}
+ ///
+ /// Updates the cached enabled instances and re-calculates [#_segmentStates].
@Override
public void onInstancesChange(Set<String> enabledInstances, List<String> changedInstances) {
_enabledInstances = enabledInstances;
refreshSegmentStates();
}
- /**
- * {@inheritDoc}
- *
- * <p>Updates the cached maps ({@link #_oldSegmentCandidatesMap} and {@link #_newSegmentStateMap}, and re-calculates
- * {@link #_segmentStates} based on the cached states.
- */
+ /// {@inheritDoc}
+ ///
+ /// Updates the cached maps ([#_oldSegmentCandidatesMap] and [#_newSegmentStateMap], and re-calculates
+ /// [#_segmentStates] based on the cached states.
@Override
public void onAssignmentChange(IdealState idealState, ExternalView externalView, Set<String> onlineSegments) {
Map<String, Long> newSegmentCreationTimeMap =
@@ -421,9 +404,7 @@ public abstract class BaseInstanceSelector implements InstanceSelector {
refreshSegmentStates();
}
- /**
- * Returns a map from new segment to their creation time based on the existing in-memory states.
- */
+ /// Returns a map from new segment to their creation time based on the existing in-memory states.
Map<String, Long> getNewSegmentCreationTimeMapFromExistingStates(IdealState idealState, ExternalView externalView,
Set<String> onlineSegments) {
Map<String, Long> newSegmentCreationTimeMap = new HashMap<>();
@@ -500,12 +481,10 @@ public abstract class BaseInstanceSelector implements InstanceSelector {
return pool;
}
- /**
- * Selects the server instances for the given segments based on the request id and segment states. Returns two maps
- * from segment to selected server instance hosting the segment. The 2nd map is for optional segments. The optional
- * segments are used to get the new segments that are not online yet. Instead of simply skipping them by broker at
- * routing time, we can send them to servers and let servers decide how to handle them.
- */
+ /// Selects the server instances for the given segments based on the request id and segment states. Returns two maps
+ /// from segment to selected server instance hosting the segment. The 2nd map is for optional segments. The optional
+ /// segments are used to get the new segments that are not online yet. Instead of simply skipping them by broker at
+ /// routing time, we can send them to servers and let servers decide how to handle them.
protected abstract Pair<Map<String, String>, Map<String, String>/*optional segments*/> select(List<String> segments,
int requestId, SegmentStates segmentStates, Map<String, String> queryOptions);
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/InstanceSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/InstanceSelector.java
index 664ea846368..b9b1434d223 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/InstanceSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/InstanceSelector.java
@@ -29,58 +29,47 @@ import org.apache.helix.model.IdealState;
import org.apache.helix.store.zk.ZkHelixPropertyStore;
import org.apache.helix.zookeeper.datamodel.ZNRecord;
import org.apache.pinot.broker.routing.adaptiveserverselector.AdaptiveServerSelector;
-import org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector;
import org.apache.pinot.common.metrics.BrokerMetrics;
import org.apache.pinot.common.request.BrokerRequest;
import org.apache.pinot.core.transport.ServerInstance;
import org.apache.pinot.spi.config.table.TableConfig;
-/**
- * The instance selector selects server instances to serve the query based on the selected segments.
- */
+/// The instance selector selects server instances to serve the query based on the selected segments.
public interface InstanceSelector {
static boolean isNewSegment(long creationTimeMs, long currentTimeMs, long newSegmentExpirationMillis) {
return creationTimeMs > 0 && currentTimeMs - creationTimeMs <= newSegmentExpirationMillis;
}
- /**
- * Initializes the instance selector with the enabled instances, ideal state, external view and online segments
- * (segments with ONLINE/CONSUMING instances in the ideal state and pre-selected by the {@link SegmentPreSelector}).
- * Should be called only once before calling other methods.
- */
+ /// Initializes the instance selector with the enabled instances, ideal state, external view and online segments
+ /// (segments with ONLINE/CONSUMING instances in the ideal state and pre-selected by the
+ /// [org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector]). Should be called only once before
+ /// calling other methods.
void init(TableConfig tableConfig, ZkHelixPropertyStore<ZNRecord> propertyStore,
BrokerMetrics brokerMetrics, @Nullable AdaptiveServerSelector adaptiveServerSelector, Clock clock,
InstanceSelectorConfig config, Set<String> enabledInstances, Map<String, ServerInstance> enabledServerMap,
IdealState idealState, ExternalView externalView, Set<String> onlineSegments);
- /**
- * Processes the instances change. Changed instances are pre-computed based on the current and previous enabled
- * instances only once on the caller side and passed to all the instance selectors.
- */
+ /// Processes the instances change. Changed instances are pre-computed based on the current and previous enabled
+ /// instances only once on the caller side and passed to all the instance selectors.
void onInstancesChange(Set<String> enabledInstances, List<String> changedInstances);
- /**
- * Processes the segment assignment (ideal state or external view) change based on the given online segments (segments
- * with ONLINE/CONSUMING instances in the ideal state and pre-selected by the {@link SegmentPreSelector}).
- */
+ /// Processes the segment assignment (ideal state or external view) change based on the given online segments
+ /// (segments with ONLINE/CONSUMING instances in the ideal state and pre-selected by the
+ /// [org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector]).
void onAssignmentChange(IdealState idealState, ExternalView externalView, Set<String> onlineSegments);
- /**
- * Selects the server instances for the given segments queried by the given broker request, returns a map from segment
- * to selected server instance hosting the segment and a set of unavailable segments (no enabled instance or all
- * enabled instances are in ERROR state).
- *
- * @param brokerRequest BrokerRequest for the query
- * @param segments segments for which instance needs to be selected
- * @param requestId requestId generated by the Broker for a query
- * @return instance of SelectionResult which describes the instance to pick for a given segment
- */
+ /// Selects the server instances for the given segments queried by the given broker request, returns a map from
+ /// segment to selected server instance hosting the segment and a set of unavailable segments (no enabled instance or
+ /// all enabled instances are in ERROR state).
+ ///
+ /// @param brokerRequest BrokerRequest for the query
+ /// @param segments segments for which instance needs to be selected
+ /// @param requestId requestId generated by the Broker for a query
+ /// @return instance of SelectionResult which describes the instance to pick for a given segment
SelectionResult select(BrokerRequest brokerRequest, List<String> segments, long requestId);
- /**
- * Returns the enabled server instances currently serving the table.
- */
+ /// Returns the enabled server instances currently serving the table.
Set<String> getServingInstances();
class SelectionResult {
@@ -95,38 +84,28 @@ public interface InstanceSelector {
_numPrunedSegments = numPrunedSegments;
}
- /**
- * Returns the map from segment to selected server instance hosting the segment.
- */
+ /// Returns the map from segment to selected server instance hosting the segment.
public Map<String, String> getSegmentToInstanceMap() {
return _segmentToInstanceMap.getLeft();
}
- /**
- * Returns the map from optional segment to selected server instance hosting the optional segment.
- * Optional segments can be skipped by broker or server upon any issue w/o failing the query.
- */
+ /// Returns the map from optional segment to selected server instance hosting the optional segment.
+ /// Optional segments can be skipped by broker or server upon any issue w/o failing the query.
public Map<String, String> getOptionalSegmentToInstanceMap() {
return _segmentToInstanceMap.getRight();
}
- /**
- * Returns the unavailable segments (no enabled instance or all enabled instances are in ERROR state).
- */
+ /// Returns the unavailable segments (no enabled instance or all enabled instances are in ERROR state).
public List<String> getUnavailableSegments() {
return _unavailableSegments;
}
- /**
- * Returns the number of segments pruned by the broker
- */
+ /// Returns the number of segments pruned by the broker
public int getNumPrunedSegments() {
return _numPrunedSegments;
}
- /**
- * Sets the number of segments pruned by the broker
- */
+ /// Sets the number of segments pruned by the broker
public void setNumPrunedSegments(int numPrunedSegments) {
_numPrunedSegments = numPrunedSegments;
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/MultiStageReplicaGroupSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/MultiStageReplicaGroupSelector.java
index 451b47dfe89..06dac8d64bf 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/MultiStageReplicaGroupSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/MultiStageReplicaGroupSelector.java
@@ -49,15 +49,13 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Instance selector for multi-stage queries which can ensure that Colocated Tables always leverage Colocated Join
- * whenever possible. To achieve this, this instance-selector uses InstancePartitions (IP) to determine replica-groups,
- * as opposed to IdealState used by other instance-selectors. Moreover, this also uses the requestId generated by
- * Pinot broker to determine the replica-group picked for each table involved in the query, as opposed to using a
- * member variable. There may be scenarios where an instance in the chosen replica-group is down. In that case, this
- * strategy will try to pick another replica-group. For realtime tables, this strategy uses only CONSUMING partitions.
- * This is feature is in <strong>Beta</strong>.
- */
+/// Instance selector for multi-stage queries which can ensure that Colocated Tables always leverage Colocated Join
+/// whenever possible. To achieve this, this instance-selector uses InstancePartitions (IP) to determine replica-groups,
+/// as opposed to IdealState used by other instance-selectors. Moreover, this also uses the requestId generated by
+/// Pinot broker to determine the replica-group picked for each table involved in the query, as opposed to using a
+/// member variable. There may be scenarios where an instance in the chosen replica-group is down. In that case, this
+/// strategy will try to pick another replica-group. For realtime tables, this strategy uses only CONSUMING partitions.
+/// This is feature is in **Beta**.
public class MultiStageReplicaGroupSelector extends BaseInstanceSelector {
private static final Logger LOGGER = LoggerFactory.getLogger(MultiStageReplicaGroupSelector.class);
@@ -106,24 +104,22 @@ public class MultiStageReplicaGroupSelector extends BaseInstanceSelector {
return assign(Sets.newHashSet(segments), segmentStates, instancePartitions, replicaGroupSelected);
}
- /**
- * Returns a map from the segmentName to the corresponding server. It tries to select all servers from the
- * preferredReplicaGroup, but if it fails, it will try to select the relevant server from other instance partitions.
- *
- * @return A pair of maps, where the first map contains the segments that are assigned to a server and the second
- * map contains the segments that are optional (i.e., the server is not online to serve that segment).
- * Example:
- * {
- * "required_segments": {
- * "segment1": "server1",
- * "segment2": "server2"
- * },
- * "optional_segments": {
- * "segment3": "server3",
- * "segment4": "server4"
- * }
- * }
- */
+ /// Returns a map from the segmentName to the corresponding server. It tries to select all servers from the
+ /// preferredReplicaGroup, but if it fails, it will try to select the relevant server from other instance partitions.
+ ///
+ /// @return A pair of maps, where the first map contains the segments that are assigned to a server and the second
+ /// map contains the segments that are optional (i.e., the server is not online to serve that segment).
+ /// Example:
+ /// {
+ /// "required_segments": {
+ /// "segment1": "server1",
+ /// "segment2": "server2"
+ /// },
+ /// "optional_segments": {
+ /// "segment3": "server3",
+ /// "segment4": "server4"
+ /// }
+ /// }
private Pair<Map<String, String>, Map<String, String>> assign(Set<String> segments,
SegmentStates segmentStates, InstancePartitions instancePartitions, int preferredReplicaId) {
Map<String, Integer> instanceToPartitionMap = instancePartitions.getInstanceToPartitionIdMap();
@@ -181,12 +177,10 @@ public class MultiStageReplicaGroupSelector extends BaseInstanceSelector {
_newSegmentExpirationTimeInSeconds * 1000);
}
- /**
- * This method selects the instances for the given partition and segments. It iterates over the replica groups
- * in a round-robin fashion, starting from the preferred replica group. It only selects the replica group if all
- * the segments are available in the selected instances.
- * If no replica group is found, it throws an exception.
- */
+ /// This method selects the instances for the given partition and segments. It iterates over the replica groups
+ /// in a round-robin fashion, starting from the preferred replica group. It only selects the replica group if all
+ /// the segments are available in the selected instances.
+ /// If no replica group is found, it throws an exception.
private void getSelectedInstancesForPartition(Map<String, Set<String>> instanceToSegmentsMap,
Set<String> requiredSegments, int partitionId, int preferredReplicaId,
Map<String, String> segmentToSelectedInstanceMapSink) {
@@ -225,10 +219,8 @@ public class MultiStageReplicaGroupSelector extends BaseInstanceSelector {
partitionId, _tableNameWithType));
}
- /**
- * Based on whether the selected instance for the segment is online to serve that segment or not,
- * this method computes the segments that are optional and the segments that are not.
- */
+ /// Based on whether the selected instance for the segment is online to serve that segment or not,
+ /// this method computes the segments that are optional and the segments that are not.
private Pair<Map<String, String>, Map<String, String>> computeOptionalSegments(
Map<String, String> segmentToSelectedInstanceMap, SegmentStates segmentStates) {
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/NewSegmentState.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/NewSegmentState.java
index 6cc186e7b87..b7d23ac37bc 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/NewSegmentState.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/NewSegmentState.java
@@ -22,9 +22,7 @@ import java.util.List;
import javax.annotation.concurrent.Immutable;
-/**
- * Contains the push time and candidate instances for a new segment.
- */
+/// Contains the push time and candidate instances for a new segment.
@Immutable
public class NewSegmentState {
// Segment creation time. This could be
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/ReplicaGroupInstanceSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/ReplicaGroupInstanceSelector.java
index 8f35ba28b6a..de15a5006c0 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/ReplicaGroupInstanceSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/ReplicaGroupInstanceSelector.java
@@ -39,32 +39,35 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Instance selector for replica-group routing strategy.
- * <p>The selection algorithm will always evenly distribute the traffic to all replicas of each segment, and will select
- * the same index of the enabled instances for all segments with the same number of replicas. The algorithm is very
- * light-weight and will do best effort to select the least servers for the request.
- * <p>The algorithm relies on the mirror segment assignment from replica-group segment assignment strategy. With mirror
- * segment assignment, any server in one replica-group will always have a corresponding server in other replica-groups
- * that have the same segments assigned. For an example, if S1 is a server in replica-group 1, and it has mirror server
- * S2 in replica-group 2 and S3 in replica-group 3. All segments assigned to S1 will also be assigned to S2 and S3. In
- * stable scenario (external view matches ideal state), all segments assigned to S1 will have the same enabled instances
- * of [S1, S2, S3] sorted (in alphabetical order). If we pick the same index of enabled instances for all segments for a
- * request, only one of S1, S2, S3 will be picked, so it is guaranteed that we pick the least server instances for the
- * request (there is no guarantee on choosing servers from the same replica-group though). In transitioning/error
- * scenario (external view does not match ideal state), there is no guarantee on picking the least server instances, but
- * the traffic is guaranteed to be evenly distributed to all available instances to avoid overwhelming hotspot servers.
- *<p> If the query option NUM_REPLICA_GROUPS_TO_QUERY is provided, the servers to be picked will be from different
- * replica groups such that segments are evenly distributed amongst the provided value of NUM_REPLICA_GROUPS_TO_QUERY.
- * Thus in case of [S1, S2, S3] if NUM_REPLICA_GROUPS_TO_QUERY = 2, the ReplicaGroup S1 and ReplicaGroup S2 will be
- * selected such that half the segments will come from S1 and other half from S2. If NUM_REPLICA_GROUPS_TO_QUERY value
- * is much greater than available servers, then ReplicaGroupInstanceSelector will behave similar to
- * BalancedInstanceSelector.
- * <p>If AdaptiveServerSelection is enabled, a single snapshot of the server ranking is fetched. This ranking is
- * referenced to pick the best available server for each segment. The algorithm ends up picking the minimum number of
- * servers required to process a query because it references a single snapshot of the server rankings. Currently,
- * NUM_REPLICA_GROUPS_TO_QUERY is not supported if AdaptiveServerSelection is enabled.
- */
+/// Instance selector for replica-group routing strategy.
+///
+/// The selection algorithm will always evenly distribute the traffic to all replicas of each segment, and will select
+/// the same index of the enabled instances for all segments with the same number of replicas. The algorithm is very
+/// light-weight and will do best effort to select the least servers for the request.
+///
+/// The algorithm relies on the mirror segment assignment from replica-group segment assignment strategy. With mirror
+/// segment assignment, any server in one replica-group will always have a corresponding server in other replica-groups
+/// that have the same segments assigned. For an example, if S1 is a server in replica-group 1, and it has mirror server
+/// S2 in replica-group 2 and S3 in replica-group 3. All segments assigned to S1 will also be assigned to S2 and S3. In
+/// stable scenario (external view matches ideal state), all segments assigned to S1 will have the same enabled
+/// instances of \[S1, S2, S3\] sorted (in alphabetical order). If we pick the same index of enabled instances for all
+/// segments for a request, only one of S1, S2, S3 will be picked, so it is guaranteed that we pick the least server
+/// instances for the request (there is no guarantee on choosing servers from the same replica-group though). In
+/// transitioning/error scenario (external view does not match ideal state), there is no guarantee on picking the least
+/// server instances, but the traffic is guaranteed to be evenly distributed to all available instances to avoid
+/// overwhelming hotspot servers.
+///
+/// If the query option NUM_REPLICA_GROUPS_TO_QUERY is provided, the servers to be picked will be from different
+/// replica groups such that segments are evenly distributed amongst the provided value of NUM_REPLICA_GROUPS_TO_QUERY.
+/// Thus in case of \[S1, S2, S3\] if NUM_REPLICA_GROUPS_TO_QUERY = 2, the ReplicaGroup S1 and ReplicaGroup S2 will be
+/// selected such that half the segments will come from S1 and other half from S2. If NUM_REPLICA_GROUPS_TO_QUERY value
+/// is much greater than available servers, then ReplicaGroupInstanceSelector will behave similar to
+/// BalancedInstanceSelector.
+///
+/// If AdaptiveServerSelection is enabled, a single snapshot of the server ranking is fetched. This ranking is
+/// referenced to pick the best available server for each segment. The algorithm ends up picking the minimum number of
+/// servers required to process a query because it references a single snapshot of the server rankings. Currently,
+/// NUM_REPLICA_GROUPS_TO_QUERY is not supported if AdaptiveServerSelection is enabled.
public class ReplicaGroupInstanceSelector extends BaseInstanceSelector {
private static final Logger LOGGER = LoggerFactory.getLogger(ReplicaGroupInstanceSelector.class);
@@ -175,19 +178,16 @@ public class ReplicaGroupInstanceSelector extends BaseInstanceSelector {
}
}
- /**
- *
- * <pre>
- * Instances unavailable for any old segment should not exist in _oldSegmentCandidatesMap or _newSegmentStateMap for
- * segments with the same instances in ideal state.
- *
- * The maps are calculated in the following steps to meet the strict replica-group guarantee:
- * 1. Compute the online instances for both old and new segments
- * 2. Compare online instances for old segments with instances in ideal state and gather the unavailable instances
- * for each set of instances
- * 3. Exclude the unavailable instances from the online instances map for both old and new segment map
- * </pre>
- */
+ /// ```
+ /// Instances unavailable for any old segment should not exist in _oldSegmentCandidatesMap or _newSegmentStateMap for
+ /// segments with the same instances in ideal state.
+ ///
+ /// The maps are calculated in the following steps to meet the strict replica-group guarantee:
+ /// 1. Compute the online instances for both old and new segments
+ /// 2. Compare online instances for old segments with instances in ideal state and gather the unavailable instances
+ /// for each set of instances
+ /// 3. Exclude the unavailable instances from the online instances map for both old and new segment map
+ /// ```
void updateSegmentMapsForUpsertTable(IdealState idealState, ExternalView externalView, Set<String> onlineSegments,
Map<String, Long> newSegmentCreationTimeMap) {
_oldSegmentCandidatesMap.clear();
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/SegmentInstanceCandidate.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/SegmentInstanceCandidate.java
index f90b573e1e6..f501ca8dfab 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/SegmentInstanceCandidate.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/SegmentInstanceCandidate.java
@@ -24,9 +24,7 @@ import javax.annotation.concurrent.Immutable;
import static org.apache.pinot.spi.utils.CommonConstants.Broker.FALLBACK_POOL_ID;
-/**
- * Represents an instance candidate for a segment.
- */
+/// Represents an instance candidate for a segment.
@Immutable
public class SegmentInstanceCandidate {
private final String _instance;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/SegmentStates.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/SegmentStates.java
index bfb56dd7bff..9348d482843 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/SegmentStates.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/SegmentStates.java
@@ -25,7 +25,7 @@ import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
-/// The {@code SegmentStates} contains the candidate instances for each segment, and the unavailable segments for
+/// The `SegmentStates` contains the candidate instances for each segment, and the unavailable segments for
/// routing purpose.
///
/// For old segments, the instance candidates should always have online flag set to true.
@@ -33,7 +33,6 @@ import javax.annotation.concurrent.Immutable;
///
/// For new segments, the online flag within the instance candidates indicates whether the instance is online or not.
/// We don't report new segments as unavailable segments because it is valid for new segments to be offline.
-///
@Immutable
public class SegmentStates {
private final Map<String, List<SegmentInstanceCandidate>> _instanceCandidatesMap;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/StrictReplicaGroupInstanceSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/StrictReplicaGroupInstanceSelector.java
index 04e3b25b359..b7c6675033d 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/StrictReplicaGroupInstanceSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/instanceselector/StrictReplicaGroupInstanceSelector.java
@@ -23,36 +23,34 @@ import java.util.Set;
import org.apache.helix.model.ExternalView;
import org.apache.helix.model.IdealState;
-/**
- * Instance selector for strict replica-group routing strategy.
- *
- * <pre>
- * The strict replica-group routing strategy always routes the query to the instances within the same replica-group.
- * (Note that the replica-group information is derived from the ideal state of the table, where the instances are sorted
- * alphabetically in the instance state map, so the replica-groups in the instance selector might not match the
- * replica-groups in the instance partitions). The goal of this algorithm is to ensure that segments from the same
- * partition are never served from multiple different instances. The instances in a replica-group should have all the
- * online segments (segments with ONLINE/CONSUMING instances in the ideal state and selected by the pre-selector)
- * available (ONLINE/CONSUMING in the external view) in order to serve queries. If any segment is unavailable in the
- * replica-group, we mark the whole replica-group down and not serve queries with this replica-group.
- *
- * The selection algorithm is the same as {@link ReplicaGroupInstanceSelector}, and will always evenly distribute the
- * traffic to all replica-groups that have all online segments available.
- *
- * The algorithm relies on the mirror segment assignment from replica-group segment assignment strategy. With mirror
- * segment assignment, any server in one replica-group will always have a corresponding server in other replica-groups
- * that have the same segments assigned. For example, if S1 is a server in replica-group 1, and it has mirror server
- * S2 in replica-group 2 and S3 in replica-group 3. All segments assigned to S1 will also be assigned to S2 and S3. In
- * stable scenario (external view matches ideal state), all segments assigned to S1 will have the same enabled instances
- * of [S1, S2, S3] sorted (in alphabetical order). If we always pick the same index of enabled instances for all
- * segments, only one of S1, S2, S3 will be picked, and all the segments are processed by the same server. In
- * transitioning/error scenario (external view does not match ideal state), if a segment is down on S1, we mark all
- * segments with the same assignment ([S1, S2, S3]) down on S1 to ensure that we always route the segments to the same
- * replica-group.
- *
- * Note that new segments won't be used to exclude instances from serving when the segment is unavailable.
- * </pre>
- */
+/// Instance selector for strict replica-group routing strategy.
+///
+/// ```
+/// The strict replica-group routing strategy always routes the query to the instances within the same replica-group.
+/// (Note that the replica-group information is derived from the ideal state of the table, where the instances are
+/// sorted alphabetically in the instance state map, so the replica-groups in the instance selector might not match the
+/// replica-groups in the instance partitions). The goal of this algorithm is to ensure that segments from the same
+/// partition are never served from multiple different instances. The instances in a replica-group should have all the
+/// online segments (segments with ONLINE/CONSUMING instances in the ideal state and selected by the pre-selector)
+/// available (ONLINE/CONSUMING in the external view) in order to serve queries. If any segment is unavailable in the
+/// replica-group, we mark the whole replica-group down and not serve queries with this replica-group.
+///
+/// The selection algorithm is the same as {@link ReplicaGroupInstanceSelector}, and will always evenly distribute the
+/// traffic to all replica-groups that have all online segments available.
+///
+/// The algorithm relies on the mirror segment assignment from replica-group segment assignment strategy. With mirror
+/// segment assignment, any server in one replica-group will always have a corresponding server in other replica-groups
+/// that have the same segments assigned. For example, if S1 is a server in replica-group 1, and it has mirror server S2
+/// in replica-group 2 and S3 in replica-group 3. All segments assigned to S1 will also be assigned to S2 and S3. In
+/// stable scenario (external view matches ideal state), all segments assigned to S1 will have the same enabled
+/// instances of [S1, S2, S3] sorted (in alphabetical order). If we always pick the same index of enabled instances for
+/// all segments, only one of S1, S2, S3 will be picked, and all the segments are processed by the same server. In
+/// transitioning/error scenario (external view does not match ideal state), if a segment is down on S1, we mark all
+/// segments with the same assignment ([S1, S2, S3]) down on S1 to ensure that we always route the segments to the same
+/// replica-group.
+///
+/// Note that new segments won't be used to exclude instances from serving when the segment is unavailable.
+/// ```
public class StrictReplicaGroupInstanceSelector extends ReplicaGroupInstanceSelector {
@Override
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/BaseBrokerRoutingManager.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/BaseBrokerRoutingManager.java
index aae1fa8ef7a..e0ccad18e36 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/BaseBrokerRoutingManager.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/BaseBrokerRoutingManager.java
@@ -106,28 +106,25 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * The {@code RoutingManager} manages the routing of all tables hosted by the broker instance. It listens to the cluster
- * changes and updates the routing components accordingly.
- * <p>The following methods are provided:
- * <ul>
- * <li>{@link #buildRouting(String)}: Builds/rebuilds the routing for a table</li>
- * <li>{@link #removeRouting(String)}: Removes the routing for a table</li>
- * <li>{@link #refreshSegment(String, String)}: Refreshes the metadata for a segment</li>
- * <li>{@link #routingExists(String)}: Returns whether the routing exists for a table</li>
- * <li>{@link #getRoutingTable(BrokerRequest, long)}: Returns the routing table for a query</li>
- * <li>{@link #getTimeBoundaryInfo(String)}: Returns the time boundary info for a table</li>
- * <li>{@link #getQueryTimeoutMs(String)}: Returns the table-level query timeout in milliseconds for a table</li>
- * </ul>
- *
- * LOCK ORDERING RULE: Always acquire locks in this order to prevent deadlocks:
- * 1. _globalLock (read or write)
- * 2. _routingTableBuildLocks (per rawTableName, grouping OFFLINE and REALTIME tables under a single lock)
- * Never hold table locks when trying to acquire global lock.
- *
- * TODO: Expose RoutingEntry class to get a consistent view in the broker request handler and save the redundant map
- * lookups.
- */
+/// The `RoutingManager` manages the routing of all tables hosted by the broker instance. It listens to the
+/// cluster changes and updates the routing components accordingly.
+///
+/// The following methods are provided:
+/// - [#buildRouting(String)]: Builds/rebuilds the routing for a table
+/// - [#removeRouting(String)]: Removes the routing for a table
+/// - [#refreshSegment(String, String)]: Refreshes the metadata for a segment
+/// - [#routingExists(String)]: Returns whether the routing exists for a table
+/// - [#getRoutingTable(BrokerRequest, long)]: Returns the routing table for a query
+/// - [#getTimeBoundaryInfo(String)]: Returns the time boundary info for a table
+/// - [#getQueryTimeoutMs(String)]: Returns the table-level query timeout in milliseconds for a table
+///
+/// LOCK ORDERING RULE: Always acquire locks in this order to prevent deadlocks:
+/// 1. \_globalLock (read or write)
+/// 2. \_routingTableBuildLocks (per rawTableName, grouping OFFLINE and REALTIME tables under a single lock)
+/// Never hold table locks when trying to acquire global lock.
+///
+/// TODO: Expose RoutingEntry class to get a consistent view in the broker request handler and save the redundant map
+/// lookups.
public abstract class BaseBrokerRoutingManager implements RoutingManager, ClusterChangeHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(BaseBrokerRoutingManager.class);
@@ -210,20 +207,16 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
_propertyStore = helixManager.getHelixPropertyStore();
}
- /**
- * Sets a callback to be invoked when a server is re-enabled after being excluded.
- * This is useful for resetting gRPC channel state to avoid exponential backoff delays.
- */
+ /// Sets a callback to be invoked when a server is re-enabled after being excluded.
+ /// This is useful for resetting gRPC channel state to avoid exponential backoff delays.
public void setServerReenableCallback(Consumer<ServerInstance> callback) {
_serverReenableCallback = callback;
}
- /**
- * Registers a provider of an extra {@link SegmentZkMetadataFetchListener} that is attached to every table's routing
- * entry, alongside the built-in segment pruners. The provider is invoked once per table with the table name with
- * type and may return {@code null} to skip a table. Must be called before routing is built (i.e. before the cluster
- * change mediator starts) so that all tables pick it up.
- */
+ /// Registers a provider of an extra [SegmentZkMetadataFetchListener] that is attached to every table's routing
+ /// entry, alongside the built-in segment pruners. The provider is invoked once per table with the table name with
+ /// type and may return `null` to skip a table. Must be called before routing is built (i.e. before the cluster
+ /// change mediator starts) so that all tables pick it up.
public void addSegmentZkMetadataFetchListenerProvider(Function<String, SegmentZkMetadataFetchListener> provider) {
_extraFetchListenerProviders.add(provider);
}
@@ -237,10 +230,8 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
return _routingTableBuildStartTimeMs.computeIfAbsent(tableNameWithType, k -> Long.MIN_VALUE);
}
- /**
- * This method is called from a method which is synchronized to prevent multiple calls to process cluster changes
- * Thus, this cannot have contention with itself, but it can have contention with other methods in this class
- */
+ /// This method is called from a method which is synchronized to prevent multiple calls to process cluster changes
+ /// Thus, this cannot have contention with itself, but it can have contention with other methods in this class
@Override
public void processClusterChange(ChangeType changeType) {
if (changeType == ChangeType.IDEAL_STATE || changeType == ChangeType.EXTERNAL_VIEW) {
@@ -366,10 +357,8 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
}
}
- /**
- * Returns true if the IS / EV version has changed (irrespective of whether the routing entry was updated), otherwise
- * return false
- */
+ /// Returns true if the IS / EV version has changed (irrespective of whether the routing entry was updated), otherwise
+ /// return false
private boolean processAssignmentChangeForTable(int idealStateVersion, int externalViewVersion,
RoutingEntry routingEntry) {
// Table lock must be held prior to calling this helper method
@@ -532,9 +521,7 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
return true;
}
- /**
- * Excludes a server from the routing.
- */
+ /// Excludes a server from the routing.
public void excludeServerFromRouting(String instanceId) {
_globalLock.writeLock().lock();
try {
@@ -577,9 +564,7 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
System.currentTimeMillis() - startTimeMs, _routingEntryMap.size());
}
- /**
- * Includes a previous excluded server to the routing.
- */
+ /// Includes a previous excluded server to the routing.
public void includeServerToRouting(String instanceId) {
_globalLock.writeLock().lock();
try {
@@ -626,10 +611,8 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
System.currentTimeMillis() - startTimeMs, _routingEntryMap.size());
}
- /**
- * Builds the routing for a logical table. This method is called when a logical table is created or updated.
- * @param logicalTableName the name of the logical table
- */
+ /// Builds the routing for a logical table. This method is called when a logical table is created or updated.
+ /// @param logicalTableName the name of the logical table
public void buildRoutingForLogicalTable(String logicalTableName) {
_globalLock.readLock().lock();
try {
@@ -704,10 +687,8 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
}
}
- /**
- * Builds the routing for a table.
- * @param tableNameWithType the name of the table
- */
+ /// Builds the routing for a table.
+ /// @param tableNameWithType the name of the table
public void buildRouting(String tableNameWithType) {
_globalLock.readLock().lock();
try {
@@ -949,9 +930,7 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
}
}
- /**
- * Returns the online segments (with ONLINE/CONSUMING instances) in the given ideal state.
- */
+ /// Returns the online segments (with ONLINE/CONSUMING instances) in the given ideal state.
private static Set<String> getOnlineSegments(IdealState idealState) {
Map<String, Map<String, String>> segmentAssignment = idealState.getRecord().getMapFields();
Set<String> onlineSegments = new HashSet<>(HashUtil.getHashMapCapacity(segmentAssignment.size()));
@@ -965,9 +944,7 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
return onlineSegments;
}
- /**
- * Removes the routing for the given table.
- */
+ /// Removes the routing for the given table.
public void removeRouting(String tableNameWithType) {
_globalLock.readLock().lock();
try {
@@ -1019,9 +996,7 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
}
}
- /**
- * Removes routing for logical tables
- */
+ /// Removes routing for logical tables
public void removeRoutingForLogicalTable(String logicalTableName) {
_globalLock.readLock().lock();
try {
@@ -1072,9 +1047,7 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
}
}
- /**
- * Refreshes the metadata for the given segment (called when segment is getting refreshed).
- */
+ /// Refreshes the metadata for the given segment (called when segment is getting refreshed).
public void refreshSegment(String tableNameWithType, String segment) {
_globalLock.readLock().lock();
try {
@@ -1098,19 +1071,15 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
}
}
- /**
- * Returns {@code true} if the routing exists for the given table.
- */
+ /// Returns `true` if the routing exists for the given table.
@Override
public boolean routingExists(String tableNameWithType) {
return _routingEntryMap.containsKey(tableNameWithType);
}
- /**
- * Returns whether the given table is enabled
- * @param tableNameWithType Table name with type
- * @return Whether the given table is enabled
- */
+ /// Returns whether the given table is enabled
+ /// @param tableNameWithType Table name with type
+ /// @return Whether the given table is enabled
@Override
public boolean isTableDisabled(String tableNameWithType) {
RoutingEntry routingEntry = _routingEntryMap.getOrDefault(tableNameWithType, null);
@@ -1121,11 +1090,10 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
}
}
- /**
- * Returns the routing table (a map from server instance to list of segments hosted by the server, and a list of
- * unavailable segments) based on the broker request, or {@code null} if the routing does not exist.
- * <p>NOTE: The broker request should already have the table suffix (_OFFLINE or _REALTIME) appended.
- */
+ /// Returns the routing table (a map from server instance to list of segments hosted by the server, and a list of
+ /// unavailable segments) based on the broker request, or `null` if the routing does not exist.
+ ///
+ /// NOTE: The broker request should already have the table suffix (\_OFFLINE or \_REALTIME) appended.
@Nullable
@Override
public RoutingTable getRoutingTable(BrokerRequest brokerRequest, long requestId) {
@@ -1243,11 +1211,10 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
return _externalViewPathPrefix + tableNameWithType;
}
- /**
- * Returns the time boundary info for the given offline table, or {@code null} if the routing or time boundary does
- * not exist.
- * <p>NOTE: Time boundary info is only available for the offline part of the hybrid table.
- */
+ /// Returns the time boundary info for the given offline table, or `null` if the routing or time boundary does
+ /// not exist.
+ ///
+ /// NOTE: Time boundary info is only available for the offline part of the hybrid table.
@Nullable
@Override
public TimeBoundaryInfo getTimeBoundaryInfo(String offlineTableName) {
@@ -1291,10 +1258,8 @@ public abstract class BaseBrokerRoutingManager implements RoutingManager, Cluste
return routingEntry._instanceSelector.getServingInstances();
}
- /**
- * Returns the table-level query timeout in milliseconds for the given table, or {@code null} if the timeout is not
- * configured in the table config.
- */
+ /// Returns the table-level query timeout in milliseconds for the given table, or `null` if the timeout is not
+ /// configured in the table config.
@Nullable
public Long getQueryTimeoutMs(String tableNameWithType) {
RoutingEntry routingEntry = _routingEntryMap.get(tableNameWithType);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManager.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManager.java
index 27cde679357..09dfbbcbed7 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManager.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManager.java
@@ -23,13 +23,11 @@ import org.apache.pinot.core.transport.server.routing.stats.ServerRoutingStatsMa
import org.apache.pinot.spi.env.PinotConfiguration;
-/**
- * Default broker routing manager implementation.
- *
- * <p>This class is a thin wrapper over {@link BaseBrokerRoutingManager} and exists primarily to provide the
- * canonical routing manager type for the local broker, while allowing specialized implementations
- * (e.g. remote-cluster routing managers) to extend the shared base behavior.
- */
+/// Default broker routing manager implementation.
+///
+/// This class is a thin wrapper over [BaseBrokerRoutingManager] and exists primarily to provide the
+/// canonical routing manager type for the local broker, while allowing specialized implementations
+/// (e.g. remote-cluster routing managers) to extend the shared base behavior.
public class BrokerRoutingManager extends BaseBrokerRoutingManager {
public BrokerRoutingManager(BrokerMetrics brokerMetrics, ServerRoutingStatsManager serverRoutingStatsManager,
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/MultiClusterRoutingManager.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/MultiClusterRoutingManager.java
index 38103db58bf..17d62a7ffad 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/MultiClusterRoutingManager.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/MultiClusterRoutingManager.java
@@ -41,15 +41,13 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * The {@code MultiClusterRoutingManager} implements the {@link RoutingManager} to support multi-cluster routing.
- * It contains a local {@link BrokerRoutingManager} and multiple remote {@link RemoteClusterBrokerRoutingManager}
- * instances. For each routing request, it first queries the local cluster routing manager, and then queries the remote
- * cluster routing managers to combine the results.
- * For example, when getting the routing table for a table, it first gets the routing table from the local cluster
- * routing manager, and then gets the routing tables from the remote cluster routing managers to merge into a combined
- * routing table.
- */
+/// The `MultiClusterRoutingManager` implements the [RoutingManager] to support multi-cluster routing.
+/// It contains a local [BrokerRoutingManager] and multiple remote [RemoteClusterBrokerRoutingManager]
+/// instances. For each routing request, it first queries the local cluster routing manager, and then queries the remote
+/// cluster routing managers to combine the results.
+/// For example, when getting the routing table for a table, it first gets the routing table from the local cluster
+/// routing manager, and then gets the routing tables from the remote cluster routing managers to merge into a combined
+/// routing table.
public class MultiClusterRoutingManager implements RoutingManager {
private static final Logger LOGGER = LoggerFactory.getLogger(MultiClusterRoutingManager.class);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/RemoteClusterBrokerRoutingManager.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/RemoteClusterBrokerRoutingManager.java
index 38d21cd9e11..11823d9afa7 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/RemoteClusterBrokerRoutingManager.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/manager/RemoteClusterBrokerRoutingManager.java
@@ -37,11 +37,9 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * The {@code RemoteClusterBrokerRoutingManager} manages the routing for a single remote Pinot cluster available for
- * federation. It periodically checks for changes in the set of tables available in the remote cluster and updates the
- * routing accordingly.
- */
+/// The `RemoteClusterBrokerRoutingManager` manages the routing for a single remote Pinot cluster available for
+/// federation. It periodically checks for changes in the set of tables available in the remote cluster and updates the
+/// routing accordingly.
public class RemoteClusterBrokerRoutingManager extends BaseBrokerRoutingManager {
private static final Logger LOGGER = LoggerFactory.getLogger(RemoteClusterBrokerRoutingManager.class);
private static final long ROUTING_CHANGE_DETECTION_INTERVAL_MS = 10_000L;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentmetadata/SegmentZkMetadataFetchListener.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentmetadata/SegmentZkMetadataFetchListener.java
index 138291089da..2fa7254700f 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentmetadata/SegmentZkMetadataFetchListener.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentmetadata/SegmentZkMetadataFetchListener.java
@@ -24,33 +24,26 @@ import javax.annotation.Nullable;
import org.apache.helix.model.ExternalView;
import org.apache.helix.model.IdealState;
import org.apache.helix.zookeeper.datamodel.ZNRecord;
-import org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector;
-/**
- * Interface to register with {@link SegmentZkMetadataFetcher}.
- *
- * <p>When registered, SegmentZKMetadataFetcher will fetch {@link ZNRecord} for associated {@code onlineSegments} list
- * or refreshed {@code segment}. Thus batch up all ZK access for segment metadata.
- */
+/// Interface to register with [SegmentZkMetadataFetcher].
+///
+/// When registered, SegmentZKMetadataFetcher will fetch [ZNRecord] for associated `onlineSegments` list
+/// or refreshed `segment`. Thus batch up all ZK access for segment metadata.
public interface SegmentZkMetadataFetchListener {
- /**
- * Initializes the segment pruner with the ideal state, external view and online segments (segments with
- * ONLINE/CONSUMING instances in the ideal state and pre-selected by the {@link SegmentPreSelector}). Should be called
- * only once before calling other methods.
- */
+ /// Initializes the segment pruner with the ideal state, external view and online segments (segments with
+ /// ONLINE/CONSUMING instances in the ideal state and pre-selected by the
+ /// [org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector]). Should be called only once before
+ /// calling other methods.
void init(IdealState idealState, ExternalView externalView, List<String> onlineSegments, List<ZNRecord> znRecords);
- /**
- * Processes the segment assignment (ideal state or external view) change based on the given online segments (segments
- * with ONLINE/CONSUMING instances in the ideal state and pre-selected by the {@link SegmentPreSelector}).
- */
+ /// Processes the segment assignment (ideal state or external view) change based on the given online segments
+ /// (segments with ONLINE/CONSUMING instances in the ideal state and pre-selected by the
+ /// [org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector]).
void onAssignmentChange(IdealState idealState, ExternalView externalView, Set<String> onlineSegments,
List<String> pulledSegments, List<ZNRecord> znRecords);
- /**
- * Refreshes the metadata for the given segment (called when segment is getting refreshed).
- */
+ /// Refreshes the metadata for the given segment (called when segment is getting refreshed).
void refreshSegment(String segment, @Nullable ZNRecord znRecord);
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentmetadata/SegmentZkMetadataFetcher.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentmetadata/SegmentZkMetadataFetcher.java
index b6d996e8f45..c272a1f63ef 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentmetadata/SegmentZkMetadataFetcher.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentmetadata/SegmentZkMetadataFetcher.java
@@ -30,10 +30,8 @@ import org.apache.helix.zookeeper.datamodel.ZNRecord;
import org.apache.pinot.common.metadata.ZKMetadataProvider;
-/**
- * {@code SegmentZkMetadataFetcher} is used to cache {@link ZNRecord} stored in {@link ZkHelixPropertyStore} for
- * segments.
- */
+/// `SegmentZkMetadataFetcher` is used to cache [ZNRecord] stored in [ZkHelixPropertyStore] for
+/// segments.
public class SegmentZkMetadataFetcher {
private final String _tableNameWithType;
private final ZkHelixPropertyStore<ZNRecord> _propertyStore;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpartition/SegmentPartitionMetadataManager.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpartition/SegmentPartitionMetadataManager.java
index 0794b6fce5c..03a15564575 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpartition/SegmentPartitionMetadataManager.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpartition/SegmentPartitionMetadataManager.java
@@ -43,14 +43,12 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * The {@code PartitionDataManager} manages partitions of a table. It manages
- * 1. all the online segments associated with the partition and their allocated servers
- * 2. all the replica of a specific segment.
- * It provides API to query
- * 1. For each partition ID, what are the servers that contains ALL segments belong to this partition ID.
- * 2. For each server, what are all the partition IDs and list of segments of those partition IDs on this server.
- */
+/// The `PartitionDataManager` manages partitions of a table. It manages
+/// 1. all the online segments associated with the partition and their allocated servers
+/// 2. all the replica of a specific segment.
+/// It provides API to query
+/// 1. For each partition ID, what are the servers that contains ALL segments belong to this partition ID.
+/// 2. For each server, what are all the partition IDs and list of segments of those partition IDs on this server.
public class SegmentPartitionMetadataManager implements SegmentZkMetadataFetchListener {
private static final Logger LOGGER = LoggerFactory.getLogger(SegmentPartitionMetadataManager.class);
private static final int INVALID_PARTITION_ID = -1;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpartition/SegmentPartitionUtils.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpartition/SegmentPartitionUtils.java
index 3ea19058567..5821b498815 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpartition/SegmentPartitionUtils.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpartition/SegmentPartitionUtils.java
@@ -40,13 +40,11 @@ public class SegmentPartitionUtils {
private static final Logger LOGGER = LoggerFactory.getLogger(SegmentPartitionUtils.class);
- /**
- * Returns the partition info for a given segment with single partition column.
- *
- * NOTE: Returns {@code null} when the ZNRecord is missing (could be transient Helix issue). Returns
- * {@link #INVALID_PARTITION_INFO} when the segment does not have valid partition metadata in its ZK metadata,
- * in which case we won't retry later.
- */
+ /// Returns the partition info for a given segment with single partition column.
+ ///
+ /// NOTE: Returns `null` when the ZNRecord is missing (could be transient Helix issue). Returns
+ /// [#INVALID_PARTITION_INFO] when the segment does not have valid partition metadata in its ZK metadata,
+ /// in which case we won't retry later.
@Nullable
public static SegmentPartitionInfo extractPartitionInfo(String tableNameWithType, String partitionColumn,
String segment, @Nullable ZNRecord znRecord) {
@@ -83,13 +81,11 @@ public class SegmentPartitionUtils {
columnPartitionMetadata.getPartitions());
}
- /**
- * Returns a map from partition column name to partition info for a given segment with multiple partition columns.
- *
- * NOTE: Returns {@code null} when the ZNRecord is missing (could be transient Helix issue). Returns
- * {@link #INVALID_COLUMN_PARTITION_INFO_MAP} when the segment does not have valid partition metadata in its ZK
- * metadata, in which case we won't retry later.
- */
+ /// Returns a map from partition column name to partition info for a given segment with multiple partition columns.
+ ///
+ /// NOTE: Returns `null` when the ZNRecord is missing (could be transient Helix issue). Returns
+ /// [#INVALID_COLUMN_PARTITION_INFO_MAP] when the segment does not have valid partition metadata in its ZK
+ /// metadata, in which case we won't retry later.
@Nullable
public static Map<String, SegmentPartitionInfo> extractPartitionInfoMap(String tableNameWithType,
Set<String> partitionColumns, String segment, @Nullable ZNRecord znRecord) {
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpreselector/SegmentLineageBasedSegmentPreSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpreselector/SegmentLineageBasedSegmentPreSelector.java
index c6dfd83db53..5fdd7ea41aa 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpreselector/SegmentLineageBasedSegmentPreSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpreselector/SegmentLineageBasedSegmentPreSelector.java
@@ -26,12 +26,10 @@ import org.apache.pinot.common.lineage.SegmentLineageAccessHelper;
import org.apache.pinot.common.lineage.SegmentLineageUtils;
-/**
- * Segment lineage based segment pre-selector
- *
- * This pre-selector reads the segment lineage metadata and filters out either merged segments or original segments
- * to make sure that the final segments contain no duplicate data.
- */
+/// Segment lineage based segment pre-selector
+///
+/// This pre-selector reads the segment lineage metadata and filters out either merged segments or original segments
+/// to make sure that the final segments contain no duplicate data.
public class SegmentLineageBasedSegmentPreSelector implements SegmentPreSelector {
private final String _tableNameWithType;
private final ZkHelixPropertyStore<ZNRecord> _propertyStore;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpreselector/SegmentPreSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpreselector/SegmentPreSelector.java
index bb07bdd810d..ee865e7d053 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpreselector/SegmentPreSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpreselector/SegmentPreSelector.java
@@ -21,21 +21,14 @@ package org.apache.pinot.broker.routing.segmentpreselector;
import java.util.Set;
-/**
- * The segment pre-selector filters the unnecessary online segments for the query.
- * <p>Segment pre-selector examples:
- * <ul>
- * <li>
- * For table with segment merge/rollup enabled, select the merged segments over the original segments with the same
- * data
- * </li>
- * </ul>
- */
+/// The segment pre-selector filters the unnecessary online segments for the query.
+///
+/// Segment pre-selector examples:
+/// - For table with segment merge/rollup enabled, select the merged segments over the original segments with the
+/// same data
public interface SegmentPreSelector {
- /**
- * Pre-selects the online segments to filter out the unnecessary segments. This method might modify the online segment
- * set passed in.
- */
+ /// Pre-selects the online segments to filter out the unnecessary segments. This method might modify the online
+ /// segment set passed in.
Set<String> preSelect(Set<String> onlineSegments);
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/EmptySegmentPruner.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/EmptySegmentPruner.java
index aeb6a01f2e9..afca6f6d3bb 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/EmptySegmentPruner.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/EmptySegmentPruner.java
@@ -33,10 +33,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * The {@code EmptySegmentPruner} prunes segments if they have 0 total docs.
- * It does not prune segments with -1 total docs (that can be either error case or CONSUMING segment).
- */
+/// The `EmptySegmentPruner` prunes segments if they have 0 total docs.
+/// It does not prune segments with -1 total docs (that can be either error case or CONSUMING segment).
public class EmptySegmentPruner implements SegmentPruner {
private static final Logger LOGGER = LoggerFactory.getLogger(EmptySegmentPruner.class);
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/MultiPartitionColumnsSegmentPruner.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/MultiPartitionColumnsSegmentPruner.java
index 6970d3f54ea..929d03abba9 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/MultiPartitionColumnsSegmentPruner.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/MultiPartitionColumnsSegmentPruner.java
@@ -38,10 +38,8 @@ import org.apache.pinot.common.request.context.RequestContextUtils;
import org.apache.pinot.sql.FilterKind;
-/**
- * The {@code MultiPartitionColumnsSegmentPruner} prunes segments based on their partition metadata stored in ZK. The
- * pruner supports queries with filter (or nested filter) of EQUALITY and IN predicates.
- */
+/// The `MultiPartitionColumnsSegmentPruner` prunes segments based on their partition metadata stored in ZK. The
+/// pruner supports queries with filter (or nested filter) of EQUALITY and IN predicates.
public class MultiPartitionColumnsSegmentPruner implements SegmentPruner {
private final String _tableNameWithType;
private final Set<String> _partitionColumns;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/SegmentPruner.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/SegmentPruner.java
index 17e92e5c158..58711ec39bf 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/SegmentPruner.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/SegmentPruner.java
@@ -23,13 +23,9 @@ import org.apache.pinot.broker.routing.segmentmetadata.SegmentZkMetadataFetchLis
import org.apache.pinot.common.request.BrokerRequest;
-/**
- * The segment pruner prunes the selected segments based on the query.
- */
+/// The segment pruner prunes the selected segments based on the query.
public interface SegmentPruner extends SegmentZkMetadataFetchListener {
- /**
- * Prunes the segments queried by the given broker request, returns the selected segments to be queried.
- */
+ /// Prunes the segments queried by the given broker request, returns the selected segments to be queried.
Set<String> prune(BrokerRequest brokerRequest, Set<String> segments);
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/SinglePartitionColumnSegmentPruner.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/SinglePartitionColumnSegmentPruner.java
index 7016484e48c..3e672b88686 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/SinglePartitionColumnSegmentPruner.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/SinglePartitionColumnSegmentPruner.java
@@ -37,10 +37,8 @@ import org.apache.pinot.common.request.context.RequestContextUtils;
import org.apache.pinot.sql.FilterKind;
-/**
- * The {@code SinglePartitionColumnSegmentPruner} prunes segments based on their partition metadata stored in ZK. The
- * pruner supports queries with filter (or nested filter) of EQUALITY and IN predicates.
- */
+/// The `SinglePartitionColumnSegmentPruner` prunes segments based on their partition metadata stored in ZK. The
+/// pruner supports queries with filter (or nested filter) of EQUALITY and IN predicates.
public class SinglePartitionColumnSegmentPruner implements SegmentPruner {
private final String _tableNameWithType;
private final String _partitionColumn;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/TimeSegmentPruner.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/TimeSegmentPruner.java
index 56c5546a2d6..19ef2ee0cc4 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/TimeSegmentPruner.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/TimeSegmentPruner.java
@@ -48,11 +48,9 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * The {@code TimeSegmentPruner} prunes segments based on their time column start & end time metadata stored in ZK.
- * The pruner
- * supports queries with filter (or nested filter) of EQUALITY and RANGE predicates.
- */
+/// The `TimeSegmentPruner` prunes segments based on their time column start & end time metadata stored in ZK.
+/// The pruner
+/// supports queries with filter (or nested filter) of EQUALITY and RANGE predicates.
public class TimeSegmentPruner implements SegmentPruner {
private static final Logger LOGGER = LoggerFactory.getLogger(TimeSegmentPruner.class);
private static final long MIN_START_TIME = 0;
@@ -125,11 +123,9 @@ public class TimeSegmentPruner implements SegmentPruner {
_intervalTree = new IntervalTree<>(_intervalMap);
}
- /**
- * NOTE: Pruning is done by searching _intervalTree based on request time interval and check if the results
- * are in the input segments. By doing so we will have run time O(M * logN) (N: # of all online segments,
- * M: # of qualified intersected segments).
- */
+ /// NOTE: Pruning is done by searching \_intervalTree based on request time interval and check if the results
+ /// are in the input segments. By doing so we will have run time O(M \* logN) (N: # of all online segments,
+ /// M: # of qualified intersected segments).
@Override
public Set<String> prune(BrokerRequest brokerRequest, Set<String> segments) {
IntervalTree<String> intervalTree = _intervalTree;
@@ -159,16 +155,14 @@ public class TimeSegmentPruner implements SegmentPruner {
return selectedSegments;
}
- /**
- * @return Null if no time condition or cannot filter base on the condition (e.g. 'SELECT * from myTable where time
- * < 50 OR firstName = Jason')
- * Empty list if time condition is specified but invalid (e.g. 'SELECT * from myTable where time < 50 AND
- * time > 100')
- * Sorted time intervals without overlapping if time condition is valid
- *
- * TODO: 1. Merge adjacent intervals
- * 2. Set interval boundary using time granularity instead of millis
- */
+ /// @return Null if no time condition or cannot filter base on the condition (e.g. 'SELECT \* from myTable where time
+ /// < 50 OR firstName = Jason')
+ /// Empty list if time condition is specified but invalid (e.g. 'SELECT * from myTable where time < 50 AND
+ /// time > 100')
+ /// Sorted time intervals without overlapping if time condition is valid
+ ///
+ /// TODO: 1. Merge adjacent intervals
+ /// 2. Set interval boundary using time granularity instead of millis
@Nullable
private List<Interval> getFilterTimeIntervals(Expression filterExpression) {
Function function = filterExpression.getFunctionCall();
@@ -277,10 +271,9 @@ public class TimeSegmentPruner implements SegmentPruner {
return getIntersectionTwoSortedIntervals(interval1, interval2);
}
- /**
- * Intersect two list of non-overlapping sorted intervals.
- * E.g. {[1, 3], [4, 6], [7, 8], [10, 10]} and {[2, 5], [7, 9]} are merged as {[2, 3], [4, 5], [7, 8]}
- */
+ /// Intersect two list of non-overlapping sorted intervals.
+ /// E.g. {\[1, 3\], \[4, 6\], \[7, 8\], \[10, 10\]} and {\[2, 5\], \[7, 9\]} are merged as {\[2, 3\], \[4, 5\], \[7,
+ /// 8\]}
private List<Interval> getIntersectionTwoSortedIntervals(List<Interval> intervals1, List<Interval> intervals2) {
List<Interval> res = new ArrayList<>();
int size1 = intervals1.size();
@@ -318,10 +311,8 @@ public class TimeSegmentPruner implements SegmentPruner {
return getUnionTwoSortedIntervals(intervals1, intervals2);
}
- /**
- * Union two list of non-overlapping sorted intervals.
- * E.g. {[1, 2], [5, 7], [9, 10]} and {[2, 3], [4, 8]} are merged as {[1, 3], [4, 8], [9, 10]}
- */
+ /// Union two list of non-overlapping sorted intervals.
+ /// E.g. {\[1, 2\], \[5, 7\], \[9, 10\]} and {\[2, 3\], \[4, 8\]} are merged as {\[1, 3\], \[4, 8\], \[9, 10\]}
private List<Interval> getUnionTwoSortedIntervals(List<Interval> intervals1, List<Interval> intervals2) {
List<Interval> res = new ArrayList<>();
int size1 = intervals1.size();
@@ -348,9 +339,7 @@ public class TimeSegmentPruner implements SegmentPruner {
return res;
}
- /**
- * Returns the complement (non-overlapping sorted intervals) of the given non-overlapping sorted intervals.
- */
+ /// Returns the complement (non-overlapping sorted intervals) of the given non-overlapping sorted intervals.
private List<Interval> getComplementSortedIntervals(List<Interval> intervals) {
List<Interval> res = new ArrayList<>();
long startTime = MIN_START_TIME;
@@ -393,10 +382,8 @@ public class TimeSegmentPruner implements SegmentPruner {
return _timeFormatSpec.fromFormatToMillis(value);
}
- /**
- * Parse interval to millisecond as [min, max] with both sides included.
- * E.g. '(* 16311]' is parsed as [0, 16311], '(1455 16311)' is parsed as [1456, 16310]
- */
+ /// Parse interval to millisecond as \[min, max\] with both sides included.
+ /// E.g. '(\* 16311\]' is parsed as \[0, 16311\], '(1455 16311)' is parsed as \[1456, 16310\]
private List<Interval> parseInterval(String rangeString) {
long startTime = MIN_START_TIME;
long endTime = MAX_END_TIME;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/interval/Interval.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/interval/Interval.java
index b61e75cddeb..b4f5f171694 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/interval/Interval.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/interval/Interval.java
@@ -22,9 +22,7 @@ import com.google.common.base.Preconditions;
import javax.annotation.Nullable;
-/**
- * The {@code Interval} class represents an one-dimensional closed interval which contains both ends.
- */
+/// The `Interval` class represents an one-dimensional closed interval which contains both ends.
public class Interval implements Comparable<Interval> {
public final long _min;
public final long _max;
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/interval/IntervalTree.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/interval/IntervalTree.java
index 7c65916c8ed..59d6dcc95dd 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/interval/IntervalTree.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentpruner/interval/IntervalTree.java
@@ -28,9 +28,7 @@ import java.util.Map;
import org.apache.pinot.spi.utils.Pairs;
-/**
- * The {@code IntervalTree} class represents read-only balanced binary interval tree map (from intervals to values)
- */
+/// The `IntervalTree` class represents read-only balanced binary interval tree map (from intervals to values)
public class IntervalTree<VALUE> {
// List representation of BST with root at index 0. For node with index x, it's left child index is (2x+1), right
@@ -53,16 +51,14 @@ public class IntervalTree<VALUE> {
buildAuxiliaryInfo();
}
- /**
- * Build interval bst by bfs, the root for each subtree will be the one with median interval.
- * A typical balanced tree:
- * [10, 20]
- * / \
- * [8, 15] [12, 20]
- * / /
- * [5, 10] [10, 30]
- * is represented as { [10, 20], [8, 15], [12, 20], [5, 10], null, [10, 30] }
- */
+ /// Build interval bst by bfs, the root for each subtree will be the one with median interval.
+ /// A typical balanced tree:
+ /// \[10, 20\]
+ /// / \
+ /// \[8, 15\] \[12, 20\]
+ /// / /
+ /// \[5, 10\] \[10, 30\]
+ /// is represented as { \[10, 20\], \[8, 15\], \[12, 20\], \[5, 10\], null, \[10, 30\] }
private List<Node> buildIntervalTree(List<Node<VALUE>> sortedNodes) {
List<Node> resNodes = new ArrayList<>();
LinkedList<Pairs.IntPair> indexQueue = new LinkedList<>();
@@ -122,12 +118,10 @@ public class IntervalTree<VALUE> {
return _nodes.get(index)._max;
}
- /**
- * Find all values whose intervals intersect with the input interval.
- *
- * @param searchInterval search interval
- * @return list of all qualified values.
- */
+ /// Find all values whose intervals intersect with the input interval.
+ ///
+ /// @param searchInterval search interval
+ /// @return list of all qualified values.
public List<VALUE> searchAll(Interval searchInterval) {
List<VALUE> list = new ArrayList<>();
if (searchInterval == null) {
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentselector/SegmentSelector.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentselector/SegmentSelector.java
index 76c0ba3b378..d3e8ac8e5de 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentselector/SegmentSelector.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/segmentselector/SegmentSelector.java
@@ -21,32 +21,25 @@ package org.apache.pinot.broker.routing.segmentselector;
import java.util.Set;
import org.apache.helix.model.ExternalView;
import org.apache.helix.model.IdealState;
-import org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector;
import org.apache.pinot.common.request.BrokerRequest;
-/**
- * The segment selector selects the segments for the query. The segments selected should cover the whole dataset (table)
- * without overlap.
- */
+/// The segment selector selects the segments for the query. The segments selected should cover the whole dataset
+/// (table) without overlap.
public interface SegmentSelector {
- /**
- * Initializes the segment selector with the ideal state, external view and online segments (segments with
- * ONLINE/CONSUMING instances in the ideal state and pre-selected by the {@link SegmentPreSelector}). Should be called
- * only once before calling other methods.
- */
+ /// Initializes the segment selector with the ideal state, external view and online segments (segments with
+ /// ONLINE/CONSUMING instances in the ideal state and pre-selected by the
+ /// [org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector]). Should be called only once before
+ /// calling other methods.
void init(IdealState idealState, ExternalView externalView, Set<String> onlineSegments);
- /**
- * Processes the segment assignment (ideal state or external view) change based on the given online segments (segments
- * with ONLINE/CONSUMING instances in the ideal state and pre-selected by the {@link SegmentPreSelector}).
- */
+ /// Processes the segment assignment (ideal state or external view) change based on the given online segments
+ /// (segments with ONLINE/CONSUMING instances in the ideal state and pre-selected by the
+ /// [org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector]).
void onAssignmentChange(IdealState idealState, ExternalView externalView, Set<String> onlineSegments);
- /**
- * Selects the segments queried by the given broker request. The segments selected should cover the whole dataset
- * (table) without overlap.
- */
+ /// Selects the segments queried by the given broker request. The segments selected should cover the whole dataset
+ /// (table) without overlap.
Set<String> select(BrokerRequest brokerRequest);
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/FirstNSegmentsTableSampler.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/FirstNSegmentsTableSampler.java
index 2e8f2fd8598..d2da47e9ba5 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/FirstNSegmentsTableSampler.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/FirstNSegmentsTableSampler.java
@@ -32,14 +32,11 @@ import org.apache.pinot.spi.config.table.TableConfig;
import org.apache.pinot.spi.config.table.sampler.TableSamplerConfig;
-/**
- * Selects the first N segments after sorting segment names lexicographically.
- *
- * <p>Config:
- * <ul>
- * <li>{@code properties.numSegments}: positive integer</li>
- * </ul>
- */
+/// Selects the first N segments after sorting segment names lexicographically.
+///
+/// Config:
+///
+/// - `properties.numSegments`: positive integer
@TableSamplerProvider(name = FirstNSegmentsTableSampler.TYPE)
public class FirstNSegmentsTableSampler implements TableSampler {
public static final String TYPE = "firstN";
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/TableSampler.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/TableSampler.java
index 1bc88ffc1ba..c520536b64c 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/TableSampler.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/TableSampler.java
@@ -25,24 +25,18 @@ import org.apache.pinot.spi.config.table.TableConfig;
import org.apache.pinot.spi.config.table.sampler.TableSamplerConfig;
-/**
- * A {@code TableSampler} deterministically selects a subset of segments from the set of online segments for a table.
- *
- * <p>Selection is performed during routing table build/update so there is no additional per-query overhead beyond
- * selecting the pre-built routing entry.
- */
+/// A `TableSampler` deterministically selects a subset of segments from the set of online segments for a table.
+///
+/// Selection is performed during routing table build/update so there is no additional per-query overhead beyond
+/// selecting the pre-built routing entry.
public interface TableSampler {
- /**
- * Initializes the sampler for a specific table and sampler config.
- */
+ /// Initializes the sampler for a specific table and sampler config.
void init(TableConfig tableConfig, TableSamplerConfig samplerConfig, ZkHelixPropertyStore<ZNRecord> propertyStore);
- /**
- * Selects a subset of segments from the provided online segments.
- *
- * <p>Implementations must not mutate the input set because the same pre-selected segment set can be reused by
- * multiple samplers. Implementations must return a non-null set.
- */
+ /// Selects a subset of segments from the provided online segments.
+ ///
+ /// Implementations must not mutate the input set because the same pre-selected segment set can be reused by
+ /// multiple samplers. Implementations must return a non-null set.
Set<String> sampleSegments(Set<String> onlineSegments);
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/TableSamplerFactory.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/TableSamplerFactory.java
index 1be8b236952..71c4924df86 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/TableSamplerFactory.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/tablesampler/TableSamplerFactory.java
@@ -153,11 +153,9 @@ public class TableSamplerFactory {
return REGISTERED_TABLE_SAMPLER_CLASS_MAP.get(normalizeType(type));
}
- /**
- * Normalizes a table sampler alias for registry lookup.
- *
- * <p>Both registration and lookup go through this method, so aliases are matched case-insensitively after trimming.
- */
+ /// Normalizes a table sampler alias for registry lookup.
+ ///
+ /// Both registration and lookup go through this method, so aliases are matched case-insensitively after trimming.
private static String normalizeType(String type) {
return type.trim().toLowerCase(Locale.ROOT);
}
diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/timeboundary/TimeBoundaryManager.java b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/timeboundary/TimeBoundaryManager.java
index b7987a83fd7..18256275af9 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/routing/timeboundary/TimeBoundaryManager.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/routing/timeboundary/TimeBoundaryManager.java
@@ -31,7 +31,6 @@ import org.apache.helix.model.ExternalView;
import org.apache.helix.model.IdealState;
import org.apache.helix.store.zk.ZkHelixPropertyStore;
import org.apache.helix.zookeeper.datamodel.ZNRecord;
-import org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector;
import org.apache.pinot.common.metadata.ZKMetadataProvider;
import org.apache.pinot.common.metadata.segment.SegmentZKMetadata;
import org.apache.pinot.common.metrics.BrokerGauge;
@@ -49,10 +48,9 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * The {@code TimeBoundaryManager} class manages the time boundary information for a table.
- * <p>TODO: Support SDF (simple date format) time column
- */
+/// The `TimeBoundaryManager` class manages the time boundary information for a table.
+///
+/// TODO: Support SDF (simple date format) time column
public class TimeBoundaryManager {
private static final Logger LOGGER = LoggerFactory.getLogger(TimeBoundaryManager.class);
private static final long INVALID_TIME_MS = -1;
@@ -102,13 +100,13 @@ public class TimeBoundaryManager {
_timeColumn, dateTimeSpec.getFormat(), isHourlyTable, _offlineTableName);
}
- /**
- * Initializes the time boundary manager with the ideal state, external view and online segments (segments with
- * ONLINE/CONSUMING instances in the ideal state and pre-selected by the {@link SegmentPreSelector}). Should be called
- * only once before calling other methods.
- * <p>NOTE: {@code idealState} and {@code externalView} are unused, but intentionally passed in in case they are
- * needed in the future.
- */
+ /// Initializes the time boundary manager with the ideal state, external view and online segments (segments with
+ /// ONLINE/CONSUMING instances in the ideal state and pre-selected by the
+ /// [org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector]). Should be called only once before
+ /// calling other methods.
+ ///
+ /// NOTE: `idealState` and `externalView` are unused, but intentionally passed in in case they are
+ /// needed in the future.
@SuppressWarnings("unused")
public void init(IdealState idealState, ExternalView externalView, Set<String> onlineSegments) {
updateExplicitlySetTimeBoundary(idealState);
@@ -195,13 +193,14 @@ public class TimeBoundaryManager {
}
}
- /**
- * Processes the segment assignment (ideal state or external view) change based on the given online segments (segments
- * with ONLINE/CONSUMING instances in the ideal state and pre-selected by the {@link SegmentPreSelector}).
- * <p>NOTE: We don't update all the segment ZK metadata for every external view change, but only the new added/removed
- * ones. The refreshed segment ZK metadata change won't be picked up.
- * <p>NOTE: {@code idealState} is unused, but intentionally passed in in case it is needed in the future.
- */
+ /// Processes the segment assignment (ideal state or external view) change based on the given online segments
+ /// (segments with ONLINE/CONSUMING instances in the ideal state and pre-selected by the
+ /// [org.apache.pinot.broker.routing.segmentpreselector.SegmentPreSelector]).
+ ///
+ /// NOTE: We don't update all the segment ZK metadata for every external view change, but only the new added/removed
+ /// ones. The refreshed segment ZK metadata change won't be picked up.
+ ///
+ /// NOTE: `idealState` is unused, but intentionally passed in in case it is needed in the future.
@SuppressWarnings("unused")
public synchronized void onAssignmentChange(IdealState idealState, ExternalView externalView,
Set<String> onlineSegments) {
@@ -228,9 +227,7 @@ public class TimeBoundaryManager {
return maxEndTimeMs;
}
- /**
- * Refreshes the metadata for the given segment (called when segment is getting refreshed).
- */
+ /// Refreshes the metadata for the given segment (called when segment is getting refreshed).
public synchronized void refreshSegment(String segment) {
_endTimeMsMap.put(segment, extractEndTimeMsFromSegmentZKMetadataZNRecord(segment,
_propertyStore.get(_segmentZKMetadataPathPrefix + segment, null, AccessOption.PERSISTENT)));
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/broker/HelixBrokerStarterTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/broker/HelixBrokerStarterTest.java
index 0118907e840..180d72a13d2 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/broker/HelixBrokerStarterTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/broker/HelixBrokerStarterTest.java
@@ -222,9 +222,7 @@ public class HelixBrokerStarterTest extends ControllerTest {
assertTrue(routingManager.routingExists(newOfflineTableName));
}
- /**
- * This test verifies that when the segments of an OFFLINE are refreshed, the TimeBoundaryInfo is also updated.
- */
+ /// This test verifies that when the segments of an OFFLINE are refreshed, the TimeBoundaryInfo is also updated.
@Test
public void testTimeBoundaryUpdate() {
BrokerRoutingManager routingManager = _brokerStarter.getRoutingManager();
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/broker/helix/ClusterChangeMediatorTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/broker/helix/ClusterChangeMediatorTest.java
index feb78a6321e..955a3d05e32 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/broker/helix/ClusterChangeMediatorTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/broker/helix/ClusterChangeMediatorTest.java
@@ -37,15 +37,13 @@ import static org.mockito.Mockito.mock;
public class ClusterChangeMediatorTest {
private final Lock _lock = new ReentrantLock();
- /**
- * Tests the potential deadlock between Helix callback handling thread and ClusterChangeMediator change handling
- * thread when the ClusterChangeMediator is stopped.
- * The deadlock chain is as following:
- * - ClusterChangeMediator.stop() is called and waiting for the change handling thread to stop
- * - Helix callback handling thread acquires a lock, then send a cluster change to the mediator which is blocked
- * ClusterChangeMediator.stop() (both stop() and enqueueChange() are synchronized)
- * - The change handling thread waits on the lock held by the Helix callback handling thread
- */
+ /// Tests the potential deadlock between Helix callback handling thread and ClusterChangeMediator change handling
+ /// thread when the ClusterChangeMediator is stopped.
+ /// The deadlock chain is as following:
+ /// - ClusterChangeMediator.stop() is called and waiting for the change handling thread to stop
+ /// - Helix callback handling thread acquires a lock, then send a cluster change to the mediator which is blocked
+ /// ClusterChangeMediator.stop() (both stop() and enqueueChange() are synchronized)
+ /// - The change handling thread waits on the lock held by the Helix callback handling thread
@Test
public void testDeadLock() {
ClusterChangeMediator mediator = new ClusterChangeMediator(
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/cursors/FsResponseStoreTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/cursors/FsResponseStoreTest.java
index 147fa96f627..bd7f123f122 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/cursors/FsResponseStoreTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/cursors/FsResponseStoreTest.java
@@ -108,10 +108,8 @@ public class FsResponseStoreTest {
overwriteExpiration(requestId, expirationTimeMs, brokerId);
}
- /**
- * Overwrites the metadata file to set custom expirationTimeMs and brokerId,
- * since storeResponse() auto-calculates expiration from current time.
- */
+ /// Overwrites the metadata file to set custom expirationTimeMs and brokerId,
+ /// since storeResponse() auto-calculates expiration from current time.
private void overwriteExpiration(String requestId, long expirationTimeMs, String brokerId)
throws Exception {
CursorResponse response = _store.readResponse(requestId);
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/grpc/BrokerGrpcServerTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/grpc/BrokerGrpcServerTest.java
index 542b02a3e67..a8f293c26a3 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/grpc/BrokerGrpcServerTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/grpc/BrokerGrpcServerTest.java
@@ -256,9 +256,7 @@ public class BrokerGrpcServerTest {
"true", "Without the metadata flag, the SQL-set option must be preserved");
}
- /**
- * Helper method to create a mock StreamObserver that captures all responses.
- */
+ /// Helper method to create a mock StreamObserver that captures all responses.
private StreamObserver<Broker.BrokerResponse> createMockStreamObserver(List<Broker.BrokerResponse> responses) {
@SuppressWarnings("unchecked")
StreamObserver<Broker.BrokerResponse> observer = mock(StreamObserver.class);
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/BaseSingleStageBrokerRequestHandlerTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/BaseSingleStageBrokerRequestHandlerTest.java
index 845e80d5224..1c0f303e66b 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/BaseSingleStageBrokerRequestHandlerTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/BaseSingleStageBrokerRequestHandlerTest.java
@@ -579,17 +579,16 @@ public class BaseSingleStageBrokerRequestHandlerTest {
"(1772109900000" + Range.DELIMITER + "1772113500000]", "Realtime mixed");
}
- /**
- * Bug: FULL_REWRITE overwrites tableName to the materialized view table name, so
- * _queryQuotaManager.acquire(tableName) charges quota against the MV
- * instead of the base table. A throttled base table is effectively
- * bypassed when its quota allows no traffic but the MV has no quota entry.
- *
- * <p>Before fix: acquire("baseTable_OFFLINE") is never called; the MV
- * table passes because the mock only denies the base table name.
- * <p>After fix: the base table name is used for quota accounting and the
- * request is correctly rate-limited.
- */
+ /// Bug: FULL_REWRITE overwrites tableName to the materialized view table name, so
+ /// \_queryQuotaManager.acquire(tableName) charges quota against the MV
+ /// instead of the base table. A throttled base table is effectively
+ /// bypassed when its quota allows no traffic but the MV has no quota entry.
+ ///
+ /// Before fix: acquire("baseTable_OFFLINE") is never called; the MV
+ /// table passes because the mock only denies the base table name.
+ ///
+ /// After fix: the base table name is used for quota accounting and the
+ /// request is correctly rate-limited.
@Test
public void testMaterializedViewFullRewriteQuotaAccountedAgainstBaseTable()
throws Exception {
@@ -701,16 +700,15 @@ public class BaseSingleStageBrokerRequestHandlerTest {
"Expected TOO_MANY_REQUESTS error code");
}
- /**
- * Bug: FULL_REWRITE overwrites tableName to the materialized view table name, so
- * accessControl.getRowColFilters(requesterIdentity, tableName) fetches RLS
- * policy for the materialized view table instead of the base table.
- *
- * <p>Before fix: getRowColFilters is called with the materialized view table name
- * "mv_baseTable_OFFLINE".
- * <p>After fix: getRowColFilters is called with the original base table
- * name "baseTable_OFFLINE".
- */
+ /// Bug: FULL_REWRITE overwrites tableName to the materialized view table name, so
+ /// accessControl.getRowColFilters(requesterIdentity, tableName) fetches RLS
+ /// policy for the materialized view table instead of the base table.
+ ///
+ /// Before fix: getRowColFilters is called with the materialized view table name
+ /// "mv_baseTable_OFFLINE".
+ ///
+ /// After fix: getRowColFilters is called with the original base table
+ /// name "baseTable_OFFLINE".
@Test
public void testMaterializedViewFullRewriteRlsLookupUsesBaseTable()
throws Exception {
@@ -1001,13 +999,11 @@ public class BaseSingleStageBrokerRequestHandlerTest {
"combined filter must retain the original WHERE clause, got literals: " + literalValues);
}
- /**
- * Pins the security-style defense that a user-supplied `materializedViewRewrite=true` query
- * option (e.g. via `SET materializedViewRewrite='true'`) is stripped at the broker entry
- * before any compile work. Without the strip, a hostile client could stamp the
- * broker-internal marker themselves and bypass `BrokerReduceService`'s "Nested query is not
- * supported without gapfill" safety net on any path where `brokerRequest != serverBrokerRequest`.
- */
+ /// Pins the security-style defense that a user-supplied `materializedViewRewrite=true` query
+ /// option (e.g. via `SET materializedViewRewrite='true'`) is stripped at the broker entry
+ /// before any compile work. Without the strip, a hostile client could stamp the
+ /// broker-internal marker themselves and bypass `BrokerReduceService`'s "Nested query is not
+ /// supported without gapfill" safety net on any path where `brokerRequest != serverBrokerRequest`.
@Test
public void testMaterializedViewMarkerStrippedFromUserSuppliedOptions()
throws Exception {
@@ -1093,12 +1089,10 @@ public class BaseSingleStageBrokerRequestHandlerTest {
+ serverOptions);
}
- /**
- * Pins the C1 fix: FULL_REWRITE is skipped at the broker layer when the base table has a
- * REALTIME sibling, because a batch MV cannot cover newly-streamed rows. Without this guard
- * the MV swap would silently drop all rows ingested via the realtime stream since the MV last
- * refreshed — an invisible data-loss path.
- */
+ /// Pins the C1 fix: FULL_REWRITE is skipped at the broker layer when the base table has a
+ /// REALTIME sibling, because a batch MV cannot cover newly-streamed rows. Without this guard
+ /// the MV swap would silently drop all rows ingested via the realtime stream since the MV last
+ /// refreshed — an invisible data-loss path.
@Test
public void testMaterializedViewFullRewriteSkippedForHybridBaseTable()
throws Exception {
@@ -1217,16 +1211,14 @@ public class BaseSingleStageBrokerRequestHandlerTest {
"FULL_REWRITE marker must not be stamped when rewrite is skipped; options: " + serverOptions);
}
- /**
- * Pins the F1 fix: when the rewrite engine returns a FULL_REWRITE plan and no skip condition
- * trips (base table is OFFLINE-only, schema present, etc.), the server-side query MUST actually
- * be swapped to target the MV — not the base table. The earlier `watermarkMs <= 0` guard in
- * `DefaultMaterializedViewHandler.compile` was over-broad and silently dropped every
- * FULL_REWRITE attempt while `annotateResponse` continued to stamp `materializedViewQueried`,
- * producing a false-positive on every operator-facing metric. This test asserts the actual
- * dataSource table name on the server query equals the MV name AND the response's
- * `materializedViewQueried` matches.
- */
+ /// Pins the F1 fix: when the rewrite engine returns a FULL_REWRITE plan and no skip condition
+ /// trips (base table is OFFLINE-only, schema present, etc.), the server-side query MUST actually
+ /// be swapped to target the MV — not the base table. The earlier `watermarkMs <= 0` guard in
+ /// `DefaultMaterializedViewHandler.compile` was over-broad and silently dropped every
+ /// FULL_REWRITE attempt while `annotateResponse` continued to stamp `materializedViewQueried`,
+ /// producing a false-positive on every operator-facing metric. This test asserts the actual
+ /// dataSource table name on the server query equals the MV name AND the response's
+ /// `materializedViewQueried` matches.
@Test
public void testMaterializedViewFullRewriteActuallySwapsServerQuery()
throws Exception {
@@ -1343,17 +1335,15 @@ public class BaseSingleStageBrokerRequestHandlerTest {
"Response must report the MV name when the swap was committed");
}
- /**
- * Per-query opt-out: a query carrying {@code enableMaterializedViewRewrite=false} (the option the
- * MV minion executor injects onto its materialization query) MUST bypass the rewrite path
- * entirely. This is the regression guard for the circular-rewrite hazard: a materialization
- * query reads the base table, and with broker-wide MV rewrite enabled it would otherwise be
- * eligible to be rewritten back onto an MV over the same base table (its own MV, or a sibling).
- * Using the identical setup to {@link #testMaterializedViewFullRewriteActuallySwapsServerQuery}
- * (which DOES swap), this asserts the gate prevents the swap: the rewrite engine is never
- * consulted, the server query targets the base table, no MV marker is stamped, and the response
- * reports no MV.
- */
+ /// Per-query opt-out: a query carrying `enableMaterializedViewRewrite=false` (the option the
+ /// MV minion executor injects onto its materialization query) MUST bypass the rewrite path
+ /// entirely. This is the regression guard for the circular-rewrite hazard: a materialization
+ /// query reads the base table, and with broker-wide MV rewrite enabled it would otherwise be
+ /// eligible to be rewritten back onto an MV over the same base table (its own MV, or a sibling).
+ /// Using the identical setup to [#testMaterializedViewFullRewriteActuallySwapsServerQuery]
+ /// (which DOES swap), this asserts the gate prevents the swap: the rewrite engine is never
+ /// consulted, the server query targets the base table, no MV marker is stamped, and the response
+ /// reports no MV.
@Test
public void testMaterializedViewRewriteSkippedWhenDisabledByQueryOption()
throws Exception {
@@ -1462,12 +1452,10 @@ public class BaseSingleStageBrokerRequestHandlerTest {
"Response must not report a materializedViewQueried when rewrite is disabled by the query option");
}
- /**
- * Pins the cascade-prevention guard: when the user's query already targets an MV table
- * directly ({@code TableConfig.isMaterializedView()} is {@code true}), the broker must skip
- * MV rewrite entirely. Cascading MV-to-MV rewrites are not supported, and the explicit
- * guard uses the new flag from PR #18564 as the single source of truth for MV identity.
- */
+ /// Pins the cascade-prevention guard: when the user's query already targets an MV table
+ /// directly (`TableConfig.isMaterializedView()` is `true`), the broker must skip
+ /// MV rewrite entirely. Cascading MV-to-MV rewrites are not supported, and the explicit
+ /// guard uses the new flag from PR #18564 as the single source of truth for MV identity.
@Test
public void testMaterializedViewRewriteSkippedWhenUserQueryTargetsMaterializedView()
throws Exception {
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/BrokerRequestOptionsTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/BrokerRequestOptionsTest.java
index e6ebccd1664..22d6f7df643 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/BrokerRequestOptionsTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/BrokerRequestOptionsTest.java
@@ -32,9 +32,7 @@ import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertTrue;
-/**
- * Tests the various options set in the broker request
- */
+/// Tests the various options set in the broker request
public class BrokerRequestOptionsTest {
@Test
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/LiteralOnlyBrokerRequestTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/LiteralOnlyBrokerRequestTest.java
index a40a1e9cf81..b3154c5bb90 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/LiteralOnlyBrokerRequestTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/LiteralOnlyBrokerRequestTest.java
@@ -348,7 +348,7 @@ public class LiteralOnlyBrokerRequestTest {
assertEquals(brokerResponse.getExceptions().get(0).getErrorCode(), QueryErrorCode.SQL_PARSING.getId());
}
- /** Tests for EXPLAIN PLAN for literal only queries. */
+ /// Tests for EXPLAIN PLAN for literal only queries.
@Test
public void testExplainPlanLiteralOnly()
throws Exception {
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/SelectStarWithOtherColsRewriteTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/SelectStarWithOtherColsRewriteTest.java
index 4bd98a60c7d..59e52827816 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/SelectStarWithOtherColsRewriteTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/SelectStarWithOtherColsRewriteTest.java
@@ -44,9 +44,7 @@ public class SelectStarWithOtherColsRewriteTest {
"$hostName", "$hostName"
);
- /**
- * When the query contains only '*', it should be expanded into columns.
- */
+ /// When the query contains only '\*', it should be expanded into columns.
@Test
public void testShouldExpandWhenOnlyStarIsSelected() {
String sql = "SELECT * FROM baseballStats";
@@ -66,9 +64,7 @@ public class SelectStarWithOtherColsRewriteTest {
(key, value) -> Assert.assertEquals((int) value, 1, key + " has more than one occurrences in new selection"));
}
- /**
- * Expansion should not contain any virtual columns
- */
+ /// Expansion should not contain any virtual columns
@Test
public void testShouldNotReturnExtraDefaultColumns() {
String sql = "SELECT $docId,*,$segmentName FROM baseballStats";
@@ -95,9 +91,7 @@ public class SelectStarWithOtherColsRewriteTest {
Assert.assertEquals(segmentNameCnt, 1);
}
- /**
- * Columns should not be deduped
- */
+ /// Columns should not be deduped
@Test
public void testShouldNotDedupMultipleRequestedColumns() {
String sql = "SELECT playerID,*,G_old FROM baseballStats";
@@ -122,9 +116,7 @@ public class SelectStarWithOtherColsRewriteTest {
Assert.assertEquals(goldCount, 2, "G_old occurs does not occur once");
}
- /**
- * Selections should be returned in the requested order
- */
+ /// Selections should be returned in the requested order
@Test
public void testSelectionOrder() {
String sql = "SELECT playerID,*,G_old FROM baseballStats";
@@ -141,9 +133,8 @@ public class SelectStarWithOtherColsRewriteTest {
Assert.assertEquals(expandedSelections, assumedUnsortedSelections, "Expanded selections not sorted alphabetically");
}
- /**
- * When the same column is requested twice, once with an alias and once as part of *, then it should be returned twice
- */
+ /// When the same column is requested twice, once with an alias and once as part of \*, then it should be
+ /// returned twice
@Test
public void testAliasing() {
String sql = "SELECT playerID as pid,* FROM baseballStats";
@@ -165,9 +156,7 @@ public class SelectStarWithOtherColsRewriteTest {
Assert.assertTrue(playerIdPresent, "playerID col is missing");
}
- /**
- * When a function is applied to a column, then that col is returned along with the original column
- */
+ /// When a function is applied to a column, then that col is returned along with the original column
@Test
public void testFuncOnColumns1() {
String sql = "SELECT sqrt(homeRuns),* FROM baseballStats";
@@ -188,9 +177,7 @@ public class SelectStarWithOtherColsRewriteTest {
Assert.assertEquals(homeRunsCnt, 1);
}
- /**
- * When a function is applied to a column, then that col is returned along with the original column
- */
+ /// When a function is applied to a column, then that col is returned along with the original column
@Test
public void testFuncOnColumns2() {
String sql = "SELECT add(homeRuns,groundedIntoDoublePlays),* FROM baseballStats";
@@ -217,9 +204,7 @@ public class SelectStarWithOtherColsRewriteTest {
Assert.assertEquals(groundedIntoDoublePlaysCnt, 1);
}
- /**
- * When 'n' no. of unqualified * are present, then each column is returned 'n' times.
- */
+ /// When 'n' no. of unqualified \* are present, then each column is returned 'n' times.
@Test
public void testMultipleUnqualifiedStars() {
String sql = "SELECT *,* FROM baseballStats";
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/SingleConnectionBrokerRequestHandlerMergeTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/SingleConnectionBrokerRequestHandlerMergeTest.java
index f871effbcc7..4233bab256e 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/SingleConnectionBrokerRequestHandlerMergeTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/requesthandler/SingleConnectionBrokerRequestHandlerMergeTest.java
@@ -36,12 +36,12 @@ import static org.testng.Assert.assertTrue;
/// Regression test for the MV-split DataTable merge contract in
-/// {@link SingleConnectionBrokerRequestHandler#mergeDataTablesByIdentity}.
+/// [SingleConnectionBrokerRequestHandler#mergeDataTablesByIdentity].
///
-/// <p>Pins the invariant that the same physical server (matching hostname/port/tableType) appearing
+/// Pins the invariant that the same physical server (matching hostname/port/tableType) appearing
/// on BOTH the base sub-query and the MV sub-query contributes two distinct entries to the merged
/// map. Using a regular HashMap would collapse the two entries (since
-/// {@link ServerRoutingInstance#equals} keys on hostname/port/tableType), silently undercounting
+/// [ServerRoutingInstance#equals] keys on hostname/port/tableType), silently undercounting
/// results during the broker reduce.
public class SingleConnectionBrokerRequestHandlerMergeTest {
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManagerConcurrencyTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManagerConcurrencyTest.java
index cf196b2a2d8..174c0f2c79f 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManagerConcurrencyTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManagerConcurrencyTest.java
@@ -67,12 +67,10 @@ import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
-/**
- * Test class to validate concurrency and race condition handling in BrokerRoutingManager,
- * specifically focusing on TimeBoundaryManager coordination for hybrid tables.
- *
- * This test uses a real ZooKeeper instance and PropertyStore for end-to-end validation.
- */
+/// Test class to validate concurrency and race condition handling in BrokerRoutingManager,
+/// specifically focusing on TimeBoundaryManager coordination for hybrid tables.
+///
+/// This test uses a real ZooKeeper instance and PropertyStore for end-to-end validation.
public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
private static final String RAW_TABLE_NAME = "testHybridTable";
private static final String OFFLINE_TABLE_NAME = TableNameBuilder.OFFLINE.tableNameWithType(RAW_TABLE_NAME);
@@ -313,17 +311,15 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
ZKMetadataProvider.setSegmentZKMetadata(_propertyStore, tableNameWithType, segmentMetadata);
}
- /**
- * Test that validates concurrent buildRouting operations for REALTIME and OFFLINE tables
- * of the same hybrid table don't result in missing TimeBoundaryManager due to race conditions.
- *
- * This test uses real ZooKeeper and PropertyStore to validate the new locking mechanism.
- *
- * The test ensures:
- * 1. Both tables can be built concurrently without corruption
- * 2. TimeBoundaryManager is properly set on the offline table when realtime is built
- * 3. No race conditions occur that would leave the offline table without a TimeBoundaryManager
- */
+ /// Test that validates concurrent buildRouting operations for REALTIME and OFFLINE tables
+ /// of the same hybrid table don't result in missing TimeBoundaryManager due to race conditions.
+ ///
+ /// This test uses real ZooKeeper and PropertyStore to validate the new locking mechanism.
+ ///
+ /// The test ensures:
+ /// 1. Both tables can be built concurrently without corruption
+ /// 2. TimeBoundaryManager is properly set on the offline table when realtime is built
+ /// 3. No race conditions occur that would leave the offline table without a TimeBoundaryManager
@Test
public void testConcurrentHybridTableBuildNoTimeBoundaryManagerRace() throws Exception {
// Clean any existing routing entries to ensure test isolation
@@ -397,9 +393,7 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
}
}
- /**
- * Test that validates sequential table building works correctly and establishes TimeBoundaryManager.
- */
+ /// Test that validates sequential table building works correctly and establishes TimeBoundaryManager.
@Test
public void testSequentialHybridTableBuildTimeBoundaryManagerCreation() {
// Clean any existing routing entries to ensure test isolation
@@ -457,11 +451,9 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
Assert.assertEquals(startTimes.get(tableNameWithType).longValue(), futureStart);
}
- /**
- * Test concurrent interactions between processSegmentAssignmentChange and buildRouting.
- * This validates that the global read lock (for processSegmentAssignmentChange) and
- * per-table locks (for buildRouting) work correctly together without deadlocks.
- */
+ /// Test concurrent interactions between processSegmentAssignmentChange and buildRouting.
+ /// This validates that the global read lock (for processSegmentAssignmentChange) and
+ /// per-table locks (for buildRouting) work correctly together without deadlocks.
@Test
public void testConcurrentProcessSegmentAssignmentChangeAndBuildRouting() throws Exception {
clearRoutingEntries();
@@ -559,13 +551,11 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
}
}
- /**
- * Test concurrent interactions between processInstanceConfigChange and buildRouting where buildRouting adds a new
- * table.
- * This validates that the global write lock (for processInstanceConfigChange) and
- * per-table locks (for buildRouting) work correctly together, especially when buildRouting creates new routing
- * entries.
- */
+ /// Test concurrent interactions between processInstanceConfigChange and buildRouting where buildRouting adds a new
+ /// table.
+ /// This validates that the global write lock (for processInstanceConfigChange) and
+ /// per-table locks (for buildRouting) work correctly together, especially when buildRouting creates new routing
+ /// entries.
@Test
public void testConcurrentProcessInstanceConfigChangeAndBuildRoutingNewTable() throws Exception {
clearRoutingEntries();
@@ -744,11 +734,9 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
}
}
- /**
- * Test concurrent interactions between excludeServerFromRouting (global write lock) and buildRouting
- * (global read lock + per-table lock).
- * This validates that global write lock properly blocks global read lock operations.
- */
+ /// Test concurrent interactions between excludeServerFromRouting (global write lock) and buildRouting
+ /// (global read lock + per-table lock).
+ /// This validates that global write lock properly blocks global read lock operations.
@Test
public void testConcurrentExcludeServerAndBuildRouting() throws Exception {
clearRoutingEntries();
@@ -856,11 +844,9 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
}
}
- /**
- * Test concurrent interactions between includeServerToRouting (global write lock) and refreshSegment
- * (global read lock + per-table lock).
- * This validates proper coordination between global write operations and segment refresh operations.
- */
+ /// Test concurrent interactions between includeServerToRouting (global write lock) and refreshSegment
+ /// (global read lock + per-table lock).
+ /// This validates proper coordination between global write operations and segment refresh operations.
@Test
public void testConcurrentIncludeServerAndRefreshSegment() throws Exception {
clearRoutingEntries();
@@ -952,11 +938,9 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
}
}
- /**
- * Test concurrent query operations (getRoutingTable, getTimeBoundaryInfo, getQueryTimeoutMs) during routing
- * modifications. This validates that query path operations can execute concurrently and are not blocked by
- * routing modifications.
- */
+ /// Test concurrent query operations (getRoutingTable, getTimeBoundaryInfo, getQueryTimeoutMs) during routing
+ /// modifications. This validates that query path operations can execute concurrently and are not blocked by
+ /// routing modifications.
@Test
public void testConcurrentQueryOperationsDuringRoutingModifications() throws Exception {
clearRoutingEntries();
@@ -1119,11 +1103,9 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
}
}
- /**
- * Test concurrent interactions between two global write lock methods: processInstanceConfigChange and
- * includeServerToRouting. This validates that global write lock methods are properly serialized and don't
- * cause deadlocks or race conditions.
- */
+ /// Test concurrent interactions between two global write lock methods: processInstanceConfigChange and
+ /// includeServerToRouting. This validates that global write lock methods are properly serialized and don't
+ /// cause deadlocks or race conditions.
@Test
public void testConcurrentGlobalWriteLockMethods() throws Exception {
clearRoutingEntries();
@@ -1253,11 +1235,9 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
}
}
- /**
- * Test concurrent interactions between buildRoutingForLogicalTable and buildRouting.
- * This validates proper coordination between logical table operations, regular table operations,
- * and global write operations. Uses a hybrid logical table configuration with both offline and realtime tables.
- */
+ /// Test concurrent interactions between buildRoutingForLogicalTable and buildRouting.
+ /// This validates proper coordination between logical table operations, regular table operations,
+ /// and global write operations. Uses a hybrid logical table configuration with both offline and realtime tables.
@Test
public void testConcurrentLogicalTableBuildAndRegularBuild() throws Exception {
clearRoutingEntries();
@@ -1431,11 +1411,9 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
}
}
- /**
- * Test concurrent interactions between buildRoutingForLogicalTable and buildRouting.
- * This validates proper coordination between logical table operations, regular table operations,
- * and global write operations. Uses a hybrid logical table configuration with both offline and realtime tables.
- */
+ /// Test concurrent interactions between buildRoutingForLogicalTable and buildRouting.
+ /// This validates proper coordination between logical table operations, regular table operations,
+ /// and global write operations. Uses a hybrid logical table configuration with both offline and realtime tables.
@Test
public void testConcurrentLogicalTableBuildAndRegularBuildAndRealtimeBuild() throws Exception {
clearRoutingEntries();
@@ -1627,10 +1605,8 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
}
}
- /**
- * Test concurrent interactions with logical table containing multiple physical tables.
- * This validates coordination when logical table operations affect multiple per-table locks.
- */
+ /// Test concurrent interactions with logical table containing multiple physical tables.
+ /// This validates coordination when logical table operations affect multiple per-table locks.
@Test
public void testConcurrentMultiPhysicalTableLogicalOperations() throws Exception {
clearRoutingEntries();
@@ -1791,10 +1767,8 @@ public class BrokerRoutingManagerConcurrencyTest extends ControllerTest {
}
}
- /**
- * Test concurrent interactions with logical table containing multiple physical tables.
- * This validates coordination when logical table operations affect multiple per-table locks.
- */
+ /// Test concurrent interactions with logical table containing multiple physical tables.
+ /// This validates coordination when logical table operations affect multiple per-table locks.
@Test
public void testConcurrentMultiPhysicalTableLogicalOperationsWithRealtimeBuild() throws Exception {
clearRoutingEntries();
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManagerTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManagerTest.java
index bc3988866ec..bc4134ebb61 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManagerTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/BrokerRoutingManagerTest.java
@@ -291,9 +291,7 @@ public class BrokerRoutingManagerTest {
assertTrue(_routingManager.getRoutableServerInstanceMap().containsKey(SERVER_INSTANCE_ID));
}
- /**
- * Creates a ZNRecord representing an enabled server instance.
- */
+ /// Creates a ZNRecord representing an enabled server instance.
private ZNRecord createEnabledServerZNRecord(String instanceId) {
ZNRecord record = new ZNRecord(instanceId);
record.setSimpleField(InstanceConfig.InstanceConfigProperty.HELIX_ENABLED.name(), "true");
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/MultiClusterRoutingManagerTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/MultiClusterRoutingManagerTest.java
index 6dd9f012747..7ba62cb47b7 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/MultiClusterRoutingManagerTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/MultiClusterRoutingManagerTest.java
@@ -47,9 +47,7 @@ import static org.testng.Assert.assertNotNull;
import static org.testng.Assert.assertNull;
import static org.testng.Assert.assertTrue;
-/**
- * Unit tests for {@link MultiClusterRoutingManager}.
- */
+/// Unit tests for [MultiClusterRoutingManager].
public class MultiClusterRoutingManagerTest {
private static final String TEST_TABLE = "testTable_OFFLINE";
private static final long REQUEST_ID = 12345L;
diff --git a/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/RemoteClusterBrokerRoutingManagerTest.java b/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/RemoteClusterBrokerRoutingManagerTest.java
index 1eecb92da0b..ffbc1025394 100644
--- a/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/RemoteClusterBrokerRoutingManagerTest.java
+++ b/pinot-broker/src/test/java/org/apache/pinot/broker/routing/manager/RemoteClusterBrokerRoutingManagerTest.java
@@ -50,11 +50,9 @@ import org.testng.annotations.Test;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.anyString;
-/**
- * Test class for {@link RemoteClusterBrokerRoutingManager}.
- * Tests the remote cluster routing manager with real ZooKeeper to validate table discovery,
- * routing updates, concurrent operations, and lifecycle management.
- */
+/// Test class for [RemoteClusterBrokerRoutingManager].
+/// Tests the remote cluster routing manager with real ZooKeeper to validate table discovery,
+/// routing updates, concurrent operations, and lifecycle management.
public class RemoteClusterBrokerRoutingManagerTest extends ControllerTest {
private static final String REMOTE_CLUSTER_NAME = "remoteCluster";
private static final String RAW_TABLE_NAME = "remoteTable";
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/AbstractResultSet.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/AbstractResultSet.java
index adcaa67ce99..a67199cbe56 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/AbstractResultSet.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/AbstractResultSet.java
@@ -20,9 +20,7 @@ package org.apache.pinot.client;
import javax.annotation.Nullable;
-/**
- * Shared implementation between the different ResultSets.
- */
+/// Shared implementation between the different ResultSets.
public abstract class AbstractResultSet implements ResultSet {
@Override
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/AggregationResultSet.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/AggregationResultSet.java
index 48cf497f0b9..d1bb8c1984f 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/AggregationResultSet.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/AggregationResultSet.java
@@ -21,11 +21,9 @@ package org.apache.pinot.client;
import com.fasterxml.jackson.databind.JsonNode;
-/**
- * A Pinot query result set for aggregation results without group by clauses, of which there is one
- * of per aggregation
- * function in the query.
- */
+/// A Pinot query result set for aggregation results without group by clauses, of which there is one
+/// of per aggregation
+/// function in the query.
class AggregationResultSet extends AbstractResultSet {
private final JsonNode _jsonObject;
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BaseResultSetGroup.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BaseResultSetGroup.java
index 9dd76e4b90f..14a2ff7d45d 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BaseResultSetGroup.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BaseResultSetGroup.java
@@ -20,54 +20,42 @@ package org.apache.pinot.client;
import java.util.List;
-/**
- * Base interface for result set groups that provides common contract for accessing query results.
- *
- * This interface defines the core methods that all result set group implementations should provide,
- * allowing for polymorphic usage across different result set group types (regular and cursor-based).
- *
- * <p><strong>Backward Compatibility:</strong> This interface is designed to be implemented by existing
- * classes without breaking any existing code.
- */
+/// Base interface for result set groups that provides common contract for accessing query results.
+///
+/// This interface defines the core methods that all result set group implementations should provide,
+/// allowing for polymorphic usage across different result set group types (regular and cursor-based).
+///
+/// **Backward Compatibility:** This interface is designed to be implemented by existing
+/// classes without breaking any existing code.
public interface BaseResultSetGroup {
- /**
- * Returns the number of result sets in this result set group.
- *
- * There is one result set per aggregation function in the original query
- * and one result set in the case of a selection query.
- *
- * @return The number of result sets, or 0 if there are no result sets
- */
+ /// Returns the number of result sets in this result set group.
+ ///
+ /// There is one result set per aggregation function in the original query
+ /// and one result set in the case of a selection query.
+ ///
+ /// @return The number of result sets, or 0 if there are no result sets
int getResultSetCount();
- /**
- * Obtains the result set at the given index, starting from zero.
- *
- * @param index The index for which to obtain the result set
- * @return The result set at the given index
- * @throws IndexOutOfBoundsException if the index is out of range
- */
+ /// Obtains the result set at the given index, starting from zero.
+ ///
+ /// @param index The index for which to obtain the result set
+ /// @return The result set at the given index
+ /// @throws IndexOutOfBoundsException if the index is out of range
ResultSet getResultSet(int index);
- /**
- * Gets the execution statistics for this query.
- *
- * @return The execution statistics
- */
+ /// Gets the execution statistics for this query.
+ ///
+ /// @return The execution statistics
ExecutionStats getExecutionStats();
- /**
- * Gets any exceptions that occurred during query processing.
- *
- * @return A list of exceptions, or an empty list if no exceptions occurred
- */
+ /// Gets any exceptions that occurred during query processing.
+ ///
+ /// @return A list of exceptions, or an empty list if no exceptions occurred
List<PinotClientException> getExceptions();
- /**
- * Gets the underlying broker response.
- *
- * @return The broker response
- */
+ /// Gets the underlying broker response.
+ ///
+ /// @return The broker response
BrokerResponse getBrokerResponse();
}
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerCache.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerCache.java
index 786f0ff4ef8..55278912376 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerCache.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerCache.java
@@ -51,10 +51,8 @@ import org.asynchttpclient.Dsl;
import org.asynchttpclient.Response;
-/**
- * Maintains table -> list of brokers, supports update
- * TODO can we introduce a SSE based controller endpoint to make the update reactive in the client?
- */
+/// Maintains table -> list of brokers, supports update
+/// TODO can we introduce a SSE based controller endpoint to make the update reactive in the client?
public class BrokerCache {
@JsonIgnoreProperties(ignoreUnknown = true)
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerCacheUpdaterPeriodic.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerCacheUpdaterPeriodic.java
index 93f7c47af14..2dd27ec89c6 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerCacheUpdaterPeriodic.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerCacheUpdaterPeriodic.java
@@ -27,9 +27,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Maintains broker cache this is updated periodically
- */
+/// Maintains broker cache this is updated periodically
public class BrokerCacheUpdaterPeriodic implements UpdatableBrokerCache {
public static final String BROKER_UPDATE_FREQUENCY_MILLIS = "brokerUpdateFrequencyInMillis";
public static final String DEFAULT_BROKER_UPDATE_FREQUENCY_MILLIS = "300000"; // 5 minutes
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerResponse.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerResponse.java
index e96d0d45e44..1cef4828c63 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerResponse.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerResponse.java
@@ -22,9 +22,7 @@ import com.fasterxml.jackson.databind.JsonNode;
import javax.annotation.Nullable;
-/**
- * Reimplementation of BrokerResponse from pinot-common, so that pinot-api does not depend on pinot-common.
- */
+/// Reimplementation of BrokerResponse from pinot-common, so that pinot-api does not depend on pinot-common.
public class BrokerResponse {
private String _requestId;
private String _brokerId;
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerSelector.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerSelector.java
index 6b43da27cd6..66f19512aba 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerSelector.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/BrokerSelector.java
@@ -21,20 +21,14 @@ package org.apache.pinot.client;
import java.util.List;
public interface BrokerSelector {
- /**
- * Returns the broker address in the form host:port
- * @param tableNames
- * @return
- */
+ /// Returns the broker address in the form host:port
+ /// @param tableNames
+ /// @return
String selectBroker(String... tableNames);
- /**
- * Returns list of all brokers.
- */
+ /// Returns list of all brokers.
List<String> getBrokers();
- /**
- * Close any resources
- */
+ /// Close any resources
void close();
}
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/Connection.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/Connection.java
index 526f5affba9..1a80738efb5 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/Connection.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/Connection.java
@@ -27,9 +27,7 @@ import org.apache.pinot.sql.parsers.parser.TableNameExtractor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * A connection to Pinot, normally created through calls to the {@link ConnectionFactory}.
- */
+/// A connection to Pinot, normally created through calls to the [ConnectionFactory].
public class Connection {
public static final String FAIL_ON_EXCEPTIONS = "failOnExceptions";
private static final Logger LOGGER = LoggerFactory.getLogger(Connection.class);
@@ -59,48 +57,40 @@ public class Connection {
_failOnExceptions = Boolean.parseBoolean(properties.getProperty(FAIL_ON_EXCEPTIONS, "TRUE"));
}
- /**
- * Creates a prepared statement, to escape query parameters.
- *
- * @param query The query for which to create a prepared statement
- * @return A prepared statement for this connection
- */
+ /// Creates a prepared statement, to escape query parameters.
+ ///
+ /// @param query The query for which to create a prepared statement
+ /// @return A prepared statement for this connection
public PreparedStatement prepareStatement(String query) {
return new PreparedStatement(this, query);
}
- /**
- * Executes a query.
- *
- * @param query The query to execute
- * @return The result of the query
- * @throws PinotClientException If an exception occurs while processing the query
- */
+ /// Executes a query.
+ ///
+ /// @param query The query to execute
+ /// @return The result of the query
+ /// @throws PinotClientException If an exception occurs while processing the query
public ResultSetGroup execute(String query) {
return execute((Iterable<String>) null, query);
}
- /**
- * Executes a query.
- *
- * @param tableName Name of the table to execute the query on
- * @param query The query to execute
- * @return The result of the query
- * @throws PinotClientException If an exception occurs while processing the query
- */
+ /// Executes a query.
+ ///
+ /// @param tableName Name of the table to execute the query on
+ /// @param query The query to execute
+ /// @return The result of the query
+ /// @throws PinotClientException If an exception occurs while processing the query
public ResultSetGroup execute(@Nullable String tableName, String query)
throws PinotClientException {
return execute(tableName == null ? null : List.of(tableName), query);
}
- /**
- * Executes a query.
- *
- * @param tableNames Names of all the tables to execute the query on
- * @param query The query to execute
- * @return The result of the query
- * @throws PinotClientException If an exception occurs while processing the query
- */
+ /// Executes a query.
+ ///
+ /// @param tableNames Names of all the tables to execute the query on
+ /// @param query The query to execute
+ /// @return The result of the query
+ /// @throws PinotClientException If an exception occurs while processing the query
public ResultSetGroup execute(@Nullable Iterable<String> tableNames, String query)
throws PinotClientException {
String[] resultTableNames = (tableNames == null) ? resolveTableName(query)
@@ -117,39 +107,33 @@ public class Connection {
return new ResultSetGroup(response);
}
- /**
- * Executes a query asynchronously.
- *
- * @param query The query to execute
- * @return A future containing the result of the query
- * @throws PinotClientException If an exception occurs while processing the query
- */
+ /// Executes a query asynchronously.
+ ///
+ /// @param query The query to execute
+ /// @return A future containing the result of the query
+ /// @throws PinotClientException If an exception occurs while processing the query
public CompletableFuture<ResultSetGroup> executeAsync(String query)
throws PinotClientException {
return executeAsync((Iterable<String>) null, query);
}
- /**
- * Executes a query asynchronously.
- *
- * @param tableName Name of the table to execute the query on
- * @param query The query to execute
- * @return A future containing the result of the query
- * @throws PinotClientException If an exception occurs while processing the query
- */
+ /// Executes a query asynchronously.
+ ///
+ /// @param tableName Name of the table to execute the query on
+ /// @param query The query to execute
+ /// @return A future containing the result of the query
+ /// @throws PinotClientException If an exception occurs while processing the query
public CompletableFuture<ResultSetGroup> executeAsync(@Nullable String tableName, String query)
throws PinotClientException {
return executeAsync(tableName == null ? null : List.of(tableName), query);
}
- /**
- * Executes a query asynchronously.
- *
- * @param tableNames Names of all the tables to execute the query on
- * @param query The query to execute
- * @return A future containing the result of the query
- * @throws PinotClientException If an exception occurs while processing the query
- */
+ /// Executes a query asynchronously.
+ ///
+ /// @param tableNames Names of all the tables to execute the query on
+ /// @param query The query to execute
+ /// @return A future containing the result of the query
+ /// @throws PinotClientException If an exception occurs while processing the query
public CompletableFuture<ResultSetGroup> executeAsync(@Nullable Iterable<String> tableNames, String query)
throws PinotClientException {
String[] resultTableNames = (tableNames == null) ? resolveTableName(query)
@@ -161,11 +145,9 @@ public class Connection {
return _transport.executeQueryAsync(brokerHostPort, query).thenApply(ResultSetGroup::new);
}
- /**
- * Returns the name of all the tables used in a sql query.
- *
- * @return name of all the tables used in a sql query.
- */
+ /// Returns the name of all the tables used in a sql query.
+ ///
+ /// @return name of all the tables used in a sql query.
@Nullable
public static String[] resolveTableName(String query) {
try {
@@ -176,45 +158,37 @@ public class Connection {
}
}
- /**
- * Returns the list of brokers to which this connection can connect to.
- *
- * @return The list of brokers to which this connection can connect to.
- */
+ /// Returns the list of brokers to which this connection can connect to.
+ ///
+ /// @return The list of brokers to which this connection can connect to.
List<String> getBrokerList() {
return _brokerSelector.getBrokers();
}
- /**
- * Close the connection for further processing
- *
- * @throws PinotClientException when connection is already closed
- */
+ /// Close the connection for further processing
+ ///
+ /// @throws PinotClientException when connection is already closed
public void close()
throws PinotClientException {
_transport.close();
_brokerSelector.close();
}
- /**
- * Provides access to the underlying transport mechanism for this connection.
- * There may be client metrics useful for monitoring and other observability goals.
- *
- * @return pinot client transport.
- */
+ /// Provides access to the underlying transport mechanism for this connection.
+ /// There may be client metrics useful for monitoring and other observability goals.
+ ///
+ /// @return pinot client transport.
public PinotClientTransport<?> getTransport() {
return _transport;
}
- /**
- * Opens a cursor for the given query, enabling pagination through large result sets.
- * The returned cursor starts with the first page already loaded.
- *
- * @param query the query to execute
- * @param pageSize the number of rows per page
- * @return ResultCursor with the first page loaded and ready for navigation
- * @throws PinotClientException If an exception occurs while processing the query
- */
+ /// Opens a cursor for the given query, enabling pagination through large result sets.
+ /// The returned cursor starts with the first page already loaded.
+ ///
+ /// @param query the query to execute
+ /// @param pageSize the number of rows per page
+ /// @return ResultCursor with the first page loaded and ready for navigation
+ /// @throws PinotClientException If an exception occurs while processing the query
public ResultCursor openCursor(String query, int pageSize) throws PinotClientException {
try {
return openCursorAsync(query, pageSize).get();
@@ -229,14 +203,12 @@ public class Connection {
}
}
- /**
- * Opens a cursor for the given query asynchronously, enabling pagination through large result sets.
- * The returned cursor starts with the first page already loaded.
- *
- * @param query the query to execute
- * @param pageSize the number of rows per page
- * @return CompletableFuture containing ResultCursor with the first page loaded and ready for navigation
- */
+ /// Opens a cursor for the given query asynchronously, enabling pagination through large result sets.
+ /// The returned cursor starts with the first page already loaded.
+ ///
+ /// @param query the query to execute
+ /// @param pageSize the number of rows per page
+ /// @return CompletableFuture containing ResultCursor with the first page loaded and ready for navigation
public CompletableFuture<ResultCursor> openCursorAsync(String query, int pageSize) {
return validateCursorSupport()
.thenCompose(unused -> selectBrokerForCursor(query))
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ConnectionFactory.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ConnectionFactory.java
index 273ccb27467..24ac2223c9e 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ConnectionFactory.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ConnectionFactory.java
@@ -25,32 +25,26 @@ import java.util.Properties;
import org.apache.pinot.client.grpc.GrpcConnection;
-/**
- * Creates connections to Pinot, given various initialization methods.
- */
+/// Creates connections to Pinot, given various initialization methods.
public class ConnectionFactory {
private static volatile PinotClientTransport _defaultTransport;
private ConnectionFactory() {
}
- /**
- * Creates a connection to a Pinot cluster, given its Zookeeper URL
- *
- * @param zkUrl The URL to the Zookeeper cluster, must include the cluster name e.g host:port/chroot/pinot-cluster
- * @return A connection that connects to the brokers in the given Helix cluster
- */
+ /// Creates a connection to a Pinot cluster, given its Zookeeper URL
+ ///
+ /// @param zkUrl The URL to the Zookeeper cluster, must include the cluster name e.g host:port/chroot/pinot-cluster
+ /// @return A connection that connects to the brokers in the given Helix cluster
public static Connection fromZookeeper(String zkUrl) {
return fromZookeeper(zkUrl, getDefault());
}
- /**
- * Creates a connection to a Pinot cluster, given its Zookeeper URL
- *
- * @param zkUrl The URL to the Zookeeper cluster, must include the cluster name e.g host:port/chroot/pinot-cluster
- * @param transport pinot transport
- * @return A connection that connects to the brokers in the given Helix cluster
- */
+ /// Creates a connection to a Pinot cluster, given its Zookeeper URL
+ ///
+ /// @param zkUrl The URL to the Zookeeper cluster, must include the cluster name e.g host:port/chroot/pinot-cluster
+ /// @param transport pinot transport
+ /// @return A connection that connects to the brokers in the given Helix cluster
public static Connection fromZookeeper(String zkUrl, PinotClientTransport transport) {
try {
return fromZookeeper(new DynamicBrokerSelector(zkUrl), transport);
@@ -59,13 +53,11 @@ public class ConnectionFactory {
}
}
- /**
- * Creates a connection to a Pinot cluster, given its Zookeeper URL and properties.
- *
- * @param properties connection properties
- * @param zkUrl zookeeper URL.
- * @return A connection that connects to the brokers in the given Helix cluster
- */
+ /// Creates a connection to a Pinot cluster, given its Zookeeper URL and properties.
+ ///
+ /// @param properties connection properties
+ /// @param zkUrl zookeeper URL.
+ /// @return A connection that connects to the brokers in the given Helix cluster
public static Connection fromZookeeper(Properties properties, String zkUrl) {
try {
return fromZookeeper(properties, new DynamicBrokerSelector(zkUrl), getDefault(properties));
@@ -74,25 +66,19 @@ public class ConnectionFactory {
}
}
- /**
- *
- * @param scheme controller URL scheme
- * @param controllerHost controller host
- * @param controllerPort controller port
- * @return A connection that connects to brokers as per the given controller
- */
+ /// @param scheme controller URL scheme
+ /// @param controllerHost controller host
+ /// @param controllerPort controller port
+ /// @return A connection that connects to brokers as per the given controller
@Deprecated
public static Connection fromController(String scheme, String controllerHost, int controllerPort) {
return fromController(new Properties(), scheme, controllerHost, controllerPort);
}
- /**
- *
- * @param scheme controller URL scheme
- * @param controllerHost controller host
- * @param controllerPort controller port
- * @return A connection that connects to brokers as per the given controller
- */
+ /// @param scheme controller URL scheme
+ /// @param controllerHost controller host
+ /// @param controllerPort controller port
+ /// @return A connection that connects to brokers as per the given controller
@Deprecated
public static Connection fromController(Properties properties, String scheme,
String controllerHost, int controllerPort) {
@@ -105,19 +91,15 @@ public class ConnectionFactory {
}
}
- /**
- * @param controllerUrl url host:port of the controller
- * @return A connection that connects to brokers as per the given controller
- */
+ /// @param controllerUrl url host:port of the controller
+ /// @return A connection that connects to brokers as per the given controller
public static Connection fromController(String controllerUrl) {
return fromController(new Properties(), controllerUrl);
}
- /**
- * @param properties
- * @param controllerUrl url host:port of the controller
- * @return A connection that connects to brokers as per the given controller
- */
+ /// @param properties
+ /// @param controllerUrl url host:port of the controller
+ /// @return A connection that connects to brokers as per the given controller
public static Connection fromController(Properties properties, String controllerUrl) {
try {
return new Connection(properties,
@@ -128,12 +110,10 @@ public class ConnectionFactory {
}
}
- /**
- * @param properties
- * @param controllerUrl url host:port of the controller
- * @param transport pinot transport
- * @return A connection that connects to brokers as per the given controller
- */
+ /// @param properties
+ /// @param controllerUrl url host:port of the controller
+ /// @param transport pinot transport
+ /// @return A connection that connects to brokers as per the given controller
public static Connection fromController(Properties properties, String controllerUrl, PinotClientTransport transport) {
try {
return new Connection(properties,
@@ -144,11 +124,9 @@ public class ConnectionFactory {
}
}
- /**
- * @param properties
- * @param controllerUrl url host:port of the controller
- * @return A connection that connects to brokers as per the given controller
- */
+ /// @param properties
+ /// @param controllerUrl url host:port of the controller
+ /// @return A connection that connects to brokers as per the given controller
public static GrpcConnection fromControllerGrpc(Properties properties, String controllerUrl) {
try {
properties.setProperty("useGrpcPort", "true");
@@ -158,14 +136,12 @@ public class ConnectionFactory {
}
}
- /**
- * Creates a connection to a Pinot cluster, given its Zookeeper URL
- *
- * @param properties The Pinot connection properties
- * @param zkUrl The URL to the Zookeeper cluster, must include the cluster name e.g host:port/chroot/pinot-cluster
- * @param transport pinot transport
- * @return A connection that connects to the brokers in the given Helix cluster
- */
+ /// Creates a connection to a Pinot cluster, given its Zookeeper URL
+ ///
+ /// @param properties The Pinot connection properties
+ /// @param zkUrl The URL to the Zookeeper cluster, must include the cluster name e.g host:port/chroot/pinot-cluster
+ /// @param transport pinot transport
+ /// @return A connection that connects to the brokers in the given Helix cluster
public static Connection fromZookeeper(Properties properties, String zkUrl, PinotClientTransport transport) {
try {
boolean preferTls = Boolean.parseBoolean(properties.getProperty("preferTLS", "false"));
@@ -187,13 +163,11 @@ public class ConnectionFactory {
return new Connection(properties, dynamicBrokerSelector, transport);
}
- /**
- * Creates a connection to a Pinot cluster, given its Zookeeper URL
- *
- * @param properties The Pinot connection properties
- * @param zkUrl The URL to the Zookeeper cluster, must include the cluster name e.g host:port/chroot/pinot-cluster
- * @return A connection that connects to the brokers in the given Helix cluster
- */
+ /// Creates a connection to a Pinot cluster, given its Zookeeper URL
+ ///
+ /// @param properties The Pinot connection properties
+ /// @param zkUrl The URL to the Zookeeper cluster, must include the cluster name e.g host:port/chroot/pinot-cluster
+ /// @return A connection that connects to the brokers in the given Helix cluster
public static GrpcConnection fromZookeeperGrpc(Properties properties, String zkUrl) {
try {
return new GrpcConnection(properties, new DynamicBrokerSelector(zkUrl, false, true));
@@ -202,56 +176,46 @@ public class ConnectionFactory {
}
}
- /**
- * Creates a connection from properties containing the connection parameters.
- *
- * @param properties The properties to use for the connection
- * @return A connection that connects to the brokers specified in the properties
- */
+ /// Creates a connection from properties containing the connection parameters.
+ ///
+ /// @param properties The properties to use for the connection
+ /// @return A connection that connects to the brokers specified in the properties
public static Connection fromProperties(Properties properties) {
return fromProperties(properties, getDefault(properties));
}
- /**
- * Creates a connection from properties containing the connection parameters.
- *
- * @param properties The properties to use for the connection
- * @param transport pinot transport
- * @return A connection that connects to the brokers specified in the properties
- */
+ /// Creates a connection from properties containing the connection parameters.
+ ///
+ /// @param properties The properties to use for the connection
+ /// @param transport pinot transport
+ /// @return A connection that connects to the brokers specified in the properties
public static Connection fromProperties(Properties properties, PinotClientTransport transport) {
return new Connection(properties, Arrays.asList(properties.getProperty("brokerList").split(",")), transport);
}
- /**
- * Creates a connection which sends queries randomly between the specified brokers.
- *
- * @param brokers The list of brokers to send queries to
- * @return A connection to the set of brokers specified
- */
+ /// Creates a connection which sends queries randomly between the specified brokers.
+ ///
+ /// @param brokers The list of brokers to send queries to
+ /// @return A connection to the set of brokers specified
public static Connection fromHostList(String... brokers) {
return fromHostList(Arrays.asList(brokers), getDefault());
}
- /**
- * Creates a connection which sends queries randomly between the specified brokers.
- *
- * @param brokers The list of brokers to send queries to
- * @param transport pinot transport
- * @return A connection to the set of brokers specified
- */
+ /// Creates a connection which sends queries randomly between the specified brokers.
+ ///
+ /// @param brokers The list of brokers to send queries to
+ /// @param transport pinot transport
+ /// @return A connection to the set of brokers specified
public static Connection fromHostList(List<String> brokers, PinotClientTransport transport) {
return new Connection(brokers, transport);
}
- /**
- * Creates a connection which sends queries randomly between the specified brokers.
- *
- * @param properties The Pinot connection properties
- * @param brokers The list of brokers to send queries to
- * @param transport pinot transport
- * @return A connection to the set of brokers specified
- */
+ /// Creates a connection which sends queries randomly between the specified brokers.
+ ///
+ /// @param properties The Pinot connection properties
+ /// @param brokers The list of brokers to send queries to
+ /// @param transport pinot transport
+ /// @return A connection to the set of brokers specified
public static Connection fromHostList(Properties properties, List<String> brokers,
PinotClientTransport transport) {
return new Connection(properties, brokers, transport);
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ConnectionTimeouts.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ConnectionTimeouts.java
index 3d3984ebbe8..c2c2b6c26b9 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ConnectionTimeouts.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ConnectionTimeouts.java
@@ -18,9 +18,7 @@
*/
package org.apache.pinot.client;
-/**
- * Connections time out for AsyncHttpClient
- */
+/// Connections time out for AsyncHttpClient
public class ConnectionTimeouts {
private final int _readTimeoutMs;
private final int _connectTimeoutMs;
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ControllerBasedBrokerSelector.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ControllerBasedBrokerSelector.java
index d07b37dd4fa..41451407b16 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ControllerBasedBrokerSelector.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ControllerBasedBrokerSelector.java
@@ -23,9 +23,7 @@ import java.util.List;
import java.util.Properties;
-/**
- * Maintains broker cache using controller APIs
- */
+/// Maintains broker cache using controller APIs
public class ControllerBasedBrokerSelector implements BrokerSelector {
private static final String SCHEME = "scheme";
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorAwareBrokerResponse.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorAwareBrokerResponse.java
index ab6ab26b49b..c37ac943922 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorAwareBrokerResponse.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorAwareBrokerResponse.java
@@ -21,10 +21,8 @@ package org.apache.pinot.client;
import com.fasterxml.jackson.databind.JsonNode;
import javax.annotation.Nullable;
-/**
- * Extended BrokerResponse with cursor-specific fields for cursor pagination queries.
- * This class adds cursor metadata fields while maintaining full compatibility with BrokerResponse.
- */
+/// Extended BrokerResponse with cursor-specific fields for cursor pagination queries.
+/// This class adds cursor metadata fields while maintaining full compatibility with BrokerResponse.
public class CursorAwareBrokerResponse extends BrokerResponse {
// Cursor-specific fields from Pinot documentation
private final Long _offset;
@@ -38,9 +36,7 @@ public class CursorAwareBrokerResponse extends BrokerResponse {
private Long _bytesWritten;
private final Long _cursorFetchTimeMs;
- /**
- * Creates a CursorAwareBrokerResponse by parsing cursor-specific fields from the JSON response.
- */
+ /// Creates a CursorAwareBrokerResponse by parsing cursor-specific fields from the JSON response.
public static CursorAwareBrokerResponse fromJson(JsonNode brokerResponse) {
return new CursorAwareBrokerResponse(brokerResponse);
}
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorCapable.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorCapable.java
index a0467ceefcd..e9994a7258d 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorCapable.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorCapable.java
@@ -20,168 +20,142 @@ package org.apache.pinot.client;
import java.util.concurrent.CompletableFuture;
-/**
- * Marker interface for transports that support cursor-based pagination operations.
- * Transports implementing this interface can be used with cursor pagination features.
- */
+/// Marker interface for transports that support cursor-based pagination operations.
+/// Transports implementing this interface can be used with cursor pagination features.
public interface CursorCapable {
- /**
- * Executes a query with cursor support.
- *
- * @param brokerAddress The broker address to send the query to
- * @param query The SQL query to execute
- * @param numRows The number of rows to return per page
- * @return CursorAwareBrokerResponse containing results and cursor metadata
- * @throws PinotClientException If query execution fails
- */
+ /// Executes a query with cursor support.
+ ///
+ /// @param brokerAddress The broker address to send the query to
+ /// @param query The SQL query to execute
+ /// @param numRows The number of rows to return per page
+ /// @return CursorAwareBrokerResponse containing results and cursor metadata
+ /// @throws PinotClientException If query execution fails
default CursorAwareBrokerResponse executeQueryWithCursor(String brokerAddress, String query, int numRows)
throws PinotClientException {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
- /**
- * Executes a query with cursor support asynchronously.
- *
- * @param brokerAddress The broker address to send the query to
- * @param query The SQL query to execute
- * @param numRows The number of rows to return per page
- * @return CompletableFuture containing CursorAwareBrokerResponse with results and cursor metadata
- * @throws PinotClientException If query execution fails
- */
+ /// Executes a query with cursor support asynchronously.
+ ///
+ /// @param brokerAddress The broker address to send the query to
+ /// @param query The SQL query to execute
+ /// @param numRows The number of rows to return per page
+ /// @return CompletableFuture containing CursorAwareBrokerResponse with results and cursor metadata
+ /// @throws PinotClientException If query execution fails
default CompletableFuture<CursorAwareBrokerResponse> executeQueryWithCursorAsync(String brokerAddress,
String query, int numRows) throws PinotClientException {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
- /**
- * Fetches the next page for a cursor with specified offset and number of rows.
- *
- * @param brokerAddress The broker address to send the request to
- * @param cursorId The cursor identifier
- * @param offset The offset for pagination
- * @param numRows The number of rows to fetch
- * @return CursorAwareBrokerResponse containing the next page
- * @throws PinotClientException If the fetch operation fails
- */
+ /// Fetches the next page for a cursor with specified offset and number of rows.
+ ///
+ /// @param brokerAddress The broker address to send the request to
+ /// @param cursorId The cursor identifier
+ /// @param offset The offset for pagination
+ /// @param numRows The number of rows to fetch
+ /// @return CursorAwareBrokerResponse containing the next page
+ /// @throws PinotClientException If the fetch operation fails
default CursorAwareBrokerResponse fetchNextPage(String brokerAddress, String cursorId, int offset, int numRows)
throws PinotClientException {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
- /**
- * Fetches the next page for a cursor asynchronously with specified offset and number of rows.
- *
- * @param brokerAddress The broker address to send the request to
- * @param cursorId The cursor identifier
- * @param offset The offset for pagination
- * @param numRows The number of rows to fetch
- * @return CompletableFuture containing the next page
- */
+ /// Fetches the next page for a cursor asynchronously with specified offset and number of rows.
+ ///
+ /// @param brokerAddress The broker address to send the request to
+ /// @param cursorId The cursor identifier
+ /// @param offset The offset for pagination
+ /// @param numRows The number of rows to fetch
+ /// @return CompletableFuture containing the next page
default CompletableFuture<CursorAwareBrokerResponse> fetchNextPageAsync(String brokerAddress, String cursorId,
int offset, int numRows) {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
- /**
- * Fetches the previous page for a cursor with specified offset and number of rows.
- *
- * @param brokerAddress The broker address to send the request to
- * @param cursorId The cursor identifier
- * @param offset The offset for pagination
- * @param numRows The number of rows to fetch
- * @return CursorAwareBrokerResponse containing the previous page
- * @throws PinotClientException If the fetch operation fails
- */
+ /// Fetches the previous page for a cursor with specified offset and number of rows.
+ ///
+ /// @param brokerAddress The broker address to send the request to
+ /// @param cursorId The cursor identifier
+ /// @param offset The offset for pagination
+ /// @param numRows The number of rows to fetch
+ /// @return CursorAwareBrokerResponse containing the previous page
+ /// @throws PinotClientException If the fetch operation fails
default CursorAwareBrokerResponse fetchPreviousPage(String brokerAddress, String cursorId, int offset, int numRows)
throws PinotClientException {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
- /**
- * Fetches the previous page for a cursor asynchronously with specified offset and number of rows.
- *
- * @param brokerAddress The broker address to send the request to
- * @param cursorId The cursor identifier
- * @param offset The offset for pagination
- * @param numRows The number of rows to fetch
- * @return CompletableFuture containing the previous page
- */
+ /// Fetches the previous page for a cursor asynchronously with specified offset and number of rows.
+ ///
+ /// @param brokerAddress The broker address to send the request to
+ /// @param cursorId The cursor identifier
+ /// @param offset The offset for pagination
+ /// @param numRows The number of rows to fetch
+ /// @return CompletableFuture containing the previous page
default CompletableFuture<CursorAwareBrokerResponse> fetchPreviousPageAsync(String brokerAddress, String cursorId,
int offset, int numRows) {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
- /**
- * Seeks to a specific page for a cursor with specified number of rows.
- *
- * @param brokerAddress The broker address to send the request to
- * @param cursorId The cursor identifier
- * @param pageNumber The 1-based page number to seek to (will be converted to offset internally)
- * @param numRows The number of rows to fetch
- * @return CursorAwareBrokerResponse containing the requested page
- * @throws PinotClientException If the seek operation fails
- */
+ /// Seeks to a specific page for a cursor with specified number of rows.
+ ///
+ /// @param brokerAddress The broker address to send the request to
+ /// @param cursorId The cursor identifier
+ /// @param pageNumber The 1-based page number to seek to (will be converted to offset internally)
+ /// @param numRows The number of rows to fetch
+ /// @return CursorAwareBrokerResponse containing the requested page
+ /// @throws PinotClientException If the seek operation fails
default CursorAwareBrokerResponse seekToPage(String brokerAddress, String cursorId, int pageNumber, int numRows)
throws PinotClientException {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
- /**
- * Seeks to a specific page for a cursor asynchronously with specified number of rows.
- *
- * @param brokerAddress The broker address to send the request to
- * @param cursorId The cursor identifier
- * @param pageNumber The 1-based page number to seek to (will be converted to offset internally)
- * @param numRows The number of rows to fetch
- * @return CompletableFuture containing the requested page
- */
+ /// Seeks to a specific page for a cursor asynchronously with specified number of rows.
+ ///
+ /// @param brokerAddress The broker address to send the request to
+ /// @param cursorId The cursor identifier
+ /// @param pageNumber The 1-based page number to seek to (will be converted to offset internally)
+ /// @param numRows The number of rows to fetch
+ /// @return CompletableFuture containing the requested page
default CompletableFuture<CursorAwareBrokerResponse> seekToPageAsync(String brokerAddress, String cursorId,
int pageNumber, int numRows) {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
- /**
- * Retrieves metadata for an existing cursor.
- *
- * @param brokerAddress The broker address in "host:port" format (must be same as cursor creator)
- * @param requestId The unique identifier of the cursor
- * @return BrokerResponse containing cursor metadata
- * @throws PinotClientException If metadata retrieval fails
- */
+ /// Retrieves metadata for an existing cursor.
+ ///
+ /// @param brokerAddress The broker address in "host:port" format (must be same as cursor creator)
+ /// @param requestId The unique identifier of the cursor
+ /// @return BrokerResponse containing cursor metadata
+ /// @throws PinotClientException If metadata retrieval fails
default BrokerResponse getCursorMetadata(String brokerAddress, String requestId) throws PinotClientException {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
- /**
- * Retrieves metadata for an existing cursor asynchronously.
- *
- * @param brokerAddress The broker address in "host:port" format (must be same as cursor creator)
- * @param requestId The unique identifier of the cursor
- * @return CompletableFuture containing BrokerResponse with cursor metadata
- */
+ /// Retrieves metadata for an existing cursor asynchronously.
+ ///
+ /// @param brokerAddress The broker address in "host:port" format (must be same as cursor creator)
+ /// @param requestId The unique identifier of the cursor
+ /// @return CompletableFuture containing BrokerResponse with cursor metadata
default CompletableFuture<BrokerResponse> getCursorMetadataAsync(String brokerAddress, String requestId) {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
- /**
- * Deletes a cursor and cleans up its resources.
- *
- * @param brokerAddress The broker address in "host:port" format (must be same as cursor creator)
- * @param requestId The unique identifier of the cursor to delete
- * @throws PinotClientException If cursor deletion fails
- */
+ /// Deletes a cursor and cleans up its resources.
+ ///
+ /// @param brokerAddress The broker address in "host:port" format (must be same as cursor creator)
+ /// @param requestId The unique identifier of the cursor to delete
+ /// @throws PinotClientException If cursor deletion fails
default void deleteCursor(String brokerAddress, String requestId) throws PinotClientException {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
- /**
- * Deletes a cursor and cleans up its resources asynchronously.
- *
- * @param brokerAddress The broker address in "host:port" format (must be same as cursor creator)
- * @param requestId The unique identifier of the cursor to delete
- * @return CompletableFuture that completes when the cursor is deleted
- */
+ /// Deletes a cursor and cleans up its resources asynchronously.
+ ///
+ /// @param brokerAddress The broker address in "host:port" format (must be same as cursor creator)
+ /// @param requestId The unique identifier of the cursor to delete
+ /// @return CompletableFuture that completes when the cursor is deleted
default CompletableFuture<Void> deleteCursorAsync(String brokerAddress, String requestId) {
throw new UnsupportedOperationException("Cursor operations not supported by this transport implementation");
}
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorResultSetGroup.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorResultSetGroup.java
index 6ea431d1d44..b737d1b0c85 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorResultSetGroup.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/CursorResultSetGroup.java
@@ -20,21 +20,17 @@ package org.apache.pinot.client;
import java.util.List;
-/**
- * A cursor-based result set group that delegates result set access to an internal ResultSetGroup
- * and provides cursor metadata access. This is a pure data container without navigation logic.
- *
- * <p><strong>Thread Safety:</strong> This class is immutable and thread-safe.
- */
+/// A cursor-based result set group that delegates result set access to an internal ResultSetGroup
+/// and provides cursor metadata access. This is a pure data container without navigation logic.
+///
+/// **Thread Safety:** This class is immutable and thread-safe.
public class CursorResultSetGroup implements BaseResultSetGroup {
private final ResultSetGroup _resultSetGroup;
private final CursorAwareBrokerResponse _cursorResponse;
- /**
- * Creates a cursor result set group from a cursor-aware broker response.
- *
- * @param cursorResponse the cursor-aware broker response containing results and cursor metadata
- */
+ /// Creates a cursor result set group from a cursor-aware broker response.
+ ///
+ /// @param cursorResponse the cursor-aware broker response containing results and cursor metadata
public CursorResultSetGroup(CursorAwareBrokerResponse cursorResponse) {
_cursorResponse = cursorResponse;
_resultSetGroup = new ResultSetGroup(cursorResponse);
@@ -110,11 +106,9 @@ public class CursorResultSetGroup implements BaseResultSetGroup {
return _resultSetGroup.getBrokerResponse();
}
- /**
- * Gets the cursor-aware broker response for accessing cursor metadata.
- *
- * @return the cursor-aware broker response
- */
+ /// Gets the cursor-aware broker response for accessing cursor metadata.
+ ///
+ /// @return the cursor-aware broker response
public CursorAwareBrokerResponse getCursorResponse() {
return _cursorResponse;
}
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/DefaultSslContextProvider.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/DefaultSslContextProvider.java
index e0000d42adb..b2588504714 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/DefaultSslContextProvider.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/DefaultSslContextProvider.java
@@ -25,9 +25,7 @@ import javax.net.ssl.SSLEngine;
import org.asynchttpclient.DefaultAsyncHttpClientConfig;
-/**
- * Default SSL context provider that uses the JDK/BCJSSE stack and disables OpenSSL.
- */
+/// Default SSL context provider that uses the JDK/BCJSSE stack and disables OpenSSL.
public class DefaultSslContextProvider implements SslContextProvider {
@Override
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/DynamicBrokerSelector.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/DynamicBrokerSelector.java
index ba82c3a8b98..5c8622149ba 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/DynamicBrokerSelector.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/DynamicBrokerSelector.java
@@ -37,9 +37,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Maintains a mapping between table name and list of brokers
- */
+/// Maintains a mapping between table name and list of brokers
public class DynamicBrokerSelector implements BrokerSelector, IZkDataListener {
private static final Logger LOGGER = LoggerFactory.getLogger(DynamicBrokerSelector.class);
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ExecutionStats.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ExecutionStats.java
index b2d2ef7919a..a07939007bc 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ExecutionStats.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ExecutionStats.java
@@ -23,13 +23,11 @@ import java.util.HashMap;
import java.util.Map;
-/**
- * Simple POJO to hold query execution statistics for a request. These stats come in every
- * query that's executed and can be used for debugging Pinot slow queries.
- *
- * <p>Please note that objects of this class will hold a reference to the given JsonNode object
- * and that will only be released when the object is GC'ed.</p>
- */
+/// Simple POJO to hold query execution statistics for a request. These stats come in every
+/// query that's executed and can be used for debugging Pinot slow queries.
+///
+/// Please note that objects of this class will hold a reference to the given JsonNode object
+/// and that will only be released when the object is GC'ed.
public class ExecutionStats {
private static final String NUM_SERVERS_QUERIED = "numServersQueried";
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ExternalViewReader.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ExternalViewReader.java
index 18989effba2..b5b992eaa91 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ExternalViewReader.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/ExternalViewReader.java
@@ -41,9 +41,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Reads brokers external view from Zookeeper
- */
+/// Reads brokers external view from Zookeeper
public class ExternalViewReader {
private static final Logger LOGGER = LoggerFactory.getLogger(ExternalViewReader.class);
private static final ObjectReader OBJECT_READER = JsonUtils.DEFAULT_READER;
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/GroupByResultSet.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/GroupByResultSet.java
index 80b3de26c2f..b0fc8ef9bd3 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/GroupByResultSet.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/GroupByResultSet.java
@@ -21,10 +21,8 @@ package org.apache.pinot.client;
import com.fasterxml.jackson.databind.JsonNode;
-/**
- * A Pinot query result set for group by results, of which there is one of per aggregation function
- * in the query.
- */
+/// A Pinot query result set for group by results, of which there is one of per aggregation function
+/// in the query.
class GroupByResultSet extends AbstractResultSet {
private final JsonNode _groupByResults;
private final JsonNode _groupByColumns;
@@ -36,10 +34,8 @@ class GroupByResultSet extends AbstractResultSet {
_functionName = jsonObject.get("function").asText();
}
- /**
- * Returns the number of rows in this result group.
- * @return The number of rows in this result group
- */
+ /// Returns the number of rows in this result group.
+ /// @return The number of rows in this result group
@Override
public int getRowCount() {
return _groupByResults.size();
diff --git a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/JsonAsyncHttpPinotClientTransport.java b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/JsonAsyncHttpPinotClientTransport.java
index d0a1aca1aa8..7532dfad10c 100644
--- a/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/JsonAsyncHttpPinotClientTransport.java
+++ b/pinot-clients/pinot-java-client/src/main/java/org/apache/pinot/client/JsonAsyncHttpPinotClientTransport.java
@@ -44,9 +44,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * JSON encoded Pinot client transport over AsyncHttpClient.
- */
+/// JSON encoded Pinot client transport over AsyncHttpClient.
... 187476 lines suppressed ...
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org