Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

JohnnieRunner is SQLAlchemy Wrapper for Active Record pattern O/R Mapper

Project Description

JohnnieRunner is SQLAlchemy Wrapper for Active Record pattern O/R Mapper

Dependencies

  • Python2.7 or Later
  • SQLAlchemy >= 1.0.8
  • MySQL-Python >= 1.2.5

Support RDBMS

  • MySQL

Goal

  • Add Rails like ActiveRecord Api
  • Database Migration
  • All Supports of SQLAlchemy RDBMS

Usage

Prepare

  1. generate testing database

    $ mysql -u root -p
    mysql> create database johnnie;
    Query OK, 1 row affected (0.01 sec)
    
    mysql> exit;
    Bye
    
  2. define O/R Mapper structure

    from johnnie import AbstractModel, create_session
    from johnnie.types import Column, String, Integer
    
    session = create_session('localhost', 'root', 'root user password', 'johnnie')
    
    
    class Repositories(AbstractModel):
        class Meta:
            session = session
    
        id = Column('id', Integer(unsigned=True), primary_key=True)
        name = Column('name', String(255), nullable=False)
        author = Column('author', String(255), nullable=False)
        url = Column('url', String(255), nullable=False)
    
  3. create model table

    $ python
    >>> from hoge import Repositories
    >>> Repositories.metadata.create_all(Repositories.get_session_engine())
    >>> exit()
    

Example

  1. create entity

    >>> from hoge import Repositories
    >>> entity = Repositories(name="JohnnieRunner", author="teitei-tk", url="https://github.com/teitei-tk/JohnnieRunner")
    
    or
    
    >>> entity_data = {"name": "JohnnieRunner", "author": "teitei-tk", "url": "https://github.com/teitei-tk/JohnnieRunner"}
    >>> entity = Repositories.new(entity_data)
    
  2. create record

    >>> entity.save()
    True
    
    mysql> select * from repositories;
    +----+---------------+-----------+--------------------------------------------+
    | id | name          | author    | url                                        |
    +----+---------------+-----------+--------------------------------------------+
    |  1 | JohnnieRunner | teitei-tk | https://github.com/teitei-tk/JohnnieRunner |
    +----+---------------+-----------+--------------------------------------------+
    1 row in set (0.00 sec)
    mysql>
    
  3. read record

    >>> entity = Repositories.get(1)
    
    or
    
    >>> entity = Repositories.find(1)
    
    >>> entity.name
    u"JohnnieRunner"
    >>> entity.author
    u"teitei-tk"
    >>> entity.url
    u"https://github.com/teitei-tk/JohnnieRunner"
    
  4. update record

    >>> entity.name = u"update_test"
    >>> entity.save()
    True
    
    mysql> select * from repositories;
    +----+-------------+-----------+--------------------------------------------+
    | id | name        | author    | url                                        |
    +----+-------------+-----------+--------------------------------------------+
    |  1 | update_test | teitei-tk | https://github.com/teitei-tk/JohnnieRunner |
    +----+-------------+-----------+--------------------------------------------+
    mysql>
    
  5. delete record

    >>> entity.delete()
    True
    
    mysql> select * from repositories;
    Empty set (0.00 sec)
    

TODO

  • [ ] Add DB Data Types
  • [ ] Easy generate table index
  • [ ] Easy Table RelationShips
  • [ ] Database Migration
  • [ ] RDBMS Support other than MySQL

License

  • MIT
Release History

Release History

This version
History Node

0.0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
JohnnieRunner-0.0.1.tar.gz (4.5 kB) Copy SHA256 Checksum SHA256 Source Sep 22, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting