Skip to content
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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Persistence alias documentation #2462

Merged
merged 1 commit into from
Feb 18, 2025
Merged

Persistence alias documentation #2462

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
20 changes: 18 additions & 2 deletions configuration/persistence.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ The syntax is as follows:

```java
Items {
<itemlist1> [-> "<alias1>"] : [strategy = <strategy1>, <strategy2>, ...] [filter = <filter1>, <filter2>, ...]
<itemlist2> [-> "<alias2>"] : [strategy = <strategyX>, <strategyY>, ...]
<itemlist1> : [strategy = <strategy1>, <strategy2>, ...] [filter = <filter1>, <filter2>, ...]
<itemlist2> : [strategy = <strategyX>, <strategyY>, ...]
...

}
Expand All @@ -176,6 +176,22 @@ The entries are additive.
This means if one Item appears in more than one `<itemlist>` either directly or indirectly (e.g. `*` which includes all Items or as a member of a Group used in `<groupName>*`), all the strategies strategies listed on all those lines apply to that Item.
In the same way, an Item defined by a `!<itemName>` or `!<groupName>*` will be excluded after all additive rules have been applied.

### Aliases

This section defines alternative names for items that will be used in storage by the persistence service.
The syntax is as follows:

```java
Aliases {
<itemName1> -> <alias1>
<itemName2> -> <alias2>
...

}
```

Note that aliases should be unique and should not have the same name as an existing item that is also stored in the persistence service.

Below you will find a complete example persistence configuration file:

```java
Expand Down