by iurisilvio

iurisilvio / bottle-sqlalchemy

Bottle SQLAlchemy plugin

126 Stars 21 Forks Last release: Not found MIT License 82 Commits 3 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

This bottle-sqlalchemy plugin integrates SQLAlchemy with your Bottle application. It injects a SQLAlchemy session in your route and handle the session cycle.

Usage Example:

import bottle
from bottle import HTTPError
from bottle.ext import sqlalchemy
from sqlalchemy import create_engine, Column, Integer, Sequence, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base() engine = create_engine('sqlite:///:memory:', echo=True)

app = bottle.Bottle() plugin = sqlalchemy.Plugin( engine, # SQLAlchemy engine created with create_engine function. Base.metadata, # SQLAlchemy metadata, required only if create=True. keyword='db', # Keyword used to inject session database in a route (default 'db'). create=True, # If it is true, execute metadata.create_all(engine) when plugin is applied (default False). commit=True, # If it is true, plugin commit changes after route is executed (default True). use_kwargs=False # If it is true and keyword is not defined, plugin uses **kwargs argument to inject session database (default False). )


class Entity(Base): tablename = 'entity' id = Column(Integer, Sequence('id_seq'), primary_key=True) name = Column(String(50))

def __init__(self, name): = name

def __repr__(self):
    return "<entity>" % (,

@app.get('/:name') def show(name, db): entity = db.query(Entity).filter_by(name=name).first() if entity: return {'id':, 'name':} return HTTPError(404, 'Entity not found.')

@app.put('/:name') def put_name(name, db): entity = Entity(name) db.add(entity)

@app.get('/spam/:eggs', sqlalchemy=dict(use_kwargs=True)) @bottle.view('some_view') def route_with_view(eggs, db): # do something useful here

It is up to you create engine and metadata, because SQLAlchemy has a lot of options to do it. The plugin just handle the SQLAlchemy session.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.