Skip to content

Fixes to the non-cloud documentation for snapshots #5164

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
psalagnac wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixes to the non-cloud documentation for snapshots #5164

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
75 changes: 60 additions & 15 deletions solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,12 +267,12 @@ The status value can be "In Progress", "success" or "failed".
If it failed then an "exception" will also be sent in the response.

[[create-snapshot-api]]
== CREATE: Create a Snapshot
== CREATESNAPSHOT: Create a Snapshot

The snapshot functionality is different from the backup functionality as the index files aren't copied anywhere.
The index files are snapshotted in the same index directory and can be referenced while taking backups.

You can trigger a snapshot command with an HTTP command like this (replace "techproducts" with the name of the core you are working with):
You can trigger a CREATESNAPSHOT command with an HTTP request like this (replace "techproducts" with the name of the core you are working with):

[tabs#createsnapshot]
======
Expand All @@ -298,9 +298,27 @@ curl -X POST http://localhost:8983/api/cores/techproducts/snapshots/commit1
====
======

=== CREATE Parameters
=== CREATESNAPSHOT Parameters

The CREATE action allows the following parameters:
The CREATESNAPSHOT action allows the following parameters:

`core`::
+
[%autowidth,frame=none]
|===
s|Required |Default: none
|===
+
The name of the core to perform the snapshot on.

`commitName`::
+
[%autowidth,frame=none]
|===
s|Required |Default: none
|===
+
The name to store the snapshot as.

`async`::
+
Expand All @@ -311,15 +329,15 @@ The CREATE action allows the following parameters:
+
Request ID to track this action which will be processed asynchronously.

=== CREATE Response
=== CREATESNAPSHOT Response

The response will include the status of the request, the core name, snapshot name, index directory path, snapshot generation, and a list of file names.
If the status is anything other than "success", an error message will explain why the request failed.

[[list-snapshot-api]]
== List: List All Snapshots for a Particular Core
== LISTSNAPSHOTS: List All Snapshots for a Particular Core

You can trigger a list snapshot command with an HTTP command like this (replace "techproducts" with the name of the core you are working with):
You can trigger a LISTSNAPSHOTS command with an HTTP request like this (replace "techproducts" with the name of the core you are working with):

[tabs#listsnapshots]
======
Expand All @@ -345,9 +363,18 @@ curl http://localhost:8983/api/cores/techproducts/snapshots
====
======

=== LIST Parameters
=== LISTSNAPSHOTS Parameters

The LISTSNAPSHOTS action allows the following parameters:

The LIST action allows the following parameters:
`core`::
+
[%autowidth,frame=none]
|===
s|Required |Default: none
|===
+
The name of the core to whose snapshots we want to list.

`async`::
+
Expand All @@ -358,15 +385,15 @@ The LIST action allows the following parameters:
+
Request ID to track this action which will be processed asynchronously.

=== LIST Response
=== LISTSNAPSHOTS Response

The response will include the status of the request and all existing snapshots for the core.
If the status is anything other than "success", an error message will explain why the request failed.

[[delete-snapshot-api]]
== DELETE: Delete a Snapshot
== DELETESNAPSHOT: Delete a Snapshot

You can trigger a delete snapshot with an HTTP command like this (replace "techproducts" with the name of the core you are working with):
You can trigger a DELETESNAPSHOT command with an HTTP request like this (replace "techproducts" with the name of the core you are working with):

[tabs#deletesnapshot]
======
Expand All @@ -392,9 +419,27 @@ curl -X DELETE http://localhost:8983/api/cores/techproducts/snapshots/commit1
====
======

=== DELETE Parameters
=== DELETESNAPSHOT Parameters

The DELETESNAPSHOT action allows the following parameters:

`commitName`::
+
[%autowidth,frame=none]
|===
s|Required |Default: none
|===
+
The commit name to be deleted.

The DELETE action allows the following parameters:
`core`::
+
[%autowidth,frame=none]
|===
s|Required |Default: none
|===
+
The name of the core whose snapshot we want to delete.

`async`::
+
Expand All @@ -405,7 +450,7 @@ The DELETE action allows the following parameters:
+
Request ID to track this action which will be processed asynchronously.

=== DELETE Response
=== DELETESNAPSHOT Response

The response will include the status of the request, the core name, and the name of the snapshot that was deleted.
If the status is anything other than "success", an error message will explain why the request failed.
Expand Down
Loading