Skip to main content

Add SQLAlchemy support to your Flask application.

Project description

Flask-SQLAlchemy is an extension for Flask that adds support for SQLAlchemy to your application. It aims to simplify using SQLAlchemy with Flask by providing useful defaults and extra helpers that make it easier to accomplish common tasks.

Installing

Install and update using pip:

$ pip install -U Flask-SQLAlchemy

A Simple Example

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column

app = Flask(__name__)
app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///example.sqlite"

class Base(DeclarativeBase):
  pass

db = SQLAlchemy(app, model_class=Base)

class User(db.Model):
    id: Mapped[int] = mapped_column(db.Integer, primary_key=True)
    username: Mapped[str] = mapped_column(db.String, unique=True, nullable=False)

with app.app_context():
    db.create_all()

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

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

Contributing

For guidance on setting up a development environment and how to make a contribution to Flask-SQLAlchemy, see the contributing guidelines.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask_sqlalchemy-3.1.1.tar.gz (81.9 kB view details)

Uploaded Source

Built Distribution

flask_sqlalchemy-3.1.1-py3-none-any.whl (25.1 kB view details)

Uploaded Python 3

File details

Details for the file flask_sqlalchemy-3.1.1.tar.gz.

File metadata

  • Download URL: flask_sqlalchemy-3.1.1.tar.gz
  • Upload date:
  • Size: 81.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for flask_sqlalchemy-3.1.1.tar.gz
Algorithm Hash digest
SHA256 e4b68bb881802dda1a7d878b2fc84c06d1ee57fb40b874d3dc97dabfa36b8312
MD5 b2439ba29a86fd594e0de4fc0e42ceb6
BLAKE2b-256 9153b0a9fcc1b1297f51e68b69ed3b7c3c40d8c45be1391d77ae198712914392

See more details on using hashes here.

Provenance

File details

Details for the file flask_sqlalchemy-3.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for flask_sqlalchemy-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4ba4be7f419dc72f4efd8802d69974803c37259dd42f3913b0dcf75c9447e0a0
MD5 e0575e969b5fd5861e4caedcfe43f61a
BLAKE2b-256 1d6a89963a5c6ecf166e8be29e0d1bf6806051ee8fe6c82e232842e3aeac9204

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page