json: support map serialization in particular order #10606

grafin · 2024-09-24T11:20:09Z

Similar to #9747 but for json.

Use cases (see #9747)

Main reason is to be able to order keys in json serialization in log messages with log_format = 'json'. It is crucial to have such feature to be able to setup custom log context and the log messages still printing the information in predictable order.

Implementation

We have a serializer class in src/lua/serializer.c and src/lua/serializer.h, which can accept options as second argument in encode() and decode() calls. Lets add an encode_key_order option, which can accept a table (array) of ordered keys, in the order we want them present in the encoded string.

It should work something like:

tarantool> json = require('json')
---
...

tarantool> map = {a = 1, c = 100, b = 2}
---
...

tarantool> json.encode(map)
---
- '{"b":2,"a":1,"c":100}'
...

tarantool> json.encode(map, {encode_key_order = {'a', 'b', 'c'}})
---
- '{"a":1,"b":2,"c":100}'
...

tarantool> json.encode(map, {encode_key_order = {'a', 'b'}})
---
- '{"a":1,"b":2,"c":100}'
...

tarantool> json.encode(map, {encode_key_order = {'a', 'b', 'd'}})
---
- '{"a":1,"b":2,"c":100}'
...

For already created serializer object we should be able to create a persistent ordering:

tarantool> json = require('json')
---
...

tarantool> map_1 = {a = 1, c = 100, b = 2}
---
...

tarantool> j = json.new()
---
...

tarantool> j.cfg({encode_key_order = {'a', 'b'}})
---
...

tarantool> j.encode(map_1)
---
- '{"a":1,"b":2,"c":100}'
...

tarantool> j.encode(map_1, {encode_key_order = {'c', 'b'}})
---
- '{"c":100,"b":2,"a":1}'
...

tarantool> j.encode(map_1)
---
- '{"a":1,"b":2,"c":100}'
...

The text was updated successfully, but these errors were encountered:

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

grafin · 2024-10-18T12:52:29Z

Currently doing this:

tarantool> require('json').encode(map, {encode_key_order = {'a', 'b', 42, {"asd"}}})

Results in assertion failure:

tarantool: src/lua/serializer.c:186: void luaL_serializer_parse_encode_key_order(struct lua_State *, struct luaL_serializer *): Assertion `lua_isstring(L, -1)' failed.
Aborted (core dumped)

I think we should change this assertion into box.error similar to:

tarantool> require('json').encode({a = 1, b = 2, c = 3, d = 4, e = 5, [{'asd'}] = 6})
---
- error: table key must be a number or string
...

Will be back with. a PR update)

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes tarantool#10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

@TarantoolBot

This option allows to pass an array of keys that will be used to sort keys in maps during serialization to json. The order of the provided keys in the resulting string will be the same as in the `encode_key_order` array. Keys, present in maps and not included in `encode_key_order` will be serialized after the sorted ones in arbitrary order. Closes #10606 @TarantoolBot document Title: A new `encode_key_order` option for json encoder introduced Product: Tarantool Since: 3.3.0 This option allows to specify the order in which the keys of object will be serialized. To specify a particular order, it is possible to pass an array of the keys, and resulting JSON string will contain the provided keys in the specified order, while other present keys of an object will be present after in some arbitrary order. ``` lua map = {a = 1, c = 100, b = 2} require('json').encode(map) -- returns '{"b":2,"a":1,"c":100}' require('json').encode(map, {encode_key_order = {'a', 'b'}}) -- returns '{"a":1,"b":2,"c":100}' require('json').(map, {encode_key_order = {'a', 'b', 'd'}}) -- returns '{"a":1,"b":2,"c":100}' ``` For a persistent serializer object a persistent ordering can be defined: ``` lua map_1 = {a = 1, c = 100, b = 2} j = require('json').new() j.cfg({encode_key_order = {'a', 'b'}}) j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' j.encode(map_1, {encode_key_order = {'c', 'b'}}) -- returns '{"c":100,"b":2,"a":1}' j.encode(map_1) -- returns '{"a":1,"b":2,"c":100}' ```

grafin added the feature A new functionality label Sep 24, 2024

grafin self-assigned this Sep 24, 2024

grafin mentioned this issue Sep 24, 2024

Add encode_key_order option to json encoder #10584

Merged

grafin mentioned this issue Sep 25, 2024

Specify the order of fields for json logger #10616

Open

Totktonada added the serializers Fearutes and bugs related to built-in serializers label Sep 25, 2024

Totktonada closed this as completed in #10584 Nov 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

json: support map serialization in particular order #10606

json: support map serialization in particular order #10606

json: support map serialization in particular order #10606

json: support map serialization in particular order #10606

Comments

Use cases (see #9747)

Implementation