SQL Server guide

Read data using Native COQL Pass-through (#DirectSql)


Runs a native Zoho CRM COQL query directly by using the #DirectSql prefix. This sends the query to Zoho as server-side COQL without using an endpoint call such as SELECT * FROM get_module_data_coql WITH(...).

Use this option when you want to paste or write a full COQL statement directly in your SQL tool. This is useful for quick testing, troubleshooting, or when you prefer native Zoho COQL syntax.

Note: The #DirectSql prefix applies only to the query where it is used. It does not change the connection-wide SQL engine mode.

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.

#DirectSql
	select Last_Name, First_Name, Email, Company
	from Leads
	where Country = 'United States'
	order by id desc

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_ZOHO_CRM_IN_GATEWAY], '#DirectSql
	select Last_Name, First_Name, Email, Company
	from Leads
	where Country = ''United States''
	order by id desc')

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) = '#DirectSql
	select Last_Name, First_Name, Email, Company
	from Leads
	where Country = ''United States''
	order by id desc'
EXEC (@MyQuery) AT [LS_TO_ZOHO_CRM_IN_GATEWAY]