Skip to content

RDoc-3838 - clarify how to run a batch of commands cluster-wide in how-to-send-multiple-commands-using-a-batch. #2461

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

RDoc-3838 - clarify how to run a batch of commands cluster-wide in how-to-send-multiple-commands-using-a-batch. #2461

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
8 changes: 6 additions & 2 deletions ...ommands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ import CodeBlock from '@theme/CodeBlock';

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

* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to the server.
* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to a cluster node.
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.
* 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.

* To run multiple commands as a **cluster-wide** transaction, do not use `SingleNodeBatchCommand`,
but open the session with `TransactionMode.ClusterWide` and call `SaveChanges`.
See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction).

* In this page:
* [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples)
* [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands)
Expand Down
8 changes: 6 additions & 2 deletions ...ommands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ import CodeBlock from '@theme/CodeBlock';

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

* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to the server.
* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to a cluster node.
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.
* 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.

* To run multiple commands as a **cluster-wide** transaction, do not use `SingleNodeBatchCommand`,
but open the session with `transactionMode: "ClusterWide"` and call `saveChanges`.
See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction).

* In this page:
* [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples)
* [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands)
Expand Down
4 changes: 4 additions & 0 deletions docs/client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: "Send multiple document commands in a single RavenDB batch request
sidebar_position: 0
supported_languages: ["csharp", "java", "nodejs"]
see_also:
- title: "Cluster Transaction - Overview"
link: "client-api/session/cluster-transaction/overview"
source: "docs"
path: "Client API > Session > Cluster Transaction"
- title: "Transaction Support"
link: "client-api/faq/transaction-support"
source: "docs"
Expand Down
8 changes: 6 additions & 2 deletions ...ommands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ import CodeBlock from '@theme/CodeBlock';

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

* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to the server.
* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to a cluster node.
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.
* 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.

* To run multiple commands as a **cluster-wide** transaction, do not use `SingleNodeBatchCommand`,
but open the session with `TransactionMode.ClusterWide` and call `SaveChanges`.
See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction).

* In this page:
* [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples)
* [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands)
Expand Down
8 changes: 6 additions & 2 deletions ...ommands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ import CodeBlock from '@theme/CodeBlock';

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

* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to the server.
* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to a cluster node.
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.
* 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.

* To run multiple commands as a **cluster-wide** transaction, do not use `SingleNodeBatchCommand`,
but open the session with `transactionMode: "ClusterWide"` and call `saveChanges`.
See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction).

* In this page:
* [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples)
* [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands)
Expand Down
4 changes: 4 additions & 0 deletions ...6.2/client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebar_label: Send Multiple Commands
sidebar_position: 0
supported_languages: ["csharp", "java", "nodejs"]
see_also:
- title: "Cluster Transaction - Overview"
link: "client-api/session/cluster-transaction/overview"
source: "docs"
path: "Client API > Session > Cluster Transaction"
- title: "Transaction Support"
link: "client-api/faq/transaction-support"
source: "docs"
Expand Down
8 changes: 6 additions & 2 deletions ...ommands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ import CodeBlock from '@theme/CodeBlock';

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

* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to the server.
* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to a cluster node.
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.
* 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.

* To run multiple commands as a **cluster-wide** transaction, do not use `SingleNodeBatchCommand`,
but open the session with `TransactionMode.ClusterWide` and call `SaveChanges`.
See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction).

* In this page:
* [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples)
* [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands)
Expand Down
8 changes: 6 additions & 2 deletions ...ommands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ import CodeBlock from '@theme/CodeBlock';

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

* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to the server.
* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to a cluster node.
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.
* 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.

* To run multiple commands as a **cluster-wide** transaction, do not use `SingleNodeBatchCommand`,
but open the session with `transactionMode: "ClusterWide"` and call `saveChanges`.
See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction).

* In this page:
* [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples)
* [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands)
Expand Down
4 changes: 4 additions & 0 deletions ...7.0/client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebar_label: Send Multiple Commands
sidebar_position: 0
supported_languages: ["csharp", "java", "nodejs"]
see_also:
- title: "Cluster Transaction - Overview"
link: "client-api/session/cluster-transaction/overview"
source: "docs"
path: "Client API > Session > Cluster Transaction"
- title: "Transaction Support"
link: "client-api/faq/transaction-support"
source: "docs"
Expand Down
8 changes: 6 additions & 2 deletions ...ommands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ import CodeBlock from '@theme/CodeBlock';

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

* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to the server.
* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to a cluster node.
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.
* 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.

* To run multiple commands as a **cluster-wide** transaction, do not use `SingleNodeBatchCommand`,
but open the session with `TransactionMode.ClusterWide` and call `SaveChanges`.
See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction).

* In this page:
* [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples)
* [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands)
Expand Down
8 changes: 6 additions & 2 deletions ...ommands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ import CodeBlock from '@theme/CodeBlock';

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

* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to the server.
* Use the low-level `SingleNodeBatchCommand` to send **multiple commands** in a **single request** to a cluster node.
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.
* 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.

* To run multiple commands as a **cluster-wide** transaction, do not use `SingleNodeBatchCommand`,
but open the session with `transactionMode: "ClusterWide"` and call `saveChanges`.
See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction).

* In this page:
* [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples)
* [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands)
Expand Down
4 changes: 4 additions & 0 deletions ...7.1/client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebar_label: Send Multiple Commands
sidebar_position: 0
supported_languages: ["csharp", "java", "nodejs"]
see_also:
- title: "Cluster Transaction - Overview"
link: "client-api/session/cluster-transaction/overview"
source: "docs"
path: "Client API > Session > Cluster Transaction"
- title: "Transaction Support"
link: "client-api/faq/transaction-support"
source: "docs"
Expand Down
Loading