Skip to content

Commit acbc104

Browse files
committed
RDoc-2293 Remove 'old' files + other fixes
1 parent 6e9d275 commit acbc104

15 files changed

+164
-188
lines changed

docs/compare-exchange/content/_atomic-guards-csharp.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,16 +139,17 @@ in the Studio:
139139

140140
![Atomic Guard](../assets/atomic-guard.png)
141141

142-
1. These are **custom compare-exchange items** that you created, as described in [Create compare-exchange items](../compare-exchange/create-cmpxchg-items),
143-
for any purpose you needed. They are NOT the automatically created atomic guards.
142+
1. These are **custom compare-exchange items**, created by the user for any purpose,
143+
as described in [Create compare-exchange items](../compare-exchange/create-cmpxchg-items).
144+
They are NOT the automatically created atomic guards.
144145

145146
2. This is the **atomic guard** that was generated by running the example above.
146147
The generated atomic guard **key** is: `rvn-atomic/users/johndoe`. It is composed of:
147148
* The prefix `rvn-atomic/`.
148149
* The ID of the associated document (`users/johndoe`).
149150

150151
<Admonition type="warning" title="">
151-
* Although this Studio view allows editing compare-exchange items, **do not delete or modify atomic guard entries**.
152+
* Although this Studio view allows editing compare-exchange items, **do NOT delete or modify atomic guard entries**.
152153
* Doing so will interfere with RavenDB's ability to track document versioning through atomic guards.
153154
</Admonition>
154155

@@ -232,9 +233,8 @@ Atomic guards are removed **automatically** in the following scenarios:
232233

233234
<Admonition type="warning" title="">
234235

235-
* **Do not delete or modify atomic guards manually while they are in use by an active session**.
236-
If a session attempts to save a document whose atomic guard has been removed or changed,
237-
it will fail with an error.
236+
* **Do not delete or modify atomic guards manually**.
237+
If a session attempts to save a document whose atomic guard was removed or modified, it will fail with an error.
238238

239239
* If you accidentally remove an atomic guard that is associated with an existing document,
240240
you can restore it by re-saving the document in a cluster-wide session,

docs/compare-exchange/content/_atomic-guards-nodejs.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,16 +102,17 @@ in the Studio:
102102

103103
![Atomic Guard](../assets/atomic-guard.png)
104104

105-
1. These are **custom compare-exchange items** that you created, as described in [Create compare-exchange items](../compare-exchange/create-cmpxchg-items),
106-
for any purpose you needed. They are NOT the automatically created atomic guards.
105+
1. These are **custom compare-exchange items**, created by the user for any purpose,
106+
as described in [Create compare-exchange items](../compare-exchange/create-cmpxchg-items).
107+
They are NOT the automatically created atomic guards.
107108

108109
2. This is the **atomic guard** that was generated by running the example above.
109110
The generated atomic guard **key** is: `rvn-atomic/users/johndoe`. It is composed of:
110111
* The prefix `rvn-atomic/`.
111112
* The ID of the associated document (`users/johndoe`).
112113

113114
<Admonition type="warning" title="">
114-
* Although this Studio view allows editing compare-exchange items, **do not delete or modify atomic guard entries**.
115+
* Although this Studio view allows editing compare-exchange items, **do NOT delete or modify atomic guard entries**.
115116
* Doing so will interfere with RavenDB's ability to track document versioning through atomic guards.
116117
</Admonition>
117118

@@ -177,9 +178,8 @@ Atomic guards are removed **automatically** in the following scenarios:
177178

178179
<Admonition type="warning" title="">
179180

180-
* **Do not delete or modify atomic guards manually while they are in use by an active session**.
181-
If a session attempts to save a document whose atomic guard has been removed or changed,
182-
it will fail with an error.
181+
* **Do not delete or modify atomic guards manually**.
182+
If a session attempts to save a document whose atomic guard was removed or modified, it will fail with an error.
183183

184184
* If you accidentally remove an atomic guard that is associated with an existing document,
185185
you can restore it by re-saving the document in a cluster-wide session,

docs/compare-exchange/content/_atomic-guards-php.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,16 +113,17 @@ in the Studio:
113113

114114
![Atomic Guard](../assets/atomic-guard.png)
115115

116-
1. These are **custom compare-exchange items** that you created, as described in [Create compare-exchange items](../compare-exchange/create-cmpxchg-items),
117-
for any purpose you needed. They are NOT the automatically created atomic guards.
116+
1. These are **custom compare-exchange items**, created by the user for any purpose,
117+
as described in [Create compare-exchange items](../compare-exchange/create-cmpxchg-items).
118+
They are NOT the automatically created atomic guards.
118119

119120
2. This is the **atomic guard** that was generated by running the example above.
120121
The generated atomic guard **key** is: `rvn-atomic/users/johndoe`. It is composed of:
121122
* The prefix `rvn-atomic/`.
122123
* The ID of the associated document (`users/johndoe`).
123124

124125
<Admonition type="warning" title="">
125-
* Although this Studio view allows editing compare-exchange items, **do not delete or modify atomic guard entries**.
126+
* Although this Studio view allows editing compare-exchange items, **do NOT delete or modify atomic guard entries**.
126127
* Doing so will interfere with RavenDB's ability to track document versioning through atomic guards.
127128
</Admonition>
128129

@@ -190,9 +191,8 @@ Atomic guards are removed **automatically** in the following scenarios:
190191

191192
<Admonition type="warning" title="">
192193

193-
* **Do not delete or modify atomic guards manually while they are in use by an active session**.
194-
If a session attempts to save a document whose atomic guard has been removed or changed,
195-
it will fail with an error.
194+
* **Do not delete or modify atomic guards manually**.
195+
If a session attempts to save a document whose atomic guard was removed or modified, it will fail with an error.
196196

197197
* If you accidentally remove an atomic guard that is associated with an existing document,
198198
you can restore it by re-saving the document in a cluster-wide session,

docs/compare-exchange/content/_atomic-guards-python.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,16 +94,17 @@ in the Studio:
9494

9595
![Atomic Guard](../assets/atomic-guard.png)
9696

97-
1. These are **custom compare-exchange items** that you created, as described in [Create compare-exchange items](../compare-exchange/create-cmpxchg-items),
98-
for any purpose you needed. They are NOT the automatically created atomic guards.
97+
1. These are **custom compare-exchange items**, created by the user for any purpose,
98+
as described in [Create compare-exchange items](../compare-exchange/create-cmpxchg-items).
99+
They are NOT the automatically created atomic guards.
99100

100101
2. This is the **atomic guard** that was generated by running the example above.
101102
The generated atomic guard **key** is: `rvn-atomic/users/johndoe`. It is composed of:
102103
* The prefix `rvn-atomic/`.
103104
* The ID of the associated document (`users/johndoe`).
104105

105106
<Admonition type="warning" title="">
106-
* Although this Studio view allows editing compare-exchange items, **do not delete or modify atomic guard entries**.
107+
* Although this Studio view allows editing compare-exchange items, **do NOT delete or modify atomic guard entries**.
107108
* Doing so will interfere with RavenDB's ability to track document versioning through atomic guards.
108109
</Admonition>
109110

@@ -169,9 +170,8 @@ Atomic guards are removed **automatically** in the following scenarios:
169170

170171
<Admonition type="warning" title="">
171172

172-
* **Do not delete or modify atomic guards manually while they are in use by an active session**.
173-
If a session attempts to save a document whose atomic guard has been removed or changed,
174-
it will fail with an error.
173+
* **Do not delete or modify atomic guards manually**.
174+
If a session attempts to save a document whose atomic guard was removed or modified, it will fail with an error.
175175

176176
* If you accidentally remove an atomic guard that is associated with an existing document,
177177
you can restore it by re-saving the document in a cluster-wide session,

docs/compare-exchange/content/_delete-cmpxchg-items-csharp.mdx

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,30 @@ import CodeBlock from '@theme/CodeBlock';
55

66
<Admonition type="note" title="">
77

8-
* Existing compare-exchange items can be deleted.
9-
10-
* An item is deleted only if the index you provide in the request matches the current index stored on the server
11-
for the specified key.
8+
* **Custom compare-exchange items can be deleted**:
9+
You can delete your own custom compare-exchange items.
10+
An item is deleted only if the index you provide in the request matches the current index stored on the server for the specified key.
1211

13-
* Compare-exchange items can also be deleted by adding an expiration date to them.
12+
* **Delete items by expiration**:
13+
Compare-exchange items can also be deleted by adding an expiration date to them.
1414
Learn more in [Compare-exchange expiration](../compare-exchange/cmpxchg-expiration).
1515

16-
* Whenever a compare-exchange item is deleted, a compare-exchange tombstone item is created for it.
16+
* **Compare-exchange tombstones**:
17+
Whenever a compare-exchange item is deleted, a compare-exchange tombstone item is created for it.
1718
Tombstones are used to indicate to other RavenDB processes that the item was deleted, so they can react accordingly.
1819
E.g., indexes referencing the deleted item will update themselves to remove those references.
1920
The tombstones themselves are not removed immediately - RavenDB uses an internal cleaner task to periodically remove tombstones that are eligible for deletion.
2021
See: [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../compare-exchange/configuration#clustercompareexchangetombstonescleanupintervalinmin).
22+
23+
* <Admonition type="warning" title="">
24+
Do NOT attempt to delete [atomic guards](../compare-exchange/atomic-guards), which RavenDB uses internally to ensure ACID guarantees in cluster-wide transactions.
25+
These compare-exchange items are created automatically and must not be modified or removed.
26+
27+
If your custom compare-exchange item was set up to protect the consistency of a transaction, deleting it will break the ACID guarantees.
28+
Only delete or modify such items if you truly know what you're doing.
29+
</Admonition>
30+
31+
---
2132

2233
* In this article:
2334
* [Delete compare-exchange item using a **cluster-wide session**](../compare-exchange/delete-cmpxchg-items#delete-compare-exchange-item-using-a-cluster-wide-session)
@@ -27,7 +38,6 @@ import CodeBlock from '@theme/CodeBlock';
2738
* [Delete compare-exchange item using a **store operation**](../compare-exchange/delete-cmpxchg-items#delete-compare-exchange-item-using-a-store-operation)
2839
* [Delete compare-exchange items using the **Studio**](../compare-exchange/delete-cmpxchg-items#delete-compare-exchange-items-using-the-studio)
2940
* [Syntax](../compare-exchange/delete-cmpxchg-items#syntax)
30-
3141

3242
</Admonition>
3343

docs/compare-exchange/content/_delete-cmpxchg-items-java.mdx

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,31 @@ import CodeBlock from '@theme/CodeBlock';
55

66
<Admonition type="note" title="">
77

8-
* Existing compare-exchange items can be deleted.
9-
10-
* An item is deleted only if the index you provide in the request matches the current index stored on the server
11-
for the specified key.
8+
* **Custom compare-exchange items can be deleted**:
9+
You can delete your own custom compare-exchange items.
10+
An item is deleted only if the index you provide in the request matches the current index stored on the server for the specified key.
1211

13-
* Compare-exchange items can also be deleted by adding an expiration date to them.
12+
* **Delete items by expiration**:
13+
Compare-exchange items can also be deleted by adding an expiration date to them.
1414
Learn more in [Compare-exchange expiration](../compare-exchange/cmpxchg-expiration).
1515

16-
* Whenever a compare-exchange item is deleted, a compare-exchange tombstone item is created for it.
16+
* **Compare-exchange tombstones**:
17+
Whenever a compare-exchange item is deleted, a compare-exchange tombstone item is created for it.
1718
Tombstones are used to indicate to other RavenDB processes that the item was deleted, so they can react accordingly.
1819
E.g., indexes referencing the deleted item will update themselves to remove those references.
1920
The tombstones themselves are not removed immediately - RavenDB uses an internal cleaner task to periodically remove tombstones that are eligible for deletion.
2021
See: [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../compare-exchange/configuration#clustercompareexchangetombstonescleanupintervalinmin).
2122

23+
* <Admonition type="warning" title="">
24+
Do not attempt to delete [atomic guards](../compare-exchange/atomic-guards), which RavenDB uses internally to ensure ACID guarantees in cluster-wide transactions.
25+
These items are created automatically and must not be modified or removed.
26+
27+
If your custom compare-exchange item was set up to protect the consistency of a transaction, deleting it will break the ACID guarantees.
28+
Only delete or modify such items if you truly know what you're doing.
29+
</Admonition>
30+
31+
---
32+
2233
* In this article:
2334
* [Delete compare-exchange item using a **store operation**](../compare-exchange/delete-cmpxchg-items#delete-compare-exchange-item-using-a-store-operation)
2435
* [Delete compare-exchange items using the **Studio**](../compare-exchange/delete-cmpxchg-items#delete-compare-exchange-items-using-the-studio)

docs/compare-exchange/content/_delete-cmpxchg-items-nodejs.mdx

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,31 @@ import CodeBlock from '@theme/CodeBlock';
55

66
<Admonition type="note" title="">
77

8-
* Existing compare-exchange items can be deleted.
9-
10-
* An item is deleted only if the index you provide in the request matches the current index stored on the server
11-
for the specified key.
8+
* **Custom compare-exchange items can be deleted**:
9+
You can delete your own custom compare-exchange items.
10+
An item is deleted only if the index you provide in the request matches the current index stored on the server for the specified key.
1211

13-
* Compare-exchange items can also be deleted by adding an expiration date to them.
12+
* **Delete items by expiration**:
13+
Compare-exchange items can also be deleted by adding an expiration date to them.
1414
Learn more in [Compare-exchange expiration](../compare-exchange/cmpxchg-expiration).
1515

16-
* Whenever a compare-exchange item is deleted, a compare-exchange tombstone item is created for it.
16+
* **Compare-exchange tombstones**:
17+
Whenever a compare-exchange item is deleted, a compare-exchange tombstone item is created for it.
1718
Tombstones are used to indicate to other RavenDB processes that the item was deleted, so they can react accordingly.
1819
E.g., indexes referencing the deleted item will update themselves to remove those references.
1920
The tombstones themselves are not removed immediately - RavenDB uses an internal cleaner task to periodically remove tombstones that are eligible for deletion.
2021
See: [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../compare-exchange/configuration#clustercompareexchangetombstonescleanupintervalinmin).
2122

23+
* <Admonition type="warning" title="">
24+
Do not attempt to delete [atomic guards](../compare-exchange/atomic-guards), which RavenDB uses internally to ensure ACID guarantees in cluster-wide transactions.
25+
These items are created automatically and must not be modified or removed.
26+
27+
If your custom compare-exchange item was set up to protect the consistency of a transaction, deleting it will break the ACID guarantees.
28+
Only delete or modify such items if you truly know what you're doing.
29+
</Admonition>
30+
31+
---
32+
2233
* In this article:
2334
* [Delete compare-exchange item using a **cluster-wide session**](../compare-exchange/delete-cmpxchg-items#delete-compare-exchange-item-using-a-cluster-wide-session)
2435
* [Delete by item](../compare-exchange/delete-cmpxchg-items#delete-by-item)

docs/compare-exchange/content/_delete-cmpxchg-items-php.mdx

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,31 @@ import CodeBlock from '@theme/CodeBlock';
55

66
<Admonition type="note" title="">
77

8-
* Existing compare-exchange items can be deleted.
9-
10-
* An item is deleted only if the index you provide in the request matches the current index stored on the server
11-
for the specified key.
12-
13-
* Compare-exchange items can also be deleted by adding an expiration date to them.
14-
Learn more in [Compare-exchange expiration](../compare-exchange/cmpxchg-expiration).
8+
* **Custom compare-exchange items can be deleted**:
9+
You can delete your own custom compare-exchange items.
10+
An item is deleted only if the index you provide in the request matches the current index stored on the server for the specified key.
1511

16-
* Whenever a compare-exchange item is deleted, a compare-exchange tombstone item is created for it.
12+
* **Delete items by expiration**:
13+
Compare-exchange items can also be deleted by adding an expiration date to them.
14+
Learn more in [Compare-exchange expiration](../compare-exchange/cmpxchg-expiration).
15+
16+
* **Compare-exchange tombstones**:
17+
Whenever a compare-exchange item is deleted, a compare-exchange tombstone item is created for it.
1718
Tombstones are used to indicate to other RavenDB processes that the item was deleted, so they can react accordingly.
1819
E.g., indexes referencing the deleted item will update themselves to remove those references.
1920
The tombstones themselves are not removed immediately - RavenDB uses an internal cleaner task to periodically remove tombstones that are eligible for deletion.
2021
See: [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../compare-exchange/configuration#clustercompareexchangetombstonescleanupintervalinmin).
2122

23+
* <Admonition type="warning" title="">
24+
Do not attempt to delete [atomic guards](../compare-exchange/atomic-guards), which RavenDB uses internally to ensure ACID guarantees in cluster-wide transactions.
25+
These items are created automatically and must not be modified or removed.
26+
27+
If your custom compare-exchange item was set up to protect the consistency of a transaction, deleting it will break the ACID guarantees.
28+
Only delete or modify such items if you truly know what you're doing.
29+
</Admonition>
30+
31+
---
32+
2233
* In this article:
2334
* [Delete compare-exchange item using a **cluster-wide session**](../compare-exchange/delete-cmpxchg-items#delete-compare-exchange-item-using-a-cluster-wide-session)
2435
* [Delete by item](../compare-exchange/delete-cmpxchg-items#delete-by-item)

0 commit comments

Comments
 (0)