Cmdlets for JSON

Build 24.0.9060

QualifyColumns Parameter (Connect-JSON Cmdlet)

Controls whether the provider will use relative column names.

Syntax

Connect-JSON -QualifyColumns string

Possible Values

None, Parent, Full

Data Type

cstr

Default Value

"None"

Remarks

By default the cmdlet will only qualify a column name as much as is necessary to make it unique. For example, in this document the cmdlet will produce 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 will always qualify columns by one level so that their table name is included, even if the column name is 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 will qualify all column names with their full XPath. 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 would generate the columns json.company.id and json.company.employee.id.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060