JSON File Connector for PowerShellIn this article you will learn how to quickly and efficiently integrate JSON File data in PowerShell without coding. We will use high-performance JSON File Connector to easily connect to JSON File and then access the data inside PowerShell. JSON File Connector can be used to extract and output JSON data stored in local files or direct JSON String (variables or DB columns). JSON Connector also supports JSONPath to filter data from nested array/sub-documents. This Connector is optimized to work with very large files. Let's follow the steps below to see how we can accomplish that! JSON File Connector for PowerShell is based on ZappySys JSON Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to JSON File in other apps
|
Create ODBC Data Source (DSN) based on ZappySys JSON Driver
Step-by-step instructions
To get data from JSON File using PowerShell we first need to create a DSN (Data Source) which will access data from JSON File. We will later be able to read data using PowerShell. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys JSON Driver
ZappySys JSON Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
You can use pass single file or multiple file path using wildcard pattern in path and you can use select single file by clicking [...] path button or multiple file using wildcard pattern in path.
Note: If you want to operation with multiple files then use wild card pattern as below (when you use wild card pattern in source path then system will treat target path as folder regardless you end with slash) C:\SSIS\Test\reponse.json (will read only single reponse.json file) C:\SSIS\Test\j*.json (all files starting with file name) C:\SSIS\Test\*.json (all files with .json Extension and located under folder subfolder)
-
Now enter JSONPath expression in Array Filter textbox to extract only specific part of JSON file as below ($.value[*] will get content of value attribute from JSON document. Value attribute is array of JSON documents so we have to use [*] to indicate we want all records of that array)
NOTE: Here, We are using our desired filter, but you need to select your desired filter based on your requirement.
Click on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.$.value[*] -
Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
-
Click OK to finish creating the data source
-
That's it; we are done. In a few clicks we configured the call to JSON File using ZappySys JSON File Connector
Video instructions
Read JSON File data in PowerShell
Sometimes, you need to quickly access and work with your JSON File data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:
Viewing data in a terminal- Quickly peek at JSON File data
- Monitor data constantly in your console
- Export data to a CSV file so that it can be sliced and diced in Excel
- Export data to a JSON file so that it can ingested by other processes
- Export data to an HTML file for user-friendly view and easy sharing
- Create a schedule to make it an automatic process
- Store data internally for analysis or for further ETL processes
- Create a schedule to make it an automatic process
- Integrate data with other systems via external APIs
In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!
Reading individual fields
- Open your favorite PowerShell IDE (we are using Visual Studio Code).
-
Then simply follow these instructions:
"DSN=JsonFileDSN"
For your convenience, here is the whole PowerShell script:
# Configure connection string and query $connectionString = "DSN=JsonFileDSN" $query = "SELECT * FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab $format = "{0}`t{1}`t{2}`t{3}" # Display data in the console foreach ($row in $table.Rows) { # Construct line based on the format and individual JSON File fields $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"]) Write-Host $line }
Access specific JSON File table field using this code snippet:
You will find more info on how to manipulate$field = $row["ColumnName"]
DataTable.Rows
property in Microsoft .NET reference.For demonstration purposes we are using sample tables which may not be available in JSON File. -
To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:
You can also use even a simpler command inside the terminal, e.g.:
. 'C:\Users\john\Documents\dsn.ps1'
Retrieving all fields
However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:

Again, for your convenience, here is the whole PowerShell script:
# Configure connection string and query
$connectionString = "DSN=JsonFileDSN"
$query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Display data in the console
foreach ($row in $table.Rows) {
$line = ""
foreach ($column in $table.Columns) {
$value = $row[$column.ColumnName]
# Let's handle NULL values
if ($value -is [DBNull])
{
$value = "(NULL)"
}
$line += $value + "`t"
}
Write-Host $line
}
LIMIT
keyword in the query, e.g.:
SELECT * FROM Customers LIMIT 10
Using a full ODBC connection string
In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:
-
Open ODBC data source configuration and click Copy settings:
ZappySys JSON Driver - JSON FileJSON File Connector can be used to extract and output JSON data stored in local files or direct JSON String (variables or DB columns). JSON Connector also supports JSONPath to filter data from nested array/sub-documents. This Connector is optimized to work with very large files.JsonFileDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then just paste the connection string into your script:
- You are good to go! The script will execute the same way as using a DSN.
Write JSON File data to a file in PowerShell
Save data to a CSV file
Export data to a CSV file so that it can be sliced and diced in Excel:
# Configure connection string and query
$connectionString = "DSN=JsonFileDSN"
$query = "SELECT * FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Export table data to a file
$table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force
Save data to a JSON file
Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force
Save data to an HTML file
Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force
ConvertTo-Csv
, ConvertTo-Json
, and ConvertTo-Html
for other data manipulation scenarios.
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([LINKED_SERVER_TO_JSON_FILE_IN_DATA_GATEWAY], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([LINKED_SERVER_TO_JSON_FILE_IN_DATA_GATEWAY], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Conclusion
In this article we showed you how to connect to JSON File in PowerShell and integrate data without any coding, saving you time and effort. We encourage you to download JSON File Connector for PowerShell and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download JSON File Connector for PowerShell Documentation
More integrations
Other connectors for PowerShell
Other application integration scenarios for JSON File
How to connect JSON File in PowerShell?
How to get JSON File data in PowerShell?
How to read JSON File data in PowerShell?
How to load JSON File data in PowerShell?
How to import JSON File data in PowerShell?
How to pull JSON File data in PowerShell?
How to push data to JSON File in PowerShell?
How to write data to JSON File in PowerShell?
How to POST data to JSON File in PowerShell?
Call JSON File API in PowerShell
Consume JSON File API in PowerShell
JSON File PowerShell Automate
JSON File PowerShell Integration
Integration JSON File in PowerShell
Consume real-time JSON File data in PowerShell
Consume real-time JSON File API data in PowerShell
JSON File ODBC Driver | ODBC Driver for JSON File | ODBC JSON File Driver | SSIS JSON File Source | SSIS JSON File Destination
Connect JSON File in PowerShell
Load JSON File in PowerShell
Load JSON File data in PowerShell
Read JSON File data in PowerShell
JSON File API Call in PowerShell