Welcome to Doma

Doma is a database access framework for Java. Doma has various strengths:

• Verifies and generates source code at compile time using annotation processing.

• Provides type-safe Criteria API.

• Supports Kotlin.

• Uses SQL templates, called “two-way SQL”.

• Has no dependence on other libraries.

This document consists of following sections:

• User Documentation

• About Doma

• Links

Please help with the improvement and localization of our documentation.

For matters related to the English version of the documentation and general issues concerning the documentation, please add issues or pull requests to the GitHub repository.

For localization into Japanese, please perform translations and voting through the project on Crowdin.

User Documentation

• Getting started
  • Summary
  • Install JDK
  • Get sample project
  • Sample project structure
  • Import project to your IDE
  • Programming styles
  • DSL style
  • DAO style
  • Next Step
• Configuration
  • Configurable items
  • Loading JDBC drivers
  • Configuration definition
• Basic classes
  • Overview
  • List of basic classes
  • Examples
• Domain classes
  • Internal domain classes
  • External domain classes
  • Example
• Embeddable classes
  • Embeddable definition
  • Field definition
  • Method definition
  • Example
• Entity classes
  • Entity definition
  • Field definition
  • Method definition
  • Example
• DAO interfaces
  • Dao definition
  • Query definition
  • Default method
  • Example
• Queries
  • Select
  • Insert
  • Update
  • Delete
  • Batch insert
  • Batch update
  • Batch delete
  • Multi-row insert
  • Stored function
  • Stored procedure
  • Factories
  • Script
  • SQL processor
• Query builders
  • Search
  • Insert
  • Update
  • Delete
• Criteria API
  • Introduction
  • Select statement
  • Delete statement
  • Insert statement
  • Update statement
  • Property expressions (Entityql, NativeSql)
  • Scopes (Entityql, NativeSql)
  • Tips
  • Sample projects
• SQL templates
  • Overview
  • SQL templates in files
  • SQL templates in annotations
  • Directives
  • Comments
  • doma-template module
• Expression language
  • Literals
  • Comparison operators
  • Logical operators
  • Arithmetic operators
  • String concatenation operator
  • Calling instance methods
  • Accessing to instance fields
  • Calling static methods
  • Accessing to static fields
  • Using built-in functions
  • Using custom functions
• Transaction
  • Configuration
  • Usage
• Building an application
  • Maven Central Repository
  • Build with Gradle
  • Build with Maven
  • Build with Eclipse
  • Build with IntelliJ IDEA
• Annotation processing
  • Options
  • Setting options in Gradle
  • Setting options in Maven
  • Setting options in Eclipse
  • Setting options in IntelliJ IDEA
  • Setting options with configuration file
• Lombok support
  • Overview
  • Best practices
• Kotlin support
  • Best practices
  • Sample project
• SLF4J support
  • Overview
  • Gradle
  • Configuration
  • Loggers
  • Examples
• JPMS support
  • Overview
  • Modules
  • Usage
• Quarkus support
  • Overview
  • Installing
  • Main features
  • Sample project
• Doma CodeGen Plugin
  • Overview
  • How to use
  • Gradle Tasks
  • Config Options
  • Customization
  • Sample Project
  • Footnote

About Doma

• Frequently Asked Questions

Links

• News and announcements

• GitHub repository

• Release Notes

• JavaDoc

• Examples

• Doma Compile Plugin

• Doma CodeGen Plugin

• Doma version 1