@@ -64,9 +64,11 @@ The job must include the following attributes in the `nest` block:
6464- `parent` : This specifies the RDI data stream for the parent entities. Typically, you only
6565 need to supply the parent `table` name, unless you are nesting children under a parent that comes from
6666 a different source database. If you do this then you must also specify `server_name` and
67- ` schema` attributes.
68- - `nesting-key` : The field of the child entity that stores the unique ID (primary key) of the child entity.
69- - `parent-key` : The field in the parent entity that stores the unique ID (foreign key) of the parent entity.
67+ ` schema` attributes. Note that this attribute refers to a Redis *key* that will be added to the target
68+ database, not to a table you can access from the pipeline. See [Using nesting](#using-nesting) below
69+ for the format of the key that is generated.
70+ - `nesting_key` : The field of the child entity that stores the unique ID (primary key) of the child entity.
71+ - `parent_key` : The field in the parent entity that stores the unique ID (foreign key) of the parent entity.
7072- `child_key` : The field in the child entity that stores the unique ID (foreign key) of the parent entity.
7173 You only need to add this attribute if the name of the child's foreign key field is different from the parent's.
7274- `path` : The [JSONPath](https://goessner.net/articles/JsonPath/)
@@ -75,6 +77,8 @@ The job must include the following attributes in the `nest` block:
7577- `structure` : (Optional) The type of JSON nesting structure for the child entities. Currently, only a JSON map
7678 is supported so if you supply this attribute then the value must be `map`.
7779
80+ # # Using nesting
81+
7882There are several important things to note when you use nesting :
7983
8084- When you specify `nest` in the job, you must also set the `data_type` attribute to `json` and
0 commit comments