Share via

DocumentDbCollectionSink Class

  • Reference

A copy activity Document Database Collection sink.

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

Inheritance
azure.mgmt.datafactory.models._models_py3.CopySink
DocumentDbCollectionSink

Constructor

DocumentDbCollectionSink(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None, disable_metrics_collection: MutableMapping[str, Any] | None = None, nesting_separator: MutableMapping[str, Any] | None = None, write_behavior: 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.
write_batch_size
<xref:JSON>

Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
write_batch_timeout
<xref:JSON>

Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
sink_retry_count
<xref:JSON>

Sink retry count. Type: integer (or Expression with resultType integer).
sink_retry_wait
<xref:JSON>

Sink 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 sink 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).
nesting_separator
<xref:JSON>

Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).
write_behavior
<xref:JSON>

Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
type
str

Copy sink type. Required.
write_batch_size
<xref:JSON>

Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
write_batch_timeout
<xref:JSON>

Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
sink_retry_count
<xref:JSON>

Sink retry count. Type: integer (or Expression with resultType integer).
sink_retry_wait
<xref:JSON>

Sink 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 sink 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).
nesting_separator
<xref:JSON>

Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).
write_behavior
<xref:JSON>

Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.