realloc/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Issues Pull requests Projects Releases Packages Wiki Activity

[#12] Add __FROSTFS__ system prefix

Browse source 
Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>
This commit is contained in:
Denis Kirillov 2023-03-06 14:56:09 +03:00
parent eafcbff11f
commit 3adb55c38a
15 changed files with 56 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

32
proto-docs/object.md
View file

@ -93,11 +93,11 @@ be restored by concatenation of object message payload and all chunks
keeping the receiving order.
Extended headers can change `Get` behaviour:
* __NEOFS__NETMAP_EPOCH \
* [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
Will use the requsted version of Network Map for object placement
calculation.
* __NEOFS__NETMAP_LOOKUP_DEPTH \
Will try older versions (starting from `__NEOFS__NETMAP_EPOCH` if specified or
* [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
Will try older versions (starting from `__NEOFS__NETMAP_EPOCH`/`__FROSTFS__NETMAP_EPOCH` if specified or
the latest one otherwise) of Network Map to find an object until the depth
limit is reached.
@ -131,7 +131,7 @@ object payload. All messages, except first one, SHOULD be payload chunks.
Chunk messages SHOULD be sent in the direct order of fragmentation.
Extended headers can change `Put` behaviour:
* __NEOFS__NETMAP_EPOCH \
* [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH \
Will use the requsted version of Network Map for object placement
calculation.
@ -166,7 +166,7 @@ Delete the object from a container. There is no immediate removal
guarantee. Object will be marked for removal and deleted eventually.
Extended headers can change `Delete` behaviour:
* __NEOFS__NETMAP_EPOCH \
* [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
Will use the requsted version of Network Map for object placement
calculation.
@ -195,7 +195,7 @@ returned. If `main_only` request field is set, the short header with only
the very minimal information will be returned instead.
Extended headers can change `Head` behaviour:
* __NEOFS__NETMAP_EPOCH \
* [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
Will use the requsted version of Network Map for object placement
calculation.
@ -226,7 +226,7 @@ Header's filed values. Please see the corresponding NeoFS Technical
Specification section for more details.
Extended headers can change `Search` behaviour:
* __NEOFS__NETMAP_EPOCH \
* [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
Will use the requsted version of Network Map for object placement
calculation.
@ -254,10 +254,10 @@ restored by concatenation of all received payload chunks keeping the receiving
order.
Extended headers can change `GetRange` behaviour:
* __NEOFS__NETMAP_EPOCH \
* [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
Will use the requsted version of Network Map for object placement
calculation.
* __NEOFS__NETMAP_LOOKUP_DEPTH \
* [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
Will try older versions of Network Map to find an object until the depth
limit is reached.
@ -291,10 +291,10 @@ length) tuples. Hashes order in response corresponds to the ranges order in
the request. Note that hash is calculated for XORed data.
Extended headers can change `GetRangeHash` behaviour:
* __NEOFS__NETMAP_EPOCH \
* [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
Will use the requsted version of Network Map for object placement
calculation.
* __NEOFS__NETMAP_LOOKUP_DEPTH \
* [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
Will try older versions of Network Map to find an object until the depth
limit is reached.
@ -848,19 +848,19 @@ Key name must be an object-unique valid UTF-8 string. Value can't be empty.
Objects with duplicated attribute names or attributes with empty values
will be considered invalid.
There are some "well-known" attributes starting with `__NEOFS__` prefix
There are some "well-known" attributes starting with `__NEOFS__`/`__FROSTFS__` prefix
that affect system behaviour:
* __NEOFS__UPLOAD_ID \
* [ __NEOFS__UPLOAD_ID | __FROSTFS__UPLOAD_ID ] \
Marks smaller parts of a split bigger object
* __NEOFS__EXPIRATION_EPOCH \
* [ __NEOFS__EXPIRATION_EPOCH | __FROSTFS__EXPIRATION_EPOCH ] \
Tells GC to delete object after that epoch
* __NEOFS__TICK_EPOCH \
* [ __NEOFS__TICK_EPOCH | __FROSTFS__TICK_EPOCH ] \
Decimal number that defines what epoch must produce
object notification with UTF-8 object address in a
body (`0` value produces notification right after
object put)
* __NEOFS__TICK_TOPIC \
* [ __NEOFS__TICK_TOPIC | __FROSTFS__TICK_TOPIC ] \
UTF-8 string topic ID that is used for object notification
And some well-known attributes used by applications only: