21 releases (7 stable)
1.6.0 | Sep 20, 2024 |
---|---|
1.2.0 | Feb 21, 2024 |
0.4.2 | Aug 19, 2021 |
0.4.1 | Feb 5, 2021 |
0.2.6 | Jul 18, 2020 |
#49 in Database interfaces
2,387 downloads per month
68KB
1.5K
SLoC
sqlx-adapter
sqlx-adapter is the Sqlx adapter for casbin-rs. With this library, Casbin can load policy from Sqlx supported database or save policy to it with fully asynchronous support.
Based on Sqlx, The current supported databases are:
Notice
In order to unify the database table name in Casbin ecosystem, we decide to use casbin_rule
instead of casbin_rules
from version 0.4.0
. If you are using old version sqlx-adapter
in your production environment, please use following command and update sqlx-adapter
version:
# MySQL & PostgreSQL & SQLite
ALTER TABLE casbin_rules RENAME TO casbin_rule;
Install
Add the following to Cargo.toml
:
For MySQL:
sqlx-adapter = { version = "1.6.0", default-features = false, features = ["mysql", "runtime-tokio-native-tls"]}
tokio = { version = "1.1.1", features = ["macros"] }
For PostgreSQL:
sqlx-adapter = { version = "1.6.0", default-features = false, features = ["postgres", "runtime-tokio-native-tls"]}
tokio = { version = "1.1.1", features = ["macros"] }
For SQLite:
sqlx-adapter = { version = "1.6.0", default-features = false, features = ["sqlite", "runtime-tokio-native-tls"]}
tokio = { version = "1.1.1", features = ["macros"] }
Warning: tokio v1.0
or later is supported from sqlx-adapter v0.4.0
, we recommend that you upgrade the relevant components to ensure that they work properly. The last version that supports tokio v0.2
is sqlx-adapter v0.3.0
, you can choose according to your needs.
Configure
-
Set up database environment
You must prepare the database environment so that
Sqlx
can do static check with queries during compile time. One convenient option is using docker to get your database environment ready:#!/bin/bash DIS=$(lsb_release -is) command -v docker > /dev/null 2>&1 || { echo "Please install docker before running this script." && exit 1; } if [ $DIS == "Ubuntu" ] || [ $DIS == "LinuxMint" ]; then sudo apt install -y \ libpq-dev \ libmysqlclient-dev \ postgresql-client \ mysql-client-core; elif [ $DIS == "Deepin" ]; then sudo apt install -y \ libpq-dev \ libmysql++-dev \ mysql-client \ postgresql-client; elif [ $DIS == "ArchLinux" ] || [ $DIS == "ManjaroLinux" ]; then sudo pacman -S libmysqlclient \ postgresql-libs \ mysql-clients \; else echo "Unsupported system: $DIS" && exit 1; fi docker run -itd \ --restart always \ -e POSTGRES_USER=casbin_rs \ -e POSTGRES_PASSWORD=casbin_rs \ -e POSTGRES_DB=casbin \ -p 5432:5432 \ -v /srv/docker/postgresql:/var/lib/postgresql \ postgres:11; docker run -itd \ --restart always \ -e MYSQL_ALLOW_EMPTY_PASSWORD=yes \ -e MYSQL_USER=casbin_rs \ -e MYSQL_PASSWORD=casbin_rs \ -e MYSQL_DATABASE=casbin \ -p 3306:3306 \ -v /srv/docker/mysql:/var/lib/mysql \ mysql:8 \ --default-authentication-plugin=mysql_native_password;
-
Create table
casbin_rule
# PostgreSQL psql postgres://casbin_rs:casbin_rs@127.0.0.1:5432/casbin -c "CREATE TABLE IF NOT EXISTS casbin_rule ( id SERIAL PRIMARY KEY, ptype VARCHAR NOT NULL, v0 VARCHAR NOT NULL, v1 VARCHAR NOT NULL, v2 VARCHAR NOT NULL, v3 VARCHAR NOT NULL, v4 VARCHAR NOT NULL, v5 VARCHAR NOT NULL, CONSTRAINT unique_key_sqlx_adapter UNIQUE(ptype, v0, v1, v2, v3, v4, v5) );" # MySQL mysql -h 127.0.0.1 -u casbin_rs -pcasbin_rs casbin CREATE TABLE IF NOT EXISTS casbin_rule ( id INT NOT NULL AUTO_INCREMENT, ptype VARCHAR(12) NOT NULL, v0 VARCHAR(128) NOT NULL, v1 VARCHAR(128) NOT NULL, v2 VARCHAR(128) NOT NULL, v3 VARCHAR(128) NOT NULL, v4 VARCHAR(128) NOT NULL, v5 VARCHAR(128) NOT NULL, PRIMARY KEY(id), CONSTRAINT unique_key_sqlx_adapter UNIQUE(ptype, v0, v1, v2, v3, v4, v5) ) ENGINE=InnoDB DEFAULT CHARSET=utf8; # SQLite touch casbin.db sqlite3 casbin.db -cmd "CREATE TABLE IF NOT EXISTS casbin_rule ( id INTEGER PRIMARY KEY, ptype VARCHAR(12) NOT NULL, v0 VARCHAR(128) NOT NULL, v1 VARCHAR(128) NOT NULL, v2 VARCHAR(128) NOT NULL, v3 VARCHAR(128) NOT NULL, v4 VARCHAR(128) NOT NULL, v5 VARCHAR(128) NOT NULL, CONSTRAINT unique_key_diesel_adapter UNIQUE(ptype, v0, v1, v2, v3, v4, v5) );"
-
Configure
env
Rename
sample.env
to.env
and putDATABASE_URL
,POOL_SIZE
insideDATABASE_URL=postgres://casbin_rs:casbin_rs@localhost:5432/casbin # DATABASE_URL=mysql://casbin_rs:casbin_rs@localhost:3306/casbin # DATABASE_URL=sqlite:casbin.db POOL_SIZE=8
Or you can export
DATABASE_URL
,POOL_SIZE
export DATABASE_URL=postgres://casbin_rs:casbin_rs@localhost:5432/casbin export POOL_SIZE=8
Example
use sqlx_adapter::casbin::prelude::*;
use sqlx_adapter::casbin::Result;
use sqlx_adapter::SqlxAdapter;
#[tokio::main]
async fn main() -> Result<()> {
let m = DefaultModel::from_file("examples/rbac_model.conf").await?;
let a = SqlxAdapter::new("postgres://casbin_rs:casbin_rs@127.0.0.1:5432/casbin", 8).await?;
let mut e = Enforcer::new(m, a).await?;
Ok(())
}
Features
postgres
mysql
sqlite
Attention: postgres
, mysql
, sqlite
are mutual exclusive which means that you can only activate one of them.
Dependencies
~18–35MB
~555K SLoC