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

docs_src/tutorial/fastapi/app_testing/tutorial001/main.py

@@ -5,9 +5,9 @@ from sqlmodel import Field, Session, SQLModel, create_engine, select
 
 
 class HeroBase(SQLModel):
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
 
 class Hero(HeroBase, table=True):

docs_src/tutorial/fastapi/delete/tutorial001.py

@@ -5,9 +5,9 @@ from sqlmodel import Field, Session, SQLModel, create_engine, select
 
 
 class HeroBase(SQLModel):
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
 
 class Hero(HeroBase, table=True):

docs_src/tutorial/fastapi/limit_and_offset/tutorial001.py

@@ -5,9 +5,9 @@ from sqlmodel import Field, Session, SQLModel, create_engine, select
 
 
 class HeroBase(SQLModel):
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
 
 class Hero(HeroBase, table=True):

docs_src/tutorial/fastapi/multiple_models/tutorial001.py

@@ -6,9 +6,9 @@ from sqlmodel import Field, Session, SQLModel, create_engine, select
 
 class Hero(SQLModel, table=True):
     id: Optional[int] = Field(default=None, primary_key=True)
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
 
 class HeroCreate(SQLModel):

docs_src/tutorial/fastapi/multiple_models/tutorial002.py

@@ -5,9 +5,9 @@ from sqlmodel import Field, Session, SQLModel, create_engine, select
 
 
 class HeroBase(SQLModel):
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
 
 class Hero(HeroBase, table=True):

docs_src/tutorial/fastapi/read_one/tutorial001.py

@@ -5,9 +5,9 @@ from sqlmodel import Field, Session, SQLModel, create_engine, select
 
 
 class HeroBase(SQLModel):
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
 
 class Hero(HeroBase, table=True):

docs_src/tutorial/fastapi/relationships/tutorial001.py

@@ -5,7 +5,7 @@ from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, sele
 
 
 class TeamBase(SQLModel):
-    name: str
+    name: str = Field(index=True)
     headquarters: str
 
 
@@ -30,9 +30,9 @@ class TeamUpdate(SQLModel):
 
 
 class HeroBase(SQLModel):
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
     team_id: Optional[int] = Field(default=None, foreign_key="team.id")
 

docs_src/tutorial/fastapi/response_model/tutorial001.py

@@ -6,9 +6,9 @@ from sqlmodel import Field, Session, SQLModel, create_engine, select
 
 class Hero(SQLModel, table=True):
     id: Optional[int] = Field(default=None, primary_key=True)
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
 
 sqlite_file_name = "database.db"

docs_src/tutorial/fastapi/session_with_dependency/tutorial001.py

@@ -5,9 +5,9 @@ from sqlmodel import Field, Session, SQLModel, create_engine, select
 
 
 class HeroBase(SQLModel):
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
 
 class Hero(HeroBase, table=True):

docs_src/tutorial/fastapi/simple_hero_api/tutorial001.py

@@ -6,9 +6,9 @@ from sqlmodel import Field, Session, SQLModel, create_engine, select
 
 class Hero(SQLModel, table=True):
     id: Optional[int] = Field(default=None, primary_key=True)
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
 
 sqlite_file_name = "database.db"

docs_src/tutorial/fastapi/teams/tutorial001.py

@@ -5,7 +5,7 @@ from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, sele
 
 
 class TeamBase(SQLModel):
-    name: str
+    name: str = Field(index=True)
     headquarters: str
 
 
@@ -30,9 +30,9 @@ class TeamUpdate(SQLModel):
 
 
 class HeroBase(SQLModel):
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
     team_id: Optional[int] = Field(default=None, foreign_key="team.id")
 

docs_src/tutorial/fastapi/update/tutorial001.py

@@ -5,9 +5,9 @@ from sqlmodel import Field, Session, SQLModel, create_engine, select
 
 
 class HeroBase(SQLModel):
-    name: str
+    name: str = Field(index=True)
     secret_name: str
-    age: Optional[int] = None
+    age: Optional[int] = Field(default=None, index=True)
 
 
 class Hero(HeroBase, table=True):