Step-by-step guides written as instructions for AI agents and developers.
Step-by-step guides covering common scenarios for creating and configuring connection pools.
| Guide | Description |
|---|---|
| Create a DataSource Pool | Basic pool creation, read-only pools, Kubernetes configuration, AWS Lambda setup, and configuration reference |
| Connection Validation Best Practices | How connection validation works; when and how to configure heartbeat validation; why explicit heartbeatSql is rarely needed |
Configuration guides for AWS Aurora database deployments.
| Guide | Description |
|---|---|
| AWS Aurora with Dual DataSources | Setup dual DataSource pools for Aurora read-write separation using read and write endpoints; integrate with Ebean ORM for automatic query routing; failover and monitoring |
AI coding agents can only follow these guides if they know they exist. Below are copy-paste snippets for the most common AI tooling configurations. Add whichever applies to your project.
Add a section near the top of your project README:
## Documentation & Guides
This project includes step-by-step guides for common tasks with the ebean-datasource connection pool:
**https://github.com/ebean-orm/ebean-datasource/tree/main/docs/guides/**
AI agents should fetch and follow the relevant guide before performing datasource-related tasks.Many AI agents (Copilot, Claude, Cursor, Aider) read the project README.md
automatically as part of understanding the codebase. A visible link in README is the
most universally effective way to ensure any agent working on your project will
discover the guides without requiring tool-specific configuration files.
## ebean-datasource
This project uses ebean-datasource for connection pooling. Step-by-step guides for common
tasks are at: https://github.com/ebean-orm/ebean-datasource/tree/main/docs/guides/
Key guides (fetch and follow when performing the relevant task):
- Create a DataSource Pool: https://raw.githubusercontent.com/ebean-orm/ebean-datasource/main/docs/guides/create-datasource-pool.mdSame content as above — Claude Code reads CLAUDE.md at the project root.
---
description: ebean-datasource connection pool guidance
globs: ["**/*.java", "**/pom.xml"]
alwaysApply: false
---
## ebean-datasource
This project uses ebean-datasource for connection pooling. Before performing any datasource configuration task, fetch and
follow the relevant step-by-step guide from:
https://github.com/ebean-orm/ebean-datasource/tree/main/docs/guides/