databricks-jdbc
CLAUDE.md41 starsChanged 3 months agoApache-2.0View on GitHub
When adding or changing an error emitted by the JDBC driver: - Use DatabricksDriverErrorCode wherever a driver-owned error code applies. Reuse an existing code when its meaning matches; otherwise add a uniquely numbered enum value. - Add or update a test that verifies the emitted error name and numeric code. - Record whether the error is a driver, server, or user error in the maintainers' OSS JDBC telemetry dashboard and automation taxonomy. Link that update in the PR, or explicitly…
The file
We split this CLAUDE.md into the rules it gives an agent
6 rules. About 0 are common, 3 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 19
When adding or changing an error emitted by the JDBC driver:
- Very specific: line 21
Use DatabricksDriverErrorCode wherever a driver-owned error code applies.
- Distinctive: line 23
Add or update a test that verifies the emitted error name and numeric code.
- Very specific: line 34
Every commit must include a Signed-off-by line.
- Very specific: line 53
When a release freeze is active (development/.release-freeze.json has "freeze": true), PRs are blocked from merging.
- Distinctive: line 61
Follow the Google Java Style Guide
≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
CLAUDE.md — Databricks JDBC Driver
Build & Test
- Build:
mvn clean install -DskipTests - Run tests:
mvn test - Run a single test:
mvn test -pl . -Dtest=ClassName#methodName - Format code:
mvn spotless:apply(also runs automatically during build/test) - JDK: Java 11+
Project Structure
src/main/java/com/databricks/jdbc/— main driver sourcesrc/test/java/com/databricks/jdbc/— unit and integration testsdevelopment/.release-freeze.json— controls release freeze state
Telemetry Error Changes
When adding or changing an error emitted by the JDBC driver:
- Use
DatabricksDriverErrorCodewherever a driver-owned error code applies. Reuse an existing code when its meaning matches; otherwise add a uniquely numbered enum value. - Add or update a test that verifies the emitted error name and numeric code.
- Record whether the error is a driver, server, or user error in the maintainers' OSS JDBC telemetry dashboard and automation taxonomy. Link that update in the PR, or explicitly ask a maintainer to make it if you do not have access. Do not infer the classification from the error name alone.
- Complete the telemetry-error section of the pull-request template.
PR Checks — Common Pitfalls
1. DCO Sign-off (required)
Every commit must include a Signed-off-by line. Always use the -s flag:
git commit -s -m "Your commit message"2. NEXT_CHANGELOG.md (required unless opted out)
The check-next-changelog CI check verifies that either:
NEXT_CHANGELOG.mdis modified in the PR, or- The PR description body contains
NO_CHANGELOG=true
When to add a changelog entry: Any change visible to users — bug fixes, new features, behavior changes, dependency bumps, or API changes. Add a brief description under the appropriate section (### Added, ### Updated, or ### Fixed) in NEXT_CHANGELOG.md.
When to opt out with NO_CHANGELOG=true: Internal refactors, test-only changes, CI/tooling updates, or documentation changes that don't affect driver behavior.
3. Release Freeze
When a release freeze is active (development/.release-freeze.json has "freeze": true), PRs are blocked from merging. To override, add OVERRIDE_FREEZE=true to the PR description. Use this only when the merge is necessary during the freeze window.
4. GitHub Account (non-EMU)
Users may have multiple GitHub accounts (e.g., an EMU/enterprise account and a personal account). Pushing and creating PRs on this repo requires the non-EMU account. Check the active account with gh auth status and switch if needed with gh auth switch --user <username>.
Coding Conventions
- Follow the Google Java Style Guide
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

