Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 13 additions & 10 deletions docs/client-api/operations/_what-are-operations-csharp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ import CodeBlock from '@theme/CodeBlock';

* These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_,
document-extensions related operations such as getting/putting an attachment, and more.
See all available operations [below](../../client-api/operations/what-are-operations.mdx#operations-list).
See all available operations [below](../../client-api/operations/what-are-operations#the-following-common-operations-are-available).

* To execute a common operation request,
use the `Send` method on the `Operations` property of the DocumentStore.
Expand Down Expand Up @@ -141,7 +141,8 @@ Task<PatchOperation.Result<TEntity>> SendAsync<TEntity>(PatchOperation<TEntity>

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

&lt;span id="operations-list"&gt; **The following common operations are available:** &lt;/span&gt;
#### The following common operations are available:

* **Attachments**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutAttachmentOperation](../../client-api/operations/attachments/put-attachment.mdx)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetAttachmentOperation](../../client-api/operations/attachments/get-attachment.mdx)
Expand Down Expand Up @@ -185,7 +186,7 @@ Task<PatchOperation.Result<TEntity>> SendAsync<TEntity>(PatchOperation<TEntity>

* These operations include database management operations such as setting client configuration,
managing indexes & ongoing-tasks operations, getting stats, and more.
See all available maintenance operations [below](../../client-api/operations/what-are-operations.mdx#maintenance-list).
See all available maintenance operations [below](../../client-api/operations/what-are-operations#the-following-maintenance-operations-are-available).

* To execute a maintenance operation request,
use the `Send` method on the `Maintenance` property in the DocumentStore.
Expand Down Expand Up @@ -255,7 +256,8 @@ Task<Operation> SendAsync(IMaintenanceOperation<OperationIdResult> operation,

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

&lt;span id="maintenance-list"&gt; **The following maintenance operations are available:** &lt;/span&gt;
#### The following maintenance operations are available:

* **Statistics**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-database-stats)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetDetailedStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats)
Expand Down Expand Up @@ -382,7 +384,7 @@ Task<Operation> SendAsync(IMaintenanceOperation<OperationIdResult> operation,
Use [ForNode](../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration.

* These operations include server management and configuration operations.
See all available operations [below](../../client-api/operations/what-are-operations.mdx#server-list).
See all available operations [below](../../client-api/operations/what-are-operations#the-following-server-maintenance-operations-are-available).

* To execute a server-maintenance operation request,
use the `Send` method on the `Maintenance.Server` property in the DocumentStore.
Expand Down Expand Up @@ -446,7 +448,8 @@ Task<Operation> SendAsync(IServerOperation<OperationIdResult> operation,

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

&lt;span id="server-list"&gt; **The following server-maintenance operations are available:** &lt;/span&gt;
#### The following server-maintenance operations are available:

* **Client certificates**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutClientCertificateOperation](../../client-api/operations/server-wide/certificates/put-client-certificate.mdx)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [CreateClientCertificateOperation](../../client-api/operations/server-wide/certificates/create-client-certificate.mdx)
Expand Down Expand Up @@ -698,10 +701,10 @@ public async Task<TResult> WaitForCompletionAsync<TResult>(CancellationToken tok
</TabItem>
</Tabs>

| Parameter | Type | Description |
|-------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **timeout** | `TimeSpan` | &lt;ul&gt;&lt;li&gt; **When timespan is specified** - <br/>The server will throw a `TimeoutException` if operation has not completed within the specified time frame.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.&lt;/li&gt;&lt;li&gt;`null` - <br/>WaitForCompletion will wait for operation to complete forever.&lt;/li&gt;&lt;/ul&gt; |
| **token** | `CancellationToken` | &lt;ul&gt;&lt;li&gt; **When cancellation token is specified** - <br/>The server will throw a `TimeoutException` if operation has not completed at cancellation time.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.&lt;/li&gt;&lt;/ul&gt; |
| Parameter | Type | Description |
|-------------|---------------------|-------------|
| **timeout** | `TimeSpan` | <ul><li><strong>When timespan is specified</strong> -<br/>The server will throw a `TimeoutException` if the operation has not completed within the specified time frame.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.</li><li>`null` -<br/>WaitForCompletion will wait for the operation to complete forever.</li></ul> |
| **token** | `CancellationToken` | <ul><li><strong>When cancellation token is specified</strong> -<br/>The server will throw a `TimeoutException` if the operation has not completed at cancellation time.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.</li></ul> |

| Return type | |
|--------------------|-------------------------------|
Expand Down
15 changes: 9 additions & 6 deletions docs/client-api/operations/_what-are-operations-nodejs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ import CodeBlock from '@theme/CodeBlock';

* These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_,
document-extensions related operations such as getting/putting an attachment, and more.
See all available operations [below](../../client-api/operations/what-are-operations.mdx#operations-list).
See all available operations [below](../../client-api/operations/what-are-operations#the-following-common-operations-are-available).

* To execute a common operation request,
use the `send` method on the `operations` property of the DocumentStore.
Expand Down Expand Up @@ -115,7 +115,8 @@ await send(patchOperation, sessionInfo, resultType);

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

&lt;span id="operations-list"&gt; __The following common operations are available:__ &lt;/span&gt;
#### The following common operations are available:

* __Attachments__:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutAttachmentOperation](../../client-api/operations/attachments/put-attachment.mdx)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetAttachmentOperation](../../client-api/operations/attachments/get-attachment.mdx)
Expand Down Expand Up @@ -160,7 +161,7 @@ await send(patchOperation, sessionInfo, resultType);

* These operations include database management operations such as setting client configuration,
managing indexes & ongoing-tasks operations, getting stats, and more.
See all available maintenance operations [below](../../client-api/operations/what-are-operations.mdx#maintenance-list).
See all available maintenance operations [below](../../client-api/operations/what-are-operations#the-following-maintenance-operations-are-available).

* To execute a maintenance operation request,
use the `send` method on the `maintenance` property in the DocumentStore.
Expand Down Expand Up @@ -201,7 +202,8 @@ __Send syntax__:

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

&lt;span id="maintenance-list"&gt; __The following maintenance operations are available:__ &lt;/span&gt;
#### The following maintenance operations are available:

* __Statistics__:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-database-stats)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetDetailedStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats)
Expand Down Expand Up @@ -325,7 +327,7 @@ __Send syntax__:
Use [forNode](../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration.

* These operations include server management and configuration operations.
See all available operations [below](../../client-api/operations/what-are-operations.mdx#server-list).
See all available operations [below](../../client-api/operations/what-are-operations#the-following-server-maintenance-operations-are-available).

* To execute a server-maintenance operation request,
use the `send` method on the `maintenance.server` property of the DocumentStore.
Expand Down Expand Up @@ -363,7 +365,8 @@ __Send syntax__:

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

&lt;span id="server-list"&gt; __The following server-maintenance operations are available:__ &lt;/span&gt;
#### The following server-maintenance operations are available:

* __Client certificates__:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutClientCertificateOperation](../../client-api/operations/server-wide/certificates/put-client-certificate.mdx)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [CreateClientCertificateOperation](../../client-api/operations/server-wide/certificates/create-client-certificate.mdx)
Expand Down
25 changes: 12 additions & 13 deletions docs/client-api/operations/_what-are-operations-php.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ import CodeBlock from '@theme/CodeBlock';

* These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_,
document-extensions related operations such as getting/putting an attachment, and more.
See all available operations [below](../../client-api/operations/what-are-operations.mdx#operations-list).
See all available operations [below](../../client-api/operations/what-are-operations#the-following-common-operations-are-available).

* To execute a common operation request,
use the `send` method on the `operations` property in the DocumentStore.
Expand Down Expand Up @@ -111,7 +111,8 @@ public function send(...$parameters);

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

&lt;span id="operations-list"&gt; **The following common operations are available:** &lt;/span&gt;
#### The following common operations are available:

* **Attachments**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutAttachmentOperation](../../client-api/operations/attachments/put-attachment.mdx)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetAttachmentOperation](../../client-api/operations/attachments/get-attachment.mdx)
Expand Down Expand Up @@ -154,7 +155,7 @@ public function send(...$parameters);

* These operations include database management operations such as setting client configuration,
managing indexes & ongoing-tasks operations, getting stats, and more.
See all available maintenance operations [below](../../client-api/operations/what-are-operations.mdx#maintenance-list).
See all available maintenance operations [below](../../client-api/operations/what-are-operations#the-following-maintenance-operations-are-available).

* To execute a maintenance operation request,
use the `send` method on the `maintenance` property in the DocumentStore.
Expand Down Expand Up @@ -192,7 +193,8 @@ $status = $indexStats->getStatus(); // will be "Paused"

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

&lt;span id="maintenance-list"&gt; **The following maintenance operations are available:** &lt;/span&gt;
#### The following maintenance operations are available:

* **Statistics**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-database-stats)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetDetailedStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats)
Expand Down Expand Up @@ -314,7 +316,7 @@ $status = $indexStats->getStatus(); // will be "Paused"
Use [forNode](../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration.

* These operations include server management and configuration operations.
See all available operations [below](../../client-api/operations/what-are-operations.mdx#server-list).
See all available operations [below](../../client-api/operations/what-are-operations#the-following-server-maintenance-operations-are-available).

* To execute a server-maintenance operation request,
use the `send` method on the `maintenance.server` property in the DocumentStore.
Expand Down Expand Up @@ -347,7 +349,8 @@ $version = $buildNumberResult->getBuildVersion();

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

&lt;span id="server-list"&gt; **The following server-maintenance operations are available:** &lt;/span&gt;
#### The following server-maintenance operations are available:

* **Client certificates**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutClientCertificateOperation](../../client-api/operations/server-wide/certificates/put-client-certificate.mdx)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [CreateClientCertificateOperation](../../client-api/operations/server-wide/certificates/create-client-certificate.mdx)
Expand Down Expand Up @@ -485,10 +488,6 @@ public function waitForCompletion(Duration|int|null $duration = null): void;
</CodeBlock>
</TabItem>

| Parameter | Type | Description |
|---------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **$duration** | `Duration` or `int` | &lt;ul&gt;&lt;li&gt; **When a duration is specified** - <br/>The server will throw a `TimeoutException` if the peration has not completed within the specified time frame.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.&lt;/li&gt;&lt;li&gt;`null` - <br/>`waitForCompletion` will wait for the operation to complete indefinitely.&lt;/li&gt;&lt;/ul&gt; |




| Parameter | Type | Description |
|---------------|---------------------|-------------|
| **$duration** | `Duration` or `int` | <ul><li><strong>When a duration is specified</strong> -<br/>The server will throw a `TimeoutException` if the operation has not completed within the specified time frame.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.</li><li>`null` -<br/>`waitForCompletion` will wait for the operation to complete indefinitely.</li></ul> |
15 changes: 9 additions & 6 deletions docs/client-api/operations/_what-are-operations-python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ import CodeBlock from '@theme/CodeBlock';

* These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_,
document-extensions related operations such as getting/putting an attachment, and more.
See all available operations [below](../../client-api/operations/what-are-operations.mdx#operations-list).
See all available operations [below](../../client-api/operations/what-are-operations#the-following-common-operations-are-available).

* To execute a common operation request,
use the `send` method on the `operations` property of the DocumentStore.
Expand Down Expand Up @@ -111,7 +111,8 @@ def send_patch_operation_with_entity_class(

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

&lt;span id="operations-list"&gt; **The following common operations are available:** &lt;/span&gt;
#### The following common operations are available:

* **Attachments**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutAttachmentOperation](../../client-api/operations/attachments/put-attachment.mdx)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetAttachmentOperation](../../client-api/operations/attachments/get-attachment.mdx)
Expand Down Expand Up @@ -154,7 +155,7 @@ def send_patch_operation_with_entity_class(

* These operations include database management operations such as setting client configuration,
managing indexes & ongoing-tasks operations, getting stats, and more.
See all available maintenance operations [below](../../client-api/operations/what-are-operations.mdx#maintenance-list).
See all available maintenance operations [below](../../client-api/operations/what-are-operations#the-following-maintenance-operations-are-available).

* To execute a maintenance operation request,
use the `send` method on the `maintenance` property in the DocumentStore.
Expand Down Expand Up @@ -193,7 +194,8 @@ def send_async(self, operation: MaintenanceOperation[OperationIdResult]) -> Oper

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

&lt;span id="maintenance-list"&gt; **The following maintenance operations are available:** &lt;/span&gt;
#### The following maintenance operations are available:

* **Statistics**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-database-stats)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetDetailedStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats)
Expand Down Expand Up @@ -315,7 +317,7 @@ def send_async(self, operation: MaintenanceOperation[OperationIdResult]) -> Oper
Use [for_node](../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration.

* These operations include server management and configuration operations.
See all available operations [below](../../client-api/operations/what-are-operations.mdx#server-list).
See all available operations [below](../../client-api/operations/what-are-operations#the-following-server-maintenance-operations-are-available).

* To execute a server-maintenance operation request,
use the `send` method on the `maintenance.server` property in the DocumentStore.
Expand Down Expand Up @@ -361,7 +363,8 @@ with self.embedded_server.get_document_store("WhatAreOperations") as store:

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

&lt;span id="server-list"&gt; **The following server-maintenance operations are available:** &lt;/span&gt;
#### The following server-maintenance operations are available:

* **Client certificates**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutClientCertificateOperation](../../client-api/operations/server-wide/certificates/put-client-certificate.mdx)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [CreateClientCertificateOperation](../../client-api/operations/server-wide/certificates/create-client-certificate.mdx)
Expand Down
Loading
Loading