Skip to content

PostCursorOptions - ForceOneShardAttributeValue Option #512

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

PostCursorOptions - ForceOneShardAttributeValue Option #512

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
9 changes: 9 additions & 0 deletions arangodb-net-standard/CursorApi/Models/PostCursorOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,5 +119,14 @@ public class PostCursorOptions
/// This feature is only available in the Enterprise Edition.
/// </summary>
public bool? SkipInaccessibleCollections { get; set; }

/// <summary>
/// This query option can be used in complex queries in case the query optimizer cannot
/// automatically detect that the query can be limited to only a single DBServer (e.g., in a
/// disjoint smart graph case). Set this to the shard key value that should be used to force
/// execution on one shard. If set incorrectly (i.e., a wrong shard key value), the query may
/// be shipped to the wrong DBServer and return no results (empty result set). Use at your own risk.
/// </summary>
public string ForceOneShardAttributeValue { get; set; }
Copy link
Collaborator

Choose a reason for hiding this comment

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

The option doesn't appear in any documentation for the cursor API that I can find, are you able to find a reference for it?

As mentioned in the other PR, I wonder if you could subclass PostCursorOptions and add additional properties? I think JSON.NET serializer will include the additional properties on your subclass

Copy link
Author

@RonAmihai RonAmihai Oct 18, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The option does not appear in ArangoDB's official REST API specification; however, as I mentioned above, it does appear in the Java and Golang driver docs. I can also link you to relevant ArangoDB developers who will confirm that.

As I mentioned in the other PR, the subclass approach works, so I can achieve what I've needed regarding that option regardless of that PR.

However, I think it's worth adding that option to the cursor option since it's a known ArangoDB option.

}
}