Mulai menggunakan Azure Cosmos DB for Table menggunakan .NET

BERLAKU UNTUK: Meja

Artikel ini memperlihatkan kepada Anda cara menyambungkan ke Azure Cosmos DB for Table menggunakan .NET SDK. Setelah tersambung, Anda dapat melakukan operasi pada database, kontainer, dan item.

Paket (NuGet) | Contoh | Referensi API | Kode sumber pustaka | Berikan Umpan Balik |

Prasyarat

• Akun Azure dengan langganan aktif. Buat akun gratis.
• Akun Azure Cosmos DB for Table. Buat API untuk akun Table.
• .NET 6.0 atau yang lebih baru
• Azure Command-Line Interface (CLI) atau Azure PowerShell

Menyiapkan proyek Anda

Membuat aplikasi konsol .NET

Buat aplikasi .NET baru dengan menggunakan perintah dotnet new dengan templat konsol.

dotnet new console

Impor paket NuGet Azure.Data.Tables menggunakan perintah dotnet add package.

dotnet add package Azure.Data.Tables

Buat proyek dengan perintah dotnet build.

dotnet build

Menyambungkan ke Azure Cosmos DB for Table

Untuk menyambungkan ke API untuk Tabel Azure Cosmos DB, buat instans TableServiceClient kelas . Kelas ini adalah titik awal untuk melakukan semua operasi terhadap tabel. Ada dua cara utama untuk menyambungkan ke API untuk akun Table menggunakan kelas TableServiceClient :

• Menyambungkan dengan API untuk string koneksi Tabel

Menghubungkan dengan string koneksi

Konstruktor paling umum untuk TableServiceClient memiliki satu parameter:

Parameter	Contoh nilai	Deskripsi
connectionString	COSMOS_CONNECTION_STRING Variabel lingkungan	String koneksi ke API untuk akun Table

Mengambil string koneksi akun Anda

Azure CLI

1. Gunakan perintah az cosmosdb list untuk mengambil nama akun Azure Cosmos DB pertama di grup sumber daya Anda dan simpan di variabel shell accountName.

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

2. Temukan STRING KONEKSI UTAMA dari daftar string koneksi untuk akun dengan perintah az-cosmosdb-keys-list.

   az cosmosdb keys list \
       --resource-group $resourceGroupName \
       --name $accountName \
       --type "connection-strings" \
       --query "connectionStrings[?description == \`Primary Table Connection String\`] | [0].connectionString"
   

PowerShell

1. Gunakan cmdlet Get-AzCosmosDBAccount untuk mengambil nama akun Azure Cosmos DB pertama di grup sumber daya Anda dan simpan di variabel shell ACCOUNT_NAME.

   # Retrieve most recently created account name
   $parameters = @{
       ResourceGroupName = $RESOURCE_GROUP_NAME
   }
   $ACCOUNT_NAME = (
       Get-AzCosmosDBAccount @parameters |
           Select-Object -Property Name -First 1
   ).Name
   

2. Temukan STRING KONEKSI UTAMA dari daftar string koneksi untuk akun dengan cmdlet Get-AzCosmosDBAccountKey.

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

Untuk menggunakan nilai STRING KONEKSI UTAMA dalam kode .NET Anda, pertahankan nilai tersebut untuk variabel lingkungan baru pada komputer lokal yang menjalankan aplikasi.

Windows

$env:COSMOS_CONNECTION_STRING = "<cosmos-account-PRIMARY-CONNECTION-STRING>"

Linux / macOS

export COSMOS_CONNECTION_STRING="<cosmos-account-PRIMARY-CONNECTION-STRING>"

Membuat TableServiceClient dengan string koneksi

Buat instans baru kelas TableServiceClient dengan variabel lingkungan COSMOS_CONNECTION_STRING sebagai satu-satunya parameter.

// New instance of TableServiceClient class using a connection string
TableServiceClient client = new(
    connectionString: Environment.GetEnvironmentVariable("COSMOS_CONNECTION_STRING")!
);

Bangun aplikasi Anda

Saat Anda membangun aplikasi, kode Anda utamanya akan berinteraksi dengan empat jenis sumber daya:

• AKUN API untuk Tabel, yang merupakan namespace layanan tingkat atas unik untuk data Azure Cosmos DB Anda.

• Tabel, yang berisi sekumpulan item individual dalam akun Anda.

• Item, yang mewakili item individual dalam tabel Anda.

Diagram berikut menunjukkan hubungan antara ketiga sumber daya ini.

Diagram hierarki memperlihatkan akun Azure Cosmos DB di bagian atas. Akun ini memiliki dua node tabel turunan. Salah satu node tabel mencakup dua item anak.

Setiap jenis sumber daya diwakili oleh satu atau lebih kelas atau antarmuka .NET terkait. Berikut adalah daftar kelas yang paling umum:

Kelas	Deskripsi
TableServiceClient	Kelas klien ini menyediakan representasi logis sisi klien untuk layanan Azure Cosmos DB. Klien ini digunakan untuk mengonfigurasi dan menjalankan permintaan terhadap layanan.
TableClient	Kelas klien ini adalah referensi ke tabel yang mungkin sudah ada, atau mungkin belum ada dalam layanan. Tabel divalidasi di sisi server saat Anda mencoba mengaksesnya atau melakukan operasi terhadapnya.
ITableEntity	Antarmuka ini adalah antarmuka dasar untuk item apa pun yang dibuat dalam tabel atau dikueri dari tabel. Antarmuka ini mencakup semua properti yang diperlukan untuk item di API untuk Tabel.
TableEntity	Kelas ini adalah implementasi generik antarmuka ITableEntity sebagai kamus pasangan kunci-nilai.

Panduan berikut menunjukkan cara menggunakan masing-masing kelas ini untuk membangun aplikasi Anda.

Panduan	Deskripsi
Buat tabel	Membuat tabel
Membuat item	Membuat item
Membaca item	Membaca item

Lihat juga

• Paket (NuGet)
• Sampel
• Referensi API
• Kode sumber pustaka
• Berikan Umpan Balik

Langkah berikutnya

Sekarang setelah Anda tersambung ke API untuk akun Table, gunakan panduan berikutnya untuk membuat dan mengelola tabel.

Membuat tabel di Azure Cosmos DB for Table menggunakan .NET