Skip to content
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.

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

RDoc-3009 [Node.js] Subscriptions > Advanced > Maintenance operations #1925

Merged

Conversation

Danielle9897
Copy link
Member

Related issue
https://issues.hibernatingrhinos.com/issue/RDoc-3009/Node.js-Client-API-Data-subscriptions-Advanced-Maintenance-operations-Replace-C-samples


Notes for this PR:
There are still fixes to be applied to this article for all languages - to be done in a separate dedicated issue:
https://issues.hibernatingrhinos.com/issue/RDoc-3055/Client-API-Data-subscriptions-Advanced-Maintenance-operations-Fix-article


Node.js: @ml054

  • Node.js files to review:
Documentation/5.4/Raven.Documentation.Pages/client-api/data-subscriptions/advanced-topics/maintenance-operations.js.markdown
Documentation/5.4/Samples/nodejs/client-api/dataSubscriptions/advanced/maintenance.js

| Member | Type | Description |
|-------------------------------------------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **query** | `string` | Subscription's RQL like query. |
| **lastBatchAckTime** | `DateTime?` | Last time a batch processing progress was acknowledged. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Date?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

| **nodeTag** | `string` | Processing server's node tag. |
| **mentorNode** | `string` | The mentor node that was manually set. |
| **subscriptionName** | `string` | The subscription's name, which is also its unique identifier. |
| **subscriptionId** | `long` | Subscription's internal identifier (cluster's operation etag during subscription creation). |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

number?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right...

| **subscriptionId** | `long` | Subscription's internal identifier (cluster's operation etag during subscription creation). |
| **changeVectorForNextBatchStartingPoint** | `string` | The Change Vector from which the subscription will begin sending documents.<br>This value is updated on batch acknowledgement and can also be set manually. |
| **disabled** | `bool` | If `true`, subscription will not allow workers to connect. |
| **lastClientConnectionTime** | `DateTime?` | Time when last client was connected (value sustained after disconnection). |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please review entire table

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

}
{
//region disable
await documentStore.subscriptions.disable("subscriptionNameToDidable");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: Didable

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@ppekrol ppekrol merged commit 6c3aaf2 into ravendb:master Oct 14, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants