mirror of
https://github.com/simonw/sqlite-utils.git
synced 2026-07-23 01:14:31 +02:00
Docs for sqlite_utils.AlterError in add_foreign_keys()
This commit is contained in:
parent
cbc22ef20c
commit
e0cd430e89
1 changed files with 4 additions and 0 deletions
|
|
@ -802,6 +802,8 @@ The ``table.add_foreign_key(column, other_table, other_column)`` method takes th
|
|||
- If the column is of format ``author_id``, look for tables called ``author`` or ``authors``
|
||||
- If the column does not end in ``_id``, try looking for a table with the exact name of the column or that name with an added ``s``
|
||||
|
||||
This method first checks that the specified foreign key references tables and columns that exist and does not clash with an existing foreign key. It will raise a ``sqlite_utils.AlterError`` exception if these checks fail.
|
||||
|
||||
.. _python_api_add_foreign_keys:
|
||||
|
||||
Adding multiple foreign key constraints at once
|
||||
|
|
@ -822,6 +824,8 @@ Here's an example adding two foreign keys at once:
|
|||
("dogs", "home_town_id", "towns", "id")
|
||||
])
|
||||
|
||||
This method runs the same checks as ``.add_foreign_keys()`` and will raise ``sqlite_utils.AlterError`` if those checks fail.
|
||||
|
||||
.. _python_api_index_foreign_keys:
|
||||
|
||||
Adding indexes for all foreign keys
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue