org.axonframework.eventsourcing.eventstore.jdbc.statements

Class JdbcEventStorageEngineStatements

java.lang.Object

org.axonframework.eventsourcing.eventstore.jdbc.statements.JdbcEventStorageEngineStatements

public abstract class JdbcEventStorageEngineStatements
extends Object

Class which holds the default PreparedStatement builder methods for use in the JdbcEventStorageEngine.

Since:

4.3

Author:

Lucas Campos

Method Summary

Modifier and Type	Method and Description
static PreparedStatement	appendEvents(Connection connection, EventSchema schema, Class<?> dataType, List<? extends EventMessage<?>> events, Serializer serializer, TimestampWriter timestampWriter) Set the PreparedStatement to be used on JdbcEventStorageEngine.appendEvents(List, Serializer).
static PreparedStatement	appendSnapshot(Connection connection, EventSchema schema, Class<?> dataType, DomainEventMessage<?> snapshot, Serializer serializer, TimestampWriter timestampWriter) Set the PreparedStatement to be used on JdbcEventStorageEngine.storeSnapshot(DomainEventMessage, Serializer) .
protected static <T> DomainEventMessage<T>	asDomainEventMessage(EventMessage<T> event) Converts an EventMessage to a DomainEventMessage.
static PreparedStatement	cleanGaps(Connection connection, EventSchema schema, SortedSet<Long> gaps) Set the PreparedStatement to be used on internal cleanGaps operation.
static PreparedStatement	createHeadToken(Connection connection, EventSchema schema) Set the PreparedStatement to be used on JdbcEventStorageEngine.createHeadToken().
static PreparedStatement	createTailToken(Connection connection, EventSchema schema) Set the PreparedStatement to be used on JdbcEventStorageEngine.createTailToken().
static PreparedStatement	createTokenAt(Connection connection, EventSchema schema, Instant dateTime) Build the PreparedStatement to be used on JdbcEventStorageEngine.createTokenAt(Instant).
static PreparedStatement	deleteSnapshots(Connection connection, EventSchema schema, String aggregateIdentifier, long sequenceNumber) Set the PreparedStatement to be used on JdbcEventStorageEngine.storeSnapshot(DomainEventMessage, Serializer) .
static PreparedStatement	fetchTrackedEvents(Connection connection, EventSchema schema, long index) Set the PreparedStatement to be used on JdbcEventStorageEngine.fetchTrackedEvents(TrackingToken, int).
static PreparedStatement	lastSequenceNumberFor(Connection connection, EventSchema schema, String aggregateIdentifier) Set the PreparedStatement to be used on JdbcEventStorageEngine.lastSequenceNumberFor(String).
static PreparedStatement	readEventDataForAggregate(Connection connection, EventSchema schema, String identifier, long firstSequenceNumber, int batchSize) Set the PreparedStatement to be used on JdbcEventStorageEngine.fetchDomainEvents(String, long, int) "SELECT [trackedEventFields] FROM [domainEventTable] WHERE [aggregateIdentifierColumn] = ?1 AND [sequenceNumberColumn] >= ?2 AND [sequenceNumberColumn] < ?3 ORDER BY [sequenceNumberColumn] ASC" NOTE: "?1" is the identifier, "?2" is the firstSequenceNumber and "?3" is based on batchSize parameters from JdbcEventStorageEngine.fetchDomainEvents(String, long, int) and they should always be present for the PreparedStatement to work.
static PreparedStatement	readEventDataWithGaps(Connection connection, EventSchema schema, long globalIndex, int batchSize, List<Long> gaps) Set the PreparedStatement to be used on JdbcEventStorageEngine.fetchTrackedEvents(TrackingToken, int) when there are gaps on the GapAwareTrackingToken.
static PreparedStatement	readEventDataWithoutGaps(Connection connection, EventSchema schema, long globalIndex, int batchSize) Set the PreparedStatement to be used on JdbcEventStorageEngine.fetchTrackedEvents(TrackingToken, int) when there is no gaps on the GapAwareTrackingToken.
static PreparedStatement	readSnapshotData(Connection connection, EventSchema schema, String identifier) Set the PreparedStatement to be used on JdbcEventStorageEngine.readSnapshotData(String).

Methods inherited from class java.lang.Object

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

Method Detail

createTokenAt

public static PreparedStatement createTokenAt(Connection connection,
                                              EventSchema schema,
                                              Instant dateTime)
                                       throws SQLException

Build the PreparedStatement to be used on JdbcEventStorageEngine.createTokenAt(Instant). Defaults to:

"SELECT min([globalIndexColumn]) - 1 FROM [domainEventTable] WHERE [timestampColumn] >= ?"

NOTE: "?" is the Instant parameter from JdbcEventStorageEngine.createTokenAt(Instant) and should always be present for the PreparedStatement to work.

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used

dateTime - The dateTime where the token will be created.

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

appendEvents

public static PreparedStatement appendEvents(Connection connection,
                                             EventSchema schema,
                                             Class<?> dataType,
                                             List<? extends EventMessage<?>> events,
                                             Serializer serializer,
                                             TimestampWriter timestampWriter)
                                      throws SQLException

Set the PreparedStatement to be used on JdbcEventStorageEngine.appendEvents(List, Serializer). Defaults to:

"INSERT INTO [domainEventTable] ([domainEventFields]) VALUES (?,?,?,?,?,?,?,?,?)"

NOTE: each "?" is a domain event field from EventSchema.domainEventFields() and should always be present for the PreparedStatement to work.

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used.

dataType - The serialized type of the payload and metadata.

events - The events to be added.

serializer - The serializer for the payload and metadata.

timestampWriter - Writer responsible for writing timestamp in the correct format for the given database.

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

asDomainEventMessage

protected static <T> DomainEventMessage<T> asDomainEventMessage(EventMessage<T> event)

Converts an EventMessage to a DomainEventMessage. If the message already is a DomainEventMessage it will be returned as is. Otherwise a new GenericDomainEventMessage is made with null type, aggregateIdentifier equal to messageIdentifier and sequence number of 0L.

Doing so allows using the DomainEventEntry to store both a GenericEventMessage and a GenericDomainEventMessage.

Type Parameters:

T - the type of payload in the message

Parameters:

event - the input event message

Returns:

the message converted to a domain event message

lastSequenceNumberFor

public static PreparedStatement lastSequenceNumberFor(Connection connection,
                                                      EventSchema schema,
                                                      String aggregateIdentifier)
                                               throws SQLException

Set the PreparedStatement to be used on JdbcEventStorageEngine.lastSequenceNumberFor(String). Defaults to:

"SELECT max([sequenceNumberColumn]) FROM [domainEventTable] WHERE [aggregateIdentifierColumn] = ?"

NOTE: "?" is the aggregateIdentifier parameter from JdbcEventStorageEngine.lastSequenceNumberFor(String) and should always be present for the PreparedStatement to work.

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used

aggregateIdentifier - The identifier of the aggregate.

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

createTailToken

public static PreparedStatement createTailToken(Connection connection,
                                                EventSchema schema)
                                         throws SQLException

Set the PreparedStatement to be used on JdbcEventStorageEngine.createTailToken(). Defaults to:

"SELECT min([globalIndexColumn]) - 1 FROM [domainEventTable]"

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

createHeadToken

public static PreparedStatement createHeadToken(Connection connection,
                                                EventSchema schema)
                                         throws SQLException

Set the PreparedStatement to be used on JdbcEventStorageEngine.createHeadToken(). Defaults to:

"SELECT max([globalIndexColumn]) FROM [domainEventTable]"

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

appendSnapshot

public static PreparedStatement appendSnapshot(Connection connection,
                                               EventSchema schema,
                                               Class<?> dataType,
                                               DomainEventMessage<?> snapshot,
                                               Serializer serializer,
                                               TimestampWriter timestampWriter)
                                        throws SQLException

Set the PreparedStatement to be used on JdbcEventStorageEngine.storeSnapshot(DomainEventMessage, Serializer) . Defaults to:

"INSERT INTO [snapshotTable] ([domainEventFields]) VALUES (?,?,?,?,?,?,?,?,?)"

NOTE: each "?" is a domain event field from EventSchema.domainEventFields() and should always be present for the PreparedStatement to work.

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used.

dataType - The serialized type of the payload and metadata.

snapshot - The snapshot to be appended.

serializer - The serializer for the payload and metadata.

timestampWriter - Writer responsible for writing timestamp in the correct format for the given database.

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

deleteSnapshots

public static PreparedStatement deleteSnapshots(Connection connection,
                                                EventSchema schema,
                                                String aggregateIdentifier,
                                                long sequenceNumber)
                                         throws SQLException

Set the PreparedStatement to be used on JdbcEventStorageEngine.storeSnapshot(DomainEventMessage, Serializer) . Defaults to:

"DELETE FROM [snapshotTable] WHERE [aggregateIdentifierColumn] = ?1 AND [sequenceNumberColumn] < ?2"

NOTE: "?1" is the aggregateIdentifier and "?2" is the sequenceNumber parameters taken from the snapshot from JdbcEventStorageEngine.storeSnapshot(DomainEventMessage, Serializer) and they should always be present for the PreparedStatement to work.

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used

aggregateIdentifier - The identifier of the aggregate taken from the snapshot.

sequenceNumber - The sequence number taken from the snapshot.

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

fetchTrackedEvents

public static PreparedStatement fetchTrackedEvents(Connection connection,
                                                   EventSchema schema,
                                                   long index)
                                            throws SQLException

Set the PreparedStatement to be used on JdbcEventStorageEngine.fetchTrackedEvents(TrackingToken, int). Defaults to:

"SELECT min([globalIndexColumn]) FROM [domainEventTable] WHERE [globalIndexColumn] > ?"

NOTE: "?" is based on the lastToken parameter from JdbcEventStorageEngine.fetchTrackedEvents(TrackingToken, int) and should always be present for the PreparedStatement to work.

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used

index - The index taken from the tracking token.

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

cleanGaps

public static PreparedStatement cleanGaps(Connection connection,
                                          EventSchema schema,
                                          SortedSet<Long> gaps)
                                   throws SQLException

Set the PreparedStatement to be used on internal cleanGaps operation. Defaults to:

"SELECT [globalIndexColumn], [timestampColumn] FROM [domainEventTable] WHERE [globalIndexColumn] >= ?1 AND [globalIndexColumn] <= ?2"

NOTE: "?1" and "?2" are taken from the GapAwareTrackingToken.getGaps() first and last.

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used

gaps - The Set of gaps taken from the tracking token.

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

readEventDataForAggregate

public static PreparedStatement readEventDataForAggregate(Connection connection,
                                                          EventSchema schema,
                                                          String identifier,
                                                          long firstSequenceNumber,
                                                          int batchSize)
                                                   throws SQLException

Set the PreparedStatement to be used on JdbcEventStorageEngine.fetchDomainEvents(String, long, int)

"SELECT [trackedEventFields] FROM [domainEventTable] WHERE [aggregateIdentifierColumn] = ?1 AND [sequenceNumberColumn] >= ?2 AND [sequenceNumberColumn] < ?3 ORDER BY [sequenceNumberColumn] ASC"

NOTE: "?1" is the identifier, "?2" is the firstSequenceNumber and "?3" is based on batchSize parameters from JdbcEventStorageEngine.fetchDomainEvents(String, long, int) and they should always be present for the PreparedStatement to work.

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used

identifier - The identifier of the aggregate.

firstSequenceNumber - The expected sequence number of the first returned entry.

batchSize - The number of items to include in the batch.

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

readSnapshotData

public static PreparedStatement readSnapshotData(Connection connection,
                                                 EventSchema schema,
                                                 String identifier)
                                          throws SQLException

Set the PreparedStatement to be used on JdbcEventStorageEngine.readSnapshotData(String). Defaults to:

"SELECT [domainEventFields] FROM [snapshotTable] WHERE [aggregateIdentifierColumn] = ? ORDER BY [sequenceNumberColumn] DESC"

NOTE: "?" is the identifier parameter from JdbcEventStorageEngine.readSnapshotData(String) and should always be present for the PreparedStatement to work.

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used

identifier - The identifier of the aggregate.

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

readEventDataWithoutGaps

public static PreparedStatement readEventDataWithoutGaps(Connection connection,
                                                         EventSchema schema,
                                                         long globalIndex,
                                                         int batchSize)
                                                  throws SQLException

Set the PreparedStatement to be used on JdbcEventStorageEngine.fetchTrackedEvents(TrackingToken, int) when there is no gaps on the GapAwareTrackingToken. Defaults to:

"SELECT [trackedEventFields] FROM [domainEventTable] WHERE ([globalIndexColumn] > ?1 AND [globalIndexColumn] <= ?2) ORDER BY [globalIndexColumn] ASC"

NOTE: "?1" is the globalIndex and "?2" is the batchSize parameters from JdbcEventStorageEngine.fetchTrackedEvents(TrackingToken, int) and they should always be present for the PreparedStatement to work.

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used

globalIndex - The index taken from the tracking token.

batchSize - The number of items to include in the batch

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.

readEventDataWithGaps

public static PreparedStatement readEventDataWithGaps(Connection connection,
                                                      EventSchema schema,
                                                      long globalIndex,
                                                      int batchSize,
                                                      List<Long> gaps)
                                               throws SQLException

Set the PreparedStatement to be used on JdbcEventStorageEngine.fetchTrackedEvents(TrackingToken, int) when there are gaps on the GapAwareTrackingToken. Defaults to:

"SELECT [trackedEventFields] FROM [domainEventTable] WHERE ([globalIndexColumn] > ?1 AND [globalIndexColumn] <= ?2) OR [globalIndexColumn] IN (?3 .. ?n) ORDER BY [globalIndexColumn] ASC"

NOTE: "?1" is the globalIndex and "?2" is the batchSize parameters from JdbcEventStorageEngine.fetchTrackedEvents(TrackingToken, int). "?3 .. ?n" is taken from the GapAwareTrackingToken.getGaps() and they should always be present for the PreparedStatement to work.

Parameters:

connection - The connection to the database.

schema - The EventSchema to be used

globalIndex - The index taken from the tracking token.

batchSize - The number of items to include in the batch

gaps - The Set of gaps taken from the tracking token.

Returns:

The newly created PreparedStatement.

Throws:

SQLException - when an exception occurs while creating the prepared statement.