Microsoft Azure Cosmos DB (DocumentDB) Reader: Feature Type Parameters

To access feature type parameters, click the gear icon on a feature type in the workspace. This opens the Feature Type Parameter Editor.

Tip: To always display the editor in Workbench, you can select View > Windows > Parameter Editor.

General

All feature types share similar General parameters, which may include Feature Type Name, Reader or Writer information, and Geometry.

In most Writer Feature Type parameter dialogs, you can also control Dynamic Schema Definitions. Some database formats accept a Table Qualifier prefix on the output table feature type.

These parameters apply only to a selected feature type, not to the entire reader.

Note: If a feature type parameter corresponds to a reader-level parameter, then the reader parameter will be ignored and the feature type parameter will be used.

WHERE Clause

Optional. This parameter constitutes the WHERE clause of the SQL query to execute against the Collection. The value is passed as-is, with no validation.

If not specified, all Documents in the Collection are read.

Note: All property (column) names must be prefixed with root. For example, to filter on the id property, the WHERE clause must be root.id = ‘foo’, not id = ‘foo’.

For details on how to build WHERE clauses for Cosmos DB, see Getting started with SQL queries.

For details about using spatial queries, see Geospatial and GeoJSON location data in Azure Cosmos DB

Partition Key

This optional 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.

Cross-Partition Query

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.

Document Options

Geometry Property

Optional. If the specified property exists on a Document, and its value is GeoJSON, the Cosmos DB Reader will parse the GeoJSON and include it as geometry on output features.

Default: geom