SQL Server guide

Read data using COQL (Native SQL)


Executes a COQL (CRM Object Query Language) query to retrieve data. This example demonstrates using the get_module_data_coql endpoint to run a server-side query, which can be more efficient than client-side filtering. Note that COQL queries have a limit of 200 rows.

Standard SQL query example

This is the base query accepted by the connector. To execute it in SQL Server, you have to pass it to the Data Gateway via a Linked Server. See how to accomplish this using the examples below.

SELECT * from get_module_data_coql WITH(sql_query= 'select Last_Name, First_Name, Company from Leads where Company like ''Test'' limit 200')

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_ZOHO_CRM_IN_GATEWAY], 'SELECT * from get_module_data_coql WITH(sql_query= ''select Last_Name, First_Name, Company from Leads where Company like ''''Test'''' limit 200'')')

Using EXEC in SQL Server (handling larger SQL text)

The major drawback of OPENQUERY is its inability to incorporate variables within SQL statements. This often leads to the use of cumbersome dynamic SQL (with numerous ticks and escape characters).

Fortunately, starting with SQL 2005 and onwards, you can utilize the EXEC (your_sql) AT [LS_TO_ZOHO_CRM_IN_GATEWAY] syntax.

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * from get_module_data_coql WITH(sql_query= ''select Last_Name, First_Name, Company from Leads where Company like ''''Test'''' limit 200'')'
EXEC (@MyQuery) AT [LS_TO_ZOHO_CRM_IN_GATEWAY]