Skip to content

IGNITE-27380 Document extra snapshot paths #13523

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

Open
ignitetcbot wants to merge 1 commit into
base: master
Choose a base branch
from
Open

IGNITE-27380 Document extra snapshot paths #13523

Show file tree
Hide file tree
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: 12 additions & 0 deletions docs/_docs/code-snippets/java/src/main/java/org/apache/ignite/snippets/Snapshots.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import org.apache.ignite.IgniteCache;
import org.apache.ignite.Ignition;
import org.apache.ignite.configuration.CacheConfiguration;
import org.apache.ignite.configuration.DataStorageConfiguration;
import org.apache.ignite.configuration.IgniteConfiguration;
import org.apache.ignite.spi.encryption.keystore.KeystoreEncryptionSpi;

Expand All @@ -35,6 +36,17 @@ void configuration() {
File exSnpDir = new File("work", "ex_snapshots");

cfg.setSnapshotPath(exSnpDir.getAbsolutePath());

cfg.setDataStorageConfiguration(new DataStorageConfiguration()
.setExtraStoragePaths(
new File("work", "persistence-a").getAbsolutePath(),
new File("work", "persistence-b").getAbsolutePath()
)
.setExtraSnapshotPaths(
new File("work", "snapshots-a").getAbsolutePath(),
new File("work", "snapshots-b").getAbsolutePath()
)
);
//end::config[]

Ignite ignite = Ignition.start(cfg);
Expand Down
18 changes: 18 additions & 0 deletions docs/_docs/code-snippets/xml/snapshots.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,24 @@
-->
<property name="snapshotPath" value="/snapshots"/>

<property name="dataStorageConfiguration">
<bean class="org.apache.ignite.configuration.DataStorageConfiguration">
<property name="extraStoragePaths">
<array>
<value>/ignite/persistence-a</value>
<value>/ignite/persistence-b</value>
</array>
</property>

<property name="extraSnapshotPaths">
<array>
<value>/snapshots/persistence-a</value>
<value>/snapshots/persistence-b</value>
</array>
</property>
</bean>
</property>

<!-- tag::cache[] -->
<property name="cacheConfiguration">
<bean class="org.apache.ignite.configuration.CacheConfiguration">
Expand Down
10 changes: 10 additions & 0 deletions docs/_docs/persistence/snapshot-directory.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,13 @@ tab:Java[]
include::{javaCodeDir}/Snapshots.java[tags=config, indent=0]
----
--

If persistence data is distributed across several storage directories with
`DataStorageConfiguration.extraStoragePaths`, you can also configure
`DataStorageConfiguration.extraSnapshotPaths`. Each extra snapshot path is used
for snapshot files that correspond to the matching extra storage path.

The `extraSnapshotPaths` array must have the same number of entries as
`extraStoragePaths`, and all extra snapshot paths must be unique. If an absolute
`IgniteConfiguration.snapshotPath` is configured without `extraSnapshotPaths`,
Ignite stores snapshot files only under the configured snapshot path.