Database Connection
Connections store authentication information. For general information about sharing database connections, please see Using Database Connections.
Note that different subsets of the Database Connection parameters below are made available in different contexts.
Connection
This parameter specifies a database connection for the reader through a drop-down menu. The Add Database Connection option in the menu allows you to create a new connection. The connection requires a name that describes the connection.
Note: The following characters are not allowed in connection names: ^ \ / : * ? " < > | & = ' + % #
The new connection can be made visible only to the current user, or can be shared among multiple users.
Document Collections
Document 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
DocumentDB Account
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.
Master Key
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.
Database
In DocumentDB, Document Collections are organized under Databases. This parameter specifies the Database(s) that contains the Document Collections from which to read.
The value(s) must correspond to the id values of Databases.
Advanced
Features Per Request
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
Retries After Throttling
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 performance level.
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
Read Original JSON Document
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
Additional Attributes to Expose
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 where you have multiple feature types, it is convenient to expose additional attributes using this one parameter. For example, if you have ten feature types and want to expose the same attribute in each one, it is easier to define it once than it is to set each feature type individually in the workspace.