Ismerkedés a MongoDB-hez készült Azure Cosmos DB-vel a .NET használatával

A KÖVETKEZŐKRE VONATKOZIK: MongoDB

Ez a cikk bemutatja, hogyan csatlakozhat a MongoDB-hez készült Azure Cosmos DB-hez a .NET Core és a vonatkozó NuGet-csomagok használatával. A csatlakozás után műveleteket hajthat végre adatbázisokon, gyűjteményeken és dokumentumokon.

Feljegyzés

A példakódrészletek .NET Core-projektként érhetők el a GitHubon.

A MongoDB-hez készült API referenciadokumentációja | MongoDB-csomag (NuGet)

Előfeltételek

• Egy Azure-fiók, aktív előfizetéssel. Fiók ingyenes létrehozása.
• .NET 6.0
• Azure Parancssori felület (CLI) vagy Azure PowerShell
• Azure Cosmos DB for MongoDB-erőforrás

Új .NET Core-alkalmazás létrehozása

1. Hozzon létre egy új .NET Core-alkalmazást egy üres mappában az előnyben részesített terminál használatával. Ebben a forgatókönyvben egy konzolalkalmazást fog használni. dotnet new A parancs használatával hozza létre és nevezze el a konzolalkalmazást.

   dotnet new console -o app
   

2. Adja hozzá a MongoDB NuGet-csomagot a konzolprojekthez. Használja a dotnet add package NuGet-csomag nevét meghatározó parancsot.

   dotnet add package MongoDB.Driver
   

3. Az alkalmazás futtatásához egy terminál használatával lépjen az alkalmazás könyvtárára, és futtassa az alkalmazást.

   dotnet run
   

Csatlakozás a MongoDB-hez készült Azure Cosmos DB-hez a MongoDB natív illesztőprogramjával

Ha a MongoDB natív illesztőprogramjával szeretne csatlakozni az Azure Cosmos DB-hez, hozzon létre egy példányt az MongoClient osztályból. Ez az osztály a kiindulópont a MongoDb-adatbázisokon végzett összes művelet végrehajtásához. A MongoClient leggyakoribb konstruktora egy kapcsolati sztring fogad el, amelyet az alábbi lépésekkel kérdezhet le:

Erőforrásnév lekérése

Azure CLI

1. Hozzon létre egy rendszerhéjváltozót a resourceGroupName számára.

   # Variable for resource group name
   resourceGroupName="msdocs-cosmos"
   

2. az cosmosdb list A paranccsal lekérheti az erőforráscsoport első Azure Cosmos DB-fiókjának nevét, és tárolhatja az accountName rendszerhéj változójában.

   # Retrieve most recently created account name
   accountName=$(
       az cosmosdb list \
           --resource-group $resourceGroupName \
           --query "[0].name" \
           --output tsv
   )
   

PowerShell

1. Hozzon létre egy rendszerhéjváltozót RESOURCE_GROUP_NAME.

   # Variable for resource group name
   $RESOURCE_GROUP_NAME = "msdocs-cosmos"
   

2. A Get-AzCosmosDBAccountKey parancsmaggal kérje le az első Azure Cosmos DB-fiók nevét az erőforráscsoportban, és tárolja az accountName rendszerhéj változójában.

   # Get the name of the first Azure Cosmos DB account in your resource group
   $ACCOUNT_NAME = (Get-AzCosmosDBAccount -ResourceGroupName $RESOURCE_GROUP_NAME)[0].Name
   

Portál

Hagyja ki ezt a lépést, és használja a portál adatait a következő lépésben.

A kapcsolati sztring lekérése

Azure CLI

1. Keresse meg a MongoDB API-kapcsolati sztring a parancsot tartalmazó az cosmosdb keys list fiók kapcsolati sztring listájából.

   az cosmosdb keys list --type connection-strings \
       --resource-group $resourceGroupName \
       --name $accountName 
   

2. Jegyezze fel az ELSŐDLEGES KULCS értékeket. Ezeket a hitelesítő adatokat később fogja használni.

PowerShell

1. Keresse meg a KAPCSOLATI SZTRINGet a parancsmaggal rendelkező Get-AzCosmosDBAccountKey fiók kulcsainak és kapcsolati sztring listájában.

   $parameters = @{
       ResourceGroupName = $RESOURCE_GROUP_NAME
       Name = $ACCOUNT_NAME
       Type = "ConnectionStrings"
   }    
   Get-AzCosmosDBAccountKey @parameters |
       Select-Object -Property "Primary MongoDB Connection String"    
   

2. Jegyezze fel a KAPCSOLATI SZTRING értékét. Ezeket a hitelesítő adatokat később fogja használni.

Portál

Tipp.

Ebben az útmutatóban az erőforráscsoport nevének msdocs-cosmoshasználatát javasoljuk.

1. Jelentkezzen be az Azure Portalra.

2. Lépjen a MongoDB-fiók meglévő Azure Cosmos DB-fiókjának lapjára.

3. Az Azure Cosmos DB for MongoDB-fiók lapján válassza a Kapcsolati sztring navigációs menüt.

4. Jegyezze fel az ELSŐDLEGES KAPCSOLAT SZTRING mezőjének értékét. Ezt az értéket egy későbbi lépésben használhatja.

   

Környezeti változók konfigurálása

A KAPCSOLATI SZTRING értékeinek a kódban való használatához állítsa be ezt az értéket az alkalmazást futtató helyi környezetben. A környezeti változó beállításához használja az előnyben részesített terminált a következő parancsok futtatásához:

Windows

$env:COSMOS_CONNECTION_STRING = "<cosmos-connection-string>"

Linux/macOS

export COSMOS_CONNECTION_STRING="<cosmos-connection-string>"

.Env

A .env fájlok a környezeti változók projektben való tárolásának szabványos módjai. Hozzon létre egy .env fájlt a projekt gyökerében. Adja hozzá a következő sorokat a .env fájlhoz:

COSMOS_CONNECTION_STRING="<cosmos-connection-string>"

MongoClient létrehozása kapcsolati sztring

Definiálja az osztály új példányát a MongoClient konstruktor és a korábban beállított kapcsolati sztring változó használatával.

// New instance of CosmosClient class
var client = new MongoClient(Environment.GetEnvironmentVariable("COSMOS_CONNECTION_STRING"));

var settings = client.Settings;

Console.WriteLine(settings.Server.Host);

A MongoDB-ügyfélosztályok használata a MongoDB-hez készült Azure Cosmos DB for API-val

Mielőtt elkezdené az alkalmazást, nézzük meg az Azure Cosmos DB-ben található erőforrások hierarchiáját. Az Azure Cosmos DB egy adott objektummodellt használ erőforrások létrehozásához és eléréséhez. Az Azure Cosmos DB olyan hierarchiában hoz létre erőforrásokat, amelyek fiókokból, adatbázisokból, gyűjteményekből és dokumentumokból állnak.

Hierarchikus diagram egy MongoDB-fiókhoz készült Azure Cosmos DB-fiókot ábrázol felül. A fióknak két gyermekadatbázis-csomópontja van. Az adatbázis-csomópontok egyike két gyermekgyűjteményi csomópontot tartalmaz. A másik adatbáziscsomópont egyetlen gyermekgyűjteményi csomópontot tartalmaz. Az egyetlen gyűjteménycsomópont három gyermek-dokumentumcsomópontból áll.

Minden erőforrástípust egy vagy több társított C#-osztály jelöl. Íme a leggyakoribb osztályok listája:

Osztály	Leírás
MongoClient	Ez az osztály ügyféloldali logikai reprezentációt biztosít a MongoDB API-réteghez az Azure Cosmos DB-ben. Az ügyfélobjektum a szolgáltatással kapcsolatos kérések konfigurálására és végrehajtására szolgál.
MongoDatabase	Ez az osztály egy olyan adatbázisra mutató hivatkozás, amely lehet, hogy még létezik a szolgáltatásban. Az adatbázis érvényesítése vagy kiszolgálóoldali létrehozása akkor történik meg, amikor műveletet kísérel meg végrehajtani rajta.
Collection	Ez az osztály olyan gyűjteményre hivatkozik, amely még nem létezik a szolgáltatásban. A gyűjtemény kiszolgálóoldali érvényesítve lesz, amikor megpróbál dolgozni vele.

Az alábbi útmutatók bemutatják, hogyan használhatja ezeket az osztályokat az alkalmazás létrehozásához és az adatok kezeléséhez.

Útmutató:

• Adatbázisok kezelése
• Gyűjtemények kezelése
• Dokumentumok kezelése
• Dokumentumok keresése lekérdezésekkel

Lásd még

• Csomag (NuGet)
• API-referencia

Következő lépések

Most, hogy csatlakozott egy MongoDB-fiókhoz készült API-hoz, a következő útmutató segítségével hozhat létre és kezelhet adatbázisokat.

Adatbázis létrehozása a MongoDB-hez készült Azure Cosmos DB-ben a .NET használatával