Hızlı Başlangıç: Node.js için Azure SDK ile NoSQL için Azure Cosmos DB kullanma
Bu hızlı başlangıçta, Node.js için Azure SDK'sını kullanarak tablo için temel bir Azure Cosmos DB uygulaması dağıtacaksınız. Tablo için Azure Cosmos DB, uygulamaların yapılandırılmış tablo verilerini bulutta depolamasına olanak sağlayan şemasız bir veri deposudur. Node.js için Azure SDK'sını kullanarak Azure Cosmos DB kaynağınızda tablo, satır oluşturma ve temel görevleri gerçekleştirme hakkında bilgi edinirsiniz.
API başvuru belgeleri | Kitaplık kaynak kodu | Paketi (npm) | Azure Geliştirici CLI
Önkoşullar
- Azure Geliştirici CLI
- Docker Desktop
- Node.js 22 veya üzeri
Azure hesabınız yoksa, başlamadan önce ücretsiz hesap oluşturun.
Projeyi başlatma
Tablo hesabı için Azure Cosmos DB oluşturmak ve kapsayıcılı örnek bir uygulama dağıtmak için Azure Geliştirici CLI'sini (azd
) kullanın. Örnek uygulama örnek verileri yönetmek, oluşturmak, okumak ve sorgulamak için istemci kitaplığını kullanır.
Boş bir dizinde bir terminal açın.
Henüz kimlik doğrulaması yapmadıysanız kullanarak
azd auth login
Azure Geliştirici CLI'sinde kimlik doğrulamasından geçin. Tercih ettiğiniz Azure kimlik bilgilerini kullanarak CLI'da kimlik doğrulaması yapmak için araç tarafından belirtilen adımları izleyin.azd auth login
Projeyi başlatmak için kullanın
azd init
.azd init --template cosmos-db-nosql-nodejs-quickstart
Başlatma sırasında benzersiz bir ortam adı yapılandırın.
Kullanarak
azd up
Azure Cosmos DB hesabını dağıtın. Bicep şablonları ayrıca örnek bir web uygulaması dağıtır.azd up
Sağlama işlemi sırasında aboneliğinizi, istediğiniz konumu ve hedef kaynak grubunu seçin. Sağlama işleminin tamamlanmasını bekleyin. İşlem yaklaşık beş dakika sürebilir.
Azure kaynaklarınızın sağlanması tamamlandıktan sonra, çalışan web uygulamasının URL'si çıktıya eklenir.
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.
Tarayıcıda web uygulamanıza gitmek için konsoldaki URL'yi kullanın. Çalışan uygulamanın çıkışını gözlemleyin.
İstemci kitaplığını yükleme
İstemci kitaplığı, node Paket Yöneticisi aracılığıyla paket olarak @azure/cosmos
kullanılabilir.
Bir terminal açın ve klasöre
/src
gidin.cd ./src
Henüz yüklü değilse, kullanarak paketini
npm install
yükleyin@azure/cosmos
.npm install --save @azure/cosmos
Ayrıca, henüz yüklü değilse paketi yükleyin
@azure/identity
.npm install --save @azure/identity
src/package.json dosyasını açıp gözden geçirerek ve
azure-identity
girdilerinin her ikisinin de var olduğunuazure-cosmos
doğrulayın.
Nesne modeli
Veri Akışı Adı | Açıklama |
---|---|
CosmosClient |
Bu sınıf birincil istemci sınıfıdır ve hesap genelindeki meta verileri veya veritabanlarını yönetmek için kullanılır. |
Database |
Bu sınıf, hesaptaki bir veritabanını temsil eder. |
Container |
Bu sınıf öncelikli olarak kapsayıcıda veya kapsayıcıda depolanan öğelerde okuma, güncelleştirme ve silme işlemleri gerçekleştirmek için kullanılır. |
PartitionKey |
Bu sınıf mantıksal bölüm anahtarını temsil eder. Bu sınıf birçok yaygın işlem ve sorgu için gereklidir. |
SqlQuerySpec |
Bu arabirim bir SQL sorgusunu ve tüm sorgu parametrelerini temsil eder. |
Kod örnekleri
Şablondaki örnek kod adlı bir veritabanı ve adlı cosmicworks
products
kapsayıcıyı kullanır. Kapsayıcı ad products
, kategori, miktar, benzersiz tanımlayıcı ve her ürün için satış bayrağı gibi ayrıntıları içerir. Kapsayıcı, mantıksal bölüm anahtarı olarak özelliğini kullanır /category
.
İstemcinin kimliğini doğrulama
Bu örnek türün CosmosClient
yeni bir örneğini oluşturur ve bir DefaultAzureCredential
örneği kullanarak kimlik doğrulaması yapar.
const credential = new DefaultAzureCredential();
const client = new CosmosClient({
'<azure-cosmos-db-nosql-account-endpoint>',
aadCredentials: credential
});
const credential: TokenCredential = new DefaultAzureCredential();
const client = new CosmosClient({
'<azure-cosmos-db-nosql-account-endpoint>',
aadCredentials: credential
});
Veritabanı alma
adlı cosmicworks
mevcut veritabanını almak için kullanınclient.database
.
const database = client.database('cosmicworks');
const database: Database = client.database('cosmicworks');
Kapsayıcı alma
kullanarak database.container
mevcut products
kapsayıcıyı alın.
const container = database.container('products');
const container: Container = database.container('products');
Öğe oluşturma
JSON'da seri hale getirmek istediğiniz tüm üyeleriyle yeni bir nesne oluşturun. Bu örnekte, türün benzersiz bir tanımlayıcısı ve kategori, ad, miktar, fiyat ve satış alanları vardır. kullanarak container.items.upsert
kapsayıcıda bir öğe oluşturun. Bu yöntem, zaten varsa öğeyi etkili bir şekilde değiştirerek öğeyi "upsert" eder.
const item = {
'id': 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
'category': 'gear-surf-surfboards',
'name': 'Yamba Surfboard',
'quantity': 12,
'price': 850.00,
'clearance': false
};
let response = await container.items.upsert(item);
const item: Product = {
'id': 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
'category': 'gear-surf-surfboards',
'name': 'Yamba Surfboard',
'quantity': 12,
'price': 850.00,
'clearance': false
};
let response: ItemResponse<Product> = await container.items.upsert<Product>(item);
Öğe okuma
Hem benzersiz tanımlayıcıyı (id
) hem de bölüm anahtarı alanlarını kullanarak nokta okuma işlemi gerçekleştirin. Bir öğeye işaretçi almak ve item.read
belirli bir öğeyi verimli bir şekilde almak için kullanıncontainer.item
.
const id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb';
const partitionKey = 'gear-surf-surfboards';
let response = await container.item(id, partitionKey).read();
let read_item = response.resource;
const id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb';
const partitionKey = 'gear-surf-surfboards';
let response: ItemResponse<Product> = await container.item(id, partitionKey).read<Product>();
let read_item: Product = response.resource!;
Sorgu öğeleri
kullanarak container.items.query
bir kapsayıcıdaki birden çok öğe üzerinde sorgu gerçekleştirin. Bu parametreli sorguyu kullanarak belirtilen kategorideki tüm öğeleri bulun:
SELECT * FROM products p WHERE p.category = @category
kullanarak query.fetchAll
sorgunun tüm sonuçlarını getirin. Sorgunun sonuçları arasında döngü yapın.
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
}
const querySpec: SqlQuerySpec = {
query: 'SELECT * FROM products p WHERE p.category = @category',
parameters: [
{
name: '@category',
value: 'gear-surf-surfboards'
}
]
};
let response: FeedResponse<Product> = await container.items.query<Product>(querySpec).fetchAll();
for (let item of response.resources) {
// Do something
}
Kaynakları temizleme
Örnek uygulamaya veya kaynaklara artık ihtiyacınız kalmadığında, ilgili dağıtımı ve tüm kaynakları kaldırın.
azd down