Before sqlmodel I used pydantic modle as input and output Schema . But now i m switched with the sqlmodel but i have some issue , some field(like password) that i don,t want to gave to the user in output schema how it will be restricted:

First Check

• I added a very descriptive title to this issue.
• I used the GitHub search to find a similar issue and didn’t find it.
• I searched the SQLModel documentation, with the integrated search.
• I already searched in Google “How to X in SQLModel” and didn’t find any information.
• I already read and followed all the tutorial in the docs and didn’t find an answer.
• I already checked if it is not related to SQLModel but to Pydantic.
• I already checked if it is not related to SQLModel but to SQLAlchemy.

Commit to Help

• I commit to help with one of those options 👆

Example Code

class Book(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    title: str
    description: str

Description

Before sqlmodel I used pydantic modle as input and output Schema . But now i m switched with the sqlmodel but i have some issue , some field(like password) that i don,t want to gave to the user in output schema how it will be restricted:

Operating System

Linux

Operating System Details

No response

SQLModel Version

0.0.6

Python Version

3.9.5

Additional Context

No response

[antont]

@Maypher has it right. There’s a more expanded example in the tutorial, with a base class and what would be here a UserCreate class to define the fields required in a POST call to create such an entity etc. https://sqlmodel.tiangolo.com/tutorial/fastapi/multiple-models/

[Maypher]

If you mean returning a table without some fields you could do something like this. Let’s say you have a users table

class User(SQLModel, table=True):
    id: Optional[int]
    name: str
    password: str

You want to return the user data without the password (id and name only) so you could do this

class UserRead(SQLModel):
    id: Optional[int]
    name: str  

class User(SQLModel, table=True):
    id: Optional[int]
    name: str
    password: str

Depending on the framework you are using the method might change. I’m assuming you are using FastAPI as your backend. You can use the response_model parameter to filter out unwanted parameters.

@app.get("/user", response_model=UserRead):
    # This is for simplicity. Here you fetch the user from the database
    user = User()
    return user

What this does is it gets the user from the database and when returning, it filters out all the fields that aren’t present in the model you passed to response_model. Here’s more info about the topic