org.gridgain.grid.cache.query

Annotation Type GridCacheQuerySqlField

@Documented
@Retention(value=RUNTIME)
@Target(value={METHOD,FIELD})
public @interface GridCacheQuerySqlField

Annotates fields for SQL queries. All fields that will be involved in SQL clauses must have this annotation. For more information about cache queries see GridCacheQuery documentation.

See Also:

GridCacheQuery

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	descending Specifies whether index should be in descending order or not.
String[]	groups Array of index groups this field belongs to.
boolean	index Specifies whether cache should maintain an index for this field or not.
String	name Property name.
GridCacheQuerySqlField.Group[]	orderedGroups Array of ordered index groups this field belongs to.
boolean	unique Deprecated. No longer supported, will be ignored.

Element Detail

index

public abstract boolean index

Specifies whether cache should maintain an index for this field or not. Just like with databases, field indexing may require additional overhead during updates, but makes select operations faster.

When GridH2IndexingSpi is set as indexing SPI and indexed field is of type com.vividsolutions.jts.geom.Geometry (or any subclass of this class) then GridGain will consider this index as spatial providing performance boost for spatial queries.

Returns:

True if index must be created for this field in database.

Default:

false

unique

@Deprecated
public abstract boolean unique

Deprecated. No longer supported, will be ignored.

Specifies whether index should be unique or not. This property only makes sense if index() property is set to true.

Returns:

True if field index should be unique.

Default:

false

descending

public abstract boolean descending

Specifies whether index should be in descending order or not. This property only makes sense if index() property is set to true.

Returns:

True if field index should be in descending order.

Default:

false

groups

public abstract String[] groups

Array of index groups this field belongs to. Groups are used for compound indexes, whenever index should be created on more than one field. All fields within the same group will belong to the same index.

Most of the times user will not specify any group, which means that cache should simply create a single field index.

Returns:

Array of group names.

Default:

{}

orderedGroups

public abstract GridCacheQuerySqlField.Group[] orderedGroups

Array of ordered index groups this field belongs to.

Returns:

Array of ordered group indexes.

Default:

{}

name

public abstract String name

Property name. If not provided then field name will be used.

Returns:

Name of property.

Default:

""