org.skife.jdbi.v2.unstable

Annotation Type BindIn

@Retention(value=RUNTIME)
public @interface BindIn

Binds an Iterable or array/varargs of any type to a placeholder as a comma-separated list (e.g. for WHERE X IN (...) query statements). Throws IllegalArgumentException if the argument is not an array or Iterable. How null and empty collections are handled can be configured with onEmpty:EmptyHandling - throws IllegalArgumentException by default. Don't forget to add @UseStringTemplate3StatementLocator to your query class and use the correct placeholder format: @SqlQuery("SELECT * FROM THINGS WHERE ID IN (<ids>)") abstract Object[] foo(@BindIn("ids") int[] ids); ids = [1, 2, 3] -> SELECT * FROM THINGS WHERE ID IN (1,2,3)

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value placeholder in your query to be replaced with comma-separated list

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
BindIn.EmptyHandling	onEmpty what to do when the argument is null or empty

Element Detail

value

public abstract String value

placeholder in your query to be replaced with comma-separated list

onEmpty

public abstract BindIn.EmptyHandling onEmpty

what to do when the argument is null or empty

Default:

org.skife.jdbi.v2.unstable.BindIn.EmptyHandling.THROW