constants group KeyRule in module com::sun::star::sdbc::

(Global Index)

Syntax

constants group KeyRule;

Description

determines the rules for foreign key constraints.

Constants Summary

CASCADE a possible value for the column's UPDATE_RULE and DELETE_RULE in the XResultSet objects returned by the methods XDatabaseMetaData::getImportedKeys() , XDatabaseMetaData::getExportedKeys() , and XDatabaseMetaData::getCrossReference() .

RESTRICT a possible value for the column's UPDATE_RULE and DELETE_RULE in the XResultSet objects returned by the methods XDatabaseMetaData::getImportedKeys() , XDatabaseMetaData::getExportedKeys() , and XDatabaseMetaData::getCrossReference() .

SET_NULL a possible value for the column's UPDATE_RULE and DELETE_RULE in the XResultSet objects returned by the methods XDatabaseMetaData::getImportedKeys() , XDatabaseMetaData::getExportedKeys() , and XDatabaseMetaData::getCrossReference() .

NO_ACTION a possible value for the column's UPDATE_RULE and DELETE_RULE in the XResultSet objects returned by the methods XDatabaseMetaData::getImportedKeys() , XDatabaseMetaData::getExportedKeys() , and XDatabaseMetaData::getCrossReference() .

SET_DEFAULT a possible value for the column's UPDATE_RULE and DELETE_RULE in the XResultSet objects returned by the methods XDatabaseMetaData::getImportedKeys() , XDatabaseMetaData::getExportedKeys() , and XDatabaseMetaData::getCrossReference() .

Field Details



CASCADE

Syntax

const long  CASCADE = 0;

Description

a possible value for the column's UPDATE_RULE and DELETE_RULE in the XResultSet objects returned by the methods XDatabaseMetaData::getImportedKeys() , XDatabaseMetaData::getExportedKeys() , and XDatabaseMetaData::getCrossReference() .

For the column UPDATE_RULE , it indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it.

For the column DELETE_RULE , it indicates that when the primary key is deleted, rows that imported that key are deleted.


RESTRICT

Syntax

const long  RESTRICT = 1;

Description

a possible value for the column's UPDATE_RULE and DELETE_RULE in the XResultSet objects returned by the methods XDatabaseMetaData::getImportedKeys() , XDatabaseMetaData::getExportedKeys() , and XDatabaseMetaData::getCrossReference() .

For the column UPDATE_RULE , it indicates that a primary key may not be updated if it has been imported by another table as a foreign key.

For the column DELETE_RULE , it indicates that a primary key may not be deleted if it has been imported by another table as a foreign key.


SET_NULL

Syntax

const long  SET_NULL = 2;

Description

a possible value for the column's UPDATE_RULE and DELETE_RULE in the XResultSet objects returned by the methods XDatabaseMetaData::getImportedKeys() , XDatabaseMetaData::getExportedKeys() , and XDatabaseMetaData::getCrossReference() .

For the columns UPDATE_RULE and DELETE_RULE , it indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed to NULL .


NO_ACTION

Syntax

const long  NO_ACTION = 3;

Description

a possible value for the column's UPDATE_RULE and DELETE_RULE in the XResultSet objects returned by the methods XDatabaseMetaData::getImportedKeys() , XDatabaseMetaData::getExportedKeys() , and XDatabaseMetaData::getCrossReference() .

For the columns UPDATE_RULE and DELETE_RULE , it indicates that if the primary key has been imported, it cannot be updated or deleted.


SET_DEFAULT

Syntax

const long  SET_DEFAULT = 4;

Description

a possible value for the column's UPDATE_RULE and DELETE_RULE in the XResultSet objects returned by the methods XDatabaseMetaData::getImportedKeys() , XDatabaseMetaData::getExportedKeys() , and XDatabaseMetaData::getCrossReference() .

For the columns UPDATE_RULE and DELETE_RULE , it indicates that if the primary key is updated or deleted, the foreign key (imported key) is set to the default value.

Top of Page