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

This commit is contained in:
Sebastián Ramírez
2021-12-28 11:48:03 +01:00
committed by GitHub
parent 3d7b74746c
commit 155c6178cd
91 changed files with 1755 additions and 142 deletions

View File

@ -5,7 +5,7 @@ from sqlmodel import Field, Relationship, SQLModel
class Team(SQLModel, table=True):
id: Optional[int] = Field(default=None, primary_key=True)
name: str
name: str = Field(index=True)
headquarters: str
heroes: List["Hero"] = Relationship(back_populates="team")
@ -13,9 +13,9 @@ class Team(SQLModel, table=True):
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)
team_id: Optional[int] = Field(default=None, foreign_key="team.id")
team: Optional[Team] = Relationship(back_populates="heroes")

View File

@ -8,9 +8,9 @@ if TYPE_CHECKING:
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)
team_id: Optional[int] = Field(default=None, foreign_key="team.id")
team: Optional["Team"] = Relationship(back_populates="heroes")

View File

@ -8,7 +8,7 @@ if TYPE_CHECKING:
class Team(SQLModel, table=True):
id: Optional[int] = Field(default=None, primary_key=True)
name: str
name: str = Field(index=True)
headquarters: str
heroes: List["Hero"] = Relationship(back_populates="team")