com.github.susom.database

Interface SqlInsert

All Known Implementing Classes:

SqlInsertImpl

public interface SqlInsert

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	SqlInsert.Apply

Method Summary

Modifier and Type	Method and Description
SqlInsert	apply(SqlInsert.Apply apply)
SqlInsert	argBigDecimal(BigDecimal arg)
SqlInsert	argBigDecimal(String argName, BigDecimal arg)
SqlInsert	argBlobBytes(byte[] arg)
SqlInsert	argBlobBytes(String argName, byte[] arg)
SqlInsert	argBlobStream(InputStream arg)
SqlInsert	argBlobStream(String argName, InputStream arg)
SqlInsert	argBoolean(Boolean arg)
SqlInsert	argBoolean(String argName, Boolean arg)
SqlInsert	argClobReader(Reader arg)
SqlInsert	argClobReader(String argName, Reader arg)
SqlInsert	argClobString(String arg)
SqlInsert	argClobString(String argName, String arg)
SqlInsert	argDate(Date arg)
SqlInsert	argDate(String argName, Date arg)
SqlInsert	argDateNowPerApp()
SqlInsert	argDateNowPerApp(String argName)
SqlInsert	argDateNowPerDb()
SqlInsert	argDateNowPerDb(String argName)
SqlInsert	argDouble(Double arg)
SqlInsert	argDouble(String argName, Double arg)
SqlInsert	argFloat(Float arg)
SqlInsert	argFloat(String argName, Float arg)
SqlInsert	argInteger(Integer arg)
SqlInsert	argInteger(String argName, Integer arg)
SqlInsert	argLocalDate(LocalDate arg)
SqlInsert	argLocalDate(String argName, LocalDate arg)
SqlInsert	argLong(Long arg)
SqlInsert	argLong(String argName, Long arg)
SqlInsert	argPkLong(Long pkValue)
SqlInsert	argPkLong(String argName, Long pkValue)
SqlInsert	argPkSeq(String sequenceName)
SqlInsert	argPkSeq(String argName, String sequenceName) Use this method to populate the primary key value (assumed to be type Long) from a sequence in the database.
SqlInsert	argString(String arg)
SqlInsert	argString(String argName, String arg)
SqlInsert	batch() Call this between setting rows of parameters for a SQL statement.
int	insert() Perform the insert into the database without any verification of how many rows were affected.
void	insert(int expectedRowsUpdated) Perform the insert into the database.
void	insertBatch() Insert multiple rows in one database call.
int[]	insertBatchUnchecked() Insert multiple rows in one database call.
<T> T	insertReturning(String tableName, String primaryKeyColumnName, RowsHandler<T> rowsHandler, String... otherColumnNames)
Long	insertReturningPkSeq(String primaryKeyColumnName) Use this method in conjunction with argPkSeq() to optimize inserts where the primary key is being populated from a database sequence at insert time.
SqlInsert	withArgs(SqlArgs args)

Method Detail

argBoolean

@Nonnull
 @CheckReturnValue
SqlInsert argBoolean(Boolean arg)

argBoolean

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

argInteger

@Nonnull
 @CheckReturnValue
SqlInsert argInteger(Integer arg)

argInteger

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

argLong

@Nonnull
 @CheckReturnValue
SqlInsert argLong(Long arg)

argLong

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

argFloat

@Nonnull
 @CheckReturnValue
SqlInsert argFloat(Float arg)

argFloat

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

argDouble

@Nonnull
 @CheckReturnValue
SqlInsert argDouble(Double arg)

argDouble

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

argBigDecimal

@Nonnull
 @CheckReturnValue
SqlInsert argBigDecimal(BigDecimal arg)

argBigDecimal

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

argString

@Nonnull
 @CheckReturnValue
SqlInsert argString(String arg)

argString

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

argDate

@Nonnull
 @CheckReturnValue
SqlInsert argDate(Date arg)

argDate

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

argLocalDate

@Nonnull
 @CheckReturnValue
SqlInsert argLocalDate(LocalDate arg)

argLocalDate

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

argDateNowPerApp

@Nonnull
 @CheckReturnValue
SqlInsert argDateNowPerApp()

argDateNowPerApp

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

argDateNowPerDb

@Nonnull
 @CheckReturnValue
SqlInsert argDateNowPerDb()

argDateNowPerDb

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

argBlobBytes

@Nonnull
 @CheckReturnValue
SqlInsert argBlobBytes(byte[] arg)

argBlobBytes

@Nonnull
 @CheckReturnValue
SqlInsert argBlobBytes(@Nonnull
                                                   String argName,
                                                   byte[] arg)

argBlobStream

@Nonnull
 @CheckReturnValue
SqlInsert argBlobStream(InputStream arg)

argBlobStream

@Nonnull
 @CheckReturnValue
SqlInsert argBlobStream(@Nonnull
                                                    String argName,
                                                    InputStream arg)

argClobString

@Nonnull
 @CheckReturnValue
SqlInsert argClobString(String arg)

argClobString

@Nonnull
 @CheckReturnValue
SqlInsert argClobString(@Nonnull
                                                    String argName,
                                                    String arg)

argClobReader

@Nonnull
 @CheckReturnValue
SqlInsert argClobReader(Reader arg)

argClobReader

@Nonnull
 @CheckReturnValue
SqlInsert argClobReader(@Nonnull
                                                    String argName,
                                                    Reader arg)

withArgs

@Nonnull
 @CheckReturnValue
SqlInsert withArgs(SqlArgs args)

apply

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

batch

SqlInsert batch()

Call this between setting rows of parameters for a SQL statement. You may call it before setting any parameters, after setting all, or multiple times between rows. This feature only currently works with basic inserts (you can't do insertReturning type operations).

insert

int insert()

Perform the insert into the database without any verification of how many rows were affected.

Returns:

the number of rows affected

insert

void insert(int expectedRowsUpdated)

Perform the insert into the database. This will automatically verify that the specified number of rows was affected, and throw a WrongNumberOfRowsException if it does not match.

insertBatch

void insertBatch()

Insert multiple rows in one database call. This will automatically verify that exactly 1 row is affected for each row of parameters.

insertBatchUnchecked

int[] insertBatchUnchecked()

Insert multiple rows in one database call. This returns the results for each row so you can check them yourself.

Returns:

an array with an element for each row in the batch; the value of each array indicates how many rows were affected; note that some database/driver combinations do now return this information (for example, older versions of Oracle return -2 rather than the number of rows)

insertReturningPkSeq

@CheckReturnValue
Long insertReturningPkSeq(String primaryKeyColumnName)

Use this method in conjunction with argPkSeq() to optimize inserts where the primary key is being populated from a database sequence at insert time. If the database can't support this feature it will be simulated with a select and then the insert.

This version of insert expects exactly one row to be inserted, and will throw a DatabaseException if that isn't the case.

insertReturning

<T> T insertReturning(String tableName,
                      String primaryKeyColumnName,
                      RowsHandler<T> rowsHandler,
                      String... otherColumnNames)

argPkSeq

@Nonnull
 @CheckReturnValue
SqlInsert argPkSeq(@Nonnull
                                               String sequenceName)

argPkSeq

@Nonnull
 @CheckReturnValue
SqlInsert argPkSeq(@Nonnull
                                               String argName,
                                               @Nonnull
                                               String sequenceName)

Use this method to populate the primary key value (assumed to be type Long) from a sequence in the database. This can be used standalone, but is intended to be used in conjunction with insertReturningPkSeq() to both insert and obtain the inserted value in an optimized way (if possible). For databases that are unable to return the value from the insert (such as Derby) this will be simulated first issuing a select to read the sequence, then an insert.

argPkLong

@Nonnull
 @CheckReturnValue
SqlInsert argPkLong(Long pkValue)

argPkLong

@Nonnull
 @CheckReturnValue
SqlInsert argPkLong(String argName,
                                                Long pkValue)