org.jooby.jdbi

Class Jdbi

java.lang.Object

org.jooby.jdbi.Jdbi

All Implemented Interfaces:

org.jooby.Jooby.Module

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

Exposes DBI, Handle and SQL Objects (a.k.a DAO).

This module depends on Jdbc module.

usage

It is pretty straightforward:

 {
   use(new Jdbc());
   use(new Jdbi());

   get("/", req  -> {
     DBI dbi = req.require(DBI.class);
     // ... work with dbi
   });

   get("/handle", req  -> {
     try (Handle handle = req.require(Handle.class)) {
       // ... work with dbi handle
     }
   });
 }
 

A call to req.require(Handle.class) is the same as: req.require(DBI.class).open(Handle.class).

sql objects

 public interface MyRepository extends Closeable {
   @SqlUpdate("create table something (id int primary key, name varchar(100))")
   void createSomethingTable();

   @SqlUpdate("insert into something (id, name) values (:id, :name)")
   void insert(@ind("id") int id, @Bind("name") String name);

   @SqlQuery("select name from something where id = :id")
   String findNameById(@Bind("id") int id);
 }

 ...
 {
   use(new Jdbc());
   use(new Jdbi());

   get("/handle", req  -> {
     try (MyRepository h = req.require(MyRepository.class)) {
       h.createSomethingTable();

       h.insert(1, "Jooby");

       String name = h.findNameById(1);

       return name;
     }
   });
 }
 

configuration

If you need to configure and/or customize a DBI instance, just do:

 {
   use(new Jdbc());
   use(new Jdbi().doWith((dbi, config)  -> {
     // set custom option
   }));
 }
 

That's all folks! Enjoy it!!!

Since:

0.5.0

Author:

edgar

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARG_FACTORIES

Constructor Summary

Constructors

Constructor and Description
Jdbi(Class<?>... sqlObjects)
Jdbi(String db, Class<?>... sqlObjects)

Method Summary

Modifier and Type	Method and Description
void	configure(org.jooby.Env env, com.typesafe.config.Config config, com.google.inject.Binder binder)
Jdbi	doWith(BiConsumer<org.skife.jdbi.v2.DBI,com.typesafe.config.Config> configurer) Configure DBI instance.
Jdbi	doWith(Consumer<org.skife.jdbi.v2.DBI> configurer) Configure DBI instance.

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

Field Detail

ARG_FACTORIES

public static final String ARG_FACTORIES

See Also:

Constant Field Values

Constructor Detail

Jdbi

public Jdbi(Class<?>... sqlObjects)

Jdbi

public Jdbi(String db,
            Class<?>... sqlObjects)

Method Detail

configure

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

Specified by:

configure in interface org.jooby.Jooby.Module

doWith

public Jdbi doWith(BiConsumer<org.skife.jdbi.v2.DBI,com.typesafe.config.Config> configurer)

Configure DBI instance.

Parameters:

configurer - Configurer.

Returns:

This module.

doWith

public Jdbi doWith(Consumer<org.skife.jdbi.v2.DBI> configurer)

Configure DBI instance.

Parameters:

configurer - Configurer.

Returns:

This module.