undeclare_foreign_key
Description:
public bool undeclare_foreign_key (MetaStruct? mstruct, string fk_name, string? catalog, string? schema, string table, string? ref_catalog, string? ref_schema, string ref_table) throws Error
Removes a declared foreign key from this.
This method begins a transaction if possible (ie. none is already started), and if it can't, then if there is an error, the job may be partially done.
A check is always performed to make sure all the database objects actually exist and returns an error if not. The check is performed using
mstruct
if it's not null (in this case only the tables already represented in mstruct
will be considered, in other words: mstruct
will not be modified), and using an internal
MetaStruct is null.
See declare_foreign_key for more information anout the
catalog
, schema
, name
, ref_catalog
, ref_schema
and ref_name
arguments.
Parameters:
this | |
mstruct |
a MetaStruct, or null |
fk_name |
the name of the foreign key to declare |
catalog |
the catalog in which the table (for which the foreign key is for) is, or null |
schema |
the schema in which the table (for which the foreign key is for) is, or null |
table |
the name of the table (for which the foreign key is for) |
ref_catalog |
the catalog in which the referenced table is, or null |
ref_schema |
the schema in which the referenced table is, or null |
ref_table |
the name of the referenced table |
Returns:
true if no error occurred |