MongoDbCollectionDataset Class

The MongoDB database dataset.

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

Inheritance

azure.synapse.artifacts.models._models_py3.Dataset

MongoDbCollectionDataset

Constructor

MongoDbCollectionDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, collection_name: object, additional_properties: Optional[Dict[str, object]] = None, description: Optional[str] = None, structure: Optional[object] = None, schema: Optional[object] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[object]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

Parameters

additional_properties

dict[str, object]

Required

Unmatched properties from the message are deserialized to this collection.

type

str

Required

Required. Type of dataset.Constant filled by server.

description

str

Required

Dataset description.

structure

object

Required

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

schema

object

Required

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

linked_service_name

LinkedServiceReference

Required

Required. Linked service reference.

parameters

dict[str, ParameterSpecification]

Required

Parameters for dataset.

annotations

list[object]

Required

List of tags that can be used for describing the Dataset.

folder

DatasetFolder

Required

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

collection_name

object

Required

Required. The table name of the MongoDB database. Type: string (or Expression with resultType string).