foreignKeyList

Retrieves a list of all foreign key constraints for a given table.

Each row in the returned cursor describes a single foreign key constraint and has the following columns:

  • id: A unique integer identifier for this foreign key within the table.

  • seq: A sequence number (starting from 0) for columns within a composite foreign key.

  • table: The name of the parent table that the foreign key refers to.

  • from: The name of the column in the child table (the table this pragma is called on).

  • to: The name of the column in the parent table that is being referenced.

  • on_update: The action to take on an UPDATE operation (e.g., CASCADE, SET NULL).

  • on_delete: The action to take on a DELETE operation (e.g., CASCADE, SET NULL).

  • match: The matching logic for composite keys (e.g., SIMPLE, PARTIAL, FULL).

Return

A KQLiteCursor containing the list of foreign key constraints.

Author

MOHAMMAD AZIM ANSARI

Parameters

table

The table for which to retrieve the foreign key constraint information.

See also