Mulai cepat: Menggunakan Azure Cosmos DB untuk NoSQL dengan Azure SDK untuk .NET
Dalam mulai cepat ini, Anda menyebarkan aplikasi Azure Cosmos DB for Table dasar menggunakan Azure SDK untuk .NET. Azure Cosmos DB for Table adalah penyimpanan data tanpa skema yang memungkinkan aplikasi menyimpan data tabel terstruktur di cloud. Anda mempelajari cara membuat tabel, baris, dan melakukan tugas dasar dalam sumber daya Azure Cosmos DB Anda menggunakan Azure SDK untuk .NET.
Dokumentasi | referensi API Paket kode | sumber pustaka (NuGet) | Azure Developer CLI
Prasyarat
- Azure Developer CLI
- Desktop Docker
- .NET 9.0
Jika Anda tidak memiliki akun Azure, buat akun gratis sebelum memulai.
Menginisialisasi proyek
Gunakan Azure Developer CLI (azd
) untuk membuat akun Azure Cosmos DB for Table dan menyebarkan aplikasi sampel kontainer. Aplikasi sampel menggunakan pustaka klien untuk mengelola, membuat, membaca, dan mengkueri data sampel.
Buka terminal di direktori kosong.
Jika Anda belum diautentikasi, autentikasi ke Azure Developer CLI menggunakan
azd auth login
. Ikuti langkah-langkah yang ditentukan oleh alat untuk mengautentikasi ke CLI menggunakan kredensial Azure pilihan Anda.azd auth login
Gunakan
azd init
untuk menginisialisasi proyek.azd init --template cosmos-db-nosql-dotnet-quickstart
Selama inisialisasi, konfigurasikan nama lingkungan yang unik.
Sebarkan akun Azure Cosmos DB menggunakan
azd up
. Templat Bicep juga menyebarkan aplikasi web sampel.azd up
Selama proses provisi, pilih langganan Anda, lokasi yang diinginkan, dan grup sumber daya target. Tunggu hingga proses provisi selesai. Prosesnya dapat memakan waktu sekitar lima menit.
Setelah provisi sumber daya Azure Anda selesai, URL ke aplikasi web yang sedang berjalan disertakan dalam output.
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.
Gunakan URL di konsol untuk menavigasi ke aplikasi web Anda di browser. Amati output aplikasi yang sedang berjalan.
Memasang pustaka klien
Pustaka klien tersedia melalui NuGet, sebagai Microsoft.Azure.Cosmos
paket.
Buka terminal dan navigasi ke
/src/web
folder .cd ./src/web
Jika belum diinstal, instal
Microsoft.Azure.Cosmos
paket menggunakandotnet add package
.dotnet add package Microsoft.Azure.Cosmos --version 3.*
Selain itu
Azure.Identity
, instal paket jika belum diinstal.dotnet add package Azure.Identity --version 1.12.*
Buka dan tinjau file src/web/Cosmos.Samples.NoSQL.Quickstart.Web.csproj untuk memvalidasi bahwa
Microsoft.Azure.Cosmos
entri danAzure.Identity
keduanya ada.
Model objek
Nama | Deskripsi |
---|---|
CosmosClient | Kelas ini adalah kelas klien utama dan digunakan untuk mengelola metadata atau database di seluruh akun. |
Database | Kelas ini mewakili database dalam akun. |
Container | Kelas ini terutama digunakan untuk melakukan operasi baca, perbarui, dan hapus pada kontainer atau item yang disimpan dalam kontainer. |
PartitionKey | Kelas ini mewakili kunci partisi logis. Kelas ini diperlukan untuk banyak operasi dan kueri umum. |
Contoh kode
- Autentikasi klien
- Mendapatkan database
- Mendapatkan kontainer
- Membuat item
- Mendapatkan item
- Item kueri
Kode sampel dalam templat menggunakan database bernama cosmicworks
dan kontainer bernama products
. Kontainer products
berisi detail seperti nama, kategori, kuantitas, pengidentifikasi unik, dan bendera penjualan untuk setiap produk. Kontainer menggunakan /category
properti sebagai kunci partisi logis.
Mengautentikasi klien
Sampel ini membuat instans CosmosClient
baru kelas dan mengautentikasi menggunakan DefaultAzureCredential
instans.
DefaultAzureCredential credential = new();
CosmosClient client = new(
accountEndpoint: "<azure-cosmos-db-nosql-account-endpoint>",
tokenCredential: new DefaultAzureCredential()
);
Mendapatkan database
Gunakan client.GetDatabase
untuk mengambil database yang sudah ada bernama cosmicworks
.
Database database = client.GetDatabase("cosmicworks");
Mendapatkan kontainer
Ambil kontainer yang products
ada menggunakan database.GetContainer
.
Container container = database.GetContainer("products");
Membuat item
Buat jenis catatan C# dengan semua anggota yang ingin Anda serialkan ke JSON. Dalam contoh ini, jenis memiliki pengidentifikasi unik, dan bidang untuk kategori, nama, kuantitas, harga, dan penjualan.
public record Product(
string id,
string category,
string name,
int quantity,
decimal price,
bool clearance
);
Buat item dalam kontainer menggunakan container.UpsertItem
. Metode ini "upsert" item secara efektif mengganti item jika sudah ada.
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")
);
Baca item
Lakukan operasi baca titik dengan menggunakan bidang pengidentifikasi unik (id
) dan kunci partisi. Gunakan container.ReadItem
untuk mengambil item tertentu secara efisien.
ItemResponse<Product> response = await container.ReadItemAsync<Product>(
id: "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
partitionKey: new PartitionKey("gear-surf-surfboards")
);
Buat kueri item
Lakukan kueri melalui beberapa item dalam kontainer menggunakan container.GetItemQueryIterator
. Temukan semua item dalam kategori tertentu menggunakan kueri berparameter ini:
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
);
Uraikan hasil kueri yang dipaginasi dengan mengulangi setiap halaman hasil menggunakan feed.ReadNextAsync
. Gunakan feed.HasMoreResults
untuk menentukan apakah ada hasil yang tersisa di awal setiap perulangan.
List<Product> items = new();
while (feed.HasMoreResults)
{
FeedResponse<Product> response = await feed.ReadNextAsync();
foreach (Product item in response)
{
items.Add(item);
}
}
Jelajahi sampel Anda
Gunakan ekstensi Visual Studio Code untuk Azure Cosmos DB untuk menjelajahi data NoSQL Anda. Anda dapat melakukan operasi database inti termasuk, tetapi tidak terbatas pada:
- Melakukan kueri menggunakan scrapbook atau editor kueri
- Memodifikasi, memperbarui, membuat, dan menghapus item
- Mengimpor data massal dari sumber lain
- Mengelola database dan kontainer
Untuk informasi selengkapnya, lihat Cara menggunakan ekstensi Visual Studio Code untuk menjelajahi data Azure Cosmos DB for NoSQL.
Membersihkan sumber daya
Saat Anda tidak lagi memerlukan aplikasi sampel atau sumber daya, hapus penyebaran dan semua sumber daya yang sesuai.
azd down