# Basic Syntax of jq_schema

Today, while using LangChain to perform RAG processing on a JSON file's data, I encountered an unfamiliar parameter called jq_schema when using jsonLoader. jq_schema is the query syntax of the jq tool, and jq is a lightweight command-line tool and query language specifically designed for parsing, filtering, and transforming JSON data. Here, I will briefly document the common jq_schema syntax.

Basic Syntax

1. . (Root node): Selects the entire JSON data.

   {
     "name": "Alice",
     "age": 25
   }
   

   Expression: . Result:

   {
     "name": "Alice",
     "age": 25
   }
   

2. .key: Selects a specific key in an object. Expression: .name Result:

   "Alice"
   

3. .key1.key2: Selects a key in a nested object.

   {
     "user": {
       "name": "Alice",
       "details": {
         "age": 25
       }
     }
   }
   

   Expression: .user.details.age Result:

   25
   

4. .[]: Selects each element in an array.

   [1, 2, 3, 4]
   

   Expression: .[] Result:

   1
   2
   3
   4
   

5. .[index]: Selects a specific element in an array.

   [10, 20, 30, 40]
   

   Expression: .[1] Result:

   20
   

Advanced Syntax

1. Filtering and Conditions:

   • Select elements in an array that meet a condition: Expression: .[] | select(.id > 1) Result:

     [
       {"id": 1, "name": "Alice"},
       {"id": 2, "name": "Bob"},
       {"id": 3, "name": "Charlie"}
     ]
     

     {"id": 2, "name": "Bob"}
     {"id": 3, "name": "Charlie"}
     

2. Pipe Operator |:

   • Passes the output of one expression as the input to the next expression.

   {
     "users": [
       {"name": "Alice", "age": 25},
       {"name": "Bob", "age": 30}
     ]
   }
   

   Expression: .users[] | .name Result:

   "Alice"
   "Bob"
   

3. String Processing:

   {
     "message": "Hello, world!"
   }
   

   Expression: .message | ascii_upcase Result:

   "HELLO, WORLD!"
   

4. Computation and Mathematical Operations:

   [1, 2, 3, 4]
   

   Expression: map(. * 2) Result:

   [2, 4, 6, 8]
   

Case Analysis

1. Extracting multiple fields from a JSON object:

   {
     "user": {
       "name": "Alice",
       "age": 25,
       "location": "Wonderland"
     }
   }
   

   Expression: {name: .user.name, age: .user.age} Result:

   {
     "name": "Alice",
     "age": 25
   }
   

2. Extracting array elements into a specific format:

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

   Expression: .[] | "\(.id): \(.name)" Result:

   "1: Alice"
   "2: Bob"
   

Useful Functions

• length: Returns the length of an array or string.

  [1, 2, 3, 4, 5]
  

  Expression: length Result:

  5
  

• map: Applies an expression to each element in an array.

  [1, 2, 3]
  

  Expression: map(. * 2) Result:

  [2, 4, 6]
  

• has(key): Checks whether a key exists in an object.

  {"name": "Alice", "age": 25}
  

  Expression: has("age") Result: