Share via

CosmosDbMongoDbApiSource interface

  • Reference
Package:
@azure/arm-datafactory

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

Extends
CopySource

Properties

additionalColumns

Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
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).
queryTimeout

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

Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

disableMetricsCollection

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections

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

Source retry count. Type: integer (or Expression with resultType integer).
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])).

Property Details

additionalColumns

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

additionalColumns?: any

Property Value

any

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

batchSize?: any

Property Value

any

cursorMethods

Cursor methods for Mongodb query.

cursorMethods?: MongoDbCursorMethodsProperties

Property Value

MongoDbCursorMethodsProperties

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

Property Value

any

queryTimeout

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

queryTimeout?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "CosmosDbMongoDbApiSource"

Property Value

"CosmosDbMongoDbApiSource"

Inherited Property Details

disableMetricsCollection

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

disableMetricsCollection?: any

Property Value

any

Inherited From CopySource.disableMetricsCollection

maxConcurrentConnections

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

maxConcurrentConnections?: any

Property Value

any

Inherited From CopySource.maxConcurrentConnections

sourceRetryCount

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

sourceRetryCount?: any

Property Value

any

Inherited From CopySource.sourceRetryCount

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

sourceRetryWait?: any

Property Value

any

Inherited From CopySource.sourceRetryWait