rustorm

A Work in Progress ORM for postgresql

A fork of my previous, very simple ORM for java

Dependency

• rust-postgres

Features

• intelligent model code generation (The only functional part for now)
  • Can figure out linker tables, then build 1:M relation with the tables on the generated code
  • Can figure out extension tables, which is just 1:1 relation with another table

To see it in action:

Configure the url to your postgres database. If you don't have a sample database schema, use the provide schema_dump in ./scripts/bazaar_v5_dump_schema.sql

bash psql -U postgres -h localhost -W -d <bazaar_v5> -f ./scripts/bazaar_v5_dump_schema.sql

```rust ///examples/generatemodelcode.rs

extern crate rustorm;

use rustorm::db::postgres::Postgres; use rustorm::codegen;

fn main(){ let pg:Result = Postgres::new("postgres://postgres:p0stgr3s@localhost/bazaarv5"); match pg{ Ok(pg) => { codegen::generateall_tables(pg,"./examples/gen.rs"); } Err(error) =>{ println!("{}",error); } } }

```

bash cargo run --release --example generate_model_code cat ./examples/gen.rs

example:

```sql

CREATE TABLE bazaar.product ( -- Inherited from table system.record: organizationid uuid, -- @Value(users.userid) , which means the value will be set with the users.userid value... -- Inherited from table system.record: clientid uuid, -- @Value(users.clientid) The clientid of the user creating this records -- Inherited from table system.record: created timestamp with time zone NOT NULL DEFAULT now(), -- Inherited from table system.record: createdby uuid, -- @Value(users.userid) -- Inherited from table system.record: updated timestamp with time zone NOT NULL DEFAULT now(), -- Inherited from table system.record: updatedby uuid, -- @Value(users.userid) -- Inherited from table system.record: priority numeric, -- Inherited from table system.record: name character varying, -- This is @Required it has @DisplayLength(50) - 50 character in display length a @MinLength(1) and @MaxLength(100) - Do not go over 100 characters or else the system will throw a ValueTooLong exception... -- Inherited from table system.record: description character varying, -- @DisplayLength(100) When building a UI for this field... -- Inherited from table system.record: help text, -- Inherited from table system.record: active boolean NOT NULL DEFAULT true, -- @Active productid uuid NOT NULL DEFAULT uuidgeneratev4(), parentproductid uuid, isservice boolean DEFAULT false, price numeric, useparentprice boolean DEFAULT false, unit character varying, tags json, info json, -- {color:"red",... seqno integer, -- @Sequence can be used to do alternate ordering of the values, when alphetical or time can not be used upfrontfee numeric DEFAULT 0.00, -- Applicable to services, usually services has an upfront fee barcode character varying, -- barcode if scanning the product, conflict can happen, expect to return matching list of products using the barcode ownerid uuid, -- Whom this product belongs, since createdby can be someone else create the product list in behalf of the owner of the product currencyid uuid, CONSTRAINT productpkey PRIMARY KEY (productid), CONSTRAINT productcurrencyidfkey FOREIGN KEY (currencyid) REFERENCES payment.currency (currencyid) MATCH SIMPLE ON UPDATE CASCADE ON DELETE RESTRICT DEFERRABLE INITIALLY DEFERRED, CONSTRAINT productuseridfkey FOREIGN KEY (ownerid) REFERENCES bazaar.users (userid) MATCH SIMPLE ON UPDATE CASCADE ON DELETE RESTRICT DEFERRABLE INITIALLY DEFERRED ) INHERITS (system.record) WITH ( OIDS=FALSE );

```

The generated rust code will be

rust /// /// This will be exposed as an @Api, including @Table(users, category, product_availability, photo) /// pub struct Product { /// primary /// defaults to: uuid_generate_v4() /// not nullable pub product_id:Uuid, /// barcode if scanning the product, conflict can happen, expect to return matching list of products using the barcode pub barcode:Option<String>, pub currency_id:Option<Uuid>, /// {color:"red", /// dimension:"10x20x30", /// dimensionUnit:"mm", /// weight:"4", /// weightUnit:"kg" /// } pub info:Option<Json>, /// defaults to: false pub is_service:Option<bool>, /// Whom this product belongs, since createdby can be someone else create the product list in behalf of the owner of the product pub owner_id:Option<Uuid>, pub parent_product_id:Option<Uuid>, pub price:Option<f64>, /// @Sequence can be used to do alternate ordering of the values, when alphetical or time can not be used pub seq_no:Option<i32>, pub tags:Option<Json>, pub unit:Option<String>, /// Applicable to services, usually services has an upfront fee /// defaults to: 0.00 pub upfront_fee:Option<f64>, /// defaults to: false pub use_parent_price:Option<bool>, /// @Active /// defaults to: true /// not nullable /// --inherited-- pub active:bool, /// @Value(users.client_id) The client_id of the user creating this records /// --inherited-- pub client_id:Option<Uuid>, /// defaults to: now() /// not nullable /// --inherited-- pub created:DateTime<UTC>, /// @Value(users.user_id) /// --inherited-- pub createdby:Option<Uuid>, /// @DisplayLength(100) When building a UI for this field /// @MaxLength(200) Do not go over 200 character on this one /// --inherited-- pub description:Option<String>, /// --inherited-- pub help:Option<String>, /// This is @Required it has @DisplayLength(50) - 50 character in display length a @MinLength(1) and @MaxLength(100) - Do not go over 100 characters or else the system will throw a ValueTooLong exception /// can also be express with @Length(1-100) /// --inherited-- pub name:Option<String>, /// @Value(users.user_id) , which means the value will be set with the users.user_id value /// /// @Where(users.active=true) /// --inherited-- pub organization_id:Option<Uuid>, /// --inherited-- pub priority:Option<f64>, /// defaults to: now() /// not nullable /// --inherited-- pub updated:DateTime<UTC>, /// @Value(users.user_id) /// --inherited-- pub updatedby:Option<Uuid>, /// has one pub owner_id_users:Option<Users>, /// has one pub currency_id_currency:Option<Currency>, /// has one, extension table pub product_availability:Option<Box<ProductAvailability>>, /// has many, indirect referring table, derived from linker table: product_category pub category:Option<Vec<Category>>, /// has many, indirect referring table, derived from linker table: product_photo pub photo:Option<Vec<Photo>>, /// has many, indirect referring table, derived from linker table: product_review pub review:Option<Vec<Review>>, }

Take notice of these last members of the struct here

rust /// has one, extension table pub product_availability:Option<Box<ProductAvailability>>, /// has many, indirect referring table, derived from linker table: product_category pub category:Option<Vec<Category>>, /// has many, indirect referring table, derived from linker table: product_photo pub photo:Option<Vec<Photo>>, /// has many, indirect referring table, derived from linker table: product_review pub review:Option<Vec<Review>>,

• The code generator can figure out that product_availability is just an extension table of the product table.
• It also knows that product:categories has 1:M relationship hinted by the linker table product_category, and so with the Photos and Reviews.
• The created column has a data type DateTime<UTC>, since it is not nullable, while nullable columns such as createdby will be wrapped with Option<Uuid>,

Documentation

docs

Roadmap

• implement all the features in ivanceras/orm
• become a full blown ORM for rust

For Updates

Follow me on twitter: @ivanceras