aiosql-mysql

Table of Contents

1. About The Project
2. Getting Started
3. Usage
4. Contributing
5. License
6. Contact
7. Thanks

About The Project

aiosql-mysql is a database adaptor intended to allow the use of asyncmy with aiosql.

Warning:

This project is in early developement. The PyMySQL adaptor works but is not fully tested. AsyncMy is not implimented and working at this time, please check back later.

Getting Started

For information about cloning and dev setup see: Contributing

Usage

This is example is adapted from aiosql's readme.

users.sql

-- name: get-user-by-username^
SELECT *
FROM users
WHERE username = :username;

-- name: create_users#
CREATE TABLE users ( userid INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
                     username VARCHAR(100),
                     firstname VARCHAR(100),
                     lastname VARCHAR(100)
);

-- name: insert_bob!
INSERT INTO users (username, firstname, lastname)
VALUES ('bob', 'bob', 'smith');

Blocking execution

Indexing a document adds it to or updates it in the search store.

import aiosql
import pymysql
from aiosql_mysql import PyMySQLAdaptor

conn = pymysql.connect(
        host="127.0.0.1",
        port=3306,
        user="root",
        password="password",
        database="ExampleDb",
        cursorclass=pymysql.cursors.DictCursor,
    )

queries = aiosql.from_path("./users.sql", PyMySQLAdaptor)
queries.create_users(conn)
queries.insert_bob(conn)
result = queries.get_user_by_username(conn, username="bob")
print(result)
# {'userid': 1, 'username': 'bob', 'firstname': 'bob', 'lastname': 'smith'}

For a more detailed and complete version of the above example see pymysql_example.py & users.sql

Async execution

import aiosql
import asyncmy
from aiosql_mysql import AsyncMySQLAdapter

queries = aiosql.from_path("./users.sql", AsyncMySQLAdapter)

async def main():
    conn = await asyncmy.connect(
        host="127.0.0.1",
        port=3306,
        user="root",
        password="password",
        database="ExampleDb",
    )

    await queries.create_users(conn)
    await queries.insert_user(conn,user_name='sbob', first_name='Bob', last_name='Smith')
    result = await queries.get_user_by_username(conn, username="sbob")
    print(result)


if __name__ == "__main__":
  import asyncio

  asyncio.run(main())
  # {'userid': 1, 'username': 'sbob', 'firstname': 'Bob', 'lastname': 'Smith'}

For a more detailed and complete version of the above example see asyncmy_example.py & users.sql

Contributing

See the open issues for a list of proposed features (and known issues).

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)

4. execute: py.test --cov-report xml:cov.xml --cov
5. Commit your Changes (git commit -m 'Add some AmazingFeature')
6. Push to the Branch (git push origin feature/AmazingFeature)
7. Open a Pull Request

Cloning / Development setup

1. Clone the repo and install

   git clone https://github.com/kajuberdut/aiosql-mysql.git
   cd aiosql-mysql
   pipenv install --dev

2. Run tests

   pipenv shell
   ward

For more about pipenv see: Pipenv Github

License

Distributed under the MIT. See LICENSE for more information.

Contact

Patrick Shechet - [email protected]

Project Link: https://github.com/kajuberdut/aiosql-mysql

Thanks

This library would be pointless without:

• Will Vaughn, creator of aiosql
• The other contributors to aiosql
• The PyMySql Team
• Long2Ice, creator of asyncmy
• The aiomysql team who's work makes asyncmy possible
• Many Many others in the Python and Open Source communities