Skip to content

DOC-2901: Add example for loading data from nested JSON arrays in GSQ… #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Tushar-TG-14 wants to merge 1 commit into
base: 4.2
Choose a base branch
from
+40 −0
Open

DOC-2901: Add example for loading data from nested JSON arrays in GSQ… #326

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions modules/ddl-and-loading/partials/load-statement.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,46 @@ The JSON loader ignores the order and accesses the fields by the nested key name
| 3
|===

==== Loading data from a nested JSON array

You can extract values from arrays of objects in JSON using the same nested key syntax. When a field contains an array, the loader can iterate through each element in the array.

For example, consider the following JSON object:

[source,json]
----
{
"id": 1234,
"nested_object": {
"id": 2345,
"neighbors": [
{ "id": 1, "name": "foo" },
{ "id": 2, "name": "bar" },
{ "id": 3, "name": "baz" }
]
}
}
----

To load each neighbor as a vertex, you can reference the array elements using the nested path:

[source,gsql]
----
CREATE VERTEX Person (PRIMARY_ID id INT, name STRING)
CREATE GRAPH example_graph (*)

CREATE LOADING JOB load_neighbors FOR GRAPH example_graph {
LOAD "data.jsonl" TO VERTEX Person
VALUES ($"nested_object":"neighbors":"id",
$"nested_object":"neighbors":"name")
USING JSON_FILE="true";
Comment on lines +428 to +431
Copy link
Copy Markdown

@adil-ainihaer adil-ainihaer Mar 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

LOAD "data.jsonl" TO TEMP_TABLE t(id, name)
  VALUES (flatten_json_array($"nested_object":"neighbors", $"id", $"name"))
  USING JSON_FILE="true";
LOAD TEMP_TABLE t TO VERTEX Person VALUES ($"id", $"name");

Reference: https://docs.tigergraph.com/gsql-ref/4.2/ddl-and-loading/functions/token/flatten_json_array#_flatten_a_json_array_of_json_objects

}
----

In this example, the loader can process each object in the `neighbors` array and creates one vertex per element.

Each neighbor object is treated as an individual record during loading.

=== Loading Parquet data

TigerGraph can load data from Parquet files using our loader.
Expand Down