Bagikan melalui

Mulai Cepat: Menggunakan Azure Cosmos DB untuk NoSQL dengan Azure SDK untuk Python

  • Berlaku untuk: ✅ NoSQL

Dalam panduan cepat ini, Anda mengimplementasikan aplikasi "Azure Cosmos DB for NoSQL" sederhana dengan menggunakan Azure SDK dengan bahasa pemrograman Python. Azure Cosmos DB for NoSQL adalah penyimpanan data tanpa skema yang memungkinkan aplikasi menyimpan data yang tidak terstruktur di cloud. Kueri data dalam kontainer Anda dan lakukan operasi umum pada item individual menggunakan Azure SDK untuk Python.

Dokumentasi referensi API | Kode sumber pustaka | Paket (PyPI) | Azure Developer CLI

Prasyarat

  • Azure Developer CLI
  • Desktop Docker
  • Python 3.12

Jika Anda tidak memiliki akun Azure, buat akun gratis sebelum memulai.

Menginisialisasi proyek

Gunakan Azure Developer CLI (azd) untuk membuat azure Cosmos DB untuk akun NoSQL dan menyebarkan aplikasi sampel dalam kontainer. Aplikasi sampel menggunakan pustaka klien untuk mengelola, membuat, membaca, dan mengkueri data sampel.

  1. Buka terminal di direktori kosong.

  2. 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

  3. Gunakan azd init untuk menginisialisasi proyek.

    azd init --template cosmos-db-nosql-python-quickstart

  4. Selama inisialisasi, konfigurasikan nama lingkungan yang unik.

  5. Sebarkan akun Azure Cosmos DB menggunakan azd up. Templat Bicep juga menyebarkan aplikasi web sampel.

    azd up

  6. 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.

  7. 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.

  8. Gunakan URL di konsol untuk menavigasi ke aplikasi web Anda di browser. Amati output aplikasi yang sedang berjalan.

Cuplikan layar aplikasi web yang sedang berjalan.

Memasang pustaka klien

Pustaka klien tersedia melalui Indeks Paket Python, sebagai pustaka azure-cosmos.

  1. Buka terminal dan navigasi ke /src folder .

    cd ./src

  2. Jika belum diinstal, instal azure-cosmos paket menggunakan pip install.

    pip install azure-cosmos

  3. Selain itu, jika belum diinstal, instal paket azure-identity.

    pip install azure-identity

  4. Buka dan tinjau file src/requirements.txt untuk memvalidasi bahwa azure-cosmos entri dan azure-identity keduanya ada.

Mengimpor pustaka

Impor DefaultAzureCredential dan jenis CosmosClient ke dalam kode aplikasi Anda.

from azure.identity import DefaultAzureCredential
from azure.cosmos import CosmosClient

Model objek

Nama Deskripsi
CosmosClient Kelas ini adalah kelas klien utama dan digunakan untuk mengelola metadata atau database di seluruh akun.
DatabaseProxy Kelas ini mewakili database dalam akun.
ContainerProxy 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 pertanyaan umum.

Contoh kode

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 baru jenis CosmosClient dan mengautentikasi menggunakan DefaultAzureCredential instans.

credential = DefaultAzureCredential()

client = CosmosClient(url="<azure-cosmos-db-nosql-account-endpoint>", credential=credential)

Mendapatkan database

Gunakan client.get_database_client untuk mengambil database yang sudah ada bernama cosmicworks.

database = client.get_database_client("cosmicworks")

Dapatkan kontainer

Ambil kontainer yang ada products menggunakan database.get_container_client.

container = database.get_container_client("products")

Buat barang

Buat objek baru dengan semua anggota yang ingin Anda serialkan ke JSON. Dalam contoh ini, tipe memiliki pengidentifikasi unik, dan kolom untuk kategori, nama, kuantitas, harga, dan penjualan. Buat item dalam kontainer menggunakan container.upsert_item. Metode ini akan "menyisipkan atau memperbarui" item, secara efektif mengganti item jika sudah ada.

new_item = {
    "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "category": "gear-surf-surfboards",
    "name": "Yamba Surfboard",
    "quantity": 12,
    "sale": False,
}

created_item = container.upsert_item(new_item)

Baca sebuah item

Lakukan operasi baca titik dengan menggunakan bidang pengidentifikasi unik (id) dan kunci partisi. Gunakan container.read_item untuk mengambil item tertentu secara efisien.

existing_item = container.read_item(
    item="aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    partition_key="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

queryText = "SELECT * FROM products p WHERE p.category = @category"

results = container.query_items(
    query=queryText,
    parameters=[
        dict(
            name="@category",
            value="gear-surf-surfboards",
        )
    ],
    enable_cross_partition_query=False,
)

Menelusuri hasil-hasil dari kueri.

items = [item for item in results]

output = json.dumps(items, indent=True)

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 fitur 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 Azure Cosmos DB untuk data NoSQL.

Membersihkan sumber daya

Saat Anda tidak lagi memerlukan aplikasi sampel atau sumber daya, hapus penyebaran dan semua sumber daya terkait.

azd down

Konten terkait

  • Last updated on