https://github.com/touchifyapp/casbin-pg-adapter
PostgreSQL native adapter for Node-Casbin with advanced filter capability and improved performance.
https://github.com/touchifyapp/casbin-pg-adapter
Last synced: 10 months ago
JSON representation
PostgreSQL native adapter for Node-Casbin with advanced filter capability and improved performance.
- Host: GitHub
- URL: https://github.com/touchifyapp/casbin-pg-adapter
- Owner: touchifyapp
- License: mit
- Created: 2020-04-18T13:10:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T03:42:35.000Z (over 3 years ago)
- Last Synced: 2025-06-16T18:55:37.957Z (12 months ago)
- Language: TypeScript
- Homepage:
- Size: 643 KB
- Stars: 16
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PostgreSQL Casbin Adapter
[](https://npmjs.org/package/casbin-pg-adapter)
[](https://npmjs.org/package/casbin-pg-adapter)
[](https://coveralls.io/github/touchifyapp/casbin-pg-adapter?branch=master)
[PostgreSQL](https://www.postgresql.org/) native adapter for [Node-Casbin](https://github.com/casbin/node-casbin). With this library, Node-Casbin can load policy from PosgreSQL database or save policy to it. It supports loading filtered policies and is built for improving performances in PostgreSQL. It uses [node-postgres](https://node-postgres.com/) to connect to PostgreSQL.
`casbin-pg-adapter` also adds advanced filtering capability. You can filter using `LIKE` or `regexp` expressions when using `loadFilteredPolicy`.
## Installation
```bash
npm install casbin-pg-adapter
```
## Simple example
```typescript
import { newEnforcer } from "casbin";
import PostgresAdapter from "casbin-pg-adapter";
async function myFunction() {
// Initialize a Postgres adapter and use it in a Node-Casbin enforcer:
// The adapter can not automatically create database.
// But the adapter will automatically and use the table named "casbin".
// I think ORM should not automatically create databases.
const a = await PostgresAdapter.newAdapter({
connectionString: "postgresql://casbin:casbin@localhost:5432/casbin"
});
const e = await newEnforcer("examples/rbac_model.conf", a);
// Load the policy from DB.
await e.loadPolicy();
// Check the permission.
e.enforce("alice", "data1", "read");
// Modify the policy.
// await e.addPolicy(...);
// await e.removePolicy(...);
// Save the policy back to DB.
await e.savePolicy();
}
```
## Filtering example
```typescript
import { newEnforcer } from "casbin";
import PostgresAdapter from "casbin-pg-adapter";
async function myFunction() {
const a = await PostgresAdapter.newAdapter({
connectionString: "postgresql://casbin:casbin@localhost:5432/casbin"
});
const e = await newEnforcer("examples/rbac_model.conf", a);
// Load the filtered policy from DB.
await e.loadFilteredPolicy({
p: ["alice"],
g: ["", "role:admin"]
});
// Check the permission.
e.enforce("alice", "data1", "read");
}
```
## Advanced filtering example
```typescript
import { newEnforcer } from "casbin";
import PostgresAdapter from "casbin-pg-adapter";
async function myFunction() {
const a = await PostgresAdapter.newAdapter({
connectionString: "postgresql://casbin:casbin@localhost:5432/casbin"
});
const e = await newEnforcer("examples/rbac_model.conf", a);
// Load the filtered policy from DB.
await e.loadFilteredPolicy({
p: ["regex:(role:.*)|(alice)"],
g: ["", "like:role:%"]
});
// Check the permission.
e.enforce("alice", "data1", "read");
}
```
## Configuration
You can pass any [node-postgres](https://node-postgres.com/) options to the Adapter.
See `node-postgres` documentation: [Connecting to PostgreSQL](https://node-postgres.com/features/connecting#Programmatic).
## Additional configurations
#### Avoid database migration
Additionnally, you can pass the following option to the Adapter:
* `migrate` (*Boolean*): If set to `false`, the Adapter will not apply migration when starting.
**Note:** If you use this parameter, you should apply migration manually:
```typescript
async function startup(): Promise {
PostgresAdapter.migrate({
connectionString: "postgresql://casbin:casbin@localhost:5432/casbin"
});
}
async function createEnforcer(): Promise {
const a = await PostgresAdapter.newAdapter({
connectionString: "postgresql://casbin:casbin@localhost:5432/casbin",
migrate: false
});
return newEnforcer("examples/rbac_model.conf", a);
}
```
#### Disabling filtered behavior
If you want to use the `savePolicy` feature from `node-casbin`, you have to disable the filtered behavior of `PostgresAdapter`.
You can do it by calling `enableFiltered` on the adapter:
```typescript
a.enableFiltered(false);
```
## Getting Help
- [Node-Casbin](https://github.com/casbin/node-casbin)
- [Casbin-PG-Adapter](https://github.com/touchifyapp/casbin-pg-adapter)
## License
This project is under MIT License. See the [LICENSE](LICENSE) file for the full license text.