Skip to main content

Middleware for integrating Falcon applications with SQLAlchemy.

Project description

Build Status PyPi Documentation codecov.io

Falcon Middleware: SQLAlchemy Integration

The falcon-sqla package provides a middleware component for managing SQLAlchemy sessions. The manager component can also serve as a base building block or a recipe for more complex use cases, such as applications leveraging multiple database binds.

Installation

$ pip install falcon-sqla

Usage

The falcon_sqla session Manager can be used in two ways:

Configuration

  • Create a SQLAlchemy engine.

  • Pass the engine to the Manager() initializer as its first parameter.

  • If using the manager as a middleware component, pass its middleware property to a falcon.App's middleware list:

engine = create_engine('dialect+driver://my/database')
manager = falcon_sqla.Manager(engine)

app = falcon.App(middleware=[manager.middleware])

# The database session will be available as req.context.session

Context Manager

A falcon_sqla.Manager can also explicitly provide a database session using the session_scope() context manager:

# Somewhere inside a responder
with self.manager.session_scope(req, resp) as session:
    # Use the session
    # <...>

session_scope() can also be used as a standalone session context outside of the request-response cycle:

with self.manager.session_scope() as session:
    # Use the session
    # <...>

Custom Vertical Partitioning

Simple random selection of read- and write- database replicas is supported out of the box. Use the add_engine() method to instruct the Manager to include the provided engines in the runtime bind selection logic:

manager = falcon_sqla.Manager(engine)

read_replica = create_engine('dialect+driver://my/database.replica')
manager.add_engine(read_replica, falcon_sqla.EngineRole.READ)

The Manager.get_bind() method can be overridden to implement custom engine selection logic for more complex use cases.

See also this SQLAlchemy recipe: Custom Vertical Partitioning.

About Falcon

Falcon is the minimalist REST API and microservices framework for Python developers, with a focus on reliability, correctness, and performance at scale.

About SQLAlchemy

SQLAlchemy is the Python SQL toolkit and Object Relational Mapper that gives application developers the full power and flexibility of SQL.

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

falcon_sqla-0.5.0.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

falcon_sqla-0.5.0-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file falcon_sqla-0.5.0.tar.gz.

File metadata

  • Download URL: falcon_sqla-0.5.0.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for falcon_sqla-0.5.0.tar.gz
Algorithm Hash digest
SHA256 fc2fe44b756c96ba25d59ac5ce92c5705b29265845dad35c6c3eebb3369a4e37
MD5 b7911ff55125f64087633d846d19e9bd
BLAKE2b-256 2673ac1356dc97d868549cbdbd5f91c0d7fe41753243f77d63d055d5f76ebe3d

See more details on using hashes here.

File details

Details for the file falcon_sqla-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: falcon_sqla-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for falcon_sqla-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7d3fc7037ba5725b582a647c148776bbc6febb6602e86a389a676e926b9a33b
MD5 000d759f6d81da1544156fd8d92d3bcc
BLAKE2b-256 4b9014f09bb227a9af7c3ecc6dd21a4ae19c48a24ac0a2381e296e6d788ead38

See more details on using hashes here.

Supported by

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