struct-keys
Outputs all the keys in a structure as a file path
struct-keys
outputs all of the keys in a structured data-type eg JSON, YAML, TOML, etc.
The output is a JSON array of the keys with each value being a file path representation of the input structure’s node.
<stdin> -> struct-keys [ depth ] -> <stdout>
<stdin> -> struct-keys [ flags ] -> <stdout>
The source for these examples will be defined in the variable $example
:
» set json example={
"firstName": "John",
"lastName": "Smith",
"isAlive": true,
"age": 27,
"address": {
"streetAddress": "21 2nd Street",
"city": "New York",
"state": "NY",
"postalCode": "10021-3100"
},
"phoneNumbers": [
{
"type": "home",
"number": "212 555-1234"
},
{
"type": "office",
"number": "646 555-4567"
},
{
"type": "mobile",
"number": "123 456-7890"
}
],
"children": [],
"spouse": null
}
» $example -> struct-keys
[
"/lastName",
"/isAlive",
"/age",
"/address",
"/address/state",
"/address/postalCode",
"/address/streetAddress",
"/address/city",
"/phoneNumbers",
"/phoneNumbers/0",
"/phoneNumbers/0/type",
"/phoneNumbers/0/number",
"/phoneNumbers/1",
"/phoneNumbers/1/number",
"/phoneNumbers/1/type",
"/phoneNumbers/2",
"/phoneNumbers/2/type",
"/phoneNumbers/2/number",
"/children",
"/spouse",
"/firstName"
]
Defining max depth and changing the separator string:
» $example -> struct-keys --depth 1 --separator '.'
[
".children",
".spouse",
".firstName",
".lastName",
".isAlive",
".age",
".address",
".phoneNumbers"
]
An example of a unicode character being used as a separator:
» $example -> struct-keys --depth 2 --separator ☺
[
"☺age",
"☺address",
"☺address☺streetAddress",
"☺address☺city",
"☺address☺state",
"☺address☺postalCode",
"☺phoneNumbers",
"☺phoneNumbers☺0",
"☺phoneNumbers☺1",
"☺phoneNumbers☺2",
"☺children",
"☺spouse",
"☺firstName",
"☺lastName",
"☺isAlive"
]
Separator can also be multiple characters:
» $example -> struct-keys --depth 1 --separator '|||'
[
"|||firstName",
"|||lastName",
"|||isAlive",
"|||age",
"|||address",
"|||phoneNumbers",
"|||children",
"|||spouse"
]
--depth
How far to traverse inside the nested structure--separator
String to use as a separator between fields (defaults to /
)-d
Alias for --depth
-s
Alias for --separator
[ Index ]
: Outputs an element from an array, map or table[[ Element ]]
: Outputs an element from a nested structureformap
: Iterate through a map or other collection of dataset
: Define a local variable and set it’s valueThis document was generated from builtins/core/datatools/structkeys_doc.yaml.
This site's content is rebuilt automatically from murex's source code after each merge to the master
branch. Downloadable murex binaries are also built with the website.
Last built on Thu Aug 15 14:38:34 UTC 2024 against commit 50ed9d650ed9d6df391240d3c2c02e623636e508dfcdad1.
Current version is 6.2.4000 which has been verified against tests cases.