info.archinnov.achilles.annotations

Annotation Type Index

@Retention(value=RUNTIME)
 @Target(value={FIELD,TYPE_USE})
 @Documented
public @interface Index

Annotation for secondary index. Example

 @Table(table = "my_entity")
 public class MyEntity {

 //Simple index
 @Column
 @Index
 private String countryCode;

 //Simple index with custom name
 @Column("custom_name")
 @Index(name = "country_code_idx")
 private String customName;

 //Index on collection
 @Column
 @Index
 private List<String> indexedList;

 //Full index on collection because of the usage of @Frozen
 @Column
 @Frozen
 @Index
 private List<String> indexedFullList;

 //Index on map key
 @Column("indexed_map_key")
 private Map<@Index String, Long> indexOnMapKey;

 //Index on map entry
 @Column("index_map_entry")
 @Index
 private Map<String, Long> indexOnMapEntry;

 //Custom index
 @Column
 @Index(indexClassName = "com.myproject.SecondaryIndex", indexOptions = "{'key1': 'value1', 'key2': 'value2'}")
 private String custom;

 ...
 }
 

The above code would produce the following CQL script for index creation:

 CREATE INDEX IF NOT EXISTS ON my_entity(countryCode);

 CREATE INDEX country_code_idx IF NOT EXISTS ON my_entity(custom_name);

 CREATE INDEX IF NOT EXISTS ON my_entity(indexedlist);

 CREATE INDEX IF NOT EXISTS ON my_entity(FULL(indexedfulllist));

 CREATE INDEX IF NOT EXISTS ON my_entity(KEYS(indexed_map_key));

 CREATE INDEX IF NOT EXISTS ON my_entity(ENTRY(index_map_entry));

 CREATE CUSTOM my_entity_custom_index INDEX IF NOT EXISTS
 ON my_entity(custom)
 USING com.myproject.SecondaryIndex
 WITH OPTIONS = {'key1': 'value1', 'key2': 'value2'};

 

/

See Also:

@Index

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	indexClassName Optional.
String	indexOptions Optional.
String	name Optional.

Element Detail

name

public abstract String name

Optional. Define the name of the secondary index. If not set, defaults to table name_field name_index

 @Table
 public class User {
    
 ...
    
 @Index(name = "country_code_index")
 @Column
 private String countryCode;
    
 ...
 }
 

If the index name was not set above, it would default to user_countrycode_index

Default:

""

indexClassName

public abstract String indexClassName

Optional. The class name of your custom secondary index implementation

Default:

""

indexOptions

public abstract String indexOptions

Optional. The options for your custom secondary index. The indexOptions should be provided using the JSON map style. Example:

{'key1': 'property1', 'key2': 'property2', ...}

Default:

""