Copiare dati da o verso Azure Cosmos DB per MongoDB usando Azure Data Factory o Synapse Analytics

Articolo
01/05/2024

SI APPLICA A: Azure Data Factory Azure Synapse Analytics

Suggerimento

Provare Data Factory in Microsoft Fabric, una soluzione di analisi completa per le aziende. Microsoft Fabric copre tutti gli elementi, dallo spostamento dei dati all'analisi scientifica dei dati, all'analisi in tempo reale, alla business intelligence e alla creazione di report. Scopri come avviare gratuitamente una nuova versione di valutazione .

Questo articolo illustra come usare l'attività di copia nelle pipeline di Azure Data Factory e Synapse Analytics per copiare dati da e in Azure Cosmos DB per MongoDB. L'articolo si basa sull'attività di copia, che presenta una panoramica generale dell'attività di copia.

Nota

Questo connettore supporta solo la copia dei dati da e verso Azure Cosmos DB per MongoDB. Per Azure Cosmos DB per NoSQL, fare riferimento al connettore Azure Cosmos DB per NoSQL. Altri tipi di API non sono attualmente supportati.

Funzionalità supportate

Questo connettore Azure Cosmos DB per MongoDB è supportato per le funzionalità seguenti:

Funzionalità supportate	IR	Endpoint privato gestito
Attività di copia (origine/sink)	① ②	✓

(1) Runtime di integrazione di Azure (2) Runtime di integrazione self-hosted

È possibile copiare dati da Azure Cosmos DB per MongoDB a qualsiasi archivio dati sink supportato o copiare dati da qualsiasi archivio dati di origine supportato in Azure Cosmos DB per MongoDB. Per un elenco degli archivi dati supportati dall'attività di copia come origini e sink, vedere Archivi dati e formati supportati.

È possibile usare il connettore Azure Cosmos DB per MongoDB per:

Copiare dati da e in Azure Cosmos DB per MongoDB.
Scrivere in Azure Cosmos DB tramite insert o upsert.
Importare ed esportare documenti JSON come sono o copiare dati da o in un set di dati tabulari, ad esempio un database SQL e un file CSV. Per copiare documenti come sono da o in file JSON oppure da o in un'altra raccolta di Azure Cosmos DB, vedere Importare o esportare documenti JSON.

Introduzione

Per eseguire l'attività di copia con una pipeline, è possibile usare uno degli strumenti o SDK seguenti:

Creare un servizio collegato ad Azure Cosmos DB per MongoDB usando l'interfaccia utente

Usare la procedura seguente per creare un servizio collegato ad Azure Cosmos DB per MongoDB nell'interfaccia utente di portale di Azure.

Passare alla scheda Gestisci nell'area di lavoro di Azure Data Factory o Synapse e selezionare Servizi collegati, quindi fare clic su Nuovo:
- Azure Data Factory
- Azure Synapse
Cercare Azure Cosmos DB per MongoDB e selezionare tale connettore.
Configurare i dettagli del servizio, testare la connessione e creare il nuovo servizio collegato.

Dettagli di configurazione di Connessione or

Le sezioni seguenti forniscono informazioni dettagliate sulle proprietà che è possibile usare per definire entità di Data Factory specifiche di Azure Cosmos DB per MongoDB.

Proprietà del servizio collegato

Per il servizio collegato Azure Cosmos DB per MongoDB sono supportate le proprietà seguenti:

Proprietà	Descrizione	Richiesto
Tipo	La proprietà type deve essere impostata su CosmosDbMongoDbApi.	Sì
connectionString	Specificare il stringa di connessione per Azure Cosmos DB per MongoDB. È possibile trovarla nel portale di Azure,> ovvero il pannello Azure Cosmos DB,> il stringa di connessione primario o secondario. Per la versione del server 3.2, il modello di stringa è `mongodb://<cosmosdb-name>:<password>@<cosmosdb-name>.documents.azure.com:10255/?ssl=true&replicaSet=globaldb`. Per le versioni del server 3.6+, il modello di stringa è `mongodb://<cosmosdb-name>:<password>@<cosmosdb-name>.mongo.cosmos.azure.com:10255/?ssl=true&replicaSet=globaldb&retrywrites=false&maxIdleTimeMS=120000&appName=@<cosmosdb-name>@`. È anche possibile inserire una password in Azure Key Vault ed estrarre la `password` configurazione dal stringa di connessione. Per altri dettagli, vedere Archiviare le credenziali in Azure Key Vault .	Sì
database	Nome del database a cui si vuole accedere.	Sì
isServerVersionAbove32	Specificare se la versione del server è superiore alla 3.2. I valori consentiti sono true e false(impostazione predefinita). Ciò determinerà il driver da usare nel servizio.	Sì
connectVia	Runtime di integrazione da usare per la connessione all'archivio dati. È possibile usare Azure Integration Runtime o un runtime di integrazione self-hosted (se l'archivio dati si trova in una rete privata). Se questa proprietà non è specificata, come valore predefinito viene usato Azure Integration Runtime.	No

Esempio

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

Proprietà del set di dati

Per un elenco completo delle sezioni e delle proprietà disponibili per la definizione dei set di dati, vedere Set di dati e servizi collegati. Per il set di dati azure Cosmos DB per MongoDB sono supportate le proprietà seguenti:

Proprietà	Descrizione	Richiesto
Tipo	La proprietà type del set di dati deve essere impostata su CosmosDbMongoDbApiCollection.	Sì
collectionName	Nome della raccolta di Azure Cosmos DB.	Sì

Esempio

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

Proprietà dell'attività di copia

Questa sezione fornisce un elenco delle proprietà supportate dall'origine e dal sink di Azure Cosmos DB per MongoDB.

Per un elenco completo delle sezioni e delle proprietà disponibili per la definizione delle attività, vedere Pipeline.

Azure Cosmos DB per MongoDB come origine

Nella sezione source dell'attività di copia sono supportate le proprietà seguenti:

Proprietà	Descrizione	Richiesto
Tipo	La proprietà type dell'origine dell'attività di copia deve essere impostata su CosmosDbMongoDbApiSource.	Sì
filter	Specifica il filtro di selezione usando gli operatori di query. Per restituire tutti i documenti in una raccolta, omettere questo parametro o passare un documento vuoto ({}).	No
cursorMethods.project	Specifica i campi da restituire nei documenti per la proiezione. Per restituire tutti i campi nei documenti corrispondenti, omettere questo parametro.	No
cursorMethods.sort	Specifica l'ordine in cui la query restituisce i documenti corrispondenti. Fare riferimento a cursor.sort().	No
cursorMethods.limit	Specifica il numero massimo di documenti restituiti dal server. Fare riferimento a cursor.limit().	No
cursorMethods.skip	Specifica il numero di documenti da ignorare e la posizione da cui MongoDB inizia a restituire i risultati. Fare riferimento a cursor.skip().	No
batchSize	Specifica il numero di documenti da restituire in ogni batch di risposta dall'istanza di MongoDB. Nella maggior parte dei casi, la modifica della dimensione del batch non influisce sull'utente o sull'applicazione. Azure Cosmos DB limita ogni batch non può superare le dimensioni di 40 MB, ovvero la somma del numero batchSize delle dimensioni dei documenti, quindi ridurre questo valore se le dimensioni del documento sono elevate.	No (il valore predefinito è 100)

Suggerimento

Azure Data Factory supporta l'utilizzo di documenti BSON in modalità strict. Assicurarsi che la query di filtro sia in modalità strict anziché in modalità shell. Altre descrizioni sono disponibili nel manuale di MongoDB.

Esempio

"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 per MongoDB come sink

Nella sezione sink dell'attività di copia sono supportate le proprietà seguenti:

Proprietà	Descrizione	Richiesto
Tipo	La proprietà type del sink dell'attività di copia deve essere impostata su CosmosDbMongoDbApiSink.	Sì
writeBehavior	Descrive come scrivere i dati in Azure Cosmos DB. Valori consentiti: insert e upsert. Il comportamento di upsert consiste nel sostituire il documento se esiste già un documento con lo stesso `_id` . In caso contrario, inserire il documento. Nota: il servizio genera automaticamente un oggetto `_id` per un documento se `_id` non è specificato nel documento originale o nel mapping di colonne. È quindi necessario assicurarsi che il documento contenga un ID in modo che upsert funzioni come previsto.	No (il valore predefinito è insert)
writeBatchSize	La proprietà writeBatchSize controlla le dimensioni dei documenti da scrivere in ogni batch. È possibile provare ad aumentare il valore di writeBatchSize per migliorare le prestazioni e a ridurre il valore se le dimensioni dei documenti sono troppo grandi.	No (il valore predefinito è 10.000)
writeBatchTimeout	Tempo di attesa per il completamento dell'operazione di inserimento batch prima del timeout. Il valore consentito è timespan.	No (il valore predefinito è 00:30:00 - 30 minuti)

Suggerimento

Per importare documenti JSON come sono, fare riferimento alla sezione Importare o esportare documenti JSON. Per copiare da dati in forma tabulare, fare riferimento a Mapping dello schema.

Esempio

"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"
            }
        }
    }
]

Importare ed esportare documenti JSON

È possibile usare questo connettore di Azure Cosmos DB per eseguire facilmente le operazioni seguenti:

Copiare documenti come sono da una raccolta di Azure Cosmos DB a un'altra.
Importare documenti JSON da varie origini ad Azure Cosmos DB, tra cui MongoDB, Archiviazione BLOB di Azure, Azure Data Lake Store e altri archivi basati su file supportati dal servizio.
Esportare documenti JSON da una raccolta di Azure Cosmos DB in diversi archivi basati su file.

Per ottenere la copia senza schema:

Quando si usa lo strumento Copia dati, selezionare l'opzione Esporta così come è in file JSON o raccolta di Azure Cosmos DB.
Quando si usa la creazione di attività, scegliere il formato JSON con l'archivio file corrispondente per l'origine o il sink.

Mapping dello schema

Per copiare dati da Azure Cosmos DB per MongoDB a sink tabulare o invertito, fare riferimento al mapping dello schema.

In particolare per la scrittura in Azure Cosmos DB, per assicurarsi di popolare Azure Cosmos DB con l'ID oggetto corretto dai dati di origine, ad esempio, si dispone di una colonna "id" nella tabella di database SQL e si vuole usare tale valore come ID documento in MongoDB per insert/upsert, è necessario impostare il mapping dello schema appropriato in base alla definizione della modalità strict di MongoDB (_id.$oid) come indicato di seguito:

Map ID in MongoDB sink

Dopo l'esecuzione dell'attività di copia, nel sink viene generato il valore ObjectId BSON indicato di seguito:

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

Per un elenco degli archivi dati supportati dall'attività di copia come origini e sink, vedere archivi dati supportati.

Copiare dati da o verso Azure Cosmos DB per MongoDB usando Azure Data Factory o Synapse Analytics

Funzionalità supportate

Introduzione

Creare un servizio collegato ad Azure Cosmos DB per MongoDB usando l'interfaccia utente

Dettagli di configurazione di Connessione or

Proprietà del servizio collegato

Proprietà del set di dati

Proprietà dell'attività di copia

Azure Cosmos DB per MongoDB come origine

Azure Cosmos DB per MongoDB come sink

Importare ed esportare documenti JSON

Mapping dello schema

Contenuto correlato

Risorse aggiuntive