-
Notifications
You must be signed in to change notification settings - Fork 136
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1949 from Danielle9897/RDoc-2637-fixCommandsArticles
RDoc-3116 & RDoc-3117 Client API > Commands [Fix articles] (C# & Node.js)
- Loading branch information
Showing
50 changed files
with
4,344 additions
and
122 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
96 changes: 51 additions & 45 deletions
96
Documentation/4.0/Raven.Documentation.Pages/client-api/how-to/.docs.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,52 @@ | ||
| [ | ||
| { | ||
| "Path": "setup-aggressive-caching.markdown", | ||
| "Name": "...setup aggressive caching", | ||
| "DiscussionId": "c2ab774a-213a-433c-9f3c-867dc4dcf2d9", | ||
| "Mappings": [ | ||
| { | ||
| "Version": 2.0, | ||
| "Key": "client-api/advanced/aggressive-caching" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "Path": "store-dates.markdown", | ||
| "Name": "...store dates", | ||
| "DiscussionId": "73c9f0f3-2b5b-4a53-8fab-b5c2bf66c46b", | ||
| "Mappings": [] | ||
| }, | ||
| { | ||
| "Path": "handle-document-relationships.markdown", | ||
| "Name": "...handle document relationships", | ||
| "DiscussionId": "2659925a-cb64-4685-a2ef-91f4c6d80784", | ||
| "Mappings": [ | ||
| { | ||
| "Version": 3.5, | ||
| "Key": "indexes/querying/handling-document-relationships" | ||
| }, | ||
| { | ||
| "Version": 1.0, | ||
| "Key": "client-api/querying/handling-document-relationships" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "Path": "use-low-level-commands.markdown", | ||
| "Name": "...use low-level commands", | ||
| "DiscussionId": "62dd8114-3cb7-487e-9371-5d5f6d37bdcc", | ||
| "Mappings": [] | ||
| }, | ||
| { | ||
| "Path": "integrate-with-excel.markdown", | ||
| "Name": "...integrate with Excel", | ||
| "DiscussionId": "22806718-be83-429b-bdc0-9e220caaa733", | ||
| "Mappings": [] | ||
| } | ||
| ] | ||
| { | ||
| "Path": "setup-aggressive-caching.markdown", | ||
| "Name": "...setup aggressive caching", | ||
| "DiscussionId": "c2ab774a-213a-433c-9f3c-867dc4dcf2d9", | ||
| "Mappings": [ | ||
| { | ||
| "Version": 2.0, | ||
| "Key": "client-api/advanced/aggressive-caching" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "Path": "store-dates.markdown", | ||
| "Name": "...store dates", | ||
| "DiscussionId": "73c9f0f3-2b5b-4a53-8fab-b5c2bf66c46b", | ||
| "Mappings": [] | ||
| }, | ||
| { | ||
| "Path": "handle-document-relationships.markdown", | ||
| "Name": "...handle document relationships", | ||
| "DiscussionId": "2659925a-cb64-4685-a2ef-91f4c6d80784", | ||
| "Mappings": [ | ||
| { | ||
| "Version": 3.5, | ||
| "Key": "indexes/querying/handling-document-relationships" | ||
| }, | ||
| { | ||
| "Version": 1.0, | ||
| "Key": "client-api/querying/handling-document-relationships" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "Path": "use-low-level-commands.markdown", | ||
| "Name": "...use low-level commands", | ||
| "DiscussionId": "62dd8114-3cb7-487e-9371-5d5f6d37bdcc", | ||
| "Mappings": [ | ||
| { | ||
| "Version": 6.0, | ||
| "Key": "client-api/commands/overview" | ||
| } | ||
| ], | ||
| "LastSupportedVersion": "5.4" | ||
| }, | ||
| { | ||
| "Path": "integrate-with-excel.markdown", | ||
| "Name": "...integrate with Excel", | ||
| "DiscussionId": "22806718-be83-429b-bdc0-9e220caaa733", | ||
| "Mappings": [] | ||
| } | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
48 changes: 24 additions & 24 deletions
48
Documentation/5.2/Raven.Documentation.Pages/client-api/commands/documents/.docs.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,25 @@ | ||
| [ | ||
| { | ||
| "Path": "get.markdown", | ||
| "Name": "Get", | ||
| "DiscussionId": "eafb1bd0-dd05-449e-bacc-0d5747d96385", | ||
| "Mappings": [] | ||
| }, | ||
| { | ||
| "Path": "put.markdown", | ||
| "Name": "Put", | ||
| "DiscussionId": "ed032e64-6fe9-4528-a4c0-893dbf4d2bf8", | ||
| "Mappings": [] | ||
| }, | ||
| { | ||
| "Path": "delete.markdown", | ||
| "Name": "Delete", | ||
| "DiscussionId": "603df172-c032-48c6-8f8a-ef40e721c3c0", | ||
| "Mappings": [] | ||
| }, | ||
| { | ||
| "Path": "/how-to", | ||
| "Name": "How to...", | ||
| "Mappings": [] | ||
| } | ||
| ] | ||
| { | ||
| "Path": "get.markdown", | ||
| "Name": "Get", | ||
| "DiscussionId": "eafb1bd0-dd05-449e-bacc-0d5747d96385", | ||
| "Mappings": [] | ||
| }, | ||
| { | ||
| "Path": "put.markdown", | ||
| "Name": "Put", | ||
| "DiscussionId": "ed032e64-6fe9-4528-a4c0-893dbf4d2bf8", | ||
| "Mappings": [] | ||
| }, | ||
| { | ||
| "Path": "delete.markdown", | ||
| "Name": "Delete", | ||
| "DiscussionId": "603df172-c032-48c6-8f8a-ef40e721c3c0", | ||
| "Mappings": [] | ||
| }, | ||
| { | ||
| "Path": "/how-to", | ||
| "Name": "How to...", | ||
| "Mappings": [] | ||
| } | ||
| ] |
17 changes: 14 additions & 3 deletions
17
Documentation/6.0/Raven.Documentation.Pages/client-api/commands/.docs.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,23 @@ | ||
| [ | ||
| [ | ||
| { | ||
| "Path": "overview.markdown", | ||
| "Name": "Commands Overview", | ||
| "DiscussionId": "77145453-b931-4323-a10f-62899c835b4d", | ||
| "Mappings": [ | ||
| { | ||
| "Version": 4.0, | ||
| "Key": "client-api/how-to/use-low-level-commands" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "Path": "/documents", | ||
| "Name": "Documents", | ||
| "Name": "Document Commands", | ||
| "Mappings": [] | ||
| }, | ||
| { | ||
| "Path": "/batches", | ||
| "Name": "Batches", | ||
| "Name": "Batching Commands", | ||
| "Mappings": [] | ||
| } | ||
| ] |
8 changes: 8 additions & 0 deletions
8
Documentation/6.0/Raven.Documentation.Pages/client-api/commands/batches/.docs.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| [ | ||
| { | ||
| "Path": "how-to-send-multiple-commands-using-a-batch.markdown", | ||
| "Name": "Send Multiple Commands", | ||
| "DiscussionId": "2b6e99a2-6807-4ffc-85d0-e39477a2ddb7", | ||
| "Mappings": [] | ||
| } | ||
| ] |
106 changes: 106 additions & 0 deletions
106
...pi/commands/batches/how-to-send-multiple-commands-using-a-batch.dotnet.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| # Send Multiple Commands in a Batch | ||
| --- | ||
|
|
||
| {NOTE: } | ||
|
|
||
| * Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to the server. | ||
| This reduces the number of remote calls and allows several operations to share the same transaction. | ||
|
|
||
| * All the commands sent in the batch are executed as a **single transaction** on the node the client communicated with. | ||
| If any command fails, the entire batch is rolled back, ensuring data integrity. | ||
|
|
||
| * The commands are replicated to other nodes in the cluster only AFTER the transaction is successfully completed on that node. | ||
|
|
||
| * In this page: | ||
| * [Examples](../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch#examples) | ||
| * [Available batch commands](../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch#available-batch-commands) | ||
| * [Syntax](../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch#syntax) | ||
|
|
||
| {NOTE/} | ||
|
|
||
| --- | ||
|
|
||
| {PANEL: Examples} | ||
|
|
||
| {CONTENT-FRAME: } | ||
|
|
||
| #### Send multiple commands - using the Store's request executor: | ||
|
|
||
| --- | ||
|
|
||
| {CODE-TABS} | ||
| {CODE-TAB:csharp:Sync batch_1@ClientApi\Commands\Batches\SendMultipleCommands.cs /} | ||
| {CODE-TAB:csharp:Async batch_1_async@ClientApi\Commands\Batches\SendMultipleCommands.cs /} | ||
| {CODE-TABS/} | ||
|
|
||
| {CONTENT-FRAME/} | ||
| {CONTENT-FRAME: } | ||
|
|
||
| #### Send multiple commands - using the Session's request executor: | ||
|
|
||
| --- | ||
|
|
||
| * `SingleNodeBatchCommand` can also be executed using the session's request executor. | ||
|
|
||
| * Note that the transaction created for the HTTP request when executing `SingleNodeBatchCommand` | ||
| is separate from the transaction initiated by the session's [SaveChanges](../../../client-api/session/saving-changes) method, even if both are called within the same code block. | ||
| Learn more about transactions in RavenDB in [Transaction support](../../../client-api/faq/transaction-support). | ||
|
|
||
| {CODE-TABS} | ||
| {CODE-TAB:csharp:Sync batch_2@ClientApi\Commands\Batches\SendMultipleCommands.cs /} | ||
| {CODE-TAB:csharp:Async batch_2_async@ClientApi\Commands\Batches\SendMultipleCommands.cs /} | ||
| {CODE-TABS/} | ||
|
|
||
| {CONTENT-FRAME/} | ||
| {PANEL/} | ||
|
|
||
| {PANEL: Available batch commands} | ||
|
|
||
| **The following commands can be sent in a batch via `SingleNodeBatchCommand`**: | ||
| (These commands implement the `ICommandData` interface). | ||
|
|
||
| * BatchPatchCommandData | ||
| * CopyAttachmentCommandData | ||
| * CountersBatchCommandData | ||
| * DeleteAttachmentCommandData | ||
| * DeleteCommandData | ||
| * DeleteCompareExchangeCommandData | ||
| * DeletePrefixedCommandData | ||
| * ForceRevisionCommandData | ||
| * IncrementalTimeSeriesBatchCommandData | ||
| * JsonPatchCommandData | ||
| * MoveAttachmentCommandData | ||
| * PatchCommandData | ||
| * PutAttachmentCommandData | ||
| * PutCommandData | ||
| * PutCompareExchangeCommandData | ||
| * TimeSeriesBatchCommandData | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL: Syntax} | ||
|
|
||
| {CODE syntax_1@ClientApi\Commands\Batches\SendMultipleCommands.cs /} | ||
| {CODE syntax_2@ClientApi\Commands\Batches\SendMultipleCommands.cs /} | ||
| {CODE syntax_3@ClientApi\Commands\Batches\SendMultipleCommands.cs /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| ## Related articles | ||
|
|
||
| ### Transactions | ||
|
|
||
| - [Transaction Support](../../../client-api/faq/transaction-support) | ||
|
|
||
| ### Commands | ||
|
|
||
| - [Put document](../../../client-api/commands/documents/put) | ||
| - [Delete document](../../../client-api/commands/documents/delete) | ||
|
|
||
| ### Patching | ||
|
|
||
| - [How to Perform Single Document Patch Operations](../../../client-api/operations/patching/single-document) | ||
|
|
||
| ### Attachments | ||
|
|
||
| - [What are Attachments](../../../document-extensions/attachments/what-are-attachments) |
Oops, something went wrong.