Microsoft Azure Cosmos DB (DocumentDB) Reader Parameters
Database Connections
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. Note that Database Connection parameters may differ slightly, depending on context and/or database format. |
Select an existing connection, or Add Database Connection to define a new connection.
The new connection can be made visible only to the current user, or can be shared among multiple users.
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 Collection list are the id values of the Collections.
Connection Parameters
This value is the same value as the dataset. It can be the name of the account (for example contoso), or the URL for the account (for example, https://contoso.documents.azure.com).
Paths in the URL are ignored.
The Master Key is required for the DocumentDB Reader to execute queries on DocumentDB. The Master Key can be obtained from your DocumentDB administrator.
Note that Resource tokens are not supported.
In DocumentDB, Collections are organized under Databases. This parameter specifies the Database(s) that contains the Collections from which to read.
The value(s) must correspond to the id values of Databases.
Advanced
DocumentDB 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 DocumentDB. 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
Schema Attributes
Use this parameter to expose Format Attributes in 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, you can use this parameter to expose additional attributes on multiple feature types.