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.

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

More adjustments of SearchV2 behavior after initial implementation #322

Merged
merged 2 commits into from
Feb 25, 2025
Merged

More adjustments of SearchV2 behavior after initial implementation #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8988cad
object: Free from sorting by secondary attributes in SearchV2
cthulhu-rider Feb 19, 2025
febb3bf
object: Mention numeric limits for SearchV2
cthulhu-rider Feb 19, 2025
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
7 changes: 4 additions & 3 deletions object/service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ service ObjectService {
// * single message
// * allows for additional header fields to be returned
//
// Result is ordered by requested attributes and object ID.
// Result is ordered by the 1st requested attribute (if any) and object ID.
rpc SearchV2(SearchV2Request) returns (SearchV2Response);

// Get byte range of data payload. Range is set as an (offset, length) tuple.
Expand Down Expand Up @@ -553,7 +553,8 @@ message SearchV2Request {
// List of search expressions. Limited to 8. If additional attributes are
// requested (see attributes below) then the first filter's key MUST be
// the first requested attribute. '$Object:containerID' and
// '$Object:objectID' filters are prohibited.
// '$Object:objectID' filters are prohibited. Numeric filters' values MUST
// be in range [-MaxUint256, MaxUint256].
repeated SearchFilter filters = 3;

// Cursor to continue search. Can be omitted or empty for the new search.
Expand All @@ -565,7 +566,7 @@ message SearchV2Request {

// List of attribute names (including special ones as defined by
// SearchFilter key) to include into the reply. Limited to 8, these
// attributes also affect result ordering (result is ordered by attributes
// attributes also affect result ordering (result is ordered by the 1st one
// and then by OID). If additional attributes are requested, then the first
// filter's key (see filters above) MUST be the first requested attribute.
// '$Object:containerID' and '$Object:objectID' attributes are prohibited.
Expand Down
6 changes: 3 additions & 3 deletions proto-docs/object.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ Search for objects in a container. Similar to Search, but:
* single message
* allows for additional header fields to be returned

Result is ordered by requested attributes and object ID.
Result is ordered by the 1st requested attribute (if any) and object ID.

| Name | Input | Output |
| ---- | ----- | ------ |
Expand Down Expand Up @@ -834,10 +834,10 @@ Object Search request body
| ----- | ---- | ----- | ----------- |
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Container where the search is being performed. |
| version | [uint32](#uint32) | | Version of the Query Language used. |
| filters | [SearchFilter](#neo.fs.v2.object.SearchFilter) | repeated | List of search expressions. Limited to 8. If additional attributes are requested (see attributes below) then the first filter's key MUST be the first requested attribute. '$Object:containerID' and '$Object:objectID' filters are prohibited. |
| filters | [SearchFilter](#neo.fs.v2.object.SearchFilter) | repeated | List of search expressions. Limited to 8. If additional attributes are requested (see attributes below) then the first filter's key MUST be the first requested attribute. '$Object:containerID' and '$Object:objectID' filters are prohibited. Numeric filters' values MUST be in range [-MaxUint256, MaxUint256]. |
| cursor | [string](#string) | | Cursor to continue search. Can be omitted or empty for the new search. |
| count | [uint32](#uint32) | | Limits the number of responses to the specified number. Can't be more than 1000. |
| attributes | [string](#string) | repeated | List of attribute names (including special ones as defined by SearchFilter key) to include into the reply. Limited to 8, these attributes also affect result ordering (result is ordered by attributes and then by OID). If additional attributes are requested, then the first filter's key (see filters above) MUST be the first requested attribute. '$Object:containerID' and '$Object:objectID' attributes are prohibited. |
| attributes | [string](#string) | repeated | List of attribute names (including special ones as defined by SearchFilter key) to include into the reply. Limited to 8, these attributes also affect result ordering (result is ordered by the 1st one and then by OID). If additional attributes are requested, then the first filter's key (see filters above) MUST be the first requested attribute. '$Object:containerID' and '$Object:objectID' attributes are prohibited. |


<a name="neo.fs.v2.object.SearchV2Response"></a>
Expand Down