yashmayya commented on code in PR #17853: URL: https://github.com/apache/pinot/pull/17853#discussion_r2924582379
########## CLAUDE.md: ########## @@ -0,0 +1,74 @@ +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +--> +# CLAUDE.md - Apache Pinot + +## What is this project? +Apache Pinot is a real-time distributed OLAP datastore for low-latency analytics over streaming and batch data. Core runtime roles: **broker** (query routing), **server** (segment storage/execution), **controller** (cluster metadata/management), **minion** (async tasks). + +## Repository layout +| Directory | Purpose | +|---|---| +| `pinot-broker` | Broker query planning and scatter-gather | +| `pinot-controller` | Controller APIs, table/segment metadata, Helix management | +| `pinot-server` | Server query execution, segment loading, indexing | +| `pinot-minion` | Background tasks (segment conversion, purge, etc.) | +| `pinot-common` / `pinot-spi` | Shared utils, config, and SPI interfaces | +| `pinot-segment-local` / `pinot-segment-spi` | Segment generation, indexes, storage | +| `pinot-query-planner` / `pinot-query-runtime` | Multi-stage query (MSQ) engine | Review Comment: nit: we use MSQE or MSE as abbreviations, not MSQ ########## CLAUDE.md: ########## @@ -0,0 +1,74 @@ +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +--> +# CLAUDE.md - Apache Pinot + +## What is this project? +Apache Pinot is a real-time distributed OLAP datastore for low-latency analytics over streaming and batch data. Core runtime roles: **broker** (query routing), **server** (segment storage/execution), **controller** (cluster metadata/management), **minion** (async tasks). + +## Repository layout +| Directory | Purpose | +|---|---| +| `pinot-broker` | Broker query planning and scatter-gather | +| `pinot-controller` | Controller APIs, table/segment metadata, Helix management | +| `pinot-server` | Server query execution, segment loading, indexing | +| `pinot-minion` | Background tasks (segment conversion, purge, etc.) | +| `pinot-common` / `pinot-spi` | Shared utils, config, and SPI interfaces | +| `pinot-segment-local` / `pinot-segment-spi` | Segment generation, indexes, storage | +| `pinot-query-planner` / `pinot-query-runtime` | Multi-stage query (MSQ) engine | +| `pinot-connectors` | External tooling to connect to Pinot | +| `pinot-plugins` | All Pinot plugins (input formats, filesystems, stream/batch ingestion, metrics, etc.) | +| `pinot-tools` | CLI and quickstart scripts | +| `pinot-integration-tests` | End-to-end validation suites | +| `pinot-distribution` | Packaging artifacts | + +## Build commands +- **JDK**: Use JDK 11+ (CI runs 11/21); code targets Java 11. +- **Default build**: `./mvnw clean install` +- **Fast dev build**: `./mvnw verify -Ppinot-fastdev` +- **Full binary/shaded build**: `./mvnw clean install -DskipTests -Pbin-dist -Pbuild-shaded-jar` +- **Build a module with deps**: `./mvnw -pl pinot-server -am test` +- **Single test**: `./mvnw -pl pinot-segment-local -Dtest=RangeIndexTest test` +- **Single integration test**: `./mvnw -pl pinot-integration-tests -am -Dtest=OfflineClusterIntegrationTest -Dsurefire.failIfNoSpecifiedTests=false test` +- **Quickstart (after build)**: `build/bin/quick-start-batch.sh` + +## Code style and formatting +- Run `./mvnw spotless:apply` to auto-format code. +- Run `./mvnw checkstyle:check` to validate style. Checkstyle config is in `config/checkstyle.xml`. +- Run `./mvnw license:format` to add license headers to new files. +- Run `./mvnw license:check` to validate license headers. +- Always use the Maven wrapper (`./mvnw`) rather than a system `mvn`. + +## Coding conventions Review Comment: Can we add a point here about avoiding qualified class names (`path.to.packageName.className`) and preferring imports instead? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
