org.axonframework.common.jdbc

Class PagingJdbcIterable<R>

java.lang.Object

org.axonframework.common.jdbc.PagingJdbcIterable<R>

Type Parameters:

R - The mapped result type.

All Implemented Interfaces:

Iterable<R>

public class PagingJdbcIterable<R>
extends Object
implements Iterable<R>

Enables iterating through a JDBC query using paging. Paging is taken care of automatically through the provided PagingJdbcIterable.PagingStatementSupplier, fetching the next page when the items run out to iterate through.

Do not use this for paging when you care about concurrent deletes. If you loaded a page, delete an item from it, and load the next, you will miss an item during iteration.

The iterator() function can be called multiple times to loop through the items, restarting the query from the start.

Since:

4.8.0

Author:

Mitchell Herrijgers, Steven van Beelen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PagingJdbcIterable.PagingIterator The Iterator that loops through the provided query's pages until it runs out of items.
static interface	PagingJdbcIterable.PagingStatementSupplier Describes a function that creates a new PreparedStatement that pages results through the given offset and maxSize, ready to be executed.

Constructor Summary

Constructors

Constructor and Description
PagingJdbcIterable(TransactionManager transactionManager, Supplier<Connection> connectionProvider, PagingJdbcIterable.PagingStatementSupplier pagingQuerySupplier, int pageSize, JdbcUtils.SqlResultConverter<R> resultConverter, Function<SQLException,RuntimeException> errorHandler) Construct a new Iterable of type R, utilizing paging queries to retrieve the entries.

Method Summary

Modifier and Type	Method and Description
Iterator<R>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PagingJdbcIterable

public PagingJdbcIterable(TransactionManager transactionManager,
                          Supplier<Connection> connectionProvider,
                          PagingJdbcIterable.PagingStatementSupplier pagingQuerySupplier,
                          int pageSize,
                          JdbcUtils.SqlResultConverter<R> resultConverter,
                          Function<SQLException,RuntimeException> errorHandler)

Construct a new Iterable of type R, utilizing paging queries to retrieve the entries.

Parameters:

transactionManager - The TransactionManager used to execute the paging query.

connectionProvider - The supplier of the Connection used by the given pagingQuerySupplier.

pagingQuerySupplier - A factory function supply the paging PreparedStatement to execute.

pageSize - The size of the pages to retrieve. Used to calculate the offset and maxSize of the paging query

resultConverter - The converter of the ResultSet into entries of type R.

errorHandler - The error handler to deal with exceptions when executing a paging PreparedStatement.

Method Detail

iterator

public Iterator<R> iterator()

Specified by:

iterator in interface Iterable<R>