✨ Document indexes and make them opt-in (#205)

tests/test_tutorial/test_fastapi/test_multiple_models/test_tutorial001.py

@@ -1,4 +1,6 @@
 from fastapi.testclient import TestClient
+from sqlalchemy import inspect
+from sqlalchemy.engine.reflection import Inspector
 from sqlmodel import create_engine
 from sqlmodel.pool import StaticPool
 
@@ -166,3 +168,16 @@ def test_tutorial(clear_sqlmodel):
         assert response.status_code == 200, response.text
 
         assert data == openapi_schema
+
+    # Test inherited indexes
+    insp: Inspector = inspect(mod.engine)
+    indexes = insp.get_indexes(str(mod.Hero.__tablename__))
+    expected_indexes = [
+        {"name": "ix_hero_name", "column_names": ["name"], "unique": 0},
+        {"name": "ix_hero_age", "column_names": ["age"], "unique": 0},
+    ]
+    for index in expected_indexes:
+        assert index in indexes, "This expected index should be in the indexes in DB"
+        # Now that this index was checked, remove it from the list of indexes
+        indexes.pop(indexes.index(index))
+    assert len(indexes) == 0, "The database should only have the expected indexes"

tests/test_tutorial/test_fastapi/test_multiple_models/test_tutorial002.py

@@ -1,4 +1,6 @@
 from fastapi.testclient import TestClient
+from sqlalchemy import inspect
+from sqlalchemy.engine.reflection import Inspector
 from sqlmodel import create_engine
 from sqlmodel.pool import StaticPool
 
@@ -166,3 +168,16 @@ def test_tutorial(clear_sqlmodel):
         assert response.status_code == 200, response.text
 
         assert data == openapi_schema
+
+    # Test inherited indexes
+    insp: Inspector = inspect(mod.engine)
+    indexes = insp.get_indexes(str(mod.Hero.__tablename__))
+    expected_indexes = [
+        {"name": "ix_hero_age", "column_names": ["age"], "unique": 0},
+        {"name": "ix_hero_name", "column_names": ["name"], "unique": 0},
+    ]
+    for index in expected_indexes:
+        assert index in indexes, "This expected index should be in the indexes in DB"
+        # Now that this index was checked, remove it from the list of indexes
+        indexes.pop(indexes.index(index))
+    assert len(indexes) == 0, "The database should only have the expected indexes"

tests/test_tutorial/test_indexes/test_tutorial001.py

@@ -0,0 +1,35 @@
+from unittest.mock import patch
+
+from sqlalchemy import inspect
+from sqlalchemy.engine.reflection import Inspector
+from sqlmodel import create_engine
+
+from ...conftest import get_testing_print_function
+
+
+def test_tutorial(clear_sqlmodel):
+    from docs_src.tutorial.indexes import tutorial001 as mod
+
+    mod.sqlite_url = "sqlite://"
+    mod.engine = create_engine(mod.sqlite_url)
+    calls = []
+
+    new_print = get_testing_print_function(calls)
+
+    with patch("builtins.print", new=new_print):
+        mod.main()
+    assert calls == [
+        [{"secret_name": "Dive Wilson", "age": None, "id": 1, "name": "Deadpond"}]
+    ]
+
+    insp: Inspector = inspect(mod.engine)
+    indexes = insp.get_indexes(str(mod.Hero.__tablename__))
+    expected_indexes = [
+        {"name": "ix_hero_name", "column_names": ["name"], "unique": 0},
+        {"name": "ix_hero_age", "column_names": ["age"], "unique": 0},
+    ]
+    for index in expected_indexes:
+        assert index in indexes, "This expected index should be in the indexes in DB"
+        # Now that this index was checked, remove it from the list of indexes
+        indexes.pop(indexes.index(index))
+    assert len(indexes) == 0, "The database should only have the expected indexes"

tests/test_tutorial/test_indexes/test_tutorial006.py

@@ -0,0 +1,36 @@
+from unittest.mock import patch
+
+from sqlalchemy import inspect
+from sqlalchemy.engine.reflection import Inspector
+from sqlmodel import create_engine
+
+from ...conftest import get_testing_print_function
+
+
+def test_tutorial(clear_sqlmodel):
+    from docs_src.tutorial.indexes import tutorial002 as mod
+
+    mod.sqlite_url = "sqlite://"
+    mod.engine = create_engine(mod.sqlite_url)
+    calls = []
+
+    new_print = get_testing_print_function(calls)
+
+    with patch("builtins.print", new=new_print):
+        mod.main()
+    assert calls == [
+        [{"name": "Tarantula", "secret_name": "Natalia Roman-on", "age": 32, "id": 4}],
+        [{"name": "Black Lion", "secret_name": "Trevor Challa", "age": 35, "id": 5}],
+    ]
+
+    insp: Inspector = inspect(mod.engine)
+    indexes = insp.get_indexes(str(mod.Hero.__tablename__))
+    expected_indexes = [
+        {"name": "ix_hero_name", "column_names": ["name"], "unique": 0},
+        {"name": "ix_hero_age", "column_names": ["age"], "unique": 0},
+    ]
+    for index in expected_indexes:
+        assert index in indexes, "This expected index should be in the indexes in DB"
+        # Now that this index was checked, remove it from the list of indexes
+        indexes.pop(indexes.index(index))
+    assert len(indexes) == 0, "The database should only have the expected indexes"

tests/test_tutorial/test_where/test_tutorial003.py

@@ -17,7 +17,7 @@ def test_tutorial(clear_sqlmodel):
     with patch("builtins.print", new=new_print):
         mod.main()
 
-    assert calls == [
+    expected_calls = [
         [{"id": 6, "name": "Dr. Weird", "secret_name": "Steve Weird", "age": 36}],
         [{"id": 3, "name": "Rusty-Man", "secret_name": "Tommy Sharp", "age": 48}],
         [
@@ -29,3 +29,8 @@ def test_tutorial(clear_sqlmodel):
             }
         ],
     ]
+    for call in expected_calls:
+        assert call in calls, "This expected item should be in the list"
+        # Now that this item was checked, remove it from the list
+        calls.pop(calls.index(call))
+    assert len(calls) == 0, "The list should only have the expected items"

tests/test_tutorial/test_where/test_tutorial004.py

@@ -16,7 +16,7 @@ def test_tutorial(clear_sqlmodel):
 
     with patch("builtins.print", new=new_print):
         mod.main()
-    assert calls == [
+    expected_calls = [
         [{"id": 5, "name": "Black Lion", "secret_name": "Trevor Challa", "age": 35}],
         [{"id": 6, "name": "Dr. Weird", "secret_name": "Steve Weird", "age": 36}],
         [{"id": 3, "name": "Rusty-Man", "secret_name": "Tommy Sharp", "age": 48}],
@@ -29,3 +29,8 @@ def test_tutorial(clear_sqlmodel):
             }
         ],
     ]
+    for call in expected_calls:
+        assert call in calls, "This expected item should be in the list"
+        # Now that this item was checked, remove it from the list
+        calls.pop(calls.index(call))
+    assert len(calls) == 0, "The list should only have the expected items"

tests/test_tutorial/test_where/test_tutorial011.py

@@ -16,7 +16,7 @@ def test_tutorial(clear_sqlmodel):
 
     with patch("builtins.print", new=new_print):
         mod.main()
-    assert calls == [
+    expected_calls = [
         [{"id": 5, "name": "Black Lion", "secret_name": "Trevor Challa", "age": 35}],
         [{"id": 6, "name": "Dr. Weird", "secret_name": "Steve Weird", "age": 36}],
         [{"id": 3, "name": "Rusty-Man", "secret_name": "Tommy Sharp", "age": 48}],
@@ -29,3 +29,8 @@ def test_tutorial(clear_sqlmodel):
             }
         ],
     ]
+    for call in expected_calls:
+        assert call in calls, "This expected item should be in the list"
+        # Now that this item was checked, remove it from the list
+        calls.pop(calls.index(call))
+    assert len(calls) == 0, "The list should only have the expected items"