適用於 JS 的 Azure Cosmos DB for NoSQL 範例

適用於：NoSQL

• .NET SDK 範例
• Java V4 SDK 範例
• Spring Data V5 SDK 範例
• Node.js 範例
• Python 範例
• Azure 程式碼範例庫

適用於 Azure Cosmos DB 的 JavaScript SDK GitHub 存放庫中包含可對 Azure Cosmos DB 資源執行 CRUD 作業和其他常見作業的範例解決方案。 本文提供：

• 每個 Node.js 範例專案檔中各項工作的連結。
• 相關 API 參考內容的連結。

必要條件

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

• 您可以 啟用 Visual Studio 訂閱者權益：您的 Visual Studio 訂用帳戶每個月都會提供額度，供您用在 Azure 付費服務。

您可以免費試用 Azure Cosmos DB，不需 Azure 訂用帳戶，也不需要承諾用量。 或者，您可以建立 Azure Cosmos DB 免費層帳戶，免費使用前 1000 RU/秒和 25 GB 的儲存體。 您也可以搭配 https://localhost:8081 的 URI 使用 Azure Cosmos DB 模擬器。 如需要搭配模擬器使用的金鑰，請參閱驗證要求。

您還需要 JavaScript SDK。

注意

每個範例都各自獨立，自己設定，並自行清理。 據此，這些範例對 Containers.create 發出多個呼叫。 每當執行此動作時，即會根據所建立容器的效能層，對訂用帳戶計入一小時的使用量費用。

資料庫範例

DatabaseManagement 檔案會顯示如何在資料庫上執行 CRUD 作業。 若要在執行下列範例之前，先了解 Azure Cosmos DB 資料庫，請參閱使用資料庫、容器和項目概念文章。

Task	API 參考
如果資料庫不存在，請建立資料庫	Databases.createIfNotExists
列出帳戶的資料庫	Databases.readAll
依識別碼讀取資料庫	Database.read
刪除資料庫	Database.delete

容器範例

ContainerManagement 檔案會顯示如何在容器上執行 CRUD 作業。 若要在執行下列範例之前，先了解 Azure Cosmos DB 集合，請參閱使用資料庫、容器和項目概念文章。

Task	API 參考
如果容器不存在，請建立容器	Containers.createIfNotExists
列出帳戶的容器	Containers.readAll
讀取容器定義	Container.read
刪除容器	Container.delete

項目範例

ItemManagement 檔案會顯示如何在項目上執行 CRUD 作業。 若要在執行下列範例之前，先了解 Azure Cosmos DB 文件，請參閱使用資料庫、容器和項目概念文章。

Task	API 參考
建立項目	Items.create
讀取容器中的所有項目	Items.readAll
依識別碼讀取項目	Item.read
在項目已變更時才讀取項目	Item.read - RequestOptions.accessCondition
查詢文件	Items.query
取代項目	Item.replace
以條件式 ETag 檢查取代項目	Item.replace - RequestOptions.accessCondition
刪除項目	Item.delete

索引範例

IndexManagement 檔案會顯示如何管理索引編製。 若要在執行下列範例之前先了解 Azure Cosmos DB 中的索引功能，請參閱索引原則、索引類型及索引路徑概念性文章。

Task	API 參考
手動編製特定項目的索引	RequestOptions.indexingDirective: 'include'
手動從索引中排除特定項目	RequestOptions.indexingDirective: 'exclude'
從索引中排除某個路徑	IndexingPolicy.ExcludedPath
建立字串路徑的範圍索引	IndexKind.Range、IndexingPolicy、Items.query
使用預設 indexPolicy 建立容器，然後在線上更新容器	Containers.create

伺服器端程式設計範例

index.ts 檔案會顯示如何執行下列工作。 若要在執行下列範例之前先了解 Azure Cosmos DB 中的伺服器端程式設計，請參閱預存程序、觸發程序和使用者定義函數概念性文章。

Task	API 參考
建立預存程序	StoredProcedures.create
執行預存程序	StoredProcedure.execute
使用預存程序進行大量更新	StoredProcedure.execute

如需伺服器端程式設計的詳細資訊，請參閱 Azure Cosmos DB 伺服器端程式設計：預存程序、資料庫觸發程序和 UDF。

Azure 身分識別 (AAD) 驗證範例

AADAuth.ts 檔案會顯示如何執行下列工作。

Task	API 參考
Create credential object from @azure/identity	API
使用金鑰 aadCredentials 將認證傳遞至用戶端物件	API
使用 aad 認證執行 cosmos 用戶端	API

其他範例

下列策劃的範例說明常見情節。

Task	API 參考
警示查詢輸送量	API
取得查詢輸送量	API
使用 SasTokens 授與 Cosmos DB 資源的範圍存取權	API

下一步

正在嘗試為遷移至 Azure Cosmos DB 進行容量規劃嗎？ 您可以使用現有資料庫叢集的相關資訊進行容量規劃。

• 如果您僅知道現有資料庫叢集中的虛擬核心和伺服器數目，請參閱使用虛擬核心或 vCPU 來估計要求單位。
• 如果您知道目前資料庫工作負載的一般要求率，請參閱使用 Azure Cosmos DB 容量規劃工具來估計要求單位