Bagikan melalui

Mulai cepat: Pustaka Azure Cosmos DB for NoSQL untuk Node.js

  • Artikel

BERLAKU UNTUK: NoSQL

Mulai menggunakan pustaka klien Azure Cosmos DB for NoSQL untuk Node.js 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 (npm) | Azure Developer CLI

Prasyarat

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.

Buka di GitHub Codespaces

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.

  1. Buka terminal di direktori akar proyek.

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

    Catatan

    Mulai cepat ini menggunakan repositori GitHub templat azure-samples/cosmos-db-nosql-dotnet-quickstart . Azure Developer CLI akan secara otomatis mengkloning proyek ini ke komputer Anda jika belum ada.

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

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

    azd up

  6. Selama proses provisi, pilih langganan dan lokasi yang Anda inginkan. 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 Node Package Manager, sebagai @azure/cosmos paket.

  1. Buka terminal dan navigasi ke /src folder .

    cd ./src

  2. Jika belum diinstal, instal @azure/cosmos paket menggunakan npm install.

    npm install --save @azure/cosmos

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

    npm install --save @azure/identity

  4. Buka dan tinjau file src/package.json 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.
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.
SqlQuerySpec Antarmuka ini mewakili kueri SQL dan parameter kueri apa pun.

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

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.

const credential = new DefaultAzureCredential();

const client = new CosmosClient({
    '<azure-cosmos-db-nosql-account-endpoint>',
    aadCredentials: credential
});

Mendapatkan database

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

const database = client.database('cosmicworks');

Mendapatkan kontainer

Ambil kontainer yang products ada menggunakan database.container.

const container = database.container('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.items.upsert. Metode ini "upsert" item secara efektif mengganti item jika sudah ada.

const item = {
    'id': '70b63682-b93a-4c77-aad2-65501347265f',
    'category': 'gear-surf-surfboards',
    'name': 'Yamba Surfboard',
    'quantity': 12,
    'price': 850.00,
    'clearance': false
};

let response = await container.items.upsert(item);

Baca item

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

const id = '70b63682-b93a-4c77-aad2-65501347265f';
const partitionKey = 'gear-surf-surfboards';

let response = await container.item(id, partitionKey).read();
let read_item = response.resource;

Buat kueri item

Lakukan kueri melalui beberapa item dalam kontainer menggunakan container.items.query. Temukan semua item dalam kategori tertentu menggunakan kueri berparameter ini:

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

Ambil semua hasil kueri menggunakan query.fetchAll. Mengulangi hasil kueri.

const querySpec = {
    query: 'SELECT * FROM products p WHERE p.category = @category',
    parameters: [
        {
            name: '@category',
            value: 'gear-surf-surfboards'
        }
    ]
};

let response = await container.items.query(querySpec).fetchAll();
for (let item of response.resources) {
    // Do something
}

Konten terkait