✨ Announcing our seed funding led by Lux Capital! Read more about it on our blog ✨
[ Learn ]
[ Concepts ]
[ Reference ]
Database
Reflex uses sqlmodel to provide a built-in ORM wrapping SQLAlchemy.
The examples on this page refer specifically to how Reflex uses various tools to expose an integrated database interface. Only basic use cases will be covered below, but you can refer to the sqlmodel tutorial for more examples and information (just replace
SQLModel with rx.Model and Session(engine) with rx.session()). For advanced use cases, please see the SQLAlchemy docs (v1.4).
Connecting
Reflex provides a built-in SQLite database for storing and retrieving data.
You can connect to your own SQL compatible database by modifying the
rxconfig.py file with your database url.config = rx.Config(
app_name="my_app",
db_url="sqlite:///reflex.db",
)You can also use a DBConfig object to connect to your database.
config = rx.Config(
app_name="my_app",
db_config=rx.DBConfig(
engine="postgresql+psycopg2",
username="your-db-username",
password="your-db-password",
host="localhost",
port=5432,
database="reflex",
),
)DBConfig class has following constructors.
DBConfig.sqlite(database="reflex.db")
DBConfig.postgresql(
username="your-db-username",
password="your-db-password",
host="localhost",
port=5432,
database="reflex",
)
DBConfig.postgresql_psycopg2(
username="your-db-username",
password="your-db-password",
host="localhost",
port=5432,
database="reflex",
)Tables
To create a table make a class that inherits from
rx.Model with and specify that it is a table.class User(rx.Model, table=True):
username: str
email: str
password: strMigrations
Reflex leverages alembic to manage database schema changes.
Before the database feature can be used in a new app you must call
reflex db init to initialize alembic and create a migration script with the current schema.After making changes to the schema, use
reflex db makemigrations --message 'something changed' to generate a script in the alembic/versions directory that will update the database schema. It is recommended that scripts be inspected before applying them.The
reflex db migrate command is used to apply migration scripts to bring the database up to date. During app startup, if Reflex detects that the current database schema is not up to date, a warning will be displayed on the console.Queries
To query the database you can create a
rx.session(), which handles opening and closing the database connection.You can use normal SQLAlchemy queries to query the database.
with rx.session() as session:
session.add(
User(
username="test",
email="admin@pynecone.io",
password="admin",
)
)
session.commit()
Copyright © 2023 Pynecone, Inc.