Cosmos DB Connector
Documentation
Version: 2
Documentation
Endpoint

Get List of Databases


Name

get_databases

Description

Gets a list of the databases in the current database account. [API reference]

Related Tables

SysDatabases

Parameters

Parameter Label Required Options Description
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
Id DT_WSTR nvarchar(255) 255 False The unique name that identifies the collection.
ResourceId DT_WSTR nvarchar(2000) 2000 False System generated property. The resource ID is a unique identifier that is also hierarchical per the resource stack on the resource model. It is used internally for placement and navigation of the permission resource.
LastUpdated DT_I4 int False System generated property. Specifies the last updated timestamp of the resource.
ETag DT_WSTR nvarchar(4000) 4000 False System generated property representing the resource etag required for optimistic concurrency control.
Collections DT_WSTR nvarchar(4000) 4000 False
Users DT_WSTR nvarchar(4000) 4000 False
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 SysDatabases table using API Destination

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

Cosmos DB
SysDatabases
Select
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get list of databases

SELECT * FROM get_databases

List Databases

Lists all databases for specified Cosmos DB Account

SELECT * FROM SysDatabases

get_databases endpoint belongs to SysDatabases 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 list of databases

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_databases';

EXEC (@MyQuery) AT [LS_TO_COSMOS_DB_IN_GATEWAY];

List Databases

Lists all databases for specified Cosmos DB Account

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM SysDatabases';

EXEC (@MyQuery) AT [LS_TO_COSMOS_DB_IN_GATEWAY];

get_databases endpoint belongs to SysDatabases table(s), and can therefore be used via those table(s).