mirror of
https://github.com/ebean-orm/ebean.git
synced 2026-10-21 13:24:27 +00:00
* Deprecate DatabaseConfig and DatabaseFactory, prefer Database.builder() Deprecate the DatabaseConfig way of creating Database instance. Migrate to use Database.builder(). * Deprecate DatabaseConfig and DatabaseFactory, migrate test code * Use @Deprecated(forRemoval = true) on DatabaseConfig and DatabaseFactory * Tidy up Database javadoc for deprecation
1.5 KiB
1.5 KiB
AGENTS.md — Ebean ORM
This project uses Ebean ORM.
AI Agent Instructions
Step-by-step guides for common Ebean tasks (Maven setup, database config, query writing, transactions, test containers, DB migrations, Lombok) are at:
https://github.com/ebean-orm/ebean/tree/HEAD/docs/guides/
Key guides (fetch and follow when performing the relevant task):
- Maven POM setup: https://raw.githubusercontent.com/ebean-orm/ebean/HEAD/docs/guides/add-ebean-postgres-maven-pom.md
- Database configuration: https://raw.githubusercontent.com/ebean-orm/ebean/HEAD/docs/guides/add-ebean-postgres-database-config.md
- Migrate to
Database.builder(): https://raw.githubusercontent.com/ebean-orm/ebean/HEAD/docs/guides/migrating-to-database-builder.md - Write queries with query beans: https://raw.githubusercontent.com/ebean-orm/ebean/HEAD/docs/guides/writing-ebean-query-beans.md
- Persisting and transactions: https://raw.githubusercontent.com/ebean-orm/ebean/HEAD/docs/guides/persisting-and-transactions-with-ebean.md
- Test container setup: https://raw.githubusercontent.com/ebean-orm/ebean/HEAD/docs/guides/add-ebean-postgres-test-container.md
- DB migration generation: https://raw.githubusercontent.com/ebean-orm/ebean/HEAD/docs/guides/add-ebean-db-migration-generation.md
- Lombok with entity beans: https://raw.githubusercontent.com/ebean-orm/ebean/HEAD/docs/guides/lombok-with-ebean-entity-beans.md
Agents: Before performing any Ebean-related task, fetch and follow the relevant guide above.