org.sql2o

Class Query

java.lang.Object

org.sql2o.Query

All Implemented Interfaces:

AutoCloseable

public class Query
extends Object
implements AutoCloseable

Represents a sql2o statement. With sql2o, all statements are instances of the Query class.

Constructor Summary

Constructors

Constructor and Description
Query(Connection connection, String queryText, String name, boolean returnGeneratedKeys)

Method Summary

Modifier and Type	Method and Description
Query	addColumnMapping(String columnName, String propertyName)
<T> Query	addParameter(String name, Class<T> parameterClass, T value)
Query	addParameter(String name, InputStream value)
Query	addParameter(String name, int value)
Query	addParameter(String name, Integer value)
Query	addParameter(String name, long value)
Query	addParameter(String name, Long value)
Query	addParameter(String name, Object value)
Query	addParameter(String name, String value)
Query	addParameter(String name, Time value)
Query	addParameter(String name, Timestamp value)
Query	addToBatch() batch stuff
Query	bind(Object pojo)
void	close()
<T> List<T>	executeAndFetch(Class<T> returnType)
<T> List<T>	executeAndFetch(ResultSetHandler<T> resultSetHandler)
<T> List<T>	executeAndFetch(ResultSetHandlerFactory<T> factory)
<T> T	executeAndFetchFirst(Class<T> returnType)
<T> T	executeAndFetchFirst(ResultSetHandler<T> resultSetHandler)
<T> T	executeAndFetchFirst(ResultSetHandlerFactory<T> resultSetHandlerFactory)
<T> ResultSetIterable<T>	executeAndFetchLazy(Class<T> returnType) Read a collection lazily.
<T> ResultSetIterable<T>	executeAndFetchLazy(ResultSetHandler<T> resultSetHandler) Read a collection lazily.
<T> ResultSetIterable<T>	executeAndFetchLazy(ResultSetHandlerFactory<T> resultSetHandlerFactory) Read a collection lazily.
Table	executeAndFetchTable()
LazyTable	executeAndFetchTableLazy()
Connection	executeBatch()
Object	executeScalar()
<V> V	executeScalar(Class<V> returnType)
<V> V	executeScalar(Converter<V> converter)
<T> List<T>	executeScalarList(Class<T> returnType)
Connection	executeUpdate()
Map<String,String>	getColumnMappings() column mapping
Connection	getConnection()
String	getName()
Map<String,List<Integer>>	getParamNameToIdxMap()
ResultSetHandlerFactoryBuilder	getResultSetHandlerFactoryBuilder()
boolean	isAutoDeriveColumnNames()
boolean	isCaseSensitive()
boolean	isThrowOnMappingFailure()
Query	setAutoDeriveColumnNames(boolean autoDeriveColumnNames)
Query	setCaseSensitive(boolean caseSensitive)
Query	setColumnMappings(Map<String,String> mappings)
void	setResultSetHandlerFactoryBuilder(ResultSetHandlerFactoryBuilder resultSetHandlerFactoryBuilder)
Query	throwOnMappingFailure(boolean throwOnMappingFailure)
String	toString()
Query	withParams(Object... paramValues)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Query

public Query(Connection connection,
             String queryText,
             String name,
             boolean returnGeneratedKeys)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

isCaseSensitive

public boolean isCaseSensitive()

setCaseSensitive

public Query setCaseSensitive(boolean caseSensitive)

isAutoDeriveColumnNames

public boolean isAutoDeriveColumnNames()

setAutoDeriveColumnNames

public Query setAutoDeriveColumnNames(boolean autoDeriveColumnNames)

throwOnMappingFailure

public Query throwOnMappingFailure(boolean throwOnMappingFailure)

isThrowOnMappingFailure

public boolean isThrowOnMappingFailure()

getConnection

public Connection getConnection()

getName

public String getName()

getResultSetHandlerFactoryBuilder

public ResultSetHandlerFactoryBuilder getResultSetHandlerFactoryBuilder()

setResultSetHandlerFactoryBuilder

public void setResultSetHandlerFactoryBuilder(ResultSetHandlerFactoryBuilder resultSetHandlerFactoryBuilder)

getParamNameToIdxMap

public Map<String,List<Integer>> getParamNameToIdxMap()

addParameter

public <T> Query addParameter(String name,
                              Class<T> parameterClass,
                              T value)

withParams

public Query withParams(Object... paramValues)

addParameter

public Query addParameter(String name,
                          Object value)

addParameter

public Query addParameter(String name,
                          InputStream value)

addParameter

public Query addParameter(String name,
                          int value)

addParameter

public Query addParameter(String name,
                          Integer value)

addParameter

public Query addParameter(String name,
                          long value)

addParameter

public Query addParameter(String name,
                          Long value)

addParameter

public Query addParameter(String name,
                          String value)

addParameter

public Query addParameter(String name,
                          Timestamp value)

addParameter

public Query addParameter(String name,
                          Time value)

bind

public Query bind(Object pojo)

close

public void close()

Specified by:

close in interface AutoCloseable

executeAndFetchLazy

public <T> ResultSetIterable<T> executeAndFetchLazy(Class<T> returnType)

Read a collection lazily. Generally speaking, this should only be used if you are reading MANY results and keeping them all in a Collection would cause memory issues. You MUST call ResultSetIterable.close() when you are done iterating.

Parameters:

returnType - type of each row

Returns:

iterable results

executeAndFetchLazy

public <T> ResultSetIterable<T> executeAndFetchLazy(ResultSetHandlerFactory<T> resultSetHandlerFactory)

Read a collection lazily. Generally speaking, this should only be used if you are reading MANY results and keeping them all in a Collection would cause memory issues. You MUST call ResultSetIterable.close() when you are done iterating.

Parameters:

resultSetHandlerFactory - factory to provide ResultSetHandler

Returns:

iterable results

executeAndFetchLazy

public <T> ResultSetIterable<T> executeAndFetchLazy(ResultSetHandler<T> resultSetHandler)

Read a collection lazily. Generally speaking, this should only be used if you are reading MANY results and keeping them all in a Collection would cause memory issues. You MUST call ResultSetIterable.close() when you are done iterating.

Parameters:

resultSetHandler - ResultSetHandler

Returns:

iterable results

executeAndFetch

public <T> List<T> executeAndFetch(Class<T> returnType)

executeAndFetch

public <T> List<T> executeAndFetch(ResultSetHandler<T> resultSetHandler)

executeAndFetch

public <T> List<T> executeAndFetch(ResultSetHandlerFactory<T> factory)

executeAndFetchFirst

public <T> T executeAndFetchFirst(Class<T> returnType)

executeAndFetchFirst

public <T> T executeAndFetchFirst(ResultSetHandler<T> resultSetHandler)

executeAndFetchFirst

public <T> T executeAndFetchFirst(ResultSetHandlerFactory<T> resultSetHandlerFactory)

executeAndFetchTableLazy

public LazyTable executeAndFetchTableLazy()

executeAndFetchTable

public Table executeAndFetchTable()

executeUpdate

public Connection executeUpdate()

executeScalar

public Object executeScalar()

executeScalar

public <V> V executeScalar(Class<V> returnType)

executeScalar

public <V> V executeScalar(Converter<V> converter)

executeScalarList

public <T> List<T> executeScalarList(Class<T> returnType)

addToBatch

public Query addToBatch()

batch stuff

executeBatch

public Connection executeBatch()
                        throws Sql2oException

Throws:

Sql2oException

getColumnMappings

public Map<String,String> getColumnMappings()

column mapping

setColumnMappings

public Query setColumnMappings(Map<String,String> mappings)

addColumnMapping

public Query addColumnMapping(String columnName,
                              String propertyName)