CosmosDbMongoDbApiSource Class
A copy activity source for a CosmosDB (MongoDB API) database.
Constructor
CosmosDbMongoDbApiSource(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
source_retry_count
|
Source retry count. Type: integer (or Expression with resultType integer). |
|
source_retry_wait
|
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
|
The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). |
|
disable_metrics_collection
|
If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). |
|
filter
|
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
|
Cursor methods for Mongodb query. |
|
batch_size
|
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
|
Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). |
|
additional_columns
|
Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). |
|
type
|
Copy source type. Required. Default value is "CosmosDbMongoDbApiSource". |
Attributes
additional_columns
array of objects(AdditionalColumns) (or Expression with resultType array of objects).
additional_columns: Any | None
batch_size
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).
batch_size: Any | None
cursor_methods
Cursor methods for Mongodb query.
cursor_methods: _models.MongoDbCursorMethodsProperties | None
filter
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).
filter: Any | None
query_timeout
string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
query_timeout: Any | None
type
Copy source type. Required. Default value is "CosmosDbMongoDbApiSource".
type: Literal['CosmosDbMongoDbApiSource']