https://github.com/pallets-eco/flask-sqlalchemy-lite

Integrate SQLAlchemy with Flask.
https://github.com/pallets-eco/flask-sqlalchemy-lite

flask flask-sqlalchemy flask-sqlalchemy-lite pallets pallets-eco python sqlalchemy

Last synced: 6 days ago
JSON representation

Integrate SQLAlchemy with Flask.

• Host: GitHub
• URL: https://github.com/pallets-eco/flask-sqlalchemy-lite
• Owner: pallets-eco
• License: mit
• Created: 2024-06-07T18:52:35.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-01T16:04:18.000Z (2 months ago)
• Last Synced: 2024-10-14T22:41:08.754Z (23 days ago)
• Topics: flask, flask-sqlalchemy, flask-sqlalchemy-lite, pallets, pallets-eco, python, sqlalchemy
• Language: Python
• Homepage: https://flask-sqlalchemy-lite.readthedocs.io
• Size: 66.4 KB
• Stars: 30
• Watchers: 6
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Flask-SQLAlchemy-Lite

Integrate [SQLAlchemy] with [Flask]. Use Flask's config to define SQLAlchemy

database engines. Create SQLAlchemy ORM sessions that are cleaned up

automatically after requests.

Intended to be a replacement for [Flask-SQLAlchemy]. Unlike the prior extension,

this one does not attempt to manage the model base class, tables, metadata, or

multiple binds for sessions. This makes the extension much simpler, letting the

developer use standard SQLAlchemy instead.

[SQLAlchemy]: https://sqlalchemy.org

[Flask]: https://flask.palletsprojects.com

[Flask-SQLAlchemy]: https://flask-sqlalchemy.readthedocs.io

## Pallets Community Ecosystem

> [!IMPORTANT]\

> This project is part of the Pallets Community Ecosystem. Pallets is the open

> source organization that maintains Flask; Pallets-Eco enables community

> maintenance of Flask extensions. If you are interested in helping maintain

> this project, please reach out on [the Pallets Discord server][discord].

>

> [discord]: https://discord.gg/pallets

 ## A Simple Example

```python

from flask import Flask

from flask_sqlalchemy_lite import SQLAlchemy

from sqlalchemy import select

from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column

class Base(DeclarativeBase):

    pass

class User(Base):

    __tablename__ = "user"

    id: Mapped[int] = mapped_column(primary_key=True)

    username: Mapped[str] = mapped_column(unique=True)

app = Flask(__name__)

app.config["SQLALCHEMY_ENGINES"] = {"default": "sqlite:///default.sqlite"}

db = SQLAlchemy(app)

with app.app_context():

    Base.metadata.create_all(db.engine)

    db.session.add(User(username="example"))

    db.session.commit()

    users = db.session.scalars(select(User))

```