Skip to content

Fix the Storage Plugin Helper Instance Types table #691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenhys merged 1 commit into from
Sep 8, 2026
Merged

Fix the Storage Plugin Helper Instance Types table #691

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions plugin-helper-overview/api-plugin-helper-storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,17 @@ This method executes storage with the given parameters and routine.
* `usage`: unique string value \(default: `''`\)
* `type`: storage plugin type \(default: `nil`\)
* `conf`: storage plugin configuration \(default: `nil`\)
* `default_conf`: storage plugin default configuration \(default: `nil`\)
* `default_type`: storage plugin type used when neither `type` nor `conf` is given \(default: `nil`\)

### Storage Plugin Helper Instance Types

| Instance Type | Attributes |
| :--- | :--- |

The helper does not always hand the storage plugin instance itself to the owner plugin. It may wrap the instance, depending on the `persistent` parameter and on what the plugin reports about itself:

Raw \| `persistent && persistent_always? || otherwise` \| Persistent Wrapper \| `persistent` \| Synchronized Wrapper \| `!synchronized?` \|
| Instance Type | Condition |
| :--- | :--- |
| Raw | `persistent && persistent_always?`, or `!persistent && synchronized?` |
| Persistent Wrapper | `persistent && !persistent_always?` |
| Synchronized Wrapper | `!persistent && !synchronized?` |

#### Raw

Expand Down