From d82b000e3d55067516e2ce42f131cf4695e80dca Mon Sep 17 00:00:00 2001
From: Simon Willison <swillison@gmail.com>
Date: Sun, 30 Jun 2019 16:44:52 -0700
Subject: [PATCH] 'Adding indexes for all foreign keys' docs

---
 docs/cli.rst        |  9 +++++++++
 docs/python-api.rst | 11 +++++++++++
 2 files changed, 20 insertions(+)

diff --git a/docs/cli.rst b/docs/cli.rst
index 8e47ad6..db1954c 100644
--- a/docs/cli.rst
+++ b/docs/cli.rst
@@ -310,6 +310,15 @@ If you omit the other table and other column references ``sqlite-utils`` will at
 
 See :ref:`python_api_add_foreign_key` in the Python API documentation for further details, including how the automatic table guessing mechanism works.
 
+.. _cli_index_foreign_keys:
+
+Adding indexes for all foreign keys
+-----------------------------------
+
+If you want to ensure that every foreign key column in your database has a corresponding index, you can do so like this::
+
+    $ sqlite-utils index-foreign-keys books.db
+
 .. _cli_defaults_not_null:
 
 Setting defaults and not null constraints
diff --git a/docs/python-api.rst b/docs/python-api.rst
index 8928c03..c7ef65a 100644
--- a/docs/python-api.rst
+++ b/docs/python-api.rst
@@ -419,6 +419,17 @@ Here's an example adding two foreign keys at once:
         ("dogs", "home_town_id", "towns", "id")
     ])
 
+.. _python_api_index_foreign_keys:
+
+Adding indexes for all foreign keys
+-----------------------------------
+
+If you want to ensure that every foreign key column in your database has a corresponding index, you can do so like this:
+
+.. code-block:: python
+
+    db.index_foreign_keys()
+
 .. _python_api_hash:
 
 Setting an ID based on the hash of the row contents