MeiliSearch/flatten-serde-json
2023-01-11 15:05:06 +00:00
..
benches Add benchmarks to the flatten-serde-json subcrate 2022-04-13 13:12:57 +02:00
fuzz improve the fuzzer of the flatten crate 2022-04-20 16:11:23 +02:00
src Modify flatten_serde_json to keep dummy value for all object keys 2022-07-19 10:07:33 +02:00
Cargo.toml Update version for the next release (v0.39.0) in Cargo.toml files 2023-01-11 15:05:06 +00:00
README.md move the flatten-serde-json crate inside of milli 2022-04-07 18:20:44 +02:00

Flatten serde Json

This crate flatten serde_json Object in a format similar to elastic search.

Examples

There is nothing to do

{
  "id": "287947",
  "title": "Shazam!",
  "release_date": 1553299200,
  "genres": [
    "Action",
    "Comedy",
    "Fantasy"
  ]
}

Flattens to:

{
  "id": "287947",
  "title": "Shazam!",
  "release_date": 1553299200,
  "genres": [
    "Action",
    "Comedy",
    "Fantasy"
  ]
}

Objects

{
  "a": {
    "b": "c",
    "d": "e",
    "f": "g"
  }
}

Flattens to:

{
  "a.b": "c",
  "a.d": "e",
  "a.f": "g"
}

Array of objects

{
  "a": [
    { "b": "c" },
    { "b": "d" },
    { "b": "e" },
  ]
}

Flattens to:

{
  "a.b": ["c", "d", "e"],
}

Array of objects with normal value in the array

{
  "a": [
    42,
    { "b": "c" },
    { "b": "d" },
    { "b": "e" },
  ]
}

Flattens to:

{
  "a": 42,
  "a.b": ["c", "d", "e"],
}

Array of objects of array of objects of ...

{
  "a": [
    "b",
    ["c", "d"],
    { "e": ["f", "g"] },
    [
        { "h": "i" },
        { "e": ["j", { "z": "y" }] },
    ],
    ["l"],
    "m",
  ]
}

Flattens to:

{
  "a": ["b", "c", "d", "l", "m"],
  "a.e": ["f", "g", "j"],
  "a.h": "i",
  "a.e.z": "y",
}

Collision between a generated field name and an already existing field

{
  "a": {
    "b": "c",
  },
  "a.b": "d",
}

Flattens to:

{
  "a.b": ["c", "d"],
}