Rustorm

An ORM for rust

Features

• Fluent high-level and low-level API
• Composable queries
• Extensible to multiple database platform
• Easy to reason out generated SQL
• Optional model code generator

Documentation

Philosophy

• Rustorm is designed to work on generic models, that is it will work on any database where the table definition is unknown

Example

• Get all contents of product table

externcrate rustorm;externcrate uuid;externcrate chrono;externcrate rustc_serialize;use uuid::Uuid;use chrono::datetime::DateTime;use chrono::offset::utc::UTC;use rustc_serialize::json;use rustorm::query::Query;use rustorm::query::{Filter,Equality};use rustorm::dao::{Dao,IsDao};use rustorm::pool::ManagedPool;use rustorm::table::{IsTable,Table};#[derive(Debug,Clone)]pubstructProduct{pubproduct_id:Uuid,pubname:Option<String>,pubdescription:Option<String>,}implIsDaoforProduct{fnfrom_dao(dao:&Dao)->Self{Product{product_id: dao.get("product_id"),name: dao.get_opt("name"),description: dao.get_opt("description"),}}fnto_dao(&self)->Dao{letmut dao = Dao::new();
dao.set("product_id",&self.product_id);matchself.name{Some(ref _value) => dao.set("name", _value),None => dao.set_null("name"),};matchself.description{Some(ref _value) => dao.set("description", _value),None => dao.set_null("description"),};
dao
}}implIsTableforProduct{fntable()->Table{Table{schema:"bazaar".to_string(),name:"product".to_string(),parent_table:None,sub_table:vec![],comment:None,columns:vec![],is_view:false}}}fnmain(){let url = "postgres://postgres:p0stgr3s@localhost/bazaar_v6";letmut pool = ManagedPool::init(&url,1).unwrap();let db = pool.connect().unwrap();let products:Vec<Product> = Query::select_all().from_table("bazaar.product").collect(db.as_ref()).unwrap();for prod in products{let name = prod.name.unwrap();let desc = match prod.description{Some(desc) => desc,None => "".to_string()};println!("{} {} {:?}", prod.product_id, name, desc);}}

• Get one photo of a product

externcrate rustorm;externcrate uuid;externcrate chrono;externcrate rustc_serialize;use uuid::Uuid;use chrono::datetime::DateTime;use chrono::offset::utc::UTC;use rustc_serialize::json;use rustorm::query::Query;use rustorm::query::{Filter,Equality};use rustorm::dao::{Dao,IsDao};use rustorm::pool::ManagedPool;use rustorm::table::{IsTable,Table};#[derive(Debug,Clone)]pubstructPhoto{pubphoto_id:Uuid,puburl:Option<String>,}implIsDaoforPhoto{fnfrom_dao(dao:&Dao)->Self{Photo{photo_id: dao.get("photo_id"),url: dao.get_opt("url"),}}fnto_dao(&self)->Dao{letmut dao = Dao::new();
dao.set("photo_id",&self.photo_id);matchself.url{Some(ref _value) => dao.set("url", _value),None => dao.set_null("url"),};
dao
}}implIsTableforPhoto{fntable()->Table{Table{schema:"bazaar".to_string(),name:"photo".to_string(),parent_table:None,sub_table:vec![],comment:None,columns:vec![],is_view:false}}}fnmain(){let url = "postgres://postgres:p0stgr3s@localhost/bazaar_v6";letmut pool = ManagedPool::init(url,1).unwrap();let db = pool.connect().unwrap();let photo:Photo = Query::select_all().column("photo.url").from_table("bazaar.product").left_join_table("bazaar.product_photo","product.product_id","product_photo.product_id").left_join_table("bazaar.photo","product_photo.photo_id","photo.photo_id").filter("product.name",Equality::EQ,&"GTX660 Ti videocard").collect_one(db.as_ref()).unwrap();println!("photo: {} {}",photo.photo_id, photo.url.unwrap());}

• One complex query

externcrate rustorm;externcrate uuid;externcrate chrono;externcrate rustc_serialize;use uuid::Uuid;use chrono::datetime::DateTime;use chrono::offset::utc::UTC;use rustc_serialize::json;use rustorm::query::Query;use rustorm::query::{Filter,Equality};use rustorm::dao::{Dao,IsDao};use rustorm::pool::ManagedPool;#[derive(Debug,Clone)]pubstructPhoto{pubphoto_id:Uuid,puburl:Option<String>,}implIsDaoforPhoto{fnfrom_dao(dao:&Dao)->Self{Photo{photo_id: dao.get("photo_id"),url: dao.get_opt("url"),}}fnto_dao(&self)->Dao{letmut dao = Dao::new();
dao.set("photo_id",&self.photo_id);matchself.url{Some(ref _value) => dao.set("url", _value),None => dao.set_null("url"),};
dao
}}fnmain(){let url = "postgres://postgres:p0stgr3s@localhost/bazaar_v6";letmut pool = ManagedPool::init(&url,1).unwrap();let db = pool.connect().unwrap();letmut query = Query::select_all();
query.from_table("bazaar.product").left_join_table("bazaar.product_category","product_category.product_id","product.product_id").left_join_table("bazaar.category","category.category_id","product_category.category_id").left_join_table("product_photo","product.product_id","product_photo.product_id").left_join_table("bazaar.photo","product_photo.photo_id","photo.photo_id").filter("product.name",Equality::EQ,&"GTX660 Ti videocard").filter("category.name",Equality::EQ,&"Electronic").group_by(vec!["category.name"]).having("count(*)",Equality::GT,&1).asc("product.name").desc("product.created");let frag = query.build(db.as_ref());let expected = " SELECT * FROM bazaar.product LEFT JOIN bazaar.product_category  ON product_category.product_id = product.product_id  LEFT JOIN bazaar.category  ON category.category_id = product_category.category_id  LEFT JOIN product_photo  ON product.product_id = product_photo.product_id  LEFT JOIN bazaar.photo  ON product_photo.photo_id = photo.photo_id  WHERE product.name = $1  AND category.name = $2  GROUP BY category.name  HAVING count(*) > $3  ORDER BY product.name ASC, product.created DESC".to_string();println!("actual: {{\n{}}} [{}]", frag.sql, frag.sql.len());println!("expected: {{{}}} [{}]", expected, expected.len());assert!(frag.sql.trim() == expected.trim());}

Supported Database

• PostgreSQL
• Sqlite
• MySQL/MariaDB
• Oracle

Roadmap

• Support for Oracle
• Support for MySql

For Updates

Follow me on twitter: @ivanceras

Support this project

• This is a 1 man show, so if you feel generous, please support this project at bountysource bountysource

• Suggestions are much welcome!