Aracılığıyla paylaş


Hızlı Başlangıç: .NET için Azure SDK ile NoSQL için Azure Cosmos DB kullanma

Bu hızlı başlangıçta.NET için Azure SDK'sını kullanarak temel bir Tablo için Azure Cosmos DB uygulaması dağıtacaksınız. Tablo için Azure Cosmos DB, uygulamaların yapılandırılmış tablo verilerini bulutta depolamasına olanak sağlayan şemasız bir veri deposudur. .NET için Azure SDK'sını kullanarak Azure Cosmos DB kaynağınızda tablo, satır oluşturma ve temel görevleri gerçekleştirme hakkında bilgi edinirsiniz.

API başvuru belgeleri | Kitaplık kaynak kodu | Paketi (NuGet) | Azure Geliştirici CLI

Önkoşullar

  • Azure Geliştirici CLI
  • Docker Desktop
  • .NET 9.0

Azure hesabınız yoksa, başlamadan önce ücretsiz hesap oluşturun.

Projeyi başlatma

Tablo hesabı için Azure Cosmos DB oluşturmak ve kapsayıcılı örnek bir uygulama dağıtmak için Azure Geliştirici CLI'sini (azd) kullanın. Örnek uygulama örnek verileri yönetmek, oluşturmak, okumak ve sorgulamak için istemci kitaplığını kullanır.

  1. Boş bir dizinde bir terminal açın.

  2. Henüz kimlik doğrulaması yapmadıysanız kullanarak azd auth loginAzure Geliştirici CLI'sinde kimlik doğrulamasından geçin. Tercih ettiğiniz Azure kimlik bilgilerini kullanarak CLI'da kimlik doğrulaması yapmak için araç tarafından belirtilen adımları izleyin.

    azd auth login
    
  3. Projeyi başlatmak için kullanın azd init .

    azd init --template cosmos-db-nosql-dotnet-quickstart
    
  4. Başlatma sırasında benzersiz bir ortam adı yapılandırın.

  5. Kullanarak azd upAzure Cosmos DB hesabını dağıtın. Bicep şablonları ayrıca örnek bir web uygulaması dağıtır.

    azd up
    
  6. Sağlama işlemi sırasında aboneliğinizi, istediğiniz konumu ve hedef kaynak grubunu seçin. Sağlama işleminin tamamlanmasını bekleyin. İşlem yaklaşık beş dakika sürebilir.

  7. Azure kaynaklarınızın sağlanması tamamlandıktan sonra, çalışan web uygulamasının URL'si çıktıya eklenir.

    Deploying services (azd deploy)
    
      (✓) Done: Deploying service web
    - Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>
    
    SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.
    
  8. Tarayıcıda web uygulamanıza gitmek için konsoldaki URL'yi kullanın. Çalışan uygulamanın çıkışını gözlemleyin.

Çalışan web uygulamasının ekran görüntüsü.

İstemci kitaplığını yükleme

İstemci kitaplığı NuGet aracılığıyla paket olarak Microsoft.Azure.Cosmos kullanılabilir.

  1. Bir terminal açın ve klasöre /src/web gidin.

    cd ./src/web
    
  2. Henüz yüklü değilse, kullanarak paketini dotnet add packageyükleyinMicrosoft.Azure.Cosmos.

    dotnet add package Microsoft.Azure.Cosmos --version 3.*
    
  3. Ayrıca, henüz yüklü değilse paketi yükleyin Azure.Identity .

    dotnet add package Azure.Identity --version 1.12.*
    
  4. src/web/Cosmos.Samples.NoSQL.Quickstart.Web.csproj dosyasını açıp gözden geçirerek ve Azure.Identity girdilerinin her ikisinin de var olduğunu Microsoft.Azure.Cosmos doğrulayın.

Nesne modeli

Veri Akışı Adı Açıklama
CosmosClient Bu sınıf birincil istemci sınıfıdır ve hesap genelindeki meta verileri veya veritabanlarını yönetmek için kullanılır.
Database Bu sınıf, hesaptaki bir veritabanını temsil eder.
Container Bu sınıf öncelikli olarak kapsayıcıda veya kapsayıcıda depolanan öğelerde okuma, güncelleştirme ve silme işlemleri gerçekleştirmek için kullanılır.
PartitionKey Bu sınıf mantıksal bölüm anahtarını temsil eder. Bu sınıf birçok yaygın işlem ve sorgu için gereklidir.

Kod örnekleri

Şablondaki örnek kod adlı bir veritabanı ve adlı cosmicworks productskapsayıcıyı kullanır. Kapsayıcı ad products , kategori, miktar, benzersiz tanımlayıcı ve her ürün için satış bayrağı gibi ayrıntıları içerir. Kapsayıcı, mantıksal bölüm anahtarı olarak özelliğini kullanır /category .

İstemcinin kimliğini doğrulama

Bu örnek, sınıfın yeni bir örneğini CosmosClient oluşturur ve bir DefaultAzureCredential örnek kullanarak kimlik doğrulaması yapar.

DefaultAzureCredential credential = new();

CosmosClient client = new(
    accountEndpoint: "<azure-cosmos-db-nosql-account-endpoint>",
    tokenCredential: new DefaultAzureCredential()
);

Veritabanı alma

adlı cosmicworksmevcut veritabanını almak için kullanınclient.GetDatabase.

Database database = client.GetDatabase("cosmicworks");

Kapsayıcı alma

kullanarak database.GetContainermevcut products kapsayıcıyı alın.

Container container = database.GetContainer("products");

Öğe oluşturma

JSON'da seri hale getirmek istediğiniz tüm üyeleri içeren bir C# kayıt türü oluşturun. Bu örnekte, türün benzersiz bir tanımlayıcısı ve kategori, ad, miktar, fiyat ve satış alanları vardır.

public record Product(
    string id,
    string category,
    string name,
    int quantity,
    decimal price,
    bool clearance
);

kullanarak container.UpsertItemkapsayıcıda bir öğe oluşturun. Bu yöntem, zaten varsa öğeyi etkili bir şekilde değiştirerek öğeyi "upsert" eder.

Product item = new(
    id: "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    category: "gear-surf-surfboards",
    name: "Yamba Surfboard",
    quantity: 12,
    price: 850.00m,
    clearance: false
);

ItemResponse<Product> response = await container.UpsertItemAsync<Product>(
    item: item,
    partitionKey: new PartitionKey("gear-surf-surfboards")
);

Öğe okuma

Hem benzersiz tanımlayıcıyı (id) hem de bölüm anahtarı alanlarını kullanarak nokta okuma işlemi gerçekleştirin. Belirli bir öğeyi verimli bir şekilde almak için kullanın container.ReadItem .

ItemResponse<Product> response = await container.ReadItemAsync<Product>(
    id: "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    partitionKey: new PartitionKey("gear-surf-surfboards")
);

Sorgu öğeleri

kullanarak container.GetItemQueryIteratorbir kapsayıcıdaki birden çok öğe üzerinde sorgu gerçekleştirin. Bu parametreli sorguyu kullanarak belirtilen kategorideki tüm öğeleri bulun:

SELECT * FROM products p WHERE p.category = @category
string query = "SELECT * FROM products p WHERE p.category = @category"

var query = new QueryDefinition(query)
  .WithParameter("@category", "gear-surf-surfboards");

using FeedIterator<Product> feed = container.GetItemQueryIterator<Product>(
    queryDefinition: query
);

kullanarak feed.ReadNextAsyncher sonuç sayfasında döngü yaparak sorgunun sayfalandırılmış sonuçlarını ayrıştırın. Her döngünün başında herhangi bir sonuç olup olmadığını belirlemek için kullanın feed.HasMoreResults .

List<Product> items = new();
while (feed.HasMoreResults)
{
    FeedResponse<Product> response = await feed.ReadNextAsync();
    foreach (Product item in response)
    {
        items.Add(item);
    }
}

Kaynakları temizleme

Örnek uygulamaya veya kaynaklara artık ihtiyacınız kalmadığında, ilgili dağıtımı ve tüm kaynakları kaldırın.

azd down