Skip to content

Commit

Permalink
Merge pull request #1986 from Danielle9897/RDoc-3176-revisionsBinCleaner
Browse files Browse the repository at this point in the history
RDoc-3176 Revisions Bin Cleaner
  • Loading branch information
reebhub authored Feb 25, 2025
2 parents 1e08a30 + 88d7114 commit ed6fd64
Show file tree
Hide file tree
Showing 75 changed files with 3,650 additions and 405 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public ConfigRevisions()
// ------------------------
// * A revision will be created anytime a document is modified or deleted.
// * Revisions of a deleted document can be accessed in the Revisions Bin view.
// * At least 100 of the latest revisions will be kept.
// * Only the latest 100 revisions will be kept. Older ones will be discarded.
// * Older revisions will be removed if they exceed 7 days on next revision creation.
// * A maximum of 15 revisions will be deleted each time a document is updated,
// until the defined '# of revisions to keep' limit is reached.
Expand Down Expand Up @@ -174,7 +174,7 @@ public async Task ConfigRevisionsAsync()
// ------------------------
// * A revision will be created anytime a document is modified or deleted.
// * Revisions of a deleted document can be accessed in the Revisions Bin view.
// * At least 100 of the latest revisions will be kept.
// * Only the latest 100 revisions will be kept. Older ones will be discarded.
// * Older revisions will be removed if they exceed 7 days on next revision creation.
// * A maximum of 15 revisions will be deleted each time a document is updated,
// until the defined '# of revisions to keep' limit is reached.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ async function configureRevisions() {
// ------------------------
// * A revision will be created anytime a document is modified or deleted.
// * Revisions of a deleted document can be accessed in the Revisions Bin view.
// * At least 100 of the latest revisions will be kept.
// * Only the latest 100 revisions will be kept. Older ones will be discarded.
// * Older revisions will be removed if they exceed 7 days on next revision creation.
// * A maximum of 15 revisions will be deleted each time a document is updated,
// until the defined '# of revisions to keep' limit is reached.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,15 @@ Let's play with revisions a little to get a taste of its advantages.
![Revision for Document Modification](images\revisions_modify-document.png "Revision for Document Modification")

5. **Delete the document**.
Though you deleted the document, its **audit trail** is **not lost**: all revisions were moved to the [Revisions Bin](../../studio/database/document-extensions/revisions#revisions-bin),
including a new revision (called "Delete-Revision"), created to indicate that the document was deleted.

To see the "orphaned" revisions (whose parent document was deleted):
Though you deleted the document, its **audit trail** is **not lost**: all its revisions are moved to the [Revisions Bin](../../studio/database/document-extensions/revisions#revisions-bin),
including a new revision (called "Delete Revision"), created to indicate that the document was deleted.

{INFO: }
* A "Delete Revision" is created only if the deleted document has revisions.
* If a document has no revisions, a "Delete Revision" will be created only if the Revisions Configuration is set and enabled for its collection.
{INFO/}

To see the revisions created for the document before it was deleted:
* Open the `Documents > Revisions Bin` section in the Studio
* Click the deleted document's ID

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -178,11 +178,16 @@ Let's play with revisions a little to get a taste of its advantages.
![Revision for Document Modification](images\revisions_modify-document.png "Revision for Document Modification")

5. **Delete the document**.
Though you deleted the document, its **audit trail** is **not lost**: all revisions were moved to the [Revisions Bin](../../studio/database/document-extensions/revisions#revisions-bin),
including a new revision (called "Delete-Revision"), created to indicate that the document was deleted.
Though you deleted the document, its **audit trail** is **not lost**: all its revisions are moved to the [Revisions Bin](../../studio/database/document-extensions/revisions#revisions-bin),
including a new revision (called "Delete Revision"), created to indicate that the document was deleted.

To see the "orphaned" revisions (whose parent document was deleted):
* Open the `Documents > Revisions Bin` section in the Studio
{INFO: }
* A "Delete Revision" is created only if the deleted document has revisions.
* If a document has no revisions, a "Delete Revision" will be created only if the Revisions Configuration is set and enabled for its collection.
{INFO/}

To see the revisions created for the document before it was deleted:
* Open the `Documents > Revisions Bin` section in the Studio
* Click the deleted document's ID

![Revisions Bin](images\revisions_revisions-bin.png "Revisions Bin")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -178,11 +178,16 @@ Let's play with revisions a little to get a taste of its advantages.
![Revision for Document Modification](images\revisions_modify-document.png "Revision for Document Modification")

5. **Delete the document**.
Though you deleted the document, its **audit trail** is **not lost**: all revisions were moved to the [Revisions Bin](../../studio/database/document-extensions/revisions#revisions-bin),
including a new revision (called "Delete-Revision"), created to indicate that the document was deleted.
Though you deleted the document, its **audit trail** is **not lost**: all its revisions are moved to the [Revisions Bin](../../studio/database/document-extensions/revisions#revisions-bin),
including a new revision (called "Delete Revision"), created to indicate that the document was deleted.

To see the "orphaned" revisions (whose parent document was deleted):
* Open the `Documents > Revisions Bin` section in the Studio
{INFO: }
* A "Delete Revision" is created only if the deleted document has revisions.
* If a document has no revisions, a "Delete Revision" will be created only if the Revisions Configuration is set and enabled for its collection.
{INFO/}

To see the revisions created for the document before it was deleted:
* Open the `Documents > Revisions Bin` section in the Studio
* Click the deleted document's ID

![Revisions Bin](images\revisions_revisions-bin.png "Revisions Bin")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Click the revision's comparison button to compare it with other revisions:
![Revision Comparison](images/revisions/revision-comparison.png "Revision Comparison")

1. **Exit revisions compare mode**
Click to exit the comparison window and return to the revisions tTab in the Document View.
Click to exit the comparison window and return to the revisions tab in the Document View.
2. **Compare with**
Click to select a revision to compare with.
![Compare-with Drop List](images/revisions/compare-with-drop-list.png "Compare-with Drop List")
Expand Down Expand Up @@ -129,9 +129,8 @@ Click the revision's comparison button to compare it with other revisions:
making them irrecoverable.
4. **Deleted document ID**
This is the ID of the document that was deleted.
Click it to inspect the revisions created for this document,
known as "orphaned revisions" since their parent document has been deleted.
![Orphaned Revisions](images/revisions/orphaned-revisions.png "Orphaned Revisions")
Click it to inspect the revisions created for this document.
![Revisions of a deleted document](images/revisions/orphaned-revisions.png "Revisions of a deleted document")
* Revisions stored in the revisions bin can be [inspected](../../../studio/database/document-extensions/revisions#revision-inspection)
and cloned just like the revisions of a live document.
5. **Change vector**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public ConfigRevisions()
// ------------------------
// * A revision will be created anytime a document is modified or deleted.
// * Revisions of a deleted document can be accessed in the Revisions Bin view.
// * At least 100 of the latest revisions will be kept.
// * Only the latest 100 revisions will be kept. Older ones will be discarded.
// * Older revisions will be removed if they exceed 7 days on next revision creation.
// * A maximum of 15 revisions will be deleted each time a document is updated,
// until the defined '# of revisions to keep' limit is reached.
Expand Down Expand Up @@ -174,7 +174,7 @@ public async Task ConfigRevisionsAsync()
// ------------------------
// * A revision will be created anytime a document is modified or deleted.
// * Revisions of a deleted document can be accessed in the Revisions Bin view.
// * At least 100 of the latest revisions will be kept.
// * Only the latest 100 revisions will be kept. Older ones will be discarded.
// * Older revisions will be removed if they exceed 7 days on next revision creation.
// * A maximum of 15 revisions will be deleted each time a document is updated,
// until the defined '# of revisions to keep' limit is reached.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ async function configureRevisions() {
// ------------------------
// * A revision will be created anytime a document is modified or deleted.
// * Revisions of a deleted document can be accessed in the Revisions Bin view.
// * At least 100 of the latest revisions will be kept.
// * Only the latest 100 revisions will be kept. Older ones will be discarded.
// * Older revisions will be removed if they exceed 7 days on next revision creation.
// * A maximum of 15 revisions will be deleted each time a document is updated,
// until the defined '# of revisions to keep' limit is reached.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def test_configure_revisions(self):
# ------------------------
# * A revision will be created anytime a document is modified or deleted.
# * Revisions of a deleted document can be accessed in the Revisions Bin view.
# * At least 100 of the latest revisions will be kept.
# * Only the latest 100 revisions will be kept. Older ones will be discarded.
# * Older revisions will be removed if they exceed 7 days on next revision creation.
# * A maximum of 15 revisions will be deleted each time a document is updated,
# until the defined '# of revisions to keep' limit is reached.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public ConfigRevisions()
// ------------------------
// * A revision will be created anytime a document is modified or deleted.
// * Revisions of a deleted document can be accessed in the Revisions Bin view.
// * At least 100 of the latest revisions will be kept.
// * Only the latest 100 revisions will be kept. Older ones will be discarded.
// * Older revisions will be removed if they exceed 7 days on next revision creation.
// * A maximum of 15 revisions will be deleted each time a document is updated,
// until the defined '# of revisions to keep' limit is reached.
Expand Down Expand Up @@ -174,7 +174,7 @@ public async Task ConfigRevisionsAsync()
// ------------------------
// * A revision will be created anytime a document is modified or deleted.
// * Revisions of a deleted document can be accessed in the Revisions Bin view.
// * At least 100 of the latest revisions will be kept.
// * Only the latest 100 revisions will be kept. Older ones will be discarded.
// * Older revisions will be removed if they exceed 7 days on next revision creation.
// * A maximum of 15 revisions will be deleted each time a document is updated,
// until the defined '# of revisions to keep' limit is reached.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ async function configureRevisions() {
// ------------------------
// * A revision will be created anytime a document is modified or deleted.
// * Revisions of a deleted document can be accessed in the Revisions Bin view.
// * At least 100 of the latest revisions will be kept.
// * Only the latest 100 revisions will be kept. Older ones will be discarded.
// * Older revisions will be removed if they exceed 7 days on next revision creation.
// * A maximum of 15 revisions will be deleted each time a document is updated,
// until the defined '# of revisions to keep' limit is reached.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def test_configure_revisions(self):
# ------------------------
# * A revision will be created anytime a document is modified or deleted.
# * Revisions of a deleted document can be accessed in the Revisions Bin view.
# * At least 100 of the latest revisions will be kept.
# * Only the latest 100 revisions will be kept. Older ones will be discarded.
# * Older revisions will be removed if they exceed 7 days on next revision creation.
# * A maximum of 15 revisions will be deleted each time a document is updated,
# until the defined '# of revisions to keep' limit is reached.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="RavenDB.Client" Version="6.2.1" />
<PackageReference Include="RavenDB.Embedded" Version="6.2.1" />
<PackageReference Include="RavenDB.TestDriver" Version="6.2.1" />
<PackageReference Include="RavenDB.Client" Version="6.2.4-nightly-20250216-0402" />
<PackageReference Include="RavenDB.Embedded" Version="6.2.4-nightly-20250216-0402" />
<PackageReference Include="RavenDB.TestDriver" Version="6.2.4-nightly-20250216-0402" />
</ItemGroup>

</Project>
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,7 @@
* **Revisions**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [ConfigureRevisionsOperation](../../document-extensions/revisions/client-api/operations/configure-revisions)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [DeleteRevisionsOperation](../../document-extensions/revisions/client-api/operations/delete-revisions)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [ConfigureRevisionsBinCleanerOperation](../../document-extensions/revisions/revisions-bin-cleaner#setting-the-revisions-bin-cleaner---from-the-client-api)

* **Sorters**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutSortersOperation](../../client-api/operations/maintenance/sorters/put-sorter)
Expand Down
Loading

0 comments on commit ed6fd64

Please sign in to comment.