org.springframework.data.gemfire.mapping.annotation

Annotation Type PartitionRegion

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @Region
public @interface PartitionRegion

Annotation defining the Partition Region in which the application persistent entity will be stored.

Since:

1.9.0

Author:

John Blum

See Also:

EnableEntityDefinedRegions, EntityDefinedRegionsConfiguration, Region

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	collocatedWith Sets the name of the Region to which this persistent entity's Region will be collocated.
String	diskStoreName Name of the DiskStore in which this persistent entity's data is overflowed and/or persisted.
boolean	diskSynchronous Determines whether disk-based operations (used in overflow and persistence) are synchronous or asynchronous.
PartitionRegion.FixedPartition[]	fixedPartitions Defines an array of fixed partitions in a DataPolicy.PARTITION Region Default is unset.
boolean	ignoreIfExists Determines whether an entity annotated with this Region annotation will ignore any existing Region definition identified by the given name() for this entity.
boolean	ignoreJta Determines whether this Region's data access operations participates in any existing, Global JTA transaction in progress.
String	name Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g.
String	partitionResolverName Name of the PartitionResolver used to customize the partitioning strategy in this persistent entity's DataPolicy.PARTITION Region.
boolean	persistent Determines whether this persistent entity's Region is persistent, storing data to disk.
int	redundantCopies Defines the number of redundant copies of this persistent entity's data.
String	value Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g.

Element Detail

name

@AliasFor(annotation=Region.class,
          attribute="name")
public abstract String name

Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g. "Users", or "/Local/Admin/Users"). Defaults to simple name of the application persistent entity defined by Class.getSimpleName().

Returns:

the name or fully-qualified path of the Region in which the application persistent entity will be stored.

Default:

""

value

@AliasFor(annotation=Region.class,
          attribute="value")
public abstract String value

Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g. "Users", or "/Local/Admin/Users"). Defaults to simple name of the application persistent entity defined by Class.getSimpleName().

Returns:

the name or fully-qualified path of the Region in which the application persistent entity will be stored.

Default:

""

collocatedWith

public abstract String collocatedWith

Sets the name of the Region to which this persistent entity's Region will be collocated. Collocation is used in data access, querying operations where the user wishes to combine data from multiple Regions into a single result set returned from an OQL statement. Defaults to unset.

Default:

""

diskStoreName

public abstract String diskStoreName

Name of the DiskStore in which this persistent entity's data is overflowed and/or persisted. Maybe the name of a Spring bean defined in the Spring context. Defaults to unset.

Default:

""

diskSynchronous

public abstract boolean diskSynchronous

Determines whether disk-based operations (used in overflow and persistence) are synchronous or asynchronous. Defaults to synchronous.

Default:

true

fixedPartitions

public abstract PartitionRegion.FixedPartition[] fixedPartitions

Defines an array of fixed partitions in a DataPolicy.PARTITION Region Default is unset.

See Also:

FixedPartitionAttributes

Default:

{}

ignoreIfExists

public abstract boolean ignoreIfExists

Determines whether an entity annotated with this Region annotation will ignore any existing Region definition identified by the given name() for this entity. Defaults to true.

Default:

true

ignoreJta

public abstract boolean ignoreJta

Determines whether this Region's data access operations participates in any existing, Global JTA transaction in progress. Defaults to false (will NOT ignore JTA).

Default:

false

partitionResolverName

public abstract String partitionResolverName

Name of the PartitionResolver used to customize the partitioning strategy in this persistent entity's DataPolicy.PARTITION Region. This setting may also be the name of a Spring bean defined in the Spring context. Defaults to unset, thus using the default GemFire/Geode partitioning strategy.

Default:

""

persistent

public abstract boolean persistent

Determines whether this persistent entity's Region is persistent, storing data to disk. Note, this setting independent of whether or not the Region associated with this persistent entity overflows data to disk during eviction due to entry/heap/memory constraints. A Region can also be persistent without an explicit DiskStore defined; in that case, GemFire/Geode writes to the "DEFAULT" DiskStore. Defaults to false.

See Also:

DataPolicy

Default:

false

redundantCopies

public abstract int redundantCopies

Defines the number of redundant copies of this persistent entity's data. Defaults to 0.

Default:

0