1 unstable release

Uses new Rust 2021

0.1.0 Jun 14, 2022

#8 in Database implementations

Download history 1955/week @ 2022-06-13 2899/week @ 2022-06-20 2484/week @ 2022-06-27 5500/week @ 2022-07-04 6155/week @ 2022-07-11 8004/week @ 2022-07-18 9258/week @ 2022-07-25 7295/week @ 2022-08-01 7635/week @ 2022-08-08

32,610 downloads per month

Apache-2.0

330KB
5.5K SLoC

OpenSrv - MySQL

Bindings for emulating a MySQL/MariaDB server.

When developing new databases or caching layers, it can be immensely useful to test your system using existing applications. However, this often requires significant work modifying applications to use your database over the existing ones. This crate solves that problem by acting as a MySQL server, and delegating operations such as querying and query execution to user-defined logic.

Usage

To start, implement AsyncMysqlShim for your backend, and create a AsyncMysqlIntermediary over an instance of your backend and a connection stream. The appropriate methods will be called on your backend whenever a client issues a QUERY, PREPARE, or EXECUTE command, and you will have a chance to respond appropriately. For example, to write a shim that always responds to all commands with a "no results" reply:

use std::io;

use opensrv_mysql::*;
use tokio::net::TcpListener;

struct Backend;

#[async_trait::async_trait]
impl<W: io::Write + Send> AsyncMysqlShim<W> for Backend {
    type Error = io::Error;

    async fn on_prepare<'a>(
        &'a mut self,
        _: &'a str,
        info: StatementMetaWriter<'a, W>,
    ) -> io::Result<()> {
        info.reply(42, &[], &[])
    }

    async fn on_execute<'a>(
        &'a mut self,
        _: u32,
        _: opensrv_mysql::ParamParser,
        results: QueryResultWriter<'a, W>,
    ) -> io::Result<()> {
        results.completed(OkResponse::default())
    }

    async fn on_close(&mut self, _: u32) {}

    async fn on_query<'a>(
        &'a mut self,
        sql: &'a str,
        results: QueryResultWriter<'a, W>,
    ) -> io::Result<()> {
        println!("execute sql {:?}", sql);
        results.start(&[])?.finish()
    }
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let listener = TcpListener::bind("0.0.0.0:3306").await?;

    loop {
        let (stream, _) = listener.accept().await?;
        tokio::spawn(async move { AsyncMysqlIntermediary::run_on(Backend, stream).await });
    }
}

This example can be exected with:

cargo run --example=serve_one

More examples can be found here.

Getting help

Submit issues for bug report or asking questions in discussion.

Credits

This project is a branch of jonhoo/msql-srv and focuses on providing asynchronous support.

License

Licensed under Apache License, Version 2.0.

Dependencies

~16MB
~312K SLoC