org.springframework.jdbc.support.incrementer.SqlServerMaxValueIncrementer Maven / Gradle / Ivy
/*
* Copyright 2002-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.jdbc.support.incrementer;
import javax.sql.DataSource;
/**
* {@link DataFieldMaxValueIncrementer} that increments the maximum value of a given SQL Server table
* with the equivalent of an auto-increment column. Note: If you use this class, your table key
* column should NOT be defined as an IDENTITY column, as the sequence table does the job.
*
* This class is intended to be used with Microsoft SQL Server.
*
*
The sequence is kept in a table. There should be one sequence table per
* table that needs an auto-generated key.
*
*
Example:
*
*
create table tab (id int not null primary key, text varchar(100))
* create table tab_sequence (id bigint identity)
* insert into tab_sequence default values
*
* If "cacheSize" is set, the intermediate values are served without querying the
* database. If the server or your application is stopped or crashes or a transaction
* is rolled back, the unused values will never be served. The maximum hole size in
* numbering is consequently the value of cacheSize.
*
* HINT: Since Microsoft SQL Server supports the JDBC 3.0 {@code getGeneratedKeys}
* method, it is recommended to use IDENTITY columns directly in the tables and then using a
* {@link org.springframework.jdbc.core.simple.SimpleJdbcInsert} or utilizing
* a {@link org.springframework.jdbc.support.KeyHolder} when calling the with the
* {@code update(PreparedStatementCreator psc, KeyHolder generatedKeyHolder)}
* method of the {@link org.springframework.jdbc.core.JdbcTemplate}.
*
* Thanks to Preben Nilsson for the suggestion!
*
* @author Thomas Risberg
* @author Juergen Hoeller
* @since 2.5.5
*/
public class SqlServerMaxValueIncrementer extends AbstractIdentityColumnMaxValueIncrementer {
/**
* Default constructor for bean property style usage.
* @see #setDataSource
* @see #setIncrementerName
* @see #setColumnName
*/
public SqlServerMaxValueIncrementer() {
}
/**
* Convenience constructor.
* @param dataSource the DataSource to use
* @param incrementerName the name of the sequence/table to use
* @param columnName the name of the column in the sequence table to use
*/
public SqlServerMaxValueIncrementer(DataSource dataSource, String incrementerName, String columnName) {
super(dataSource, incrementerName, columnName);
}
@Override
protected String getIncrementStatement() {
return "insert into " + getIncrementerName() + " default values";
}
@Override
protected String getIdentityStatement() {
return "select @@identity";
}
}