Microsoft Azure Cosmos DB Reader Parameters

Database formats include a Database Connection parameter that defines and stores authentication information. For general information about sharing database connections, please see Using Database Connections.Using Database Connections.

Note that Database Connection parameters differ slightly, depending on context and/or database format.

Connection

From the Connection parameter in a database format, you can do one of the following:

  • Select an existing, previously defined connection. See the section Reusing a Database Connection in Using Database Connections
  • Select Add Database Connection to define a new connection. See database-specific parameters below, as well as the section Adding a Database Connection in a Workspace in Using Database Connections. The new connection can be made visible only to the current user, or can be shared among multiple users.

Database Connection

Select an existing Microsoft Azure Cosmos DB database connection, or Add Database Connection...

Add Microsoft Azure Cosmos DB Database Connection

To define a new connection from the Connection parameter in a Cosmos DB format, see the topic Microsoft Azure Cosmos DB: Add Database Connection

Collections

Collections correspond to Feature Types in FME. This parameter lets you browse and select Collections for which to generate Feature Types.

The names displayed in the list are the ID values of the Collections.

Document Query Options

This parameter corresponds to the x-ms-documentdb-query-enablecrosspartition header.

If your query is against a partitioned Collection but does not filter on a Partition Key, you must enable this parameter.

This parameter corresponds to the x-ms-documentdb-partitionkey header.

The value will be converted to a JSON array with a single string element if it does not already appear to be one. This is the format required for the header.

Advanced

Cosmos DB paginates query results. This parameter specifies the maximum number of Documents (features) that may be returned in each page.

Valid values: 1 to 1000

Default value: 1000

This parameter specifies the maximum number of times to reattempt a request that is rate-limited by the server. The server performs rate-limiting when the size and frequency of requests exceeds the Collection’s provisioned throughput.

If the request continues to be rate-limited after retrying for the specified number of times, the writer logs a warning and skips the request.

Default: 3

If this parameter is set to Yes, the complete JSON for each Document is included in the documentdb_json format attribute.

Default: No

Prior to FME 2022.0, web access through this format would automatically disable HTTPS Certificate verification when an SSL Error was received from the server. Now, this behavior must be explicitly enabled or disabled by this parameter.

The value of this parameter takes priority over the value of the Verify SSL Certificates parameter which might be defined by the Web Connection used with this format.

Schema Attributes

Use this parameter to expose Format Attributes in FME Workbench when you create a workspace:

  • In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime.
  • In a non-dynamic scenario, this parameter allows you to expose additional attributes on multiple feature types. Click the browse button to view the available format attributes (which are different for each format) for the reader.