org.jooby.jdbi

Class Jdbi3

java.lang.Object

org.jooby.jdbi.Jdbi3

All Implemented Interfaces:

org.jooby.Jooby.Module

public class Jdbi3
extends Object
implements org.jooby.Jooby.Module

jdbi

Jdbi provides a convenience interface for SQL operations in Java.

This module depends on Jdbc module.

usage

 {
   use(new Jdbc());

   use(new Jdbi3());

   get("/pets", () -> {
     Jdbi jdbi = require(Jdbi.class);
     return jdbi.withHandle(handle -> {
       // work with handle
       return ...;
     })
   });
 }
 

transaction per request

 {
   use(new Jdbc());

   use(new Jdbi3()
       .transactionPerRequest()
   );

   get("/pets", () -> {
     // This code run inside a transaction
     Handle handle = require(Handle.class);
     // work with handle
     return ...;
   });
 }
 

The {#transactionPerRequest()} opens a Handle then start, commit/rollback a transaction and finally close a Handle.

The Handle is accessible via `require` call inside a route handler:

 {
   get("/pets", () -> {
     // This code run inside a transaction
     Handle handle = require(Handle.class);
     // work with handle
     return ...;
   });
 }
 

You can optionally name the Handle:

 {

   use(new Jdbi3()
       .transactionPerRequest(new TransactionalRequest()
           .handle("trxPerReq")
       )
   );

   get("/pets", () -> {
     // This code run inside a transaction
     Handle handle = require("trxPerReq", Handle.class);
     // work with handle
     return ...;
   });
 }
 

sqlObjects

You can attach `SqlObjects` to the transaction per request `Handle`:

 {

   use(new Jdbi3()
       .transactionPerRequest(new TransactionalRequest()
           .attach(PetRepository.class)
       )
   );

   get("/pets", () -> {
     // Now you can request a pet repository:
     PetRepository petRepo = require(PetRepository.class);
     // work with petRepo
     return ...;
   });
 }
 

multiple database connections

 {
   use(new Jdbc("main"));
   use(new Jdbi3("main"));

   use(new Jdbc("audit"));
   use(new Jdbi3("audit"));

   get("/", () -> {
     Jdbi main = require("main", Jdbi.class);
     Jdbi audit = require("audit", Jdbi.class);
     ...
   });
 }
 

configuration

Configuration is done via configuration callback:

 {

   use(new Jdbc());

   use(new Jdbi3().doWith(jdbi -> {
     jdbi.installPlugin(new SqlObjectPlugin());
   }));
 }
 

Since:

1.2.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Jdbi3() Creates a new Jdbi module and connects to default database key: db.
Jdbi3(String name) Creates a new Jdbi module and connect to the given database.

Method Summary

Modifier and Type	Method and Description
void	configure(org.jooby.Env env, com.typesafe.config.Config conf, com.google.inject.Binder binder)
Jdbi3	doWith(BiConsumer<org.jdbi.v3.core.Jdbi,com.typesafe.config.Config> configurer) Configurer a jdbi instance.
Jdbi3	doWith(Consumer<org.jdbi.v3.core.Jdbi> configurer) Configurer a jdbi instance.
Jdbi3	transactionPerRequest() Add a transaction-per-request filter to the route pipeline.
Jdbi3	transactionPerRequest(TransactionalRequest request) Add a transaction-per-request filter to the route pipeline.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jooby.Jooby.Module

config

Constructor Detail

Jdbi3

public Jdbi3(String name)

Creates a new Jdbi module and connect to the given database.

Parameters:

name - Database key.

Jdbi3

public Jdbi3()

Creates a new Jdbi module and connects to default database key: db.

Method Detail

doWith

public Jdbi3 doWith(BiConsumer<org.jdbi.v3.core.Jdbi,com.typesafe.config.Config> configurer)

Configurer a jdbi instance.

Parameters:

configurer - Configurer callback.

Returns:

This module.

doWith

public Jdbi3 doWith(Consumer<org.jdbi.v3.core.Jdbi> configurer)

Configurer a jdbi instance.

Parameters:

configurer - Configurer callback.

Returns:

This module.

transactionPerRequest

public Jdbi3 transactionPerRequest()

Add a transaction-per-request filter to the route pipeline.

Returns:

This module.

transactionPerRequest

public Jdbi3 transactionPerRequest(TransactionalRequest request)

Add a transaction-per-request filter to the route pipeline.

Parameters:

request - Transactional request options.

Returns:

This module.

configure

public void configure(org.jooby.Env env,
                      com.typesafe.config.Config conf,
                      com.google.inject.Binder binder)
               throws Throwable

Specified by:

configure in interface org.jooby.Jooby.Module

Throws:

Throwable