SimpleJdbcInsert

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.jdbc.core.simple
Class SimpleJdbcInsert

java.lang.Object
  org.springframework.jdbc.core.simple.AbstractJdbcInsert
      org.springframework.jdbc.core.simple.SimpleJdbcInsert

All Implemented Interfaces:: SimpleJdbcInsertOperations

public class SimpleJdbcInsert
extends AbstractJdbcInsert
implements SimpleJdbcInsertOperations
extends AbstractJdbcInsert
implements SimpleJdbcInsertOperations

A SimpleJdbcInsert is a multi-threaded, reusable object providing easy insert capabilities for a table. It provides meta data processing to simplify the code needed to construct a basic insert statement. All you need to provide is the name of the table and a Map containing the column names and the column values.

The meta data processing is based on the DatabaseMetaData provided by the JDBC driver. As long as the JBDC driver can provide the names of the columns for a specified table than we can rely on this auto-detection feature. If that is not the case then the column names must be specified explicitly.

The actual insert is being handled using Spring's JdbcTemplate.

Many of the configuration methods return the current instance of the SimpleJdbcInsert to provide the ability to string multiple ones together in a "fluid" interface style.

Since:: 2.5
Author:: Thomas Risberg
See Also:: DatabaseMetaData, JdbcTemplate

Field Summary

Fields inherited from class org.springframework.jdbc.core.simple.AbstractJdbcInsert
`logger`

Constructor Summary
`SimpleJdbcInsert(DataSource dataSource)` Constructor that takes one parameter with the JDBC DataSource to use when creating the JdbcTemplate.
`SimpleJdbcInsert(JdbcTemplate jdbcTemplate)` Alternative Constructor that takes one parameter with the JdbcTemplate to be used.

Method Summary
`int`	`execute(Map<String,Object> args)` Execute the insert using the values passed in.
`int`	`execute(SqlParameterSource parameterSource)` Execute the insert using the values passed in.
`Number`	`executeAndReturnKey(Map<String,Object> args)` Execute the insert using the values passed in and return the generated key.
`Number`	`executeAndReturnKey(SqlParameterSource parameterSource)` Execute the insert using the values passed in and return the generated key.
`KeyHolder`	`executeAndReturnKeyHolder(Map<String,Object> args)` Execute the insert using the values passed in and return the generated keys.
`KeyHolder`	`executeAndReturnKeyHolder(SqlParameterSource parameterSource)` Execute the insert using the values passed in and return the generated keys.
`int[]`	`executeBatch(Map<String,Object>[] batch)` Execute a batch insert using the batch of values passed in.
`int[]`	`executeBatch(SqlParameterSource[] batch)` Execute a batch insert using the batch of values passed in.
`SimpleJdbcInsertOperations`	`includeSynonymsForTableColumnMetaData()` Include synonyms for the column meta data lookups via JDBC.
`SimpleJdbcInsertOperations`	`useNativeJdbcExtractorForMetaData(NativeJdbcExtractor nativeJdbcExtractor)` Use a the provided NativeJdbcExtractor during the column meta data lookups via JDBC.
`SimpleJdbcInsert`	`usingColumns(String... columnNames)` Specify the column names that the insert statement should be limited to use.
`SimpleJdbcInsert`	`usingGeneratedKeyColumns(String... columnNames)` Specify the name sof any columns that have auto generated keys.
`SimpleJdbcInsert`	`withCatalogName(String catalogName)` Specify the catalog name, if any, to be used for the insert.
`SimpleJdbcInsertOperations`	`withoutTableColumnMetaDataAccess()` Turn off any processing of column meta data information obtained via JDBC.
`SimpleJdbcInsert`	`withSchemaName(String schemaName)` Specify the shema name, if any, to be used for the insert.
`SimpleJdbcInsert`	`withTableName(String tableName)` Specify the table name to be used for the insert.

Methods inherited from class org.springframework.jdbc.core.simple.AbstractJdbcInsert
checkCompiled, checkIfConfigurationModificationIsAllowed, compile, compileInternal, doExecute, doExecute, doExecuteAndReturnKey, doExecuteAndReturnKey, doExecuteAndReturnKeyHolder, doExecuteAndReturnKeyHolder, doExecuteBatch, doExecuteBatch, getCatalogName, getColumnNames, getGeneratedKeyNames, getInsertString, getInsertTypes, getJdbcTemplate, getSchemaName, getTableName, isCompiled, matchInParameterValuesWithInsertColumns, matchInParameterValuesWithInsertColumns, onCompileInternal, setAccessTableColumnMetaData, setCatalogName, setColumnNames, setGeneratedKeyName, setGeneratedKeyNames, setNativeJdbcExtractor, setOverrideIncludeSynonymsDefault, setSchemaName, setTableName

Methods inherited from class org.springframework.jdbc.core.simple.AbstractJdbcInsert

checkCompiled, checkIfConfigurationModificationIsAllowed, compile, compileInternal, doExecute, doExecute, doExecuteAndReturnKey, doExecuteAndReturnKey, doExecuteAndReturnKeyHolder, doExecuteAndReturnKeyHolder, doExecuteBatch, doExecuteBatch, getCatalogName, getColumnNames, getGeneratedKeyNames, getInsertString, getInsertTypes, getJdbcTemplate, getSchemaName, getTableName, isCompiled, matchInParameterValuesWithInsertColumns, matchInParameterValuesWithInsertColumns, onCompileInternal, setAccessTableColumnMetaData, setCatalogName, setColumnNames, setGeneratedKeyName, setGeneratedKeyNames, setNativeJdbcExtractor, setOverrideIncludeSynonymsDefault, setSchemaName, setTableName

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

SimpleJdbcInsert

public SimpleJdbcInsert(DataSource dataSource)

Constructor that takes one parameter with the JDBC DataSource to use when creating the JdbcTemplate.

Parameters:: dataSource - the DataSource to use
See Also:: JdbcAccessor.setDataSource(javax.sql.DataSource)

SimpleJdbcInsert

public SimpleJdbcInsert(JdbcTemplate jdbcTemplate)

Alternative Constructor that takes one parameter with the JdbcTemplate to be used.

Parameters:: jdbcTemplate - the JdbcTemplate to use
See Also:: JdbcAccessor.setDataSource(javax.sql.DataSource)

Method Detail