-PrimaryKey (Oracle - Berkeley DB Java API) -

-Indicates the primary key field of an entity class. The value of the - primary key field is the unique identifier for the entity in a PrimaryIndex. - -

+
+
+
```
@Documented
+@Retention(value=RUNTIME)
+@Target(value=FIELD)
+public @interface PrimaryKey
```
+
Indicates the primary key field of an entity class. The value of the + primary key field is the unique identifier for the entity in a PrimaryIndex. + +
PrimaryKey may appear on at most one declared field per class.

Primary key values may be automatically assigned as sequential integers - using a sequence(). In this case the type of the key field is + using a sequence(). In this case the type of the key field is restricted to a simple integer type.

A primary key field may not be null, unless it is being assigned from a @@ -126,8 +115,8 @@ Indicates the primary key field of an entity class. The value of the
Array types are not allowed.

When using a composite key class, each field of the composite key class - must be annotated with KeyField to identify the storage order and - default sort order. See KeyField for an example and more + must be annotated with KeyField to identify the storage order and + default sort order. See KeyField for an example and more information on composite keys.

Key Sort Order
@@ -137,7 +126,7 @@ Indicates the primary key field of an entity class. The value of the encoding that allows a fast byte-by-byte comparison.
- All simple types except for String are encoded so that they are - sorted as expected, that is, as if the Comparable.compareTo(T) method + sorted as expected, that is, as if the Comparable.compareTo(T) method of their class (or, for primitives, their wrapper class) is called.
- Strings are encoded as UTF-8 byte arrays. Zero (0x0000) character @@ -152,9 +141,9 @@ Indicates the primary key field of an entity class. The value of the
When using a composite key class with more than one field, the sorting - order among fields is determined by the KeyField annotations. To + order among fields is determined by the KeyField annotations. To override the default sort order, you can use a composite key class that - implements Comparable. This allows overriding the sort order and is + implements Comparable. This allows overriding the sort order and is therefore useful even when there is only one key field in the composite key class. See Custom Sort Order for more information on sorting of composite keys.
@@ -212,47 +201,63 @@ Indicates the primary key field of an entity class. The value of the @PrimaryKey String uuid; ... - } -
- -
-
- -
+ }
+

- - - - - - - - - - -
-Optional Element Summary
- String sequence - -
- The name of a sequence from which to assign primary key values - automatically.
- -
-
-sequence
-
```
-public abstract String sequence
```
-
-
The name of a sequence from which to assign primary key values +
- + + +
  Optional Element Summary
  + + + + + + + + + + +
  Optional Elements
  Modifier and Type Optional Element and Description
  java.lang.String sequence +
  The name of a sequence from which to assign primary key values + automatically.
  +
  +
+

-Optional Element Summary
- `String`	`sequence` - - - The name of a sequence from which to assign primary key values - automatically.

Optional Elements
Modifier and Type	Optional Element and Description
`java.lang.String`	`sequence` + The name of a sequence from which to assign primary key values + automatically. +

+ +
- + + +
  Element Detail
  + + + +
  - +
    sequence
    +
```
public abstract java.lang.String sequence
```
    +
    The name of a sequence from which to assign primary key values automatically. If a non-empty string is specified, sequential integers will be assigned from the named sequence.
    A single sequence may be used for more than one entity class by specifying the same sequence name for each PrimaryKey. For - each named sequence, a Sequence will be used to + each named sequence, a Sequence will be used to assign key values. For more information on configuring sequences, see - EntityStore.setSequenceConfig.
    + EntityStore.setSequenceConfig.
    
    To use a sequence, the type of the key field must be a primitive integer type (byte, short, int or long) @@ -262,7 +267,7 @@ public abstract PrimaryIndex, a new key will be + put methods in the PrimaryIndex, a new key will be assigned if the primary key field in the entity instance is null (for a reference type) or zero (for a primitive integer type). Specifying zero for a primitive integer key field is allowed because the initial value @@ -271,81 +276,80 @@ public abstract PrimaryIndex +
    When one of the put methods in the PrimaryIndex is called and a new key is assigned, the assigned value is returned to the caller via the key field of the entity object that is passed as a - parameter.
    -
    -
    -
    -
    -
    -
    -
    -
    Default:
    ""
    -
    - + parameter.
    +
    +
    Default:
    +
    ""
    +
    +
  +
+

- -com.sleepycat.persist.model -
-Annotation Type PrimaryKey

Annotation Type PrimaryKey

-sequence

Optional Element Summary

Element Detail

sequence

- -com.sleepycat.persist.model - -Annotation Type PrimaryKey

Annotation Type PrimaryKey

-sequence

Optional Element Summary

Element Detail

sequence

- -com.sleepycat.persist.model -
-Annotation Type PrimaryKey