CosmosDbMongoDbApiSource Class

A copy activity source for a CosmosDB (MongoDB API) database.

All required parameters must be populated in order to send to server.

Inheritance

azure.mgmt.datafactory.models._models_py3.CopySource

CosmosDbMongoDbApiSource

Constructor

CosmosDbMongoDbApiSource(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None, disable_metrics_collection: MutableMapping[str, Any] | None = None, filter: MutableMapping[str, Any] | None = None, cursor_methods: _models.MongoDbCursorMethodsProperties | None = None, batch_size: MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
source_retry_count	<xref:JSON> Source retry count. Type: integer (or Expression with resultType integer).
source_retry_wait	<xref:JSON> Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
max_concurrent_connections	<xref:JSON> The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
disable_metrics_collection	<xref:JSON> If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
filter	<xref:JSON> Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).
cursor_methods	MongoDbCursorMethodsProperties Cursor methods for Mongodb query.
batch_size	<xref:JSON> Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).
query_timeout	<xref:JSON> Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
additional_columns	<xref:JSON> Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
type	str Copy source type. Required.
source_retry_count	<xref:JSON> Source retry count. Type: integer (or Expression with resultType integer).
source_retry_wait	<xref:JSON> Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
max_concurrent_connections	<xref:JSON> The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
disable_metrics_collection	<xref:JSON> If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
filter	<xref:JSON> Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).
cursor_methods	MongoDbCursorMethodsProperties Cursor methods for Mongodb query.
batch_size	<xref:JSON> Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).
query_timeout	<xref:JSON> Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
additional_columns	<xref:JSON> Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).