LibreOffice LibreOffice 6.2 SDK API Reference

Variables
com::sun::star::sdbc::KeyRule Constant Group Referencepublished

determines the rules for foreign key constraints. More...

## Variables
const long | CASCADE = 0
| a possible value for the column's `UPDATE_RULE` and `DELETE_RULE` in the com::sun::star::sdbc::XResultSet objects returned by the methods com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference(). More...
const long | RESTRICT = 1
| a possible value for the column's `UPDATE_RULE` and `DELETE_RULE` in the com::sun::star::sdbc::XResultSet objects returned by the methods com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference(). More...
const long | SET_NULL = 2
| a possible value for the column's `UPDATE_RULE` and `DELETE_RULE` in the com::sun::star::sdbc::XResultSet objects returned by the methods com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference(). More...
const long | NO_ACTION = 3
| a possible value for the column's `UPDATE_RULE` and `DELETE_RULE` in the com::sun::star::sdbc::XResultSet objects returned by the methods com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference(). More...
const long | SET_DEFAULT = 4
| a possible value for the column's `UPDATE_RULE` and `DELETE_RULE` in the com::sun::star::sdbc::XResultSet objects returned by the methods com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference(). More...

## Detailed Description

determines the rules for foreign key constraints.

## Variable Documentation

## ◆ CASCADE

const long CASCADE = 0

a possible value for the column's `UPDATE_RULE` and `DELETE_RULE` in the com::sun::star::sdbc::XResultSet objects returned by the methods com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), and com::sun::star::sdbc::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.

## ◆ NO_ACTION

const long NO_ACTION = 3

a possible value for the column's `UPDATE_RULE` and `DELETE_RULE` in the com::sun::star::sdbc::XResultSet objects returned by the methods com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), and com::sun::star::sdbc::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.

## ◆ RESTRICT

const long RESTRICT = 1

a possible value for the column's `UPDATE_RULE` and `DELETE_RULE` in the com::sun::star::sdbc::XResultSet objects returned by the methods com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), and com::sun::star::sdbc::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_DEFAULT

const long SET_DEFAULT = 4

a possible value for the column's `UPDATE_RULE` and `DELETE_RULE` in the com::sun::star::sdbc::XResultSet objects returned by the methods com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), and com::sun::star::sdbc::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.

## ◆ SET_NULL

const long SET_NULL = 2

a possible value for the column's `UPDATE_RULE` and `DELETE_RULE` in the com::sun::star::sdbc::XResultSet objects returned by the methods com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), and com::sun::star::sdbc::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`.