Read items from a list

Reads list items from any SharePoint list when you supply ListId. For a document library, each item corresponds to a file or folder row. Turn on metadata detection below if you need extra or hidden fields (e.g. Link field in Lists, Content Type Id, etc. which are not included by default in the standard endpoint).

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_list_items
WITH (
	  ListId='14bdfd1d-1090-4cfe-adc1-XXXXXXXXXXXXXX'
	 -- Turn on Metadata Detection to get additional fields (e.g. Link to item, Content Type Id, etc.) that are not included by default in the standard endpoint. This is especially useful for document libraries.
	 --,MetaDetectionOrder='MergeStaticDynamic' 
	)
--Obtain ListId from the Lists table or list_lists (e.g. SELECT id, name FROM Lists).

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY], 'SELECT * FROM get_list_items
WITH (
	  ListId=''14bdfd1d-1090-4cfe-adc1-XXXXXXXXXXXXXX''
	 -- Turn on Metadata Detection to get additional fields (e.g. Link to item, Content Type Id, etc.) that are not included by default in the standard endpoint. This is especially useful for document libraries.
	 --,MetaDetectionOrder=''MergeStaticDynamic'' 
	)
--Obtain ListId from the Lists table or list_lists (e.g. SELECT id, name FROM Lists).')

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_SHAREPOINT_ONLINE_IN_GATEWAY] syntax.

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_list_items
WITH (
	  ListId=''14bdfd1d-1090-4cfe-adc1-XXXXXXXXXXXXXX''
	 -- Turn on Metadata Detection to get additional fields (e.g. Link to item, Content Type Id, etc.) that are not included by default in the standard endpoint. This is especially useful for document libraries.
	 --,MetaDetectionOrder=''MergeStaticDynamic'' 
	)
--Obtain ListId from the Lists table or list_lists (e.g. SELECT id, name FROM Lists).'
EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY]