TrueCloudLab/frostfs-api
28
0
Fork 17
Code Issues 11 Pull requests 1 Releases Activity Actions

Clarify object search filter header name usage

Browse source 
Related: nspcc-dev/neofs-spec#12

Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2020-10-21 19:41:24 +03:00 committed by Stanislav Bogatyrev
parent 31e1801c4a
commit 8056035132
2 changed files with 63 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
acl/types.proto
View file

@ -97,6 +97,29 @@ message EACLRecord {
Action action = 2 [json_name = "action"]; Action action = 2 [json_name = "action"];
// Filter to check particular properties of the request or object. // Filter to check particular properties of the request or object.
//
// By default `header_name` field refers to the corresponding object's
// `Attribute`. Some Object's header fields can also be accessed by adding
// `$Object:` prefix to the name. Here is the list of fields available via
// this prefix:
//
// * $Object:version \
// version
// * $Object:containerID \
// container_id
// * $Object:ownerID \
// owner_id
// * $Object:creationEpoch \
// creation_epoch
// * $Object:payloadLength \
// payload_length
// * $Object:payloadHash \
// payload_hash
// * $Object:objectType \
// object_type
// * $Object:homomorphicHash \
// homomorphic_hash
//
message Filter { message Filter {
// Define if Object or Request header will be used // Define if Object or Request header will be used
HeaderType header_type = 1 [json_name = "headerType"]; HeaderType header_type = 1 [json_name = "headerType"];

43
object/service.proto
View file

@ -295,15 +295,52 @@ message SearchRequest {
// Version of the Query Language used // Version of the Query Language used
uint32 version = 2; uint32 version = 2;
// Filter structure // Filter structure checks if object header field or attribute content
// matches a value.
//
// By default `name` field refers to the corresponding object's `Attribute`.
// Some Object's header fields can also be accessed by adding `$Object:`
// prefix to the name. Here is the list of fields available via this prefix:
//
// * $Object:version \
// version
// * $Object:containerID \
// container_id
// * $Object:ownerID \
// owner_id
// * $Object:creationEpoch \
// creation_epoch
// * $Object:payloadLength \
// payload_length
// * $Object:payloadHash \
// payload_hash
// * $Object:objectType \
// object_type
// * $Object:homomorphicHash \
// homomorphic_hash
//
// There are some well-known filter aliases to match objects by certain
// properties:
//
// * $Object:ROOT \
// With the `value` set to `true` checks if an object is a top object in a
// split hierarchy. With other values returns non-root objects.
// * $Object:LEAF \
// With the `value` set to `true` checks if an object is a leaf in a split
// hierarchy. With other values returns non-leaf objects.
// * $Object:PARENT \
// With the `value` set to `true` checks if an object has any child
// objects is `Split` header or there are objects known to reference this
// object as a parent. If set to `false` returns object without child
// objects in `Split` header or any objects known to reference them.
message Filter { message Filter {
// Match type to use // Match type to use
MatchType match_type = 1; MatchType match_type = 1;
// Header name to match // Attribute or Header fields to match
string name = 2; string name = 2;
// Header value to match // Value to match
string value = 3; string value = 3;
} }
// List of search expressions // List of search expressions