A python implementation of the mysql server protocol
Project description
MySQL-Mimic
Pure-python implementation of the MySQL server wire protocol.
This can be used to create applications that act as a MySQL server.
MySQL-Mimic doesn't parse SQL - it only handles the wire protocol. For parsing, check out sqlglot.
Installation
pip install mysql-mimic
Usage
This library is meant to be used as the basis for a proxy SQL service. A minimal use case might look like this:
import asyncio
from mysql_mimic import MysqlServer, Session
class MySession(Session):
async def init(self, connection):
print(f"new session: {connection}")
async def query(self, sql, attrs):
print(f"received query: {sql}")
return [("a", 1), ("b", 2)], ["col1", "col2"]
async def close(self):
print("session closed")
if __name__ == "__main__":
server = MysqlServer(session_factory=MySession)
asyncio.run(server.serve_forever())
See examples for more examples.
Todo
- Add support for (at least) the
mysql_native_password
authentication method with another callback. - Eventually Compression support
- Eventually SSL support
Development
You can install dependencies with make deps
. You can format your code with
make format
. You can lint with make lint
. You can run tests with make test
. This will build a coverage report in ./htmlcov/index.html
. You can
build a pip package with make build
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mysql_mimic-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c246ee6f672328f1be0f67f01bd4eccdfb8fa9ce247042f85b1cdd8bd3f366a0 |
|
MD5 | 4bc12255a872c2676833b0de653d17fb |
|
BLAKE2b-256 | 7b473aa81a24a6cb13a4158b612f64b18ddcab37fa27b1d412db35c8c756d463 |