https://github.com/casbin-lua/luasql-adapter

LuaSQL adapter for Lua-Casbin
https://github.com/casbin-lua/luasql-adapter

access-control adapter apisix casbin kong lua luasql openresty orm

Last synced: 2 months ago
JSON representation

LuaSQL adapter for Lua-Casbin

• Host: GitHub
• URL: https://github.com/casbin-lua/luasql-adapter
• Owner: casbin-lua
• License: apache-2.0
• Created: 2021-08-02T12:03:56.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-07-06T14:54:40.000Z (over 1 year ago)
• Last Synced: 2024-08-05T17:39:29.516Z (6 months ago)
• Topics: access-control, adapter, apisix, casbin, kong, lua, luasql, openresty, orm
• Language: Lua
• Homepage: https://github.com/casbin/lua-casbin
• Size: 15.6 KB
• Stars: 4
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - casbin-lua/luasql-adapter - LuaSQL adapter for Lua-Casbin (Lua)

README

        
# luasql-adapter

[![GitHub Action](https://github.com/casbin-lua/luasql-adapter/workflows/test/badge.svg?branch=master)](https://github.com/casbin-lua/luasql-adapter/actions)

[![Coverage Status](https://coveralls.io/repos/github/casbin-lua/luasql-adapter/badge.svg?branch=master)](https://coveralls.io/github/casbin-lua/luasql-adapter?branch=master)

[![Discord](https://img.shields.io/discord/1022748306096537660?logo=discord&label=discord&color=5865F2)](https://discord.gg/S5UjpzGZjN)

casbin-adapter is a LuaSQL based adapter for Casbin that supports policies from SQL-based databases (MySQL, PostgreSQL, SQLite3).

## Installation

First, install the corresponding driver of LuaSQL from LuaRocks based on the database you use:

- For MySQL, install luasql-mysql.

- For PostgreSQL, install luasql-postgres.

- For SQLite3, install luasql-sqlite3.

Then install the casbin-adapter from LuaRocks by

```bash

sudo luarocks install https://raw.githubusercontent.com/casbin-lua/luasql-adapter/master/casbin-adapter-1.0.0-1.rockspec

```

## Usage

To create a new Casbin Enforcer using a MySQL adapter, use:

```lua

local Enforcer = require("casbin")

local Adapter = require("casbin.mysql")

local a = Adapter:new(database, user, password, hostname, port) -- hostname, port are optional

local e = Enforcer:new("/path/to/model.conf", a) -- creates a new Casbin enforcer with the model.conf file and the database

```

For other adapters, replace `local Adapter = require("casbin.mysql")` with:

- `local Adapter = require("casbin.postgres")` for PostgreSQL adapter.

- `local Adapter = require("casbin.sqlite3")` for SQLite3 adapter. In SQLite3 adapter, only database field is required and others are optional.

## Getting Help

- [Lua Casbin](https://github.com/casbin/lua-casbin)

## License

This project is under Apache 2.0 License. See the [LICENSE](https://github.com/casbin-lua/luasql-adapter/blob/master/LICENSE) file for the full license text.