Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 5 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Go-pg Adapter
# Go pgx Adapter

[![Go](https://github.com/casbin/casbin-pg-adapter/actions/workflows/ci.yml/badge.svg)](https://github.com/casbin/casbin-pg-adapter/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/casbin/casbin-pg-adapter/badge.svg?branch=master)](https://coveralls.io/github/casbin/casbin-pg-adapter?branch=master)

Go-pg Adapter is the [Go-pg](https://github.com/go-pg/pg) adapter for [Casbin](https://github.com/casbin/casbin). With this library, Casbin can load policy from PostgreSQL or save policy to it.
Go-pgx Adapter is the [pgx](https://github.com/jackc/pgx) adapter for [Casbin](https://github.com/casbin/casbin). With this library, Casbin can load policy from PostgreSQL or save policy to it.

## Installation

Expand All @@ -20,23 +20,11 @@ import (
)

func main() {
// Initialize a Go-pg adapter and use it in a Casbin enforcer:
// Initialize a pgx adapter and use it in a Casbin enforcer:
// The adapter will use the Postgres database named "casbin".
// If it doesn't exist, the adapter will create it automatically.
a, _ := pgadapter.NewAdapter("postgresql://username:password@postgres:5432/database?sslmode=disable") // Your driver and data source.
// Alternatively, you can construct an adapter instance with *pg.Options:
// a, _ := pgadapter.NewAdapter(&pg.Options{
// Database: "...",
// User: "...",
// Password: "...",
// })

// The adapter will use the table named "casbin_rule".
// If it doesn't exist, the adapter will create it automatically.

// Or you can use an existing DB by adding a second string parameter with your database name to the NewAdapter(), like this:
// a, _ := pgadapter.NewAdapter("postgresql://username:password@postgres:5432/database?sslmode=disable", "your_database_name")

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

// Load the policy from DB.
Expand Down Expand Up @@ -88,13 +76,11 @@ package main
import (
"github.com/casbin/casbin/v2"
pgadapter "github.com/casbin/casbin-pg-adapter"
"github.com/go-pg/pg/v9"
"github.com/jackc/pgx/v5/pgxpool"
)

func main() {
opts, _ := pg.ParseURL("postgresql://pguser:pgpassword@localhost:5432/pgdb?sslmode=disable")

db := pg.Connect(opts)
db, _ := pgxpool.New(context.Background(), "postgresql://pguser:pgpassword@localhost:5432/pgdb?sslmode=disable")
defer db.Close()

a, _ := pgadapter.NewAdapterByDB(db, pgadapter.WithTableName("custom_table"))
Expand Down
Loading
Loading