com.github.susom.database

Interface SqlSelect

All Known Implementing Classes:

SqlSelectImpl

public interface SqlSelect

Interface for configuring (setting parameters) and executing a chunk of SQL.

Author:

garricko

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SqlSelect.Apply

Method Summary

Modifier and Type	Method and Description
SqlSelect	apply(SqlSelect.Apply apply)
SqlSelect	argBigDecimal(BigDecimal arg)
SqlSelect	argBigDecimal(String argName, BigDecimal arg)
SqlSelect	argBoolean(Boolean arg)
SqlSelect	argBoolean(String argName, Boolean arg)
SqlSelect	argDate(Date arg)
SqlSelect	argDate(String argName, Date arg)
SqlSelect	argDateNowPerApp()
SqlSelect	argDateNowPerApp(String argName)
SqlSelect	argDateNowPerDb()
SqlSelect	argDateNowPerDb(String argName)
SqlSelect	argDouble(Double arg)
SqlSelect	argDouble(String argName, Double arg)
SqlSelect	argFloat(Float arg)
SqlSelect	argFloat(String argName, Float arg)
SqlSelect	argInteger(Integer arg)
SqlSelect	argInteger(String argName, Integer arg)
SqlSelect	argLocalDate(LocalDate arg)
SqlSelect	argLocalDate(String argName, LocalDate arg)
SqlSelect	argLong(Long arg)
SqlSelect	argLong(String argName, Long arg)
SqlSelect	argString(String arg)
SqlSelect	argString(String argName, String arg)
SqlSelect	fetchSize(int fetchSize)
<T> T	query(RowsHandler<T> rowsHandler) This is the most generic and low-level way to iterate the query results.
BigDecimal	queryBigDecimalOrNull()
BigDecimal	queryBigDecimalOrZero()
List<BigDecimal>	queryBigDecimals()
boolean	queryBooleanOrFalse()
Boolean	queryBooleanOrNull()
boolean	queryBooleanOrTrue()
Date	queryDateOrNull()
List<Date>	queryDates()
Double	queryDoubleOrNull()
double	queryDoubleOrZero()
List<Double>	queryDoubles()
<T> T	queryFirstOrNull(RowHandler<T> rowHandler) Query zero or one row.
<T> T	queryFirstOrThrow(RowHandler<T> rowHandler) Query zero or one row.
Float	queryFloatOrNull()
float	queryFloatOrZero()
List<Float>	queryFloats()
Integer	queryIntegerOrNull()
int	queryIntegerOrZero()
List<Integer>	queryIntegers()
LocalDate	queryLocalDateOrNull()
List<LocalDate>	queryLocalDates()
Long	queryLongOrNull()
long	queryLongOrZero()
List<Long>	queryLongs() Shorthand for reading numbers from the first column of the result.
<T> List<T>	queryMany(RowHandler<T> rowHandler) Query zero or more rows.
<T> T	queryOneOrNull(RowHandler<T> rowHandler) Query zero or one row.
<T> T	queryOneOrThrow(RowHandler<T> rowHandler) Query exactly one row.
String	queryStringOrEmpty()
String	queryStringOrNull()
List<String>	queryStrings() Shorthand for reading strings from the first column of the result.
SqlSelect	withArgs(SqlArgs args)
SqlSelect	withMaxRows(int rows)
SqlSelect	withTimeoutSeconds(int seconds)

Method Detail

argBoolean

@Nonnull
 @CheckReturnValue
SqlSelect argBoolean(Boolean arg)

argBoolean

@Nonnull
 @CheckReturnValue
SqlSelect argBoolean(@Nonnull
                                                 String argName,
                                                 Boolean arg)

argInteger

@Nonnull
 @CheckReturnValue
SqlSelect argInteger(Integer arg)

argInteger

@Nonnull
 @CheckReturnValue
SqlSelect argInteger(@Nonnull
                                                 String argName,
                                                 Integer arg)

argLong

@Nonnull
 @CheckReturnValue
SqlSelect argLong(Long arg)

argLong

@Nonnull
 @CheckReturnValue
SqlSelect argLong(@Nonnull
                                              String argName,
                                              Long arg)

argFloat

@Nonnull
 @CheckReturnValue
SqlSelect argFloat(Float arg)

argFloat

@Nonnull
 @CheckReturnValue
SqlSelect argFloat(@Nonnull
                                               String argName,
                                               Float arg)

argDouble

@Nonnull
 @CheckReturnValue
SqlSelect argDouble(Double arg)

argDouble

@Nonnull
 @CheckReturnValue
SqlSelect argDouble(@Nonnull
                                                String argName,
                                                Double arg)

argBigDecimal

@Nonnull
 @CheckReturnValue
SqlSelect argBigDecimal(BigDecimal arg)

argBigDecimal

@Nonnull
 @CheckReturnValue
SqlSelect argBigDecimal(@Nonnull
                                                    String argName,
                                                    BigDecimal arg)

argString

@Nonnull
 @CheckReturnValue
SqlSelect argString(String arg)

argString

@Nonnull
 @CheckReturnValue
SqlSelect argString(@Nonnull
                                                String argName,
                                                String arg)

argDate

@Nonnull
 @CheckReturnValue
SqlSelect argDate(Date arg)

argDate

@Nonnull
 @CheckReturnValue
SqlSelect argDate(@Nonnull
                                              String argName,
                                              Date arg)

argLocalDate

@Nonnull
 @CheckReturnValue
SqlSelect argLocalDate(LocalDate arg)

argLocalDate

@Nonnull
 @CheckReturnValue
SqlSelect argLocalDate(@Nonnull
                                                   String argName,
                                                   LocalDate arg)

argDateNowPerApp

@Nonnull
 @CheckReturnValue
SqlSelect argDateNowPerApp()

argDateNowPerApp

@Nonnull
 @CheckReturnValue
SqlSelect argDateNowPerApp(@Nonnull
                                                       String argName)

argDateNowPerDb

@Nonnull
 @CheckReturnValue
SqlSelect argDateNowPerDb()

argDateNowPerDb

@Nonnull
 @CheckReturnValue
SqlSelect argDateNowPerDb(@Nonnull
                                                      String argName)

withTimeoutSeconds

@Nonnull
 @CheckReturnValue
SqlSelect withTimeoutSeconds(int seconds)

withMaxRows

@Nonnull
 @CheckReturnValue
SqlSelect withMaxRows(int rows)

withArgs

@Nonnull
 @CheckReturnValue
SqlSelect withArgs(SqlArgs args)

apply

@Nonnull
 @CheckReturnValue
SqlSelect apply(SqlSelect.Apply apply)

fetchSize

@Nonnull
 @CheckReturnValue
SqlSelect fetchSize(int fetchSize)

queryBooleanOrNull

@Nullable
 @CheckReturnValue
Boolean queryBooleanOrNull()

queryBooleanOrFalse

@CheckReturnValue
boolean queryBooleanOrFalse()

queryBooleanOrTrue

@CheckReturnValue
boolean queryBooleanOrTrue()

queryLongOrNull

@Nullable
 @CheckReturnValue
Long queryLongOrNull()

queryLongOrZero

@CheckReturnValue
long queryLongOrZero()

queryLongs

@Nonnull
 @CheckReturnValue
List<Long> queryLongs()

Shorthand for reading numbers from the first column of the result.

Returns:

the first column values, omitting any that were null

queryIntegerOrNull

@Nullable
 @CheckReturnValue
Integer queryIntegerOrNull()

queryIntegerOrZero

@CheckReturnValue
int queryIntegerOrZero()

queryIntegers

@Nonnull
 @CheckReturnValue
List<Integer> queryIntegers()

queryFloatOrNull

@Nullable
 @CheckReturnValue
Float queryFloatOrNull()

queryFloatOrZero

@CheckReturnValue
float queryFloatOrZero()

queryFloats

@Nonnull
 @CheckReturnValue
List<Float> queryFloats()

queryDoubleOrNull

@Nullable
 @CheckReturnValue
Double queryDoubleOrNull()

queryDoubleOrZero

@CheckReturnValue
double queryDoubleOrZero()

queryDoubles

@Nonnull
 @CheckReturnValue
List<Double> queryDoubles()

queryBigDecimalOrNull

@Nullable
 @CheckReturnValue
BigDecimal queryBigDecimalOrNull()

queryBigDecimalOrZero

@Nonnull
 @CheckReturnValue
BigDecimal queryBigDecimalOrZero()

queryBigDecimals

@Nonnull
 @CheckReturnValue
List<BigDecimal> queryBigDecimals()

queryStringOrNull

@Nullable
 @CheckReturnValue
String queryStringOrNull()

queryStringOrEmpty

@Nonnull
 @CheckReturnValue
String queryStringOrEmpty()

queryStrings

@Nonnull
 @CheckReturnValue
List<String> queryStrings()

Shorthand for reading strings from the first column of the result.

Returns:

the first column values, omitting any that were null

queryDateOrNull

@Nullable
 @CheckReturnValue
Date queryDateOrNull()

queryDates

@Nonnull
 @CheckReturnValue
List<Date> queryDates()

queryLocalDateOrNull

@Nullable
 @CheckReturnValue
LocalDate queryLocalDateOrNull()

queryLocalDates

@Nonnull
 @CheckReturnValue
List<LocalDate> queryLocalDates()

query

<T> T query(RowsHandler<T> rowsHandler)

This is the most generic and low-level way to iterate the query results. Consider using one of the other methods that can handle the iteration for you.

Parameters:

rowsHandler - the process() method of this handler will be called once and it will be responsible for iterating the results

queryOneOrNull

<T> T queryOneOrNull(RowHandler<T> rowHandler)

Query zero or one row. If zero rows are available a null will be returned. If more than one row is available a ConstraintViolationException will be thrown.

Parameters:

rowHandler - the process() method of this handler will be called once if there are results, or will not be called if there are no results

queryOneOrThrow

<T> T queryOneOrThrow(RowHandler<T> rowHandler)

Query exactly one row. If zero rows are available or more than one row is available a ConstraintViolationException will be thrown.

Parameters:

rowHandler - the process() method of this handler will be called once if there are results, or will not be called if there are no results

queryFirstOrNull

<T> T queryFirstOrNull(RowHandler<T> rowHandler)

Query zero or one row. If zero rows are available a null will be returned. If more than one row is available the first row will be returned.

Parameters:

rowHandler - the process() method of this handler will be called once if there are results (for the first row), or will not be called if there are no results

queryFirstOrThrow

<T> T queryFirstOrThrow(RowHandler<T> rowHandler)

Query zero or one row. If zero rows are available a ConstraintViolationException will be thrown. If more than one row is available the first row will be returned.

Parameters:

rowHandler - the process() method of this handler will be called once if there are results (for the first row), or will not be called if there are no results

queryMany

<T> List<T> queryMany(RowHandler<T> rowHandler)

Query zero or more rows. If zero rows are available an empty list will be returned. If one or more rows are available each row will be read and added to a list, which is returned.

Parameters:

rowHandler - the process() method of this handler will be called once for each row in the result, or will not be called if there are no results. Only non-null values returned will be added to the result list.