Skip to content

RDoc-3442 and RDoc-3459 #2110

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

Merged
merged 1 commit into from
Aug 14, 2025
Merged

RDoc-3442 and RDoc-3459 #2110

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
6 changes: 3 additions & 3 deletions docs/ai-integration/gen-ai-integration/gen-ai-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ and reacts when a document is added or modified by Retrieving the document, Gene
based on its data, Sending these objects to a generative AI model along with instructions regarding what
to do with the data and how to format the reply, and potentially Acting upon the model's response.

<Admonition type="note" title="&lt;a id=the-flow /&gt;The flow" id="lt-a-id-the-flow-gt-the-flow" href="#lt-a-id-the-flow-gt-the-flow">
<Admonition type="note" title="The flow" id="the-flow" href="#the-flow">
Let's put the above stages in order.
<br/>
<br/>
Expand All @@ -73,7 +73,7 @@ Let's put the above stages in order.
is applied to handle the results.
</Admonition>

<Admonition type="note" title="&lt;a id=the-elements /&gt;The elements" id="lt-a-id-the-elements-gt-the-elements" href="#lt-a-id-the-elements-gt-the-elements">
<Admonition type="note" title="The elements" id="the-elements" href="#the-elements">
These are the elements that need to be defined for a GenAI task.
<br/>
<br/>
Expand Down Expand Up @@ -186,7 +186,7 @@ if($output.Blocked)

</Admonition>

<Admonition type="note" title="&lt;a id=how-to-create-and-run-a-gen-ai-task /&gt;How to create and run a GenAI task" id="lt-a-id-how-to-create-and-run-a-gen-ai-task-gt-how-to-create-and-run-a-genai-task" href="#lt-a-id-how-to-create-and-run-a-gen-ai-task-gt-how-to-create-and-run-a-genai-task">
<Admonition type="note" title="How to create and run a GenAI task" id="how-to-create-and-run-a-genai-task" href="#how-to-create-and-run-a-genai-task">

* You can use [Studio's intuitive wizard](../../ai-integration/gen-ai-integration/gen-ai-studio.mdx#add-a-genai-task)
to create GenAI tasks. The wizard will guide you through the task creation phases,
Expand Down
4 changes: 2 additions & 2 deletions docs/client-api/commands/documents/delete.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ catch (Exception e)
| Parameter | Type | Description |
|------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **id** | `string` | The ID of the document to delete. |
| **changeVector** | `string` | The change-vector of the document you wish to delete,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control-&-change-vectors).<br/>Pass `null` to skip the check and force the deletion. |
| **changeVector** | `string` | The change-vector of the document you wish to delete,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors).<br/>Pass `null` to skip the check and force the deletion. |



Expand Down Expand Up @@ -376,7 +376,7 @@ catch (err) \{
| Parameter | Type | Description |
|------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **id** | `string` | The ID of the document to delete. |
| **changeVector** | `string` | The change-vector of the document you wish to delete,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control-&-change-vectors).<br/>Pass `null` to skip the check and force the deletion. |
| **changeVector** | `string` | The change-vector of the document you wish to delete,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors).<br/>Pass `null` to skip the check and force the deletion. |



Expand Down
4 changes: 2 additions & 2 deletions docs/client-api/commands/documents/put.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ var theDocumentCV = putResult.ChangeVector;
| Parameter | Type | Description |
|------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **id** | `string` | Unique ID under which document will be stored. |
| **changeVector** | `string` | The change-vector of the document you wish to update,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control-&-change-vectors).<br/>Pass `null` to skip the check and force the 'put'. |
| **changeVector** | `string` | The change-vector of the document you wish to update,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors).<br/>Pass `null` to skip the check and force the 'put'. |
| **document** | `BlittableJsonReaderObject` | The document to store. Use:<br/>`session.Advanced.JsonConverter.ToBlittable(doc, docInfo);` to convert your entity to a `BlittableJsonReaderObject`. |

<TabItem value="syntax_2" label="syntax_2">
Expand Down Expand Up @@ -478,7 +478,7 @@ assert.strictEqual(theDocumentID, "categories/999");
| Parameter | Type | Description |
|------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **id** | `string` | Unique ID under which document will be stored. |
| **changeVector** | `string` | The change-vector of the document you wish to update,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control-&-change-vectors).<br/>Pass `null` to skip the check and force the 'put'. |
| **changeVector** | `string` | The change-vector of the document you wish to update,<br/>used for [optimistic concurrency control](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors).<br/>Pass `null` to skip the check and force the 'put'. |
| **document** | `object` | The document to store. |

<TabItem value="syntax_2" label="syntax_2">
Expand Down
16 changes: 8 additions & 8 deletions docs/client-api/data-subscriptions/consumption/api-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ export const supportedLanguages = ["csharp", "java", "python", "nodejs"];
* [Create the subscription worker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker)
* [SubscriptionWorkerOptions](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions)
* [Run the subscription worker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)
* [SubscriptionBatch&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch&lt;t&gt;)
* [SubscriptionBatch&lt;T&gt;.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch&lt;t&gt;item)
* [SubscriptionWorker&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker&lt;t&gt;)
* [SubscriptionBatch&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatcht)
* [SubscriptionBatch&lt;T&gt;.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatchtitem)
* [SubscriptionWorker&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert)

</Admonition>
## Create the subscription worker
Expand Down Expand Up @@ -129,7 +129,7 @@ Learn more about `SubscriptionOpeningStrategy` in [worker strategies](../../../c
## Run the subscription worker

After [creating](../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents.
To start processing, you need to call the `Run` method of the [SubscriptionWorker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker&lt;t&gt;).
To start processing, you need to call the `Run` method of the [SubscriptionWorker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert).

The `Run` function takes a delegate, which is your client-side code responsible for processing the received document batches.

Expand Down Expand Up @@ -160,7 +160,7 @@ Task Run(Func<SubscriptionBatch<T>, Task> processDocuments,

| Member | Type | Description |
|--------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Items** | `List<SubscriptionBatch<T>.Item>` | List of items in the batch.<br/>See [SubscriptionBatch&lt;T&gt;.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch&lt;t&gt;item) below. |
| **Items** | `List<SubscriptionBatch<T>.Item>` | List of items in the batch.<br/>See [SubscriptionBatch&lt;T&gt;.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatchtitem) below. |
| **NumberOfItemsInBatch** | `int` | Number of items in the batch. |

| Method Signature | Return value | Description |
Expand Down Expand Up @@ -285,8 +285,8 @@ Using it outside this scope may cause unexpected behavior.
* [Create the subscription worker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker)
* [SubscriptionWorkerOptions](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions)
* [Run the subscription worker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)
* [SubscriptionBatch&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch&lt;t&gt;)
* [SubscriptionWorker&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker&lt;t&gt;)
* [SubscriptionBatch&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatcht)
* [SubscriptionWorker&lt;T&gt;](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert)

</Admonition>
## Create the subscription worker
Expand Down Expand Up @@ -350,7 +350,7 @@ All other parameters are optional and will default to their respective default v
## Run the subscription worker

After [creating](../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents.
To start processing, you need to call the `run` method of the [SubscriptionWorker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker&lt;t&gt;).
To start processing, you need to call the `run` method of the [SubscriptionWorker](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert).

The `run` function takes a delegate, which is your client-side code responsible for processing the received document batches.

Expand Down
4 changes: 2 additions & 2 deletions docs/client-api/data-subscriptions/creation/examples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ See how to consume this type of subscription [here](../../../client-api/data-sub
**Include using builder**:

Include statements can be added to the subscription with `ISubscriptionIncludeBuilder`.
This builder is assigned to the `Includes` property in [SubscriptionCreationOptions&lt;T&gt;](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions&lt;t&gt;).
This builder is assigned to the `Includes` property in [SubscriptionCreationOptions&lt;T&gt;](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst).
It supports methods for including documents as well as [counters](../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters).
These methods can be chained.

Expand Down Expand Up @@ -700,7 +700,7 @@ See how to consume this type of subscription [here](../../../client-api/data-sub
**Include using builder**:

Include statements can be added to the subscription with `SubscriptionIncludeBuilder`.
This builder is assigned to the `includes` property in [SubscriptionCreationOptions](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions&lt;t&gt;).
This builder is assigned to the `includes` property in [SubscriptionCreationOptions](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst).
It supports methods for including documents as well as [counters](../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters).
These methods can be chained.

Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/faq/transaction-support.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ If you care about avoiding lost updates, you need to ensure you have the conflic

The following is an important aspect to RavenDB's transactional behavior with regards to asynchronous replication.

When replicating modifications to another server, RavenDB will ensure that the [transaction boundaries](../../server/clustering/replication/replication-overview.mdx#replication-&-transaction-boundary) are maintained.
When replicating modifications to another server, RavenDB will ensure that the [transaction boundaries](../../server/clustering/replication/replication-overview.mdx#replication--transaction-boundary) are maintained.
If there are several document modifications in the same transaction they will be sent in the same replication batch, keeping the transaction boundary on the destination as well.

However, a special attention is needed when a document is modified in two separate transactions but the replication of the first transaction has not occurred yet.
Expand Down
16 changes: 8 additions & 8 deletions docs/client-api/session/updating-entities.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"];


* In this page:
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document-&-update)
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents-&-update)
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document--update)
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents--update)

</Admonition>
## Load a document & update
Expand Down Expand Up @@ -158,8 +158,8 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"];


* In this page:
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document-&-update)
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents-&-update)
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document--update)
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents--update)

</Admonition>
## Load a document & update
Expand Down Expand Up @@ -236,8 +236,8 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"];


* In this page:
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document-&-update)
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents-&-update)
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document--update)
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents--update)

</Admonition>
## Load a document & update
Expand Down Expand Up @@ -323,8 +323,8 @@ try \{


* In this page:
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document-&-update)
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents-&-update)
* [Load a document & update](../../client-api/session/updating-entities.mdx#load-a-document--update)
* [Query for documents & update](../../client-api/session/updating-entities.mdx#query-for-documents--update)

</Admonition>
## Load a document & update
Expand Down
Loading