JSON Extension

JSON (JavaScript Object Notation) is a widely used data format for web APIs and data exchange. NeuG supports JSON file import functionality through the Extension framework. After loading the JSON Extension, users can directly load external JSON files using the LOAD FROM syntax.

Install Extension

INSTALL JSON;

Load Extension

LOAD JSON;

Using JSON Extension

LOAD FROM supports two JSON formats: JSON Array and JSONL (JSON Lines).

JSON Format Options

The following options control how JSON files are parsed:

Supported Formats

JSON Array Format

A JSON array contains multiple objects in a single array structure:

[
  {"id": 1, "name": "Alice", "age": 30},
  {"id": 2, "name": "Bob", "age": 25}
]

When newline_delimited is false (default), the system parses the entire file as a single JSON array.

JSONL Format (JSON Lines)

JSONL format contains one JSON object per line:

{"id": 1, "name": "Alice", "age": 30}
{"id": 2, "name": "Bob", "age": 25}

When newline_delimited is true, the system parses each line as a separate JSON object. This format is particularly efficient for large datasets as it enables streaming processing.

Query Examples

Basic JSON Array Loading

Load all columns from a JSON array file:

LOAD FROM "person.json"
RETURN *;

JSONL Format Loading

Load data from a JSONL file by specifying newline_delimited=true:

LOAD FROM "person.jsonl" (newline_delimited=true)
RETURN *;

Column Projection

Return only specific columns from JSON data:

LOAD FROM "person.jsonl" (newline_delimited=true)
RETURN fName, age;

Column Aliases

Use AS to assign aliases to columns:

LOAD FROM "person.jsonl" (newline_delimited=true)
RETURN fName AS name, age AS years;

Note: All relational operations supported by LOAD FROM — including type conversion, WHERE filtering, aggregation, sorting, and limiting — work the same way with JSON files. See the LOAD FROM reference for the complete list of operations.