Reference

Endpoint Get Database Information by Id or Name

Name

get_database

Description

Gets a database by its Id. [API reference]

Related Tables

SysDatabases

Parameters

Parameter	Required	Options
Name: Id Label: Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen	YES

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Description
Id	`DT_WSTR`	`nvarchar(255)`	255	The unique name that identifies the collection.
ResourceId	`DT_WSTR`	`nvarchar(2000)`	2000	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`		System generated property. Specifies the last updated timestamp of the resource.
ETag	`DT_WSTR`	`nvarchar(4000)`	4000	System generated property representing the resource etag required for optimistic concurrency control.
Collections	`DT_WSTR`	`nvarchar(4000)`	4000
Users	`DT_WSTR`	`nvarchar(4000)`	4000

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

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	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 or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the SysDatabases table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Cosmos DB

Connect to your Azure Cosmos DB databases to read, query, create, update, and delete documents and more!

Cosmos DB

SysDatabases

Required Parameters
Database Name (keep blank to use default) Case-Sensitive	Fill-in the parameter...

SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the SysDatabases table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get database information by id or name:

API Destination - Cosmos DB

Connect to your Azure Cosmos DB databases to read, query, create, update, and delete documents and more!

Cosmos DB

SysDatabases

Lookup

Required Parameters
Database Name (keep blank to use default) Case-Sensitive	Fill-in the parameter...

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get database information by id or name

SELECT * FROM SysDatabases
WHERE Id = 'abcd-1234-id'

get_database 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 database information by id or name

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM SysDatabases
WHERE Id = ''abcd-1234-id''';

EXEC (@MyQuery) AT [LS_TO_COSMOS_DB_IN_GATEWAY];

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