Azure Functions DB¶
Unified DB integration (trigger + input/output binding) for Azure Functions Python v2.
Features¶
- DB Change Detection (Trigger): Poll-based pseudo trigger that detects new/changed rows via cursor tracking
- Input Binding: Read rows declaratively with
@db.input()— data injected into your handler - Output Binding: Write rows declaratively with
@db.output()andDbOut.set() - Client Injection: Full imperative control with
@db.inject_reader()/@db.inject_writer() - Multi-DB Support: PostgreSQL, MySQL, SQL Server via SQLAlchemy
- Azure Functions v2 Native: Integrates with the Python v2 programming model
Quick Start¶
from azure_functions_db import DbBindings, DbOut, DbReader, DbWriter
from azure_functions_db import SqlAlchemySource, BlobCheckpointStore, EngineProvider
Documentation¶
- Installation — install and verify the package
- Getting Started — quickstart walkthrough
- Examples — complete code examples
- API Reference — auto-generated API docs
- Troubleshooting — common issues and solutions
- FAQ — frequently asked questions
Docs ownership & canonical sources¶
This project maintains two complementary documentation sets:
- Numbered specs & ADRs (
00-*…28-*, including the ADRs) are the canonical source for design and API contract.04-python-api-spec.mdis the authoritative API reference; the auto-generated API Reference is derived from source and cross-links back to it. - Standard user-facing pages (this index, Installation, Getting Started, Troubleshooting, FAQ) are derivations tuned for task-oriented reading.
When changing behavior, update 04-python-api-spec.md first, then propagate to the user-facing pages so the two systems do not drift.