快速入門：搭配適用於 Node.js 的 Azure SDK 使用適用於 NoSQL 的 Azure Cosmos DB

• 適用於:

  ✅ NoSQL

• .NET
• Node.js
• Java
• Python
• Go

在本快速入門中，您會使用適用於 Node.js 的 Azure SDK 來部署適用於資料表的基本 Azure Cosmos DB 應用程式。 Azure Cosmos DB for Table 是無架構的數據存放區，可讓應用程式將結構化數據表數據儲存在雲端中。 您將瞭解如何使用 Azure SDK for Node.js，在 Azure Cosmos DB 資源內建立數據表、數據列和執行基本工作。

API 參考文件 | 程式庫原始程式碼 | 套件 (npm) | Azure Developer CLI

必要條件

• Azure Developer CLI
• Docker Desktop
• Node.js 22 或更新

如果您沒有 Azure 帳戶，請在您開始之前先建立 免費帳戶。

初始化專案

使用 Azure 開發人員 CLI （azd） 建立適用於資料表帳戶的 Azure Cosmos DB，並部署容器化範例應用程式。 應用程式範例使用用戶端程式庫管理、建立、讀取和查詢樣本資料。

1. 在空的目錄中開啟終端機。

2. 如果您尚未通過驗證，請使用 azd auth login向 Azure 開發人員 CLI 進行驗證。 依照工具指定的步驟，使用您慣用的 Azure 認證向 CLI 進行驗證。

   azd auth login
   

3. 使用 azd init 來初始化專案。

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

4. 在初始化期間，請設定唯一的環境名稱。

5. 使用 azd up 部署 Azure Cosmos DB 帳戶。 Bicep 範本也會部署範例 Web 應用程式。

   azd up
   

6. 在布建程式期間，選取您的訂用帳戶、所需的位置和目標資源群組。 等候佈建程序完成。 此流程「大約需要五分鐘」的時間。

7. Azure 資源佈建完成後，輸出將包含正在執行的 Web 應用程式的 URL。

   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. 請使用主控台中的 URL，以在瀏覽器中導覽至您的 Web 應用程式。 觀察執行中應用程式的輸出。

安裝用戶端程式庫

用戶端程式庫可透過 Node 套件管理員以 @azure/cosmos 套件形式提供。

1. 開啟終端機，然後導覽至 /src 資料夾。

   cd ./src
   

2. 如果尚未安裝，則請使用 npm install 來安裝 @azure/cosmos 套件。

   npm install --save @azure/cosmos
   

3. 也請安裝 @azure/identity 套件 (如果尚未安裝)。

   npm install --save @azure/identity
   

4. 開啟並檢閱 src/package.json 檔案，以驗證 azure-cosmos 和 azure-identity 項目都存在。

物件模型

名稱	描述
CosmosClient	此類別是主要用戶端類別，並且用來管理全帳戶中繼資料或資料庫。
Database	此類別代表帳戶內的資料庫。
Container	此類別主要用來對容器或容器內所儲存的項目執行讀取、更新和刪除作業。
PartitionKey	此類別代表邏輯分割區索引鍵。 許多常見的作業和查詢都需要此類別。
SqlQuerySpec	此介面代表 SQL 查詢和任何查詢參數。

程式碼範例

• 驗證用戶端
• 取得資料庫
• 取得容器
• 建立項目
• 取得項目
• 查詢項目

範本中的程式碼範例使用 cosmicworks 資料庫和 products 容器。 products 容器包含每個產品的名稱、類別、數量、唯一識別碼和銷售旗標這類詳細資料。 容器使用 /category 屬性作為邏輯分割區索引鍵。

驗證用戶端

此範例會建立 CosmosClient 類型的新執行個體，並使用 DefaultAzureCredential 執行個體來進行驗證。

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
});

取得資料庫

使用 client.database 來擷取名為 cosmicworks 的現有資料庫。

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

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

取得容器

使用 database.container 來擷取現有 products 容器。

const container = database.container('products');

const container: Container = database.container('products');

建立項目

建置新的物件，而此物件具有所有您想要序列化成 JSON 的成員。 在此範例中，此類型具有唯一識別碼，以及類別、名稱、數量、價格和銷售的欄位。 使用 container.items.upsert，以在容器中建立項目。 此方法會有效地 "upserts" 可取代項目 (如果已存在) 的項目。

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);

讀取項目

使用唯一識別碼 (id) 和分割區索引鍵欄位，來執行點讀取作業。 使用 container.item 來取得項目的指標，以及使用 item.read 來有效率地擷取特定項目。

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!;

查詢項目

使用 container.items.query，以對容器中的多個項目執行查詢。 使用此參數化查詢，來尋找所指定類別內的所有項目：

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

使用 query.fetchAll 來擷取查詢的所有結果。 重複查看查詢的結果。

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
}

清除資源

當您不再需要範例應用程式或資源時，請移除對應的部署和所有資源。

azd down

相關內容

• .NET 快速入門
• Java 快速入門
• Python 快速入門
• Go 快速入門