Specifies how column names are qualified to ensure uniqueness in the generated schema.

Syntax

Connect-JSON -QualifyColumns string

Possible Values

Data Type

cstr

Default Value

"None"

Remarks

By default, the cmdlet qualifies column names only as much as necessary to make them unique. For example, given the following JSON document, the cmdlet produces the columns id (referring to the company id) and employee.id.

{
  "company": [
    {
      "id": "Smith Holdings", 
      "employee": [
        {"id": "George Smith"},
        {"id": "Mike Johnson"}
      ]
    }
  ]
}

When this option is set to Parent, the cmdlet uses a similar procedure to the one above. However, the cmdlet always qualifies columns by one level so that each includes its parent table name, even when the name is already unique. For example, the above document would generate the columns company.id and employee.id because both are unique when including their parent.

When this option is set to Full, the cmdlet qualifies all column names with their full JSON path, ensuring clarity about each column’s origin. This generates longer column names, but ensures that it is clear where each column name comes from within the document. For the example above, the cmdlet generates the columns json.company.id and json.company.employee.id.