org.openspaces.persistency.hibernate

Class DefaultHibernateSpaceDataSourceConfigurer

java.lang.Object

org.openspaces.persistency.hibernate.DefaultHibernateSpaceDataSourceConfigurer

public class DefaultHibernateSpaceDataSourceConfigurer
extends Object

A configurer class which is used to configure a DefaultHibernateSpaceDataSource

Since:

9.5

Author:

eitany

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	augmentInitialLoadEntries
protected ClusterInfo	clusterInfo
protected int	fetchSize
protected int	initialLoadChunkSize
protected String[]	initialLoadEntries
protected String[]	initialLoadQueryScanningBasePackages
protected int	initialLoadThreadPoolSize
protected org.apache.commons.logging.Log	logger
protected Set<String>	managedEntries
protected boolean	performOrderById
protected org.hibernate.SessionFactory	sessionFactory
protected boolean	useScrollableResultSet

Constructor Summary

Constructors

Constructor and Description
DefaultHibernateSpaceDataSourceConfigurer()

Method Summary

Modifier and Type	Method and Description
DefaultHibernateSpaceDataSourceConfigurer	augmentInitialLoadEntries(boolean augmentInitialLoadEntries) Feature switch for initial load entries augmentation (creation of partition-specific query for entries) Defaults to true.
DefaultHibernateSpaceDataSourceConfigurer	clusterInfo(ClusterInfo clusterInfo) Injects the ClusterInfo to be used with the SpaceDataSource
DefaultHibernateSpaceDataSource	create() Creates a DefaultHibernateSpaceDataSource with the setup configuration.
DefaultHibernateSpaceDataSourceConfigurer	fetchSize(int fetchSize) Sets the fetch size that will be used when working with scrollable results.
DefaultHibernateSpaceDataSourceConfigurer	initialLoadChunkSize(int initalLoadChunkSize) By default, the initial load process will chunk large tables and will iterate over the table (entity) per chunk (concurrently).
DefaultHibernateSpaceDataSourceConfigurer	initialLoadEntries(String... initialLoadEntries) Sets a list of entries that will be used to perform the #initialLoad() operation.
DefaultHibernateSpaceDataSourceConfigurer	initialLoadQueryScanningBasePackages(String[] initialLoadQueryScanningBasePackages) optional.
DefaultHibernateSpaceDataSourceConfigurer	initialLoadThreadPoolSize(int initialLoadThreadPoolSize) The initial load operation uses the ConcurrentMultiDataIterator.
DefaultHibernateSpaceDataSourceConfigurer	managedEntries(String... entries) Sets all the entries this Hibernate data source will work with.
DefaultHibernateSpaceDataSourceConfigurer	performOrderById(boolean performOrderById) When performing initial load, this flag indicates if the generated query will order to results by the id.
DefaultHibernateSpaceDataSourceConfigurer	sessionFactory(org.hibernate.SessionFactory sessionFactory) Injects the Hibernate SessionFactory to be used with this data source.
DefaultHibernateSpaceDataSourceConfigurer	useScrollableResultSet(boolean useScrollableResultSet) Controls if scrollable result sets will be used with initial load operation.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

sessionFactory

protected org.hibernate.SessionFactory sessionFactory

managedEntries

protected Set<String> managedEntries

initialLoadEntries

protected String[] initialLoadEntries

fetchSize

protected int fetchSize

initialLoadThreadPoolSize

protected int initialLoadThreadPoolSize

initialLoadChunkSize

protected int initialLoadChunkSize

performOrderById

protected boolean performOrderById

useScrollableResultSet

protected boolean useScrollableResultSet

augmentInitialLoadEntries

protected boolean augmentInitialLoadEntries

initialLoadQueryScanningBasePackages

protected String[] initialLoadQueryScanningBasePackages

clusterInfo

protected ClusterInfo clusterInfo

Constructor Detail

DefaultHibernateSpaceDataSourceConfigurer

public DefaultHibernateSpaceDataSourceConfigurer()

Method Detail

sessionFactory

public DefaultHibernateSpaceDataSourceConfigurer sessionFactory(org.hibernate.SessionFactory sessionFactory)

Injects the Hibernate SessionFactory to be used with this data source.

managedEntries

public DefaultHibernateSpaceDataSourceConfigurer managedEntries(String... entries)

Sets all the entries this Hibernate data source will work with. By default, will use Hibernate meta data API in order to get the list of all the given entities it handles.

This list is used to filter out entities when performing all data source operations exception for the #initialLoad() operation.

Usually, there is no need to explicitly set this.

fetchSize

public DefaultHibernateSpaceDataSourceConfigurer fetchSize(int fetchSize)

Sets the fetch size that will be used when working with scrollable results. Defaults to 100.

See Also:

Criteria.setFetchSize(int)

performOrderById

public DefaultHibernateSpaceDataSourceConfigurer performOrderById(boolean performOrderById)

When performing initial load, this flag indicates if the generated query will order to results by the id. By default set to true as it most times results in better initial load performance.

initialLoadEntries

public DefaultHibernateSpaceDataSourceConfigurer initialLoadEntries(String... initialLoadEntries)

Sets a list of entries that will be used to perform the #initialLoad() operation. By default, will try and build a sensible list based on Hibernate meta data.

Note, sometimes an explicit list should be provided. For example, if we have a class A and class B, and A has a relationship to B which is not component. If in the space, we only wish to have A, and have B just as a field in A (and not as an Entry), then we need to explicitly set the list just to A. By default, if we won't set it, it will result in two entries existing in the Space, A and B, with A having a field of B as well.

initialLoadThreadPoolSize

public DefaultHibernateSpaceDataSourceConfigurer initialLoadThreadPoolSize(int initialLoadThreadPoolSize)

The initial load operation uses the ConcurrentMultiDataIterator. This property allows to control the thread pool size of the concurrent multi data iterator. Defaults to 10.

Note, this usually will map one to one to the number of open connections / cursors against the database.

initialLoadChunkSize

public DefaultHibernateSpaceDataSourceConfigurer initialLoadChunkSize(int initalLoadChunkSize)

By default, the initial load process will chunk large tables and will iterate over the table (entity) per chunk (concurrently). This setting allows to control the chunk size to split the table by. By default, set to 100,000. Batching can be disabled by setting -1.

useScrollableResultSet

public DefaultHibernateSpaceDataSourceConfigurer useScrollableResultSet(boolean useScrollableResultSet)

Controls if scrollable result sets will be used with initial load operation. Defaults to true.

initialLoadQueryScanningBasePackages

public DefaultHibernateSpaceDataSourceConfigurer initialLoadQueryScanningBasePackages(String[] initialLoadQueryScanningBasePackages)

optional.

Parameters:

initialLoadQueryScanningBasePackages - array of base packages to scan for custom initial load query methods marked with the SpaceInitialLoadQuery annotation (default: null, scans nothing).

Returns:

this instance.

clusterInfo

public DefaultHibernateSpaceDataSourceConfigurer clusterInfo(ClusterInfo clusterInfo)

Injects the ClusterInfo to be used with the SpaceDataSource

augmentInitialLoadEntries

public DefaultHibernateSpaceDataSourceConfigurer augmentInitialLoadEntries(boolean augmentInitialLoadEntries)

Feature switch for initial load entries augmentation (creation of partition-specific query for entries) Defaults to true.

create

public DefaultHibernateSpaceDataSource create()

Creates a DefaultHibernateSpaceDataSource with the setup configuration.