Endpoint

Get All Documents for a Table

Name

get_documents

Description

Gets all documents for a Table. [API reference]

Related Tables

[Dynamic Table]

Parameters

Parameter	Label	Required	Description
Table	Table Name (Case-Sensitive)	YES
Database	Database Name (keep blank to use default) Case-Sensitive	NO	Leave blank to use default DB set on connection screen
MaxItemCount	Max Rows Per Page (Adjust for Speed)	NO	An integer indicating the maximum number of items to be returned per page.

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

If the column you are looking for is missing, consider customizing Cosmos DB Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Cosmos DB Connector in API Source component to read data or in API Destination component to read/write data:

Read from [Dynamic Table] table using API Destination

This Endpoint belongs to [Dynamic Table] table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Cosmos DB

[Dynamic Table]

Select

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get all documents for a table

SELECT * FROM get_documents
WITH
(
    "Table" = 'abcd-1234-table'
)

get_documents endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get all documents for a table

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_documents
WITH
(
    "Table" = ''abcd-1234-table''
)';

EXEC (@MyQuery) AT [LS_TO_COSMOS_DB_IN_GATEWAY];

get_documents endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).