Skip to content

Add examples of @, ? and = JSound operators to tutorial 6 #2

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
CaiJimmy wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add examples of @, ? and = JSound operators to tutorial 6 #2

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a820ed
Add usage of @, ? and = JSound operators in Tutorial 6
CaiJimmy Dec 2, 2025
d3c839b
Disable setLaxJSONNullValidation for nullable value example of JSound
CaiJimmy Dec 3, 2025
674546c
Specify that @ works inside an array only
CaiJimmy Dec 3, 2025
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
139 changes: 138 additions & 1 deletion JSONiq-tutorial-6.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -759,12 +759,149 @@
"return $my-date.da + $my-date.du"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"We can also use `@` to impose primary key restriction for objects inside an array.\n",
"\n",
"For example, the following object will not pass schema validation, because the primary key `id` is duplicated."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
"source": [
"%%jsoniq\n",
"declare type students as {\n",
" \"students\": [\n",
" {\n",
" \"@id\": \"integer\",\n",
" \"name\": \"string\",\n",
" \"age\": \"integer\"\n",
" }\n",
" ]\n",
"};\n",
"\n",
"let $my-student := validate type students {\n",
"{\n",
" \"students\": [\n",
" {\n",
" \"id\" : 1,\n",
" \"name\" : \"John Doe\",\n",
" \"age\" : 21\n",
" },\n",
" {\n",
" \"id\" : 1,\n",
" \"name\" : \"Jane Doe\",\n",
" \"age\" : 22\n",
" }\n",
" ]\n",
"}\n",
"}\n",
"return $my-student"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Or use `?` to allow a nullable field. The following object will not pass schema validation because the field `age` is null in the first student. By default, JSONiq considers JSON null values in an object as absent for validation against an optional key. The following cell will first disable this behavior, and then perform the validation.\n",
"\n",
"Try adding `?` after `age` in the schema definition to allow null values (`age` --> `age?`)."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"from jsoniq import RumbleSession\n",
"rumble = RumbleSession.builder.getOrCreate();\n",
"conf = rumble.getRumbleConf()\n",
"conf.setLaxJSONNullValidation(False) # Disable lax validation for JSON nulls"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"%%jsoniq\n",
"declare type students as {\n",
" \"students\": [\n",
" {\n",
" \"@id\": \"integer\",\n",
" \"name\": \"string\",\n",
" \"age\": \"integer\"\n",
" }\n",
" ]\n",
"};\n",
"\n",
"let $my-student := validate type students {\n",
"{\n",
" \"students\": [\n",
" {\n",
" \"id\" : 1,\n",
" \"name\" : \"John Doe\",\n",
" \"age\" : null\n",
" },\n",
" {\n",
" \"id\" : 2,\n",
" \"name\" : \"Jane Doe\",\n",
" \"age\" : 22\n",
" }\n",
" ]\n",
"}\n",
"}\n",
"return $my-student"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Lastly, `=` allows to define default values for missing fields. For example, the following schema definition will assign a default value of 18 to the field `age` if it is missing in a student object. "
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"%%jsoniq\n",
"declare type students as {\n",
" \"students\": [\n",
" {\n",
" \"@id\": \"integer\",\n",
" \"name\": \"string\",\n",
" \"age\": \"integer=18\"\n",
" }\n",
" ]\n",
"};\n",
"\n",
"let $my-student := validate type students {\n",
"{\n",
" \"students\": [\n",
" {\n",
" \"id\" : 1,\n",
" \"name\" : \"John Doe\"\n",
" },\n",
" {\n",
" \"id\" : 2,\n",
" \"name\" : \"Jane Doe\",\n",
" \"age\" : 22\n",
" }\n",
" ]\n",
"}\n",
"}\n",
"return $my-student"
]
},
{
"cell_type": "markdown",
Expand Down