Mulai cepat: Azure Cosmos DB untuk pustaka NoSQL untuk Python

Artikel
01/10/2024

BERLAKU UNTUK: NoSQL

Mulai menggunakan pustaka klien Azure Cosmos DB for NoSQL untuk Python untuk mengkueri data dalam kontainer Anda dan melakukan operasi umum pada item individual. Ikuti langkah-langkah ini untuk menyebarkan solusi minimal ke lingkungan Anda menggunakan Azure Developer CLI.

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

Prasyarat

Akun Azure dengan langganan aktif. Buat akun secara gratis.
Akun GitHub

Akun Azure dengan langganan aktif. Buat akun secara gratis.
Azure Developer CLI
Desktop Docker

Menyiapkan

Sebarkan kontainer pengembangan proyek ini ke lingkungan Anda. Kemudian, gunakan Azure Developer CLI (azd) untuk membuat akun Azure Cosmos DB for NoSQL dan menyebarkan aplikasi sampel dalam kontainer. Aplikasi sampel menggunakan pustaka klien untuk mengelola, membuat, membaca, dan mengkueri data sampel.

Penting

Akun GitHub mencakup pemberian izin penyimpanan dan jam inti tanpa biaya. Untuk informasi selengkapnya, lihat penyimpanan dan jam inti yang disertakan untuk akun GitHub.

Buka terminal di direktori akar proyek.
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
```
Selama inisialisasi, konfigurasikan nama lingkungan yang unik.

Tip

Nama lingkungan juga akan digunakan sebagai nama grup sumber daya target. Untuk mulai cepat ini, pertimbangkan untuk menggunakan msdocs-cosmos-db-.
Sebarkan akun Azure Cosmos DB menggunakan azd up. Templat Bicep juga menyebarkan aplikasi web sampel.
```
azd up
```
Selama proses provisi, pilih langganan dan lokasi yang Anda inginkan. 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 Indeks Paket Python, sebagai azure-cosmos pustaka.

Buka terminal dan navigasi ke /src folder .
```
cd ./src
```
Jika belum diinstal, instal azure-cosmos paket menggunakan pip install.
```
pip install azure-cosmos
```
Selain itu azure-identity , instal paket jika belum diinstal.
```
pip install azure-identity
```
Buka dan tinjau file src/requirements.txt untuk memvalidasi bahwa azure-cosmos entri dan azure-identity keduanya ada.

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

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

Permintaan aplikasi ke sebagian besar layanan Azure harus diotorisasi. DefaultAzureCredential Gunakan jenis sebagai cara yang disukai untuk menerapkan koneksi tanpa kata sandi antara aplikasi Anda dan Azure Cosmos DB untuk NoSQL. DefaultAzureCredential mendukung beberapa metode autentikasi dan menentukan metode autentikasi yang harus digunakan saat runtime bahasa umum.

Penting

Anda juga dapat mengotorisasi permintaan ke layanan Azure menggunakan kata sandi, string koneksi, atau kredensial lainnya secara langsung. Namun, pendekatan ini harus digunakan dengan hati-hati. Pengembang harus rajin untuk tidak pernah mengekspos rahasia ini di lokasi yang tidak aman. Siapa pun yang mendapatkan akses ke kata sandi atau kunci rahasia dapat mengautentikasi ke layanan database. DefaultAzureCredential menawarkan manfaat manajemen dan keamanan yang ditingkatkan atas kunci akun untuk memungkinkan autentikasi tanpa kata sandi tanpa risiko menyimpan kunci.

Sampel ini membuat instans baru jenis CosmosClient dan mengautentikasi menggunakan DefaultAzureCredential instans.

credential = DefaultAzureCredential()
client = CosmosClient(url=endpoint, credential=credential)

Mendapatkan database

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

database = client.get_database_client("cosmicworks")

Mendapatkan kontainer

Ambil kontainer yang products ada menggunakan database.get_container_client.

container = database.get_container_client("products")

Membuat item

Buat objek baru 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. Buat item dalam kontainer menggunakan container.upsert_item. Metode ini "upsert" item secara efektif mengganti item jika sudah ada.

new_item = {
    "id": "70b63682-b93a-4c77-aad2-65501347265f",
    "category": "gear-surf-surfboards",
    "name": "Yamba Surfboard",
    "quantity": 12,
    "sale": False,
}
created_item = container.upsert_item(new_item)

Baca 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="70b63682-b93a-4c77-aad2-65501347265f",
    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,
)

Mengulangi hasil kueri.

items = [item for item in results]
output = json.dumps(items, indent=True)

Langkah selanjutnya

Paket PyPI