Class SQLServerPkGenerator

java.lang.Object

org.apache.cayenne.dba.JdbcPkGenerator

org.apache.cayenne.dba.oracle.OraclePkGenerator

org.apache.cayenne.dba.sqlserver.SQLServerPkGenerator

All Implemented Interfaces:

PkGenerator

public class SQLServerPkGenerator
extends OraclePkGenerator

The default PK generator for MS SQL, which uses sequences to generate a PK for an integer key type and NEWID() for UNIQUEIDENTIFIER key type

Since:

4.1

Field Summary

Fields inherited from class JdbcPkGenerator

adapter, DEFAULT_PK_CACHE_SIZE, pkCache, pkCacheSize, pkStartValue

Modifier and Type	Field	Description
protected JdbcAdapter	adapter
static final int	DEFAULT_PK_CACHE_SIZE
protected ConcurrentMap<String, Queue<Long>>	pkCache
protected int	pkCacheSize
protected long	pkStartValue

Constructor Summary

Constructors

Modifier	Constructor	Description
	SQLServerPkGenerator()
protected	SQLServerPkGenerator(JdbcAdapter adapter)

Method Summary

Modifier and Type	Method	Description
List<String>	createAutoPkStatements(List<DbEntity> dbEntities)	Creates a list of CREATE SEQUENCE statements for the list of DbEntities.
protected String	createSequenceString(DbEntity ent)
List<String>	dropAutoPkStatements(List<DbEntity> dbEntities)	Creates a list of DROP SEQUENCE statements for the list of DbEntities.
Object	generatePk(DataNode node, DbAttribute pk)	Generates a unique and non-repeating primary key for specified dbEntity.
protected String	getSequencePrefix()
protected String	guidPkFromDatabase(DataNode node, DbEntity entity)
protected String	selectAllSequencesQuery()
protected String	selectNextValQuery(String sequenceName)
protected String	sequenceName(DbEntity entity)	Returns expected primary key sequence name for a DbEntity.

Methods inherited from class OraclePkGenerator

createAutoPk, dropAutoPk, dropSequenceString, getExistingSequences, longPkFromDatabase, pkCacheSize

Modifier and Type	Method	Description
void	createAutoPk(DataNode node, List<DbEntity> dbEntities)	Generates necessary database objects to provide automatic primary key support.
void	dropAutoPk(DataNode node, List<DbEntity> dbEntities)	Drops PK sequences for all specified DbEntities.
protected String	dropSequenceString(DbEntity ent)	Returns a SQL string needed to drop any database objects associated with automatic primary key generation process for a specific DbEntity.
protected List<String>	getExistingSequences(DataNode node)	Fetches a list of existing sequences that might match Cayenne generated ones.
protected long	longPkFromDatabase(DataNode node, DbEntity entity)	Generates primary key by calling Oracle sequence corresponding to the dbEntity.
protected int	pkCacheSize(DbEntity entity)

Methods inherited from class JdbcPkGenerator

autoPkTableExists, dropAutoPkString, getAdapter, getPkCacheSize, pkCreateString, pkDeleteString, pkSelectString, pkTableCreateString, pkUpdateString, reset, runUpdate, setAdapter, setPkCacheSize

Modifier and Type	Method	Description
protected boolean	autoPkTableExists(DataNode node)	Checks if AUTO_PK_TABLE already exists in the database.
protected String	dropAutoPkString()
JdbcAdapter	getAdapter()	Get an adapter associated with current PkGenerator
int	getPkCacheSize()	Returns a size of the entity primary key cache.
protected String	pkCreateString(String entName)
protected String	pkDeleteString(List<DbEntity> dbEntities)
protected String	pkSelectString(String entName)
protected String	pkTableCreateString()
protected String	pkUpdateString(String entName)
void	reset()	Resets any cached primary keys forcing generator to go to the database next time id generation is requested.
int	runUpdate(DataNode node, String sql)	Runs JDBC update over a Connection obtained from DataNode.
void	setAdapter(DbAdapter adapter)	Install the adapter associated with current PkGenerator
void	setPkCacheSize(int pkCacheSize)	Sets the size of the entity primary key cache.

Methods inherited from class Object

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

Constructor Details

SQLServerPkGenerator

public SQLServerPkGenerator()

SQLServerPkGenerator

protected SQLServerPkGenerator(JdbcAdapter adapter)

Method Details

createSequenceString

protected String createSequenceString(DbEntity ent)

Overrides:

createSequenceString in class OraclePkGenerator

getSequencePrefix

protected String getSequencePrefix()

Overrides:

getSequencePrefix in class OraclePkGenerator

selectNextValQuery

protected String selectNextValQuery(String sequenceName)

Overrides:

selectNextValQuery in class OraclePkGenerator

createAutoPkStatements

public List<String> createAutoPkStatements(List<DbEntity> dbEntities)

Description copied from class: OraclePkGenerator

Creates a list of CREATE SEQUENCE statements for the list of DbEntities.

Specified by:

createAutoPkStatements in interface PkGenerator

Overrides:

createAutoPkStatements in class OraclePkGenerator

dropAutoPkStatements

public List<String> dropAutoPkStatements(List<DbEntity> dbEntities)

Description copied from class: OraclePkGenerator

Creates a list of DROP SEQUENCE statements for the list of DbEntities.

Specified by:

dropAutoPkStatements in interface PkGenerator

Overrides:

dropAutoPkStatements in class OraclePkGenerator

generatePk

public Object generatePk(DataNode node,
 DbAttribute pk)
                  throws Exception

Description copied from class: JdbcPkGenerator

Generates a unique and non-repeating primary key for specified dbEntity.

This implementation is naive since it does not lock the database rows when executing select and subsequent update. Adapter-specific implementations are more robust.

Specified by:

generatePk in interface PkGenerator

Overrides:

generatePk in class JdbcPkGenerator

Throws:

Exception

selectAllSequencesQuery

protected String selectAllSequencesQuery()

Overrides:

selectAllSequencesQuery in class OraclePkGenerator

sequenceName

protected String sequenceName(DbEntity entity)

Description copied from class: OraclePkGenerator

Returns expected primary key sequence name for a DbEntity.

Overrides:

sequenceName in class OraclePkGenerator

guidPkFromDatabase

protected String guidPkFromDatabase(DataNode node,
 DbEntity entity)
                             throws SQLException

Throws:

SQLException