Official Content

Cosmos DB Inspector is a tool that allows inspecting a Cosmos DB and creating the Azure Cosmos DB external data store automatically, along with the transactions and data views needed to build your application.

It can be accessed through the menu Tools > Application Integration > External Datastore Service Import.


There, select Service Provider = CosmosDB.


If you do not have defined an external datastore, use the NEW button to define it. The datastore has to be assigned to go on with the following steps.

In Service URI, enter the connection string.

The connection string is taken from the Azure portal


At Connection Info, enter:


The container is optional. If not set, all the containers of the database will be shown.

The Database and ApplicationRegion information is mandatory.

Note: To create a new data store automatically, click on the "New" button.

Index inspection

CosmosDB inspector reads the Range and Composite indexes defined in the Cosmos DB settings of each container. See Indexing policies in Azure CosmosDB.

GeneXus does not support the Indexing mode = None (it is ignored by the CosmosDB Inspector).

When a container is inspected, all the Range and Composite indexes are defined in the dataview associated with the Transaction (all except Blob or Binary fields are considered).

The index definition is needed in order to use the Order clause. See Cosmos DB error spc0116.

Considerations on Cosmos DB inspector

  • As Cosmos DB is a schema-less database, the inspector does its best effort to create the transaction attributes and infer their data types.
  • It loops over a set of data items (by default 15 items) in the table and adds to the transaction definition all the attributes it finds, inferring their data types from the data itself.
  • If you want to change the number of items to be read to infer the structure, use the importItems connection info. E.g.: importItems=20.
  • The transaction and data view can be adjusted manually if necessary.
  • Only single-level transactions are created.


Generators: .NETJava


As since GeneXus 18 Upgrade 3.


Last update: November 2023 | © GeneXus. All rights reserved. GeneXus Powered by Globant