Package info.archinnov.achilles.annotations

Enum Summary

Enum	Description
Enumerated.Encoding
SASI.Analyzer
SASI.IndexMode
SASI.Normalization

Data type Index Mode Analyzer Class Possible option values Text or Ascii PREFIX or CONTAINS NoOpAnalyzer analyzed = false (DEFAULT) normalization = NONE (DEFAULT) locale is ignored maxCompactionFlushMemoryInMb (OPTIONAL) enableStemming = false (DEFAULT) skipStopWords = false (DEFAULT) Text or Ascii PREFIX or CONTAINS NonTokenizingAnalyzer analyzed = true (MANDATORY) normalization (OPTIONAL) locale (OPTIONAL) maxCompactionFlushMemoryInMb (OPTIONAL) enableStemming = false (DEFAULT) skipStopWords = false (DEFAULT) Text or Ascii PREFIX or CONTAINS StandardAnalyzer analyzed = true (MANDATORY) normalization (OPTIONAL) locale (OPTIONAL) maxCompactionFlushMemoryInMb (OPTIONAL) enableStemming = false (DEFAULT) skipStopWords = false (DEFAULT) Non Text PREFIX OR SPARSE NoOpAnalyzer analyzed = false (DEFAULT) normalization = NONE (DEFAULT) locale is ignored maxCompactionFlushMemoryInMb (OPTIONAL) enableStemming = false (DEFAULT) skipStopWords = false (DEFAULT)

Annotation Types Summary

Annotation Type	Description
ASCII	Map this Java String type to Cassandra ascii type.
ClusteringColumn	Indicates that this component is a clustering column key.
Codec	Transform a custom Java type into one of native types supported by the Java driver The Codec class provided should implement the Codec interface.
CodecRegistry	Marker annotation to be used on configuration class for compile-time code generation.
Column	Annotation for simple column.
CompileTimeConfig	Define options for source code generation at compile time.
Computed	Annotation for computed column.
Consistency	Define the default consistency level for an Entity for all operations @Table(table = "user") @Consistency(read = ConsistencyLevel.ONE, write = ConsistencyLevel.ALL, serial = ConsistencyLevel.LOCAL_SERIAL) public class User {...}
Counter	Indicate that a column is a CQL counter.
DSE_Search	Annotation for DSE Search.
EmptyCollectionIfNull	In Cassandra there is no difference between an empty collection/map and a null value for collection/map In Java we do make the difference.
EntityCreator	Define the custom constructor to be use to instantiate the entity.
Enumerated	Annotation for enum type column.
Frozen	Annotation to indicate that a type is frozen.
FunctionRegistry	Marks a class as a function registry and let Achilles manage it @FunctionRegistry public interface MyFunctions { Integer sumOf(int val1, int val2); Long toLong(Date javaDate); }
Immutable	Mark an entity/udt/view as immutable.
Index	Annotation for secondary index.
JSON	Annotation to makes Achilles serialize the object into JSON String.
MaterializedView	Marks a class as a materialized view and let Achilles manage it @MaterializedView(baseEntity = UserEntity.class) public class UserByCountryView {...}
PartitionKey	Indicates that this component is part of the partition key.Useful to define a composite partition key.
RuntimeCodec	Transform a custom Java type into one of native types supported by the Java driver.
SASI	Annotation for SASI index The following combinations are allowed for index options:
Static	Define a static column @Table public class Entity { // Partition key @PartitionKey private Long id; // Clustering column @ClusteringColumn private int date; // Static column @Column @Static private String staticCol; }
Strategy	Choose a strategy for insertion and schema naming. For insertion strategy, available values are : info.archinnov.achilles.type.InsertStrategy.ALL_FIELDS info.archinnov.achilles.type.InsertStrategy.NOT_NULL_FIELDS Default value = info.archinnov.achilles.type.InsertStrategy.ALL_FIELDS @Table(table = "users") @Strategy(insert = InsertStrategy.NOT_NULL_FIELDS) public class UserEntity;
Table	Marks a class as an entity and let Achilles manage it @Table public class UserEntity {...}
TimeUUID	Map this Java UUID type to Cassandra timeuuid type.
Transient	Annotation to tell Achilles to ignore this column in the mapping // Transient colum, @Transient private String transient;
TTL	Define the default time to live, in second(s) for an Entity.
UDT	Annotation to indicate that a field is an UDT (User Defined Type).