使用 Azure 数据工厂或 Synapse Analytics 向/从 Azure Cosmos DB for MongoDB 复制数据

项目
03/04/2024

适用于： Azure 数据工厂 Azure Synapse Analytics

提示

试用 Microsoft Fabric 中的数据工厂，这是一种适用于企业的一站式分析解决方案。 Microsoft Fabric 涵盖从数据移动到数据科学、实时分析、商业智能和报告的所有内容。了解如何免费开始新的试用！

本文概述如何使用 Azure 数据工厂和 Synapse Analytics 管道中的复制活动从/向 Azure Cosmos DB for MongoDB 复制数据。本文是基于概括性介绍复制活动的复制活动一文编写的。

注意

此连接器仅支持向/从 Azure Cosmos DB for MongoDB 复制数据。对于 Azure Cosmos DB for NoSQL，请参阅 Azure Cosmos DB for NoSQL 连接器。目前不支持其他 API 类型。

支持的功能

此 Azure Cosmos DB for MongoDB 连接器支持以下功能：

支持的功能	IR	托管专用终结点
复制活动（源/接收器）	① ②	✓

① Azure 集成运行时 ② 自承载集成运行时

可将 Azure Cosmos DB for MongoDB 中的数据复制到任一受支持的接收器数据存储，或将数据从任一受支持的源数据存储复制到 Azure Cosmos DB for MongoDB。有关复制活动支持作为源和接收器的数据存储的列表，请参阅支持的数据存储和格式。

可以将 Azure Cosmos DB for MongoDB 连接器用于：

从和向 Azure Cosmos DB for MongoDB 复制数据。
以 insert 或 upsert 的形式写入 Azure Cosmos DB。
按原样导入和导出 JSON 文档，或在表格数据集中复制或粘贴数据。示例包括 SQL 数据库和 CSV 文件。若要在 JSON 文件或另一个 Azure Cosmos DB 集合中按原样复制或粘贴文档，请参阅“导入或导出 JSON 文档”。

入门

若要使用管道执行复制活动，可以使用以下工具或 SDK 之一：

使用 UI 创建到 Azure Cosmos DB for MongoDB 的链接服务

使用以下步骤在 Azure 门户 UI 中创建到 Azure Cosmos DB for MongoDB 的链接服务。

浏览到 Azure 数据工厂或 Synapse 工作区中的“管理”选项卡并选择“链接服务”，然后单击“新建”：
- Azure 数据工厂
- Azure Synapse
搜索 Azure Cosmos DB for MongoDB 并选择该连接器。
配置服务详细信息、测试连接并创建新的链接服务。

连接器配置详细信息

对于特定于 Azure Cosmos DB for MongoDB 的数据工厂实体，以下部分提供了有关可用于定义这些实体的属性的详细信息。

链接服务属性

Azure Cosmos DB for MongoDB 链接服务支持以下属性：

属性	描述	必需
type	type 属性必须设置为 CosmosDbMongoDbApi。	是
connectionString	指定 Azure Cosmos DB for MongoDB 的连接字符串。可以在 Azure 门户 -> Azure Cosmos DB 边栏选项卡 -> 主要或辅助连接字符串中找到该字符串。对于 3.2 服务器版本，字符串模式为 `mongodb://<cosmosdb-name>:<password>@<cosmosdb-name>.documents.azure.cn:10255/?ssl=true&replicaSet=globaldb`。对于 3.6+ 服务器版本，字符串模式为 `mongodb://<cosmosdb-name>:<password>@<cosmosdb-name>.mongo.cosmos.azure.cn:10255/?ssl=true&replicaSet=globaldb&retrywrites=false&maxIdleTimeMS=120000&appName=@<cosmosdb-name>@`。还可以将密码放在 Azure 密钥保管库中，并从连接字符串中拉取 `password` 配置。有关更多详细信息，请参阅在 Azure Key Vault 中存储凭据。	是
database	要访问的数据库的名称。	是
isServerVersionAbove32	指定服务器版本是否高于 3.2。允许的值为“true”和“false”（默认值）。这将确定要在服务中使用的驱动程序。	是
connectVia	用于连接到数据存储的 Integration Runtime。可使用 Azure Integration Runtime 或自承载集成运行时（如果数据存储位于专用网络）。如果未指定此属性，则使用默认的 Azure Integration Runtime。	否

示例

{
    "name": "CosmosDbMongoDBAPILinkedService",
    "properties": {
        "type": "CosmosDbMongoDbApi",
        "typeProperties": {
            "connectionString": "mongodb://<cosmosdb-name>:<password>@<cosmosdb-name>.documents.azure.cn:10255/?ssl=true&replicaSet=globaldb",
            "database": "myDatabase",
            "isServerVersionAbove32": "false"
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

数据集属性

有关可用于定义数据集的各部分和属性的完整列表，请参阅数据集和链接服务。 Azure Cosmos DB for MongoDB 数据集支持以下属性：

属性	描述	必需
type	数据集的 type 属性必须设置为 CosmosDbMongoDbApiCollection。	是
collectionName	Azure Cosmos DB 集合的名称。	是

示例

{
    "name": "CosmosDbMongoDBAPIDataset",
    "properties": {
        "type": "CosmosDbMongoDbApiCollection",
        "typeProperties": {
            "collectionName": "<collection name>"
        },
        "schema": [],
        "linkedServiceName":{
            "referenceName": "<Azure Cosmos DB for MongoDB linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

复制活动属性

本部分列出 Azure Cosmos DB for MongoDB 源和接收器支持的属性。

有关可用于定义活动的各个部分和属性的完整列表，请参阅管道。

Azure Cosmos DB for MongoDB 作为源

复制活动 source 节支持以下属性：

属性	描述	必需
type	复制活动源的 type 属性必须设置为 CosmosDbMongoDbApiSource。	是
filter	使用查询运算符指定选择筛选器。若要返回集合中的所有文档，请省略此参数或传递空文档 ({})。	否
cursorMethods.project	指定要在文档中返回用于投影的字段。若要返回匹配文档中的所有字段，请省略此参数。	否
cursorMethods.sort	指定查询返回匹配文档的顺序。请参阅 cursor.sort()。	否
cursorMethods.limit	指定服务器返回的文档的最大数量。请参阅 cursor.limit()。	否
cursorMethods.skip	指定要跳过的文档数量以及 MongoDB 开始返回结果的位置。请参阅 cursor.skip()。	否
batchSize	指定从 MongoDB 实例的每批响应中返回的文档数量。大多数情况下，修改批大小不会影响用户或应用程序。 Azure Cosmos DB 限制每个批不能超过 40 MB（这是文档大小的 batchSize 数量的总和），因此如果文档很大，请减小此值。	否（默认值为 100）

提示

ADF 支持在严格模式下使用 BSON 文档。请确保筛选器查询处于严格模式，而不是 Shell 模式。有关详细说明，请参阅 MongoDB 手册。

示例

"activities":[
    {
        "name": "CopyFromCosmosDBMongoDBAPI",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Azure Cosmos DB for MongoDB input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "CosmosDbMongoDbApiSource",
                "filter": "{datetimeData: {$gte: ISODate(\"2018-12-11T00:00:00.000Z\"),$lt: ISODate(\"2018-12-12T00:00:00.000Z\")}, _id: ObjectId(\"5acd7c3d0000000000000000\") }",
                "cursorMethods": {
                    "project": "{ _id : 1, name : 1, age: 1, datetimeData: 1 }",
                    "sort": "{ age : 1 }",
                    "skip": 3,
                    "limit": 3
                }
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Azure Cosmos DB for MongoDB 作为接收器

复制活动 sink 节支持以下属性：

属性	描述	必需
type	复制活动接收器的 type 属性必须设置为 CosmosDbMongoDbApiSink。	是
writeBehavior	描述如何将数据写入 Azure Cosmos DB。允许的值为 insert 和 upsert。 upsert 的行为是，如果已存在具有相同 `_id` 的文档，则替换该文档；否则将插入该文档。注意：如果未在原始文档中指定 `_id`，或未通过列映射指定 `_id`，则服务会自动为文档生成 _id。这表示必须先确保文档有 ID，才能让 upsert 按预期工作。	否（默认值为 insert）
writeBatchSize	writeBatchSize 属性控制每个批中可写入的文档大小。可尝试增大 writeBatchSize 的值以提高性能，并在文档大小较大时减小该值。	否（默认值为 10,000）
writeBatchTimeout	超时前等待批插入操作完成的时间。允许的值为 timespan。	否（默认值为 00:30:00 - 30 分钟）

提示

若要按原样导入 JSON 文档，请参阅导入或导出 JSON 文档部分；若要从表格形数据复制，请参阅架构映射。

示例

"activities":[
    {
        "name": "CopyToCosmosDBMongoDBAPI",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<Document DB output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "<source type>"
            },
            "sink": {
                "type": "CosmosDbMongoDbApiSink",
                "writeBehavior": "upsert"
            }
        }
    }
]

导入和导出 JSON 文档

使用此 Azure Cosmos DB 连接器，可以轻松地：

在两个 Azure Cosmos DB 集合之间按原样复制文档。
从各种源（包括 MongoDB、Azure Blob 存储和服务支持的其他基于文件的存储）将 JSON 文档导入 Azure Cosmos DB。
将 JSON 文档从 Azure Cosmos DB 集合导出到各种基于文件的存储。

若要实现“架构不可知”复制，请执行以下操作：

使用“复制数据”工具时，选择“按原样导出到 JSON 文件或 Azure Cosmos DB 集合”选项。
使用活动创作时，请为源或接收器选择 JSON 格式以及相应的文件存储。

架构映射

要将数据从 Azure Cosmos DB for MongoDB 复制到表格接收器或进行反向复制，请参阅架构映射。

具体而言，在写入到 Azure Cosmos DB 时，为了确保使用源数据中的正确对象 ID 填充 Azure Cosmos DB（例如，SQL 数据库表中包含一个“id”列，你想要使用该列的值作为 MongoDB 中的文档 ID 以完成插入/更新插入操作），需要根据 MongoDB 严格模式定义 (_id.$oid) 设置适当的架构映射，如下所示：

Map ID in MongoDB sink

完成复制活动的执行后，接收器中将生成以下 BSON ObjectId：

{
    "_id": ObjectId("592e07800000000000000000")
}

有关复制活动支持作为源和接收器的数据存储的列表，请参阅支持的数据存储。