CosmosDbMongoDbApiSource Class

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts.Models
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
CosmosDbMongoDbApiSource.cs

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

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.CosmosDbMongoDbApiSource+CosmosDbMongoDbApiSourceConverter))]
public class CosmosDbMongoDbApiSource : Azure.Analytics.Synapse.Artifacts.Models.CopySource
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.CosmosDbMongoDbApiSource+CosmosDbMongoDbApiSourceConverter))>]
type CosmosDbMongoDbApiSource = class
    inherit CopySource
Public Class CosmosDbMongoDbApiSource
Inherits CopySource
Inheritance
Object
CopySource
CosmosDbMongoDbApiSource
Attributes
JsonConverterAttribute

Constructors

CosmosDbMongoDbApiSource()

Initializes a new instance of CosmosDbMongoDbApiSource.

Properties

AdditionalColumns

Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
AdditionalProperties

Additional Properties.

(Inherited from CopySource)
BatchSize

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).
CursorMethods

Cursor methods for Mongodb query.
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).
MaxConcurrentConnections

The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

(Inherited from CopySource)
QueryTimeout

Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
SourceRetryCount

Source retry count. Type: integer (or Expression with resultType integer).

(Inherited from CopySource)
SourceRetryWait

Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

(Inherited from CopySource)

Applies to