OData Connector for SQL Server

In this article you will learn how to integrate OData data in SQL Server without coding in just a few clicks (live / bi-directional connection to OData). OData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started..

Using OData Connector you will be able to connect, read, and write data from within SQL Server. Follow the steps below to see how we would accomplish that.

Download  Documentation 

Video Tutorial - Integrate OData data in SQL Server

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download / install required driver for OData integration in SQL Server
  • How to configure connection for OData
  • Features about API Driver (Authentication / Query Language / Examples / Driver UI)
  • Using OData Connection in SQL Server

Create Data Source in ZappySys Data Gateway based on ZappySys API Driver

  1. Download and install ZappySys ODBC PowerPack.

  2. Search for gateway in start menu and Open ZappySys Data Gateway:
    Open ZappySys Data Gateway

  3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
    ZappySys Data Gateway - Add User

  4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

    ODataDSN

    ZappySys Data Gateway - Add Data Source

  5. When the Configuration window appears give your data source a name if you haven't done that already, then select "OData" from the list of Popular Connectors. If "OData" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    ODataDSN
    OData
    ODBC DSN Template Selection

  6. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    OData
    No Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    IgnoreSSLCertificateErrors Fill in the parameter...
    SslVersion Fill in the parameter...
    ODBC DSN HTTP Connection Configuration

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    OData
    Windows Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    ODBC DSN HTTP Connection Configuration

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    OData
    Basic Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    UserName Fill in the parameter...
    Password Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    IgnoreSSLCertificateErrors Fill in the parameter...
    SslVersion Fill in the parameter...
    ODBC DSN HTTP Connection Configuration

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    OData
    NTLM Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    UserName (i.e. Domain\UserName) Fill in the parameter...
    Password Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    IgnoreSSLCertificateErrors Fill in the parameter...
    SslVersion Fill in the parameter...
    ODBC DSN HTTP Connection Configuration

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    OData
    Token Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Token Fill in the parameter...
    Optional Parameters
    AuthScheme Fill in the parameter...
    AuthHeader Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    IgnoreSSLCertificateErrors Fill in the parameter...
    SslVersion Fill in the parameter...
    ODBC DSN HTTP Connection Configuration

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    OData
    OAuth Connection for OData API [OAuth]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    GrantType Fill in the parameter...
    OAuthVersion Fill in the parameter...
    ClientId Fill in the parameter...
    ClientSecret Fill in the parameter...
    UserName Fill in the parameter...
    Password Fill in the parameter...
    Scope Fill in the parameter...
    AuthUrl Fill in the parameter...
    TokenUrl Fill in the parameter...
    ReturnUrl Fill in the parameter...
    ExtraAttributesForTokenRequest Fill in the parameter...
    ExtraAttributesForAuthRequest Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    IgnoreSSLCertificateErrors Fill in the parameter...
    SslVersion Fill in the parameter...
    ODBC DSN Oauth Connection Configuration

  7. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
    ODBC ZappySys Data Source Preview

  8. Click OK to finish creating the data source.

Read data in SQL Server from the ZappySys Data Gateway

  1. To read the data in SQL Server the first thing you have to do is create a Linked Server. Go to SQL Server Management Studio and configure it in a similar way:
    SSMS SQL Server Configure Linked Server

  2. Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:
    SSMS SQL Server Configure Linked Server User Name

  3. Optional: Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).

    RPC and MSDTC Settings

    You need to enable RPC Out if you plan to use EXEC(...) AT [MY_LINKED_SERVER_NAME] rather than OPENQUERY.
    If don't enabled it, you will encounter the Server 'MY_LINKED_SERVER_NAME' is not configured for RPC error.

    Query Example:

    EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]


    If you plan to use 'INSERT INTO...EXEC(....) AT [MY_LINKED_SERVER_NAME]' in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
    If don't disabled it, you will encounter the The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction. error.

    Query Example:

    Insert Into dbo.Products
     EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
    


  4. Finally, open a new query and execute a query we saved in one of the previous steps:

    SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Products');

    SSMS SQL Server Query Data Results

Create Linked Server using Code

In previous section you saw how to create a Linked Server from UI. You can do similar action by code too (see below). Run below script after changing necessary parameters. Assuming your Data Source name on ZappySys Data Gateway UI is 'ODataDSN'

    USE [master]
    GO
    --///////////////////////////////////////////////////////////////////////////////////////
    --Run below code in SSMS to create Linked Server and use ZappySys Drivers in SQL Server
    --///////////////////////////////////////////////////////////////////////////////////////

    //Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
    //Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server
    //Replace Port 5000 if you configured gateway on a different port


    --1. Configure your gateway service as per this article https://zappysys.com/links?id=10036
    
    --2. Make sure you have SQL Server Installed. You can download FREE SQL Server Express Edition from here if you dont want to buy Paid version https://www.microsoft.com/en-us/sql-server/sql-server-editions-express

    --Uncomment below if you like to drop linked server if it already exists
    --EXEC master.dbo.sp_dropserver @server=N'LS_ODataDSN', @droplogins='droplogins'

    --3. Create new linked server
    
    EXEC master.dbo.sp_addlinkedserver
      @server = N'LS_ODataDSN'  --Linked server name (this will be used in OPENQUERY sql
    , @srvproduct=N''
    , @provider=N'SQLNCLI11'
    , @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
    , @provstr=N'Network Library=DBMSSOCN;'
    , @catalog=N'ODataDSN' --Data source name you gave on Gateway service settings

    --4. Attach gateway login with linked server

    EXEC master.dbo.sp_addlinkedsrvlogin
      @rmtsrvname=N'LS_ODataDSN'  --linked server name
    , @useself=N'False'
    , @locallogin=NULL
    , @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
    , @rmtpassword='YOUR_GATEWAY_PASSWORD'  --enter your Gateway user's password
    GO

    --5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
    EXEC sp_serveroption 'LS_ODataDSN', 'rpc', true;
    EXEC sp_serveroption 'LS_ODataDSN', 'rpc out', true;

    --Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
    EXEC sp_serveroption 'LS_ODataDSN', 'remote proc transaction promotion', false;
    
    --Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
    --EXEC sp_serveroption 'LS_ODataDSN', 'query timeout', 1200;
    GO

Firewall settings

So far we have assumed that Gateway is running on the same machine as SQL Server. However there will be a case when ZappySys ODBC PowerPack is installed on a different machine than SQL Server. In such case you may have to perform additional Firewall configurations. On most computers firewall settings wont allow outside traffic to ZappySys Data Gateway. In such case perform following steps to allow other machines to connect to Gateway.

Method-1 (Preferred)

If you are using newer version of ZappySys Data Gateway then adding firewall rule is just a single click.

  1. Search for gateway in start menu and open ZappySys Data Gateway.
  2. Go to Firewall Tab and click Add Firewall Rule button like below. This will create Firewall rule to all Inbound Traffic on Port 5000 (Unless you changed it). Allow Inbound Traffic - Add Firewall Rule for ZappySys Data Gateway

Method-2 Here is another way to add / edit Inbound Traffic rule in windows firewall. Use below method if you choose to customize your rule (for advanced users).
  1. Search for Windows Firewall Advanced Security in start menu.
  2. Under Inbound Rules > Right click and click [New Rule] >> Click Next
  3. Select Port on Rule Type >> Click Next
  4. Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
  5. Select Profile (i.e. Private, Public) >> Click Next
  6. Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
  7. Click OK to save the rule
SQL Server Firewall Allow Inbound Data Gateway

OPENQUERY vs EXEC (handling larger SQL text)

So far we have seen examples of using OPENQUERY. It allows us to send pass-through query at remote server. The biggest limitation of OPENQUERY is it doesn't allow you to use variables inside SQL so often we have to use unpleasant looking dynamic SQL (Lots of tick, tick …. and escape hell). Well there is good news. With SQL 2005 and later you can use EXEC(your_sql) AT your_linked_server syntax . Disadvantage of EXEC AT is you cannot do SELECT INTO like OPENQUERY. Also you cannot perform JOIN like below in EXEC AT


    SELECT a.* FROM OPENQUERY([ls_ODataDSN],'select * from Customers') a
    JOIN OPENQUERY([ls_ODataDSN],'select * from Orders') b ON a.CustomerId=b.CustomerId;

However you can always do INSERT INTO SomeTable EXEC(…) AT your_linked_server. So table must exists when you do that way. Here is how to use it. To use EXEC(..) AT {linked-server} you must turn on RPC OUT option. Notice how we used variable in SQL to make it dynamic. This is much cleaner than previous approach we saw.

    USE [master]
    GO
    --Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
    --Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server

    --Create new linked server
    EXEC master.dbo.sp_addlinkedserver
      @server = N'LS_ODataDSN'  --Linked server name (this will be used in OPENQUERY sql)
    , @srvproduct=N''
    , @provider=N'SQLNCLI11'
    , @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
    , @provstr=N'Network Library=DBMSSOCN;'
    , @catalog=N'ODataDSN' --Data source name you gave on Gateway service settings

    --Attach gateway login with linked server
    EXEC master.dbo.sp_addlinkedsrvlogin
      @rmtsrvname=N'LS_ODataDSN'  --linked server name
    , @useself=N'False'
    , @locallogin=NULL
    , @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
    , @rmtpassword='YOUR_GATEWAY_PASSWORD'  --enter your Gateway user's password
    GO

    --5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
    EXEC sp_serveroption 'LS_ODataDSN', 'rpc', true;
    EXEC sp_serveroption 'LS_ODataDSN', 'rpc out', true;
    --Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
    EXEC sp_serveroption 'LS_ODataDSN', 'remote proc transaction promotion', false;
    --Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
    --EXEC sp_serveroption 'LS_ODataDSN', 'query timeout', 1200;
    GO

Here is the difference between OPENQUERY vs EXEC approaches: OPENQUERY vs EXEC

Fetching Tables / Columns using metadata stored procs

ZappySys Data Gateway emulates certains system procs you might find in real SQL Server. You can call using below syntax using 4-Parts syntax
exec [linked-server-name].[gateway-datasource-name].[DATA].sp_tables
exec [linked-server-name].[gateway-datasource-name].[DATA].sp_columns_90 N'your-table-name'
Example:

    //List all tables
    exec [ls_ODataDSN].[ODataDSN].[DATA].sp_tables

    //List all columns and its type for specified table
    exec [ls_ODataDSN].[ODataDSN].[DATA].sp_columns_90 N'Account'

Known Issues

Let's explore some common problems that can occur when using OPENQUERY or Data Gateway connectivity.


Error: The data is invalid

There will be a time when, you may encounter unexpected errors like the ones listed below. These can include:

OLE DB provider "SQLNCLI11" for linked server "Zs_Csv" returned message "Deferred prepare could not be completed.".
OLE DB provider "SQLNCLI11" for linked server "Zs_Csv" returned message "Communication link failure".
Msg 13, Level 16, State 1, Line 0

Session Provider: The data is invalid.
Possible Cause:

There are few reasons for such error but below are two main reasons

  • If the query length exceeds 2000 characters, as shown below, you might encounter this error.

    SELECT * FROM OPENQUERY(LS, '--some really long text more than 2000 chars--')
  • If a query contains multiple OPENQUERY statements for JOINs or UNIONs, as shown below, it might fail due to a MARS compatibility issue where the gateway doesn't support parallel queries on a single connection.

    SELECT a.id, b.name from OPENQUERY(LS, 'select * from tbl1') a join OPENQUERY(LS, 'select * from tbl2') b on a.id=b.id
Possible Fix:

There are few ways to fix above error based on reason why you getting this error (i.e. Query Length issue OR JOIN/UNION in the same statement)

  • If your query has long SQL (more than 2000 chars ) then reduce SQL length using different techniques
    • e.g. use SELECT * FROM MyTable rather than SELECT col1,col2… FROM MyTable
    • Use Meta Option in WITH clause if you must use column name. (e.g. SELECT * FROM MyTable WITH(META=’c:\meta.txt’) this way you can define column in Meta file rather than SELECT query. Check this article
    • Consider using EXECT (….) AT [Linked_Server_name] option rather than OPENQUERY so you can use very long SQL (See next section on EXEC..AT usecase)
    • Consider using Virtual Table / Stored Proc to wrap long SQL so your call is very small (where usp_GetOrdersByYear is custom proc created on ZappySys Driver UI)
      SELECT * FROM OPENQUERY(LS, 'EXEC usp_GetOrdersByYear 2021')
  • If your query uses JOIN  / UNION with multiple OPENQUERY in same SQL then use multiple Linked servers (one for each OPENQUERY clause) as below.
    select a.id, b.name from OPENQUERY(LS_1, 'select * from tbl1') a join OPENQUERY(LS_2, 'select * from tbl2') b on a.id=b.id

Error: Unable to begin a distributed transaction (When INSERT + EXEC used)

If you try to use the EXEC statement to insert data into a table, as shown below, you might encounter the following error unless the MSDTC option is turned off.

INSERT INTO MyTable EXEC('select * from tbl') AT MyLinkedServer
"Protocol error in TDS stream"
The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "ls_Json2" was unable to begin a distributed transaction.
--OR--
The operation could not be performed because OLE DB provider "MSOLEDBSQL" for linked server "ls_Json" was unable to begin a distributed transaction.

Solution:
Method-1: Go to linked server properties | Server Options | Enable Promotion of Distributed Transaction | Change to false (Default is true)
Now your try your INSERT with EXEC AT and it should work

Method-2: Run the below command if you dont want to use UI

EXEC master.dbo.sp_serveroption @server=N'My_Linked_Server', @optname=N'remote proc transaction promotion', @optvalue=N'false'

Error: Cannot use OPENQUERY with JOIN / UNION

When you perform a JOIN or UNION ALL on the same Linked Server, it may fail to process sometimes because the Data Gateway doesn't support parallel query requests on the same connection. A workaround for that would be to create multiple linked servers for the same data source. Refer to the section above for the same workaround.


Error: Truncation errors due to data length mismatch

Many times, you may encounter truncation errors if a table column's length is less than the actual column size from the query column. To solve this issue, use the new version of Data Gateway and check the 'Use nvarchar(max) for string options' option found on the General Tab.


Performance Tips

Now, let's look at a few performance tips in this section.


Use INSERT INTO rather than SELECT INTO to avoid extra META request

We discussed some Pros and Cons of OPENQUERY vs EXEC (…) AT in previous section. One obvious advantage of EXEC (….) AT is it reduces number of requests to driver (It sends pass through query). With EXEC you cannot load data dynamically like SELECT INTO tmp FROM OPENQUERY. Table must exist before hand if you use EXEC.


INSERT INTO tmp_API_Report_Load(col1,col2)
EXEC('select col1,col2 from some_api_table') AT [API-LINKED-SERVER]
--OR--
INSERT INTO tmp_API_Report_Load(col1,col2)
select col1,col2 from OPENQUERY([API-LINKED-SERVER], 'select col1,col2 from some_api_table')

The advantage of this method is that your query speed will increase because the system only calls the API once when you use EXEC AT. In contrast, with OPENROWSET, the query needs to be called twice: once to obtain metadata and once to retrieve the data.


Use Cached Metadata if possible

By default, most SQL queries sent to the Data Gateway need to invoke two phases: first, to get metadata, and second, to fetch data. However, you can bypass the metadata API call by supplying static metadata. Use the META property in the WITH clause, as explained in this article, to speed up your SQL queries.

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

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. 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>';
    

    ZappySys Driver - Create Custom Stored Procedure

  4. 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';

    ZappySys Driver - Execute Custom Stored Procedure

  5. 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([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

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.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. 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'

    ZappySys Driver - Create Custom Table

  5. 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"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. 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([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Conclusion

In this article we discussed how to connect to OData in SQL Server and integrate data without any coding. Click here to Download OData Connector for SQL Server and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download OData Connector for SQL Server Documentation 

Actions supported by OData Connector

OData Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 List Tables (JSON API)
   [Read more...]
 List Tables (XML API)
   [Read more...]
 Generic Read Data (JSON API)
   [Read more...]
Parameter Description
TableName Read data from specified module (Json Format API)
 Generic Read Data (XML API)
   [Read more...]
Parameter Description
TableName Read data from specified module (Xml Format API)
 Read [$parent.name$]
   [Read more...]
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

OData Connector Examples for SQL Server Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Read all records from an JSON OData Service Table    [Read more...]

SELECT * FROM Customers

Read all records from an XML OData Service Table    [Read more...]

SELECT * FROM read_data_xml WITH(TableName='MyTable')

Filter records using server side criteria    [Read more...]

SELECT * FROM Customers WITH( SearchCriteria='Country -eq ''USA'' ')

Filter records using client side criteria    [Read more...]

SELECT * FROM Customers WHERE Country = 'USA'

List all Tables (JSON Based Format)    [Read more...]

SELECT * FROM list_tables_json

List all Tables (XML Based Format)    [Read more...]

SELECT * FROM list_tables_xml

Other App Integration scenarios for OData

Other Connectors for SQL Server


Download OData Connector for SQL Server Documentation 

  • How to connect OData in SQL Server?

  • How to get OData data in SQL Server?

  • How to read OData data in SQL Server?

  • How to load OData data in SQL Server?

  • How to import OData data in SQL Server?

  • How to pull OData data in SQL Server?

  • How to push data to OData in SQL Server?

  • How to write data to OData in SQL Server?

  • How to POST data to OData in SQL Server?

  • Call OData API in SQL Server

  • Consume OData API in SQL Server

  • OData SQL Server Automate

  • OData SQL Server Integration

  • Integration OData in SQL Server

  • Consume real-time OData data in SQL Server

  • Consume real-time OData API data in SQL Server

  • OData ODBC Driver | ODBC Driver for OData | ODBC OData Driver | SSIS OData Source | SSIS OData Destination

  • Connect OData in SQL Server

  • Load OData in SQL Server

  • Load OData data in SQL Server

  • Read OData data in SQL Server

  • OData API Call in SQL Server