Skip to main content

(SQLAlchemy - ORM) + Twisted = win

Project description

alchimia lets you use most of the SQLAlchemy-core API with Twisted, it does not allow you to use the ORM.

Getting started

from alchimia import wrap_engine

from sqlalchemy import (
    create_engine, MetaData, Table, Column, Integer, String
)
from sqlalchemy.schema import CreateTable

from twisted.internet.defer import inlineCallbacks
from twisted.internet.task import react


@inlineCallbacks
def main(reactor):
    engine = wrap_engine(reactor, create_engine("sqlite://"))

    metadata = MetaData()
    users = Table("users", metadata,
        Column("id", Integer(), primary_key=True),
        Column("name", String()),
    )

    # Create the table
    yield engine.execute(CreateTable(users))

    # Insert some users
    yield engine.execute(users.insert().values(name="Jeremy Goodwin"))
    yield engine.execute(users.insert().values(name="Natalie Hurley"))
    yield engine.execute(users.insert().values(name="Dan Rydell"))
    yield engine.execute(users.insert().values(name="Casey McCall"))
    yield engine.execute(users.insert().values(name="Dana Whitaker"))

    result = yield engine.execute(users.select(users.c.name.startswith("D")))
    d_users = yield result.fetchall()
    # Print out the users
    for user in d_users:
        print("Username: %s" % user[users.c.name])
    # Queries that return results should be explicitly closed to
    # release the connection
    result.close()

if __name__ == "__main__":
    react(main, [])

Documentation

The documentation is all on Read the Docs.

Limitations

There are some limitations to alchimia's ability to expose the SQLAlchemy API.

  • Some methods simply haven’t been implemented yet. If you file a bug, we’ll implement them! See CONTRIBUTING.rst for more info.

  • Some methods in SQLAlchemy either have no return value, or don’t have a return value we can control. Since most of the alchimia API is predicated on returning Deferred instances which fire with the underlying SQLAlchemy instances, it is impossible for us to wrap these methods in a useful way. Luckily, many of these methods have alternate spelling. The docs call these out in more detail.

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

alchimia-0.8.1.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

alchimia-0.8.1-py2.py3-none-any.whl (6.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file alchimia-0.8.1.tar.gz.

File metadata

  • Download URL: alchimia-0.8.1.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for alchimia-0.8.1.tar.gz
Algorithm Hash digest
SHA256 c41b42e629ff8139b64dd28341704bdd5734be28d87b3e46259241f8b0173b8a
MD5 e03d07a46e8bcd88ad1c7c05988f1f0f
BLAKE2b-256 d986c63b218ad606a5538cbd777c0b926467e849e87b92cc863039843ebdc75c

See more details on using hashes here.

File details

Details for the file alchimia-0.8.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for alchimia-0.8.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 161ebe7076d8b5feda728df7128b2f5aea1d26d9b67cf33212ebaaeb26cff1b7
MD5 24dec430e26c1b98d4dc1a30f1ff2f1a
BLAKE2b-256 d2417bf9f947d845318d0c8603c98e8dfae39151398793d5bb46ad9757139062

See more details on using hashes here.

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