Skip to content

AGENTS.md

Latest commit

 

History

History
90 lines (66 loc) · 3.63 KB

AGENTS.md

File metadata and controls

90 lines (66 loc) · 3.63 KB

Apache Druid

Real-time analytics database. Java, Maven, multi-module project.

Key Modules

  • processing/: Core query processing, aggregation, data structures
  • server/: Common server functionality, HTTP services
  • sql/: SQL planning (Calcite), SQL-to-native translation
  • indexing-service/: Task framework, ingestion coordination
  • multi-stage-query/: MSQ engine
  • extensions-core/: Core extensions (S3, Kafka, Kinesis, Parquet, DataSketches, etc.)
  • web-console/: React/TypeScript management UI
  • quidem-ut/: SQL query testing framework

Code Style

  • Read dev/style-conventions.md for conventions.
  • Forbidden APIs: codestyle/druid-forbidden-apis.txt.
  • Always use final for fields and variables that are not reassigned.
  • End every file with a newline.
  • Don't format changes unnecessarily.

Running Tests

Use these flags for faster tests: -Pskip-static-checks -Dweb.console.skip=true -T1C

Single test method:

mvn test -pl sql -am -Dtest="org.apache.druid.sql.calcite.CalciteQueryTest#testFoo" -Dsurefire.failIfNoSpecifiedTests=false -Pskip-static-checks -Dweb.console.skip=true -T1C

All tests in a package:

mvn test -pl sql -am -Dtest="org.apache.druid.sql.**" -Dsurefire.failIfNoSpecifiedTests=false -Pskip-static-checks -Dweb.console.skip=true -T1C

Quidem (.iq) tests:

To run sql/src/test/quidem/org.apache.druid.quidem.SqlQuidemTest/numMerge.iq:

mvn test -pl sql -am -Dtest="org.apache.druid.sql.calcite.SqlQuidemTest" -Dquidem.filter=numMerge -Dsurefire.failIfNoSpecifiedTests=false -Pskip-static-checks -Dweb.console.skip=true -T1C

To run quidem-ut/src/test/quidem/org.apache.druid.quidem.QTest/qaWin/basics_group_by.all.iq:

mvn test -pl quidem-ut -am -Dtest="org.apache.druid.quidem.QTest" -Dquidem.filter=qaWin/basics_group_by.all -Dsurefire.failIfNoSpecifiedTests=false -Pskip-static-checks -Dweb.console.skip=true -T1C

Always use -Dquidem.filter to avoid running the full suite. To run multiple tests, use commas like -Dquidem.filter=file1,file2,file3 or use wildcards like -Dquidem.filter=join*. Include subdirectory names if present, such as -Dquidem.filter=qaWin/**.

Web Console Development

Refer to web-console/README.md for general instructions on developing the web console.

Run npm run test-unit from the web-console/ directory to verify your work. Before doing this for the first time in a fresh checkout, you will also need to run npm install.

Run npm run autofix from the web-console/ directory to fix formatting issues.

Documentation

  • When updating Markdown tables in docs/, preserve the existing table formatting.
  • Use backquotes for any code references. e.g., serverPriorityToReplicas, ioConfig.
  • Run npm run spellcheck from the website/ directory to verify doc updates and update the .spelling file if needed.