com.sleepycat.client

Enum SForeignKeyDeleteAction

java.lang.Object

java.lang.Enum<SForeignKeyDeleteAction>

com.sleepycat.client.SForeignKeyDeleteAction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SForeignKeyDeleteAction>

public enum SForeignKeyDeleteAction
extends java.lang.Enum<SForeignKeyDeleteAction>

The action taken when a referenced record in the foreign key database is deleted.

The delete action applies to a secondary database that is configured to have a foreign key integrity constraint. The delete action is specified by calling SSecondaryConfig.setForeignKeyDeleteAction(com.sleepycat.client.SForeignKeyDeleteAction).

When a record in the foreign key database is deleted, it is checked to see if it is referenced by any record in the associated secondary database. If the key is referenced, the delete action is applied. By default, the delete action is ABORT.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT When a referenced record in the foreign key database is deleted, abort the transaction by throwing a SDatabaseException.
CASCADE When a referenced record in the foreign key database is deleted, delete the primary database record that references it.
NULLIFY When a referenced record in the foreign key database is deleted, set the reference to null in the primary database record that references it, thereby deleting the secondary key.

Method Summary

Modifier and Type	Method and Description
static SForeignKeyDeleteAction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SForeignKeyDeleteAction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ABORT

public static final SForeignKeyDeleteAction ABORT

When a referenced record in the foreign key database is deleted, abort the transaction by throwing a SDatabaseException.

CASCADE

public static final SForeignKeyDeleteAction CASCADE

When a referenced record in the foreign key database is deleted, delete the primary database record that references it.

NULLIFY

public static final SForeignKeyDeleteAction NULLIFY

When a referenced record in the foreign key database is deleted, set the reference to null in the primary database record that references it, thereby deleting the secondary key.

See Also:

SForeignKeyNullifier, SForeignMultiKeyNullifier

Method Detail

values

public static SForeignKeyDeleteAction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SForeignKeyDeleteAction c : SForeignKeyDeleteAction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SForeignKeyDeleteAction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null