メインコンテンツにスキップ

Policy Storage

Casbin implements policy storage through adapters.

.CSVファイルからポリシーを読み込む

Loading from a CSV file is the standard approach. This method is straightforward for beginners and convenient when seeking help from the Casbin team.

Here's an example CSV file examples/rbac_policy.csv:

p, alice, data1, read
p, bob, data2, write
p, data2_admin, data2, read
p, data2_admin, data2, write
g, alice, data2_admin
メモ

When CSV fields contain commas, wrap them in double quotes:

p, alice, "data1,data2", read    --correct
p, alice, data1,data2, read --incorrect (the whole phrase "data1,data2" should be wrapped in double quotes)

When fields contain both commas and double quotes, wrap the field in double quotes and escape embedded quotes by doubling them:

p, alice, data, "r.act in (""get"", ""post"")"        --correct
p, alice, data, "r.act in ("get", "post")" --incorrect (you should use "" to escape "")

関連する問題:casbin#886

アダプタAPI

メソッドタイプ説明
LoadPolicy()基本ストレージからすべてのポリシールールを読み込む
SavePolicy()基本すべてのポリシールールをストレージに保存する
AddPolicy()オプションストレージにポリシールールを追加する
RemovePolicy()オプションストレージからポリシールールを削除する
RemoveFilteredPolicy()オプションフィルターに一致するポリシールールをストレージから削除する

データベースストレージフォーマット

あなたのポリシーファイル

p, data2_admin, data2, read
p, data2_admin, data2, write
g, alice, admin

対応するデータベース構造(MySQLなど)

idptypev0v1v2v3v4v5
1pdata2_admindata2read
2pdata2_admindata2write
3galiceadmin

各列の意味

  • id: Database primary key, not part of the Casbin policy. Generation method depends on the adapter implementation.

  • ptype: Corresponds to p, g, g2, etc.

  • v0-v5: Generic column names that map to policy CSV values from left to right. The number of columns depends on your policy definition. Most adapters implement 6 columns, though theoretically unlimited columns are possible. Submit an issue to the adapter repository if you need more columns.

アダプターの詳細

For more information about the adapter API and database structure design, see /docs/adapters.