com.github.susom.database

Class SqlInsertImpl

java.lang.Object

com.github.susom.database.SqlInsertImpl

All Implemented Interfaces:

SqlInsert

public class SqlInsertImpl
extends Object
implements SqlInsert

This is the key class for configuring (query parameters) and executing a database query.

Author:

garricko

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.susom.database.SqlInsert

SqlInsert.Apply

Constructor Summary

Constructors

Constructor and Description
SqlInsertImpl(Connection connection, DatabaseMock mock, String sql, Options options)

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 arg)
SqlInsert	argPkLong(String argName, Long arg)
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> handler, 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)

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlInsertImpl

public SqlInsertImpl(Connection connection,
                     DatabaseMock mock,
                     String sql,
                     Options options)

Method Detail

argBoolean

@Nonnull
public SqlInsert argBoolean(Boolean arg)

Specified by:

argBoolean in interface SqlInsert

argBoolean

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

Specified by:

argBoolean in interface SqlInsert

argInteger

@Nonnull
public SqlInsert argInteger(Integer arg)

Specified by:

argInteger in interface SqlInsert

argInteger

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

Specified by:

argInteger in interface SqlInsert

argLong

@Nonnull
public SqlInsert argLong(Long arg)

Specified by:

argLong in interface SqlInsert

argLong

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

Specified by:

argLong in interface SqlInsert

argFloat

@Nonnull
public SqlInsert argFloat(Float arg)

Specified by:

argFloat in interface SqlInsert

argFloat

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

Specified by:

argFloat in interface SqlInsert

argDouble

@Nonnull
public SqlInsert argDouble(Double arg)

Specified by:

argDouble in interface SqlInsert

argDouble

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

Specified by:

argDouble in interface SqlInsert

argBigDecimal

@Nonnull
public SqlInsert argBigDecimal(BigDecimal arg)

Specified by:

argBigDecimal in interface SqlInsert

argBigDecimal

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

Specified by:

argBigDecimal in interface SqlInsert

argString

@Nonnull
public SqlInsert argString(String arg)

Specified by:

argString in interface SqlInsert

argString

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

Specified by:

argString in interface SqlInsert

argDate

@Nonnull
public SqlInsert argDate(Date arg)

Specified by:

argDate in interface SqlInsert

argDate

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

Specified by:

argDate in interface SqlInsert

argLocalDate

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

Specified by:

argLocalDate in interface SqlInsert

argLocalDate

@Nonnull
public SqlInsert argLocalDate(LocalDate arg)

Specified by:

argLocalDate in interface SqlInsert

argDateNowPerApp

@Nonnull
public SqlInsert argDateNowPerApp()

Specified by:

argDateNowPerApp in interface SqlInsert

argDateNowPerApp

@Nonnull
public SqlInsert argDateNowPerApp(@Nonnull
                                           String argName)

Specified by:

argDateNowPerApp in interface SqlInsert

argDateNowPerDb

@Nonnull
public SqlInsert argDateNowPerDb()

Specified by:

argDateNowPerDb in interface SqlInsert

argDateNowPerDb

@Nonnull
public SqlInsert argDateNowPerDb(@Nonnull
                                          String argName)

Specified by:

argDateNowPerDb in interface SqlInsert

argBlobBytes

@Nonnull
public SqlInsert argBlobBytes(byte[] arg)

Specified by:

argBlobBytes in interface SqlInsert

argBlobBytes

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

Specified by:

argBlobBytes in interface SqlInsert

argBlobStream

@Nonnull
public SqlInsert argBlobStream(InputStream arg)

Specified by:

argBlobStream in interface SqlInsert

argBlobStream

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

Specified by:

argBlobStream in interface SqlInsert

argClobString

@Nonnull
public SqlInsert argClobString(String arg)

Specified by:

argClobString in interface SqlInsert

argClobString

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

Specified by:

argClobString in interface SqlInsert

argClobReader

@Nonnull
public SqlInsert argClobReader(Reader arg)

Specified by:

argClobReader in interface SqlInsert

argClobReader

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

Specified by:

argClobReader in interface SqlInsert

withArgs

@Nonnull
public SqlInsert withArgs(SqlArgs args)

Specified by:

withArgs in interface SqlInsert

apply

@Nonnull
public SqlInsert apply(SqlInsert.Apply apply)

Specified by:

apply in interface SqlInsert

batch

public SqlInsert batch()

Description copied from interface: SqlInsert

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).

Specified by:

batch in interface SqlInsert

insert

public int insert()

Description copied from interface: SqlInsert

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

Specified by:

insert in interface SqlInsert

Returns:

the number of rows affected

insert

public void insert(int expectedRowsUpdated)

Description copied from interface: SqlInsert

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.

Specified by:

insert in interface SqlInsert

insertBatch

public void insertBatch()

Description copied from interface: SqlInsert

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

Specified by:

insertBatch in interface SqlInsert

insertBatchUnchecked

public int[] insertBatchUnchecked()

Description copied from interface: SqlInsert

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

Specified by:

insertBatchUnchecked in interface SqlInsert

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

public Long insertReturningPkSeq(String primaryKeyColumnName)

Description copied from interface: SqlInsert

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.

Specified by:

insertReturningPkSeq in interface SqlInsert

insertReturning

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

Specified by:

insertReturning in interface SqlInsert

argPkSeq

@Nonnull
public SqlInsert argPkSeq(@Nonnull
                                   String sequenceName)

Specified by:

argPkSeq in interface SqlInsert

argPkSeq

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

Description copied from interface: SqlInsert

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.

Specified by:

argPkSeq in interface SqlInsert

argPkLong

@Nonnull
public SqlInsert argPkLong(String argName,
                                    Long arg)

Specified by:

argPkLong in interface SqlInsert

argPkLong

@Nonnull
public SqlInsert argPkLong(Long arg)

Specified by:

argPkLong in interface SqlInsert