Adding `welds` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add welds

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

welds = "0.4.20"

The welds library will be automatically available globally.

Back to the crate overview.

Readme

An async ORM written in rust using sqlx and/or Tiberius

Welds

Welds is an async ORM written in rust using sqlx and/or Tiberius.

Features

Async for all.
Support for multiple SQL databases (Mssql, MySql, Postgres, Sqlite)
Written for ease of development. Features aren't hidden behind traits. Code should be simple to write, and simple to read.
Low level connection always available when you need to drop down to raw SQL.

Under the hood welds uses:

sqlx for Postgres, MySql, and Sqlite.
Tiberius for MSSQL

Compatibility:

the 0.4.* line of welds is compiled with sqlx 0.8
the 0.3.* line of welds is compiled with sqlx 0.7

Example Setup

#[derive(Debug, WeldsModel)]
#[welds(schema= "inventory", table = "products")]
#[welds(BelongsTo(seller, super::people::People, "seller_id"))]
pub struct Product {
    #[welds(rename = "product_id")]
    #[welds(primary_key)]
    pub id: i32,
    pub name: String,
    pub seller_id: Option<i32>,
    pub description: Option<String>,
    pub price: Option<f32>,
}

Example Usage

Basic Select

  let url = "postgres://postgres:password@localhost:5432";
  let client = welds::connections::connect(url).await.unwrap();

  let products = Product::where_col(|p| p.price.equal(3.50)).run(&client).await?;

Basic Filter Across tables

  let client = welds::connections::connect(url).await.unwrap();

  let sellers = Product::where_col(|product| product.price.equal(3.50))
        .map_query(|product| product.seller )
        .where_col(|seller| seller.name.ilike("%Nessie%") )
        .run(&client).await?;

Create And Update

  let client = welds::connections::connect(url).await.unwrap();

  let mut cookies = Product::new();
  cookies.name = "cookies".to_owned();
  // Creates the product cookie
  cookies.save(&client).await?;
  cookies.description = "Yum".to_owned();
  // Updates the Cookies
  cookies.save(&client).await?;

Types from external crates

Both Tiberius and sqlx support types from external crates such at chrono and serde_json. These types need to be enabled in the underlying crate to use. In order to use types that are external the appropriate feature needs to be enabled in these underlying frameworks. We have chosen to leave this up to you as the developer so you have full control over your underlying SQLX/Tiberius setup.

In order to get these types to work you will need to:

Add the external crate cargo add chrono
Enable the feature in the underlying SQL framework. cargo add sqlx --features=chrono
(Tiberius only) enable the corresponding feature for welds-connections feature cargo add welds-connections --features=mssql,mssql-chrono

welds-connections features needed for mssql (tiberius):

mssql-chrono
mssql-time
mssql-rust_decimal
mssql-bigdecimal

Documentation

If you are looking for documentation on how to use welds, A good place to start is The Welds Book.

Other Examples

For more good examples check out the examples repo.

Adding welds library as a dependency

Adding `welds` library as a dependency