Bevy SQLx

Bevy SQLx is a database plugin for Bevy's ECS which allows for SQL queries to be performed and data entities to be spawned.

Usage

use std::env;
use bevy::prelude::*;
use sqlx::{FromRow, Sqlite, SqlitePool};
use bevy_sqlx::{SqlxPlugin, SqlxDatabase, SqlxPrimaryKey, SqlxEvent};

#[derive(Component, FromRow, Debug)]
struct MyRecord {
    id: u32,
    flag: bool,
    text: String,
}

impl SqlxPrimaryKey for MyRecord {
    type Column = u32;

    fn primary_key(&self) -> Self::Column {
        self.id
    }
}

fn main() {
    let url = "sqlite:db/sqlite.db";
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(SqlxPlugin::<Sqlite, MyRecord>::from_url(&url))
        .add_systems(Startup, insert)
        .add_systems(Update, query)
        .run();
}

fn insert(mut events: EventWriter<SqlxEvent<Sqlite, MyRecord>>) {
    let sql = "INSERT INTO foos(text) VALUES ('test') RETURNING *";
    events.send(SqlxEvent::<Sqlite, MyRecord>::query(sql))
}

fn query(mut my_records: Query<&MyRecord>) {
    for my_record in &my_records {
        dbg!(my_record);
    }
}

fn resource(db: Res<SqlxDatabase<Sqlite>>) {
    let record = bevy::tasks::block_on(async {
        sqlx::query!("SELECT (1) as id, 'test' as text")
            .fetch_one(&db.pool)
            .await.unwrap()
    });
}

Running the sqlite Example

cargo run --example sqlite-minimal \
    --features sqlx/sqlite,bevy/bevy_winit,bevy/wayland