java.lang.Object
- org.jooby.requery.Requery

All Implemented Interfaces:: org.jooby.Jooby.Module

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

requery

Safe, clean and efficient database access via Requery.

usage


 {
   use(new Jdbc());

   use(new Requery(Models.DEFAULT));

   get("/people", () -> {
     EntityStore store = require(EntityStore.class);
     return store.select(Person.class)
        .where(Person.ID.eq(req.param("id").intValue()))
        .get()
        .first();
   });
 }

This module requires a DataSource connection. That's why you also need the Jdbc module.

code generation

maven

We do provide code generation via Maven profile. All you have to do is to write a requery.activator file inside the src/etc folder. File presence triggers Requery annotation processor and generated contents.

Generated content can be found at: target/generated-sources. You can change the default output location by setting the build property requery.output in your pom.xml.

gradle

Please refer to requery documentation for Gradle.

schema generation


 {
   use(new Requery(Models.DEFAULT)
     .schema(TableCreationMode.DROP_CREATE)
   );
 }

Optionally, schema generation could be set from .conf file via requery.schema property.

listeners


 public class MyListener implements EntityStateListener<Person> {
    &#64;Inject
    public MyListener(Dependency dep) {
      this.dep = dep;
    }

    ...
 }

 {
   use(new Requery(Models.DEFAULT)
     .entityStateListener(MyListener.class)
   );
 }

Support for TransactionListener and StatementListener is also provided:


 {
   use(new Requery(Models.DEFAULT)
     .statementListener(MyStatementListener.class)
     .transactionListener(TransactionListener.class)
   );
 }

You can add as many listener as you need. Each listener will be created by Guice

Type-Safe injection

If you love DAO like classes, we are happy to tell you that it you easily inject type-safe EntityStore:



 public class PersonDAO {
   private EntityStore&lt;Persistable, Person&gt; store;

   &#64;Inject
   public PersonDAO(EntityStore&lt;<Persistable, Person&gt; store) {
     this.store = store;
   }
 }

Please note we don't inject a raw EntityStore. Instead we ask for a Person EntityStore. You can safely inject a EntityStore per each of your domain objects.

async and reactive idioms

Rxjava:


 {
   use(Requery.reactive(Models.DEFAULT));

   get("/", () -> {
     ReactiveEntityStore store = require(ReactiveEntityStore.class);
     // work with reactive store
   });
 }

Reactor:


 {
   use(Requery.reactor(Models.DEFAULT));

   get("/", () -> {
     ReactorEntityStore store = require(ReactorEntityStore.class);
     // work with reactor store
   });
 }

Java 8:


 {
   use(Requery.completionStage(Models.DEFAULT));

   get("/", () -> {
     CompletionStageEntityStore store = require(CompletionStageEntityStore.class);
     // work with reactor store
   });
 }

advanced configuration

Advanced configuration is available via callback function:


 {
   use(new Requery(Models.DEFAULT)
     .doWith(builder -> {
       builder.useDefaultLogging();
       ....
     })
   );
 }

Author:: edgar

Constructor Summary

Constructors
Constructor and Description
`Requery(io.requery.meta.EntityModel model)` Creates a new `Requery` module.
`Requery(String name, io.requery.meta.EntityModel model)` Creates a new `Requery` module.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Requery`	`completionStage(io.requery.meta.EntityModel model)` Creates an async Requery module with Java 8 data store.
`static Requery`	`completionStage(String name, io.requery.meta.EntityModel model)` Creates an async Requery module with Java 8 data store.
`void`	`configure(org.jooby.Env env, com.typesafe.config.Config conf, com.google.inject.Binder binder)`
`Requery`	`doWith(BiConsumer<com.typesafe.config.Config,io.requery.sql.ConfigurationBuilder> configurer)` Advanced configuration callback:
`Requery`	`doWith(Consumer<io.requery.sql.ConfigurationBuilder> configurer)` Advanced configuration callback:
`Requery`	`entityStateListener(Class<? extends io.requery.sql.EntityStateListener<?>> listener)` Add an `EntityStateListener`.
`static Requery`	`kotlin(io.requery.meta.EntityModel model)` Creates a Kotlin Requery module.
`static Requery`	`kotlin(String name, io.requery.meta.EntityModel model)` Creates a Kotlin Requery module.
`static Requery`	`reactive(io.requery.meta.EntityModel model)` Creates a Requery module with RxJava data store.
`static Requery`	`reactive(String name, io.requery.meta.EntityModel model)` Creates a Requery module with RxJava data store.
`static Requery`	`reactor(io.requery.meta.EntityModel model)` Creates a Requery module with Reactor data store.
`static Requery`	`reactor(String name, io.requery.meta.EntityModel model)` Creates a Requery module with Reactor data store.
`Requery`	`schema(io.requery.sql.TableCreationMode schema)` Run the give schema command at application startup time.
`Requery`	`statementListener(Class<? extends io.requery.sql.StatementListener> listener)` Add an `StatementListener`.
`Requery`	`transactionListener(Class<? extends io.requery.TransactionListener> listener)` Add an `TransactionListener`.

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
- Requery
```
public Requery(String name,
               io.requery.meta.EntityModel model)
```
  Creates a new Requery module.
  
  Parameters:
  
  name - Database name.
  
  model - Entity model.
- Requery
```
public Requery(io.requery.meta.EntityModel model)
```
  Creates a new Requery module.
  
  Parameters:
  
  model - Entity model.

Method Detail

doWith

public Requery doWith(BiConsumer<com.typesafe.config.Config,io.requery.sql.ConfigurationBuilder> configurer)

Advanced configuration callback:



   use(new Requery(Models.DEFAULT)
     .doWith((conf, builder) -> {
       builder.useDefaultLogging();
     });

Parameters:: configurer - Configurer callback.
Returns:: This module.

doWith

public Requery doWith(Consumer<io.requery.sql.ConfigurationBuilder> configurer)

Advanced configuration callback:



   use(new Requery(Models.DEFAULT)
     .doWith(builder -> {
       builder.useDefaultLogging();
     })
   );

Parameters:: configurer - Configurer callback.
Returns:: This module.

schema
```
public Requery schema(io.requery.sql.TableCreationMode schema)
```
Run the give schema command at application startup time.

Parameters:

schema - Command to run.

Returns:

This module.

entityStateListener
```
public Requery entityStateListener(Class<? extends io.requery.sql.EntityStateListener<?>> listener)
```
Add an EntityStateListener. The listener will be created by Guice.

Parameters:

listener - Guice entity listener.

Returns:

This module.

statementListener
```
public Requery statementListener(Class<? extends io.requery.sql.StatementListener> listener)
```
Add an StatementListener. The listener will be created by Guice.

Parameters:

listener - Guice statement listener.

Returns:

This module.

transactionListener
```
public Requery transactionListener(Class<? extends io.requery.TransactionListener> listener)
```
Add an TransactionListener. The listener will be created by Guice.

Parameters:

listener - Guice transaction listener.

Returns:

This module.

configure

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

Specified by:: configure in interface org.jooby.Jooby.Module

reactive

public static Requery reactive(String name,
                               io.requery.meta.EntityModel model)

Creates a Requery module with RxJava data store.


 {
   use(Requery.reactive(Models.DEFAULT));

   get("/", () -> {
     ReactiveEntityStore store = require(ReactiveEntityStore.class);
     // work with reactive store
   });
 }

Parameters:: name - Database name.; model - Entity model.
Returns:: A new Requery module.

reactive

public static Requery reactive(io.requery.meta.EntityModel model)

Creates a Requery module with RxJava data store.


 {
   use(Requery.reactive(Models.DEFAULT));

   get("/", () -> {
     ReactiveEntityStore store = require(ReactiveEntityStore.class);
     // work with reactive store
   });
 }

Parameters:: model - Entity model.
Returns:: A new Requery module.

reactor

public static Requery reactor(String name,
                              io.requery.meta.EntityModel model)

Creates a Requery module with Reactor data store.


 {
   use(Requery.reactor(Models.DEFAULT));

   get("/", () -> {
     ReactorEntityStore store = require(ReactorEntityStore.class);
     // work with reactive store
   });
 }

Parameters:: name - Database name.; model - Entity model.
Returns:: A new Requery module.

reactor

public static Requery reactor(io.requery.meta.EntityModel model)

Creates a Requery module with Reactor data store.


 {
   use(Requery.reactor(Models.DEFAULT));

   get("/", () -> {
     ReactorEntityStore store = require(ReactorEntityStore.class);
     // work with reactive store
   });
 }

Parameters:: model - Entity model.
Returns:: A new Requery module.

completionStage

public static Requery completionStage(String name,
                                      io.requery.meta.EntityModel model)

Creates an async Requery module with Java 8 data store.


 {
   use(Requery.completionStage(Models.DEFAULT));

   get("/", () -> {
     CompletionStageEntityStore store = require(CompletionStageEntityStore.class);
     // work with reactive store
   });
 }

Parameters:: name - Database name.; model - Entity model.
Returns:: A new Requery module.

completionStage

public static Requery completionStage(io.requery.meta.EntityModel model)

Creates an async Requery module with Java 8 data store.


 {
   use(Requery.completionStage(Models.DEFAULT));

   get("/", () -> {
     CompletionStageEntityStore store = require(CompletionStageEntityStore.class);
     // work with reactive store
   });
 }

Parameters:: model - Entity model.
Returns:: A new Requery module.

kotlin

public static Requery kotlin(String name,
                             io.requery.meta.EntityModel model)

Creates a Kotlin Requery module.


 {
   use(Requery.kotlin(Models.DEFAULT));

   get("/", () -> {
     KotlinEntityDataStore store = require(KotlinEntityDataStore.class);
     // work with kotlin store
   });
 }

Parameters:: name - Database name.; model - Entity model.
Returns:: A new Requery module.

kotlin

public static Requery kotlin(io.requery.meta.EntityModel model)

Creates a Kotlin Requery module.


 {
   use(Requery.kotlin(Models.DEFAULT));

   get("/", () -> {
     KotlinEntityDataStore store = require(KotlinEntityDataStore.class);
     // work with kotlin store
   });
 }

Parameters:: model - Entity model.
Returns:: A new Requery module.

Class Requery

requery

usage

code generation

maven

gradle

schema generation

listeners

Type-Safe injection

async and reactive idioms

advanced configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jooby.Jooby.Module

Constructor Detail

Requery

Requery

Method Detail

doWith

doWith

schema

entityStateListener

statementListener

transactionListener

configure

reactive

reactive

reactor

reactor

completionStage

completionStage

kotlin

kotlin