https://github.com/casbin/sqlx-adapter

sqlx adapter for Casbin
https://github.com/casbin/sqlx-adapter

abac acl adapter auth authorization casbin go golang orm rbac sqlx storage-driver

Last synced: 5 days ago
JSON representation

sqlx adapter for Casbin

• Host: GitHub
• URL: https://github.com/casbin/sqlx-adapter
• Owner: casbin
• License: apache-2.0
• Created: 2023-12-14T16:46:01.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-14T16:47:11.000Z (about 1 year ago)
• Last Synced: 2024-10-29T22:37:49.131Z (2 months ago)
• Topics: abac, acl, adapter, auth, authorization, casbin, go, golang, orm, rbac, sqlx, storage-driver
• Language: Go
• Homepage: https://github.com/casbin/casbin
• Size: 19.5 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# casbin-sqlx-adapter

sqlx adapter for Casbin https://github.com/casbin/casbin

Based on [sqlx](https://github.com/jmoiron/sqlx), and tested in [MySQL](https://github.com/go-sql-driver/mysql).

## Installation

    go get github.com/memwey/casbin-sqlx-adapter

## Usage example

```go

opts := &AdapterOptions{

    DriverName: "mysql",

    DataSourceName: "root:1234@tcp(127.0.0.1:3306)/yourdb",

    TableName: "casbin_rule",

    // or reuse an existing connection:

    // DB: myDBConn,

}

a := NewAdapterFromOptions(opts)

// Casbin v2 may return an error

e, err := casbin.NewEnforcer("examples/rbac_model.conf", a)

if err != nil {

    panic(err)

}

```

## Notice

The v2 version of Casbin has some break change, check for the [detail](https://github.com/casbin/casbin/releases/tag/v2.0.0). If you are still using v1 version, use `0.1.x` of this project.

The implement is kind of different from the [official one](https://casbin.org/docs/en/adapters). In this implement you should create the database and table on your own.

In my opinion, in a general PRODUCTION environment, the business code can rarely create a database, create a table or drop a table.

The filtered adapter feature has been added in some adapter implements such as [Xorm Adapter](https://github.com/casbin/xorm-adapter). However, it's not yet documented in the [doc](https://casbin.org/docs/en/adapters). I will add it after it's documented. See this [issue](https://github.com/casbin/casbin/issues/707).

## Thank

Special thanks to [Casbin](https://github.com/casbin). They provide a superb authorization library.

Special thanks to [sqlx](https://github.com/jmoiron/sqlx). It provides a brilliant set of extensions on go's standard `database/sql` library.

And this project is inspected by [Xorm Adapter](https://github.com/casbin/xorm-adapter), [Gorm Adapter](https://github.com/casbin/gorm-adapter), [Beego ORM Adapter](https://github.com/casbin/beego-orm-adapter) and [MySQL adapter

](https://github.com/casbin/mysql-adapter). Thanks all of them.

## Others

This is a very first opensource of me and if this project violates any of the opensource guidelines, please contact me. The project is far from perfect, issues and pull requesets are very welcome.

## License

This project is under Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text.