Package com.activeviam.database.datastore.api.description.impl

Class StoreDescription

java.lang.Object

com.activeviam.database.datastore.api.description.impl.StoreDescription

All Implemented Interfaces:

IDataTable, IStoreDescription

public final class StoreDescription
extends Object
implements IStoreDescription

Default immutable implementation of IStoreDescription.

Author:

ActiveViam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StoreDescription.SimpleStoreDescriptionBuilder	A simple IStoreDescription builder.

Field Summary

Fields inherited from interface com.activeviam.database.datastore.api.description.IStoreDescription

BATCH_SIZE_PROPERTY

Constructor Summary

Constructors

Constructor	Description
StoreDescription(@NonNull String name, List<String> keyFieldNames, List<? extends IFieldDescription> fields)	Constructor which makes the collections immutable.
StoreDescription(@NonNull String name, List<String> keyFieldNames, List<? extends IFieldDescription> fields, IPartitioningDescription partitioning, Collection<IOptimizationDescription> optimizations, boolean updateOnlyIfDifferent, int chunkSize, IDuplicateKeyHandler duplicateKeyHandler, IStoreDescriptionBuilder.IRemoveUnknownKeyListener removeUnknownKeyBehavior, Properties properties, INumaSelectorDescription numaNodeSelector, boolean shouldCompressIndexes)	Deprecated, for removal: This API element is subject to removal in a future version. Use the builder instead

Method Summary

Modifier and Type	Method	Description
static IStoreDescriptionBuilder	builder()	Retrieves a builder to construct this class.
boolean	equals(Object o)
int	getChunkSize()	Gets the chunk size required for this store.
IDuplicateKeyHandler	getDuplicateKeyHandler()	Returns how to handle adding two records with the same key fields.
List<? extends IFieldDescription>	getFields()	Gets the fields of this table, ordered by field index.
List<String>	getKeyFieldNames()	Gets the key field names of this table.
String	getName()	Gets the name of the table.
INumaSelectorDescription	getNumaSelector()	Gets the numa selector.
Collection<IOptimizationDescription>	getOptimizationDescriptions()	Returns the optimizations to use on fields of this schema.
IPartitioningDescription	getPartitioning()	Gets the description of the partitioning on this store (null if there is no partitioning in place). A partitioning expression contains the partition key (one or several fields that belongs to a store) and a partitioning policy (will there be one partition per distinct value of the partition key, or some bucketing based on the hash of the partition key) The schema can be partitioned by several such expressions, one per store at most.
Properties	getProperties()	Returns some additional properties.
IStoreDescriptionBuilder.IRemoveUnknownKeyListener	getRemoveUnknownKeyBehavior()	Gets the policy handling a remove operation on an unknown key.
int	hashCode()
boolean	shouldCompressIndexes()	Specifies to store the indexes of this store in a compressed format, in order to reduce the memory usage.
static StoreDescription.SimpleStoreDescriptionBuilder	simpleBuilder()	Creates a non-fluent IStoreDescription builder.
static StoreDescription.SimpleStoreDescriptionBuilder	simpleBuilder(IStoreDescription desc)	Creates a non-fluent IStoreDescription builder initialized with the given description.
String	toString()
boolean	updateOnlyIfDifferent()	States whether a record should be updated when it contains exactly the same content as the previously existing record.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.activeviam.database.api.schema.IDataTable

getFieldIndex, getFieldNames, hasField

Methods inherited from interface com.activeviam.database.datastore.api.description.IStoreDescription

getField, getKeyFields

Constructor Details

StoreDescription

public StoreDescription(@NonNull
 @NonNull String name,
 List<String> keyFieldNames,
 List<? extends IFieldDescription> fields)

Constructor which makes the collections immutable.

Parameters:

name - the name of the store

keyFieldNames - the key fields

fields - the field descriptions

StoreDescription

@DeprecatedApi(forRemoval="6.2.0",
               rationale="Use the builder instead")
@Deprecated(since="6.1.5",
            forRemoval=true)
public StoreDescription(@NonNull
 @NonNull String name,
 List<String> keyFieldNames,
 List<? extends IFieldDescription> fields,
 @Nullable
 IPartitioningDescription partitioning,
 Collection<IOptimizationDescription> optimizations,
 boolean updateOnlyIfDifferent,
 int chunkSize,
 IDuplicateKeyHandler duplicateKeyHandler,
 IStoreDescriptionBuilder.IRemoveUnknownKeyListener removeUnknownKeyBehavior,
 Properties properties,
 @Nullable
 INumaSelectorDescription numaNodeSelector,
 boolean shouldCompressIndexes)

Deprecated, for removal: This API element is subject to removal in a future version.

Use the builder instead

Constructor which makes the collections immutable.

Parameters:

name - see getName()

keyFieldNames - see getKeyFieldNames()

fields - see getFields()

partitioning - see getPartitioning()

optimizations - see getOptimizationDescriptions()

updateOnlyIfDifferent - see updateOnlyIfDifferent()

chunkSize - see getChunkSize()

duplicateKeyHandler - see getDuplicateKeyHandler()

removeUnknownKeyBehavior - see getRemoveUnknownKeyBehavior()

properties - see getProperties()

numaNodeSelector - see getNumaSelector()

shouldCompressIndexes - see shouldCompressIndexes()

Method Details

builder

public static IStoreDescriptionBuilder builder()

Retrieves a builder to construct this class.

simpleBuilder

public static StoreDescription.SimpleStoreDescriptionBuilder simpleBuilder()

Creates a non-fluent IStoreDescription builder.

Returns:

the builder

See Also:

• builder()

simpleBuilder

public static StoreDescription.SimpleStoreDescriptionBuilder simpleBuilder(IStoreDescription desc)

Creates a non-fluent IStoreDescription builder initialized with the given description.

This method is for case when one need to change a few attributes of an existing IStoreDescription.

Parameters:

desc - the description used to initialize the builder

Returns:

the builder

updateOnlyIfDifferent

public boolean updateOnlyIfDifferent()

Description copied from interface: IStoreDescription

States whether a record should be updated when it contains exactly the same content as the previously existing record.

Specified by:

updateOnlyIfDifferent in interface IStoreDescription

shouldCompressIndexes

public boolean shouldCompressIndexes()

Description copied from interface: IStoreDescription

Specifies to store the indexes of this store in a compressed format, in order to reduce the memory usage.

It is false by default, as it entails a performance cost (additional computation is needed to "decompress", and reading a key may require additional memory accesses).

Therefore, you should set this option to true only if you encounter memory issues.

Specified by:

shouldCompressIndexes in interface IStoreDescription

Returns:

true if we should attempt to reduce memory usage at the cost of performance, false otherwise

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Description copied from interface: IDataTable

Gets the name of the table.

Specified by:

getName in interface IDataTable

getKeyFieldNames

public List<String> getKeyFieldNames()

Description copied from interface: IDataTable

Gets the key field names of this table.

Specified by:

getKeyFieldNames in interface IDataTable

getFields

public List<? extends IFieldDescription> getFields()

Description copied from interface: IDataTable

Gets the fields of this table, ordered by field index.

The index of a field is its 0-based position within the table.

Specified by:

getFields in interface IDataTable

Specified by:

getFields in interface IStoreDescription

getPartitioning

@Nullable
public IPartitioningDescription getPartitioning()

Description copied from interface: IStoreDescription

Gets the description of the partitioning on this store (null if there is no partitioning in place).
A partitioning expression contains the partition key (one or several fields that belongs to a store) and a partitioning policy (will there be one partition per distinct value of the partition key, or some bucketing based on the hash of the partition key)
The schema can be partitioned by several such expressions, one per store at most.

Expression examples:

• value(product) | value(currency)
• modulo8(tradeId)

Specified by:

getPartitioning in interface IStoreDescription

getChunkSize

public int getChunkSize()

Description copied from interface: IStoreDescription

Gets the chunk size required for this store.

Specified by:

getChunkSize in interface IStoreDescription

Returns:

the wanted chunk size, or -1 if none defined

See Also:

• Chunks.DEFAULT_CHUNK_SIZE

getOptimizationDescriptions

public Collection<IOptimizationDescription> getOptimizationDescriptions()

Description copied from interface: IStoreDescription

Returns the optimizations to use on fields of this schema.

Specified by:

getOptimizationDescriptions in interface IStoreDescription

getDuplicateKeyHandler

public IDuplicateKeyHandler getDuplicateKeyHandler()

Description copied from interface: IStoreDescription

Returns how to handle adding two records with the same key fields.

Specified by:

getDuplicateKeyHandler in interface IStoreDescription

getRemoveUnknownKeyBehavior

public IStoreDescriptionBuilder.IRemoveUnknownKeyListener getRemoveUnknownKeyBehavior()

Description copied from interface: IStoreDescription

Gets the policy handling a remove operation on an unknown key.

Specified by:

getRemoveUnknownKeyBehavior in interface IStoreDescription

getProperties

public Properties getProperties()

Description copied from interface: IStoreDescription

Returns some additional properties.

Specified by:

getProperties in interface IStoreDescription

getNumaSelector

@Nullable
public INumaSelectorDescription getNumaSelector()

Description copied from interface: IStoreDescription

Gets the numa selector.

Specified by:

getNumaSelector in interface IStoreDescription