Implementations of this interface can hold any number of keys. In the general case, the keys are returned as a List containing one Map for each row of keys.
Most applications only use one key per row and process only one row at a
time in an insert statement. In these cases, just call getKey
or getKeyAs to retrieve the key. The value returned
by getKey is a Number, which is the usual type for auto-generated
keys. For any other auto-generated key type, use getKeyAs instead.
org.springframework.jdbc.core.JdbcTemplate , org.springframework.jdbc.object.SqlUpdate
| Modifier and Type | Method and Description |
|---|---|
| public Number | Returns: the generated key as a numberRetrieve the first item from the first map, assuming that there is just one item and just one map, and that the item is a number. |
| public <T> T | |
| public List | Returns: the List for the generated keys, with each entry representing an individual row through a Map of column names and key valuesReturn a reference to the List that contains the keys. |
| public Map |
| getKey | back to summary |
|---|---|
| public Number getKey() throws InvalidDataAccessApiUsageException Retrieve the first item from the first map, assuming that there is just one item and just one map, and that the item is a number. This is the typical case: a single, numeric generated key. Keys are held in a List of Maps, where each item in the list represents the keys for each row. If there are multiple columns, then the Map will have multiple entries as well. If this method encounters multiple entries in either the map or the list meaning that multiple keys were returned, then an InvalidDataAccessApiUsageException is thrown.
| |
| getKeyAs | back to summary |
|---|---|
| public <T> T getKeyAs(Class<T> keyType) throws InvalidDataAccessApiUsageException Retrieve the first item from the first map, assuming that there is just one item and just one map, and that the item is an instance of specified type. This is a common case: a single generated key of the specified type. Keys are held in a List of Maps, where each item in the list represents the keys for each row. If there are multiple columns, then the Map will have multiple entries as well. If this method encounters multiple entries in either the map or the list meaning that multiple keys were returned, then an InvalidDataAccessApiUsageException is thrown.
| |
| getKeyList | back to summary |
|---|---|
| public List Return a reference to the List that contains the keys. Can be used for extracting keys for multiple rows (an unusual case), and also for adding new maps of keys. | |
| getKeys | back to summary |
|---|---|
| public Map Retrieve the first map of keys. If there are multiple entries in the list (meaning that multiple rows had keys returned), then an InvalidDataAccessApiUsageException is thrown.
| |