Microsoft Azure Cosmos DB SQL API Connector > Mappings for Microsoft Azure Cosmos DB SQL API > Microsoft Azure Cosmos DB SQL API source properties
  

Microsoft Azure Cosmos DB SQL API source properties

To read data from Microsoft Azure Cosmos DB SQL API, configure a Microsoft Azure Cosmos DB SQL API object as the Source transformation in a mapping.
The following table describes the Microsoft Azure Cosmos DB SQL API source properties that you can configure in a Source transformation:
Property
Description
Connection
Name of the source connection.
You can select an existing connection, create a new connection, or define parameter values for the source connection property.
If you want to overwrite the source connection properties at runtime, select the Allow parameter to be overridden at run time option.
Specify the parameter file directory and name in the advanced session properties.
Source Type
Type of source object. Select Single Object or Parameter.
Object
Name of the source object.
Parameter
The parameter that holds the value of the object that you want to define at run-time.
Select an existing parameter for the source object, or click New Parameter to define a new parameter for the source object.
The Parameter property appears only if you select parameter as the source type.
If you want to overwrite the parameter at runtime, select the Allow parameter to be overridden at run time option when you create a parameter. When the task runs, the agent uses the parameters from the file that you specify in the advanced session properties.
Format
Mandatory. Microsoft Azure Cosmos DB format options.
Select one of the following formats:
  • - None.1 To read multilevel-hierarchical data in the string format.
  • - Json. To read or write JSON documents that have one level of hierarchy.
Default is None.
1Doesn't apply to mappings in advanced mode.
The following table describes the advanced properties that you can configure in a Source transformation:
Property
Description
Throughput1
Request units processed per second. Overrides the throughput that you specify for the collection in Microsoft Azure Cosmos DB SQL API at runtime.
You cannot override the throughput of the database. Before you override the throughput for the collection, ensure that the throughput is set for the collection in Microsoft Azure Cosmos DB SQL API.
Specify the throughput value based on the throughput type:
  • - Autoscale throughput. Specify the value in multiples of 1000. The minimum value is 1000 and maximum value is 1000000.
  • - Manual throughput. Specify the value in multiples of 100. The minimum value for manual throughput is 400 and maximum value is 1000000.
Default is -1.
Partition Key
Mandatory. Value for the partition field key. You can add more than one value to the field.
You can specify the following values:
  • - <All>. Reads data from all partitions.
  • - Field name. Reads data from the field name partition. For example, you can read data from a partition named on the City field, Boston. You can specify comma-separated multiple field names.
  • - <null>. Reads data from the null partition.
Default is <All>.
When you use the partition key for mappings in advanced mode, ensure that the key is of string data type.
Page Size1
Number of documents to read per request. Default is 50.
Filter Query
A case-sensitive filter query with conditional and logical operators to filter the source data.
Use the following syntax:
<objectName>.<columnName>="conditionValue"
For example, Address.City="Boston"
To use the array data type for mappings in advanced mode, use the following syntax:
<objectName>.<arrayName>[rowNumber][colNumber]="conditionValue"
To use the struct data type for mappings in advanced mode, use the following syntax:
<objectName>.<structLevel1>.<structLevel2>.<structLevel<n>>.<variableName>=
"conditionValue"
Tracing Level
Not applicable.
1Doesn't apply to mappings in advanced mode.