SQLAlchemy The Python SQL Toolkit and Object Relational Mapper
SQLAlchemy Muhammet S. AYDIN Python Developer @ Metglobal @mengukagan
SQLAlchemy No ORM Required ● Mature ● High Performing ● Non-opinionated ● Unit of Work ● Function based query construction ● Modular ●
SQLAlchemy Seperation of mapping & classes ● Eager loading & caching related objects ● Inheritance mapping ● Raw SQL ●
SQLAlchemy Drivers: PostgreSQL MySQL MSSQL SQLite Sybase Drizzle Firebird Oracle
SQLAlchemy Core Engine Connection Dialect MetaData Table Column
SQLAlchemy Core Engine Starting point for SQLAlchemy app. Home base for the database and it's API.
SQLAlchemy Core Connection Provides functionality for a wrapped DB-API connection. Executes SQL statements. Not thread-safe.
SQLAlchemy Core Dialect Defines the behavior of a specific database and DB-API combination. Query generation, execution, result handling, anything that differs from other dbs is handled in Dialect.
SQLAlchemy Core MetaData Binds to an Engine or Connection. Holds the Table and Column metadata in itself.
SQLAlchemy Core Table Represents a table in the database. Stored in the MetaData.
SQLAlchemy Core Column Represents a column in a database table.
SQLAlchemy Core Creating an engine:
SQLAlchemy Core Creating tables Register the Table with MetaData. Define your columns. Call metadata.create_all(engine) or table.create(engine)
SQLAlchemy Core Creating tables
SQLAlchemy Core More on Columns Columns have some important parameters. index=bool, nullable=bool, unique=bool, primary_key=bool, default=callable/scalar, onupdate=callable/scalar, autoincrement=bool
SQLAlchemy Core Column Types Integer, BigInteger, String, Unicode, UnicodeText, Date, DateTime, Boolean, Text, Time and All of the SQL std types.
SQLAlchemy Core Insert insert = countries_table.insert().values( code='TR', name='Turkey') conn.execute(insert)
SQLAlchemy Core Select select([countries_table]) select([ct.c.code, ct.c.name]) select([ct.c.code.label('c')])
SQLAlchemy Core Select select([ct]).where(ct.c.region == 'Europe & Central Asia') select([ct]).where(or_(ct.c.region.il ike('%europe%', ct.c.region.ilike('%asia%')))
SQLAlchemy Core Select A Little Bit Fancy select([func.count(ct.c.id).label('co unt'), ct.c.region]).group_by(ct.c.region).o rder_by('count DESC') SELECT count(countries.id) AS count, countries.region FROM countries GROUP BY countries.region ORDER BY count DESC
SQLAlchemy Core Update ct.update().where(ct.c.id == 1).values(name='Turkey', code='TUR')
SQLAlchemy Core Cooler Update case_list = [(pt.c.id == photo_id, index+1) for index, photo_id in enumerate(order_list)] pt.update().values(photo_order=case(case_l ist)) UPDATE photos SET photo_order=CASE WHEN (photos.id = :id_1) THEN :param_1 WHEN (photos.id = :id_2) THEN :param_2 END
SQLAlchemy Core Delete ct.delete().where(ct.c.id_in([60,71,8 0,97]))
SQLAlchemy Core Joins select([ct.c.name, dt.c.data]).select_from(ct.join(dt)). where(ct.c.code == 'TRY')
SQLAlchemy Core Joins select([ct.c.name, dt.c.data]).select_from(join(ct, dt, ct.c.id == dt.c.country_id)).where(ct.c.code == 'TRY')
SQLAlchemy Core Func A SQL function generator with attribute access. simply put: func.count() becomes COUNT().
SQLAlchemy Core Func select([func.concat_ws(“ -> “, ct.c.name, ct.c.code)]) SELECT concat_ws(%(concat_ws_2)s, countries.name, countries.code) AS concat_ws_1 FROM countries
SQLAlchemy ORM - Built on top of the core - Applied usage of the Expression Language - Class declaration - Table definition is nested in the class
SQLAlchemy ORM Definition
SQLAlchemy ORM Session Basically it establishes all connections to the db. All objects are kept on it through their lifespan. Entry point for Query.
SQLAlchemy ORM Master / Slave Connection? master_session = sessionmaker(bind=engine1) slave_session = sessionmaker(bind=engine2) Session = master_session() SlaveSession = slave_session()
SQLAlchemy ORM Querying Session.query(Country).filter(Country .name.startswith('Tur')).all() Session.query(func.count(Country.id)) .one() Session.query(Country.name, Data.data).join(Data).all()
SQLAlchemy ORM Querying Session.query(Country).filter_by(id=1 ).update({“name”: “USA”}) Session.query(Country).filter(~Countr y.region.in_('Europe & Central Asia')).delete()
SQLAlchemy ORM Relationships: One To Many
SQLAlchemy ORM Relationships: One To One
SQLAlchemy ORM Relationships: Many To Many
SQLAlchemy ORM Relationships: Many To Many
SQLAlchemy ORM Relationship Loading
SQLAlchemy ORM Relationship Loading
SQLAlchemy ORM More? http://sqlalchemy.org http://github.com/zzzeek/sqlalchemy irc.freenode.net #sqlalchemy

An introduction to SQLAlchemy

Editor's Notes

  • #5 If you use ORM you just use classes But if you use the core, you can also map the tables to Python classess with mapper()
  • #7 SQLAlchemy core consists of 6 classes
  • #15 We define columns as arguments to Table object
  • #19 Conn is retrieved from engine.connect()
  • #24 Case – when statement is a way of saying When the condition is met, use this value to update the column.