We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Replicate OData Services from PowerShell
Write a quick PowerShell script to query OData services. Use connectivity to the live data to replicate OData services to SQL Server.
The CData ODBC Driver for OData enables out-of-the-box integration with Microsoft's built-in support for ODBC. The ODBC driver instantly integrates connectivity to the real OData services with PowerShell.
You can use the .NET Framework Provider for ODBC built into PowerShell to quickly automate integration tasks like replicating OData services to other databases. This article shows how to replicate OData services to SQL Server in 5 lines of code.
You can also write PowerShell code to execute create, read, update, and delete (CRUD) operations. See the examples below.
About OData Data Integration
CData simplifies access and integration of live OData services data. Our customers leverage CData connectivity to:
- Access OData versions 2.0, 3.0, and 4.0, working with legacy services and the latest features and capabilities.
- Leverage advanced query options, including $filter, $select, and $expand, enhancing data retrieval from 3rd party tools.
- Use Server-side execution of aggregation and grouping to minimize data transfer and boost performance.
- Authenticate securely using a variety of schemes, including Azure AD, digest, negotiate, NTLM, OAuth, and more means secure authentication with every connection.
- Use SQL stored procedures to manage OData service entities - listing, creating, and removing associations between entities.
Customers use CData's solutions to regularly integrate their OData services with preferred tools, such as Power BI, MicroStrategy, or Tableau, and to replicate data from OData services to their databases or data warehouses.
Getting Started
Create an ODBC Data Source for OData
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
The User and Password properties, under the Authentication section, must be set to valid OData user credentials. In addition, you will need to specify a URL to a valid OData server organization root or OData services file.
Connect to OData
The code below shows how to use the DSN to initialize the connection to OData services in PowerShell:
$conn = New-Object System.Data.Odbc.OdbcConnection
$conn.ConnectionString = "DSN=CData OData Source x64"
Back Up OData Services to SQL Server
After you enable caching, you can use the code below to replicate data to SQL Server.
Set the following connection properties to configure the caching database:
CacheProvider: The name of the ADO.NET provider. This can be found in the Machine.config for your version of .NET. For example, to configure SQL Server, enter System.Data.SqlClient.
CacheConnection: The connection string of properties required to connect to the database. Below is an example for SQL Server:
Server=localhost;Database=RSB;User Id=sqltest;Password=sqltest;
The SQL query in the example can be used to refresh the entire cached table, including its schema. Any already existing cache is deleted.
$conn.Open()
# Create and execute the SQL Query
$SQL = "CACHE DROP EXISTING SELECT * FROM " + $Orders
$cmd = New-Object System.Data.Odbc.OdbcCommand($sql,$conn)
$count = $cmd.ExecuteNonQuery()
$conn.Close()
The driver gives you complete control over the caching functionality. See the help documentation for more caching commands and usage examples. See the help documentation for steps to replicate to other databases.
Other Operations
To retrieve OData services in PowerShell, call the Fill method of the OdbcDataAdapter method. To execute data manipulation commands, initialize the OdbcCommand object and then call ExecuteNonQuery. Below are some more examples CRUD commands to OData through the .NET Framework Provider for ODBC:
Retrieve OData Services
$sql="SELECT OrderName, Freight from Orders"
$da= New-Object System.Data.Odbc.OdbcDataAdapter($sql, $conn)
$dt= New-Object System.Data.DataTable
$da.Fill($dt)
$dt.Rows | foreach {
$dt.Columns | foreach ($col in dt{
Write-Host $1[$_]
}
}
Update OData Services
$cmd = New-Object System.Data.Odbc.OdbcCommand("UPDATE Orders SET ShipCity='New York' WHERE Id = @myId", $conn)
$cmd.Parameters.Add(new System.Data.Odbc.OdbcParameter("myId","001d000000YBRseAAH")
$cmd.ExecuteNonQuery()
Insert OData Services
$cmd = New-Object System.Data.Odbc.OdbcCommand("INSERT INTO Orders SET ShipCity='New York' WHERE Id = @myId", $conn)
$cmd.Parameters.Add(new System.Data.Odbc.OdbcParameter("myId","001d000000YBRseAAH")
$cmd.ExecuteNonQuery()
Delete OData Services
$cmd = New-Object System.Data.Odbc.OdbcCommand("DELETE FROM Orders WHERE Id = @myid", $conn)
$cmd.Parameters.Add(new System.Data.Odbc.OdbcParameter("myId","001d000000YBRseAAH")
$cmd.ExecuteNonQuery()