Skip to content

RelationalTable.unset_foreign_key()

Unset an existing column as a foreign key in the GNN table. This will remove the column from its role as foreign key.

NameTypeDescriptionOptional
foreign_keyForeignKeyThe foreign key definition to unset.No

Raises ValueError if the referenced column does not exist in the GNN table or KeyError if the foreign key is not part of the declared foreign keys.

from relationalai_predictive import RelationalTable, ForeignKey
table_with_foreign_keys = RelationalTable(
connector=connector,
name="TableWithFKeys",
source="DATABASE.SCHEMA.TABLE_WITH_FKEYS",
type="node",
foreign_keys=[ForeignKey(column_name="Id1", link_to="TableWithCKey1.Id1"),
ForeignKey(column_name="Id2", link_to="TableWithCKey2.Id2")]
)
table_with_foreign_keys.unset_foreign_key(ForeignKey(column_name="Id1", link_to="TableWithCKey1.Id1"))