javax.jdo.annotations.Index - JDO annotation
javax.jdo.annotations
Annotation Index
- Target:
- Classes and fields (including property get methods)
Annotation for a database index. Used for database schema generation to create indexes. Corresponds to the xml element "index".
- Since:
- JDO 2.1
Columns that compose this index.
- Returns:
- columns that compose this index
- Default value:
- {}
- Since:
- JDO 2.1
String[]
members
Member (field and property) names that compose this index.
- Returns:
- member names that compose this index
- Default value:
- {}
- Since:
- JDO 2.1
String
name
Name of the index
- Returns:
- the name of the index
- Default value:
- ""
- Since:
- JDO 2.1
String
table
Table for the index. This is needed iff annotating a type where the index is not defined on the primary table for the type.
- Returns:
- the table on which the index is defined
- Default value:
- ""
- Since:
- JDO 2.1
String
unique
Whether this index is unique
- Returns:
- whether this index is unique
- Default value:
- ""
- Since:
- JDO 2.1
This documentation page is derived (with some adjustments) from the JDO 2.2 API
and is available under the terms of the Apache License, v. 2.0.
