在 Azure Cosmos DB 中管理資料的 Node.js 範例

適用於: SQL API

azure-cosmos-js GitHub 存放庫中包含可對 Azure Cosmos DB 資源執行 CRUD 作業和其他常見作業的範例解決方案。 本文提供:

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

先決條件

如果您沒有 Azure 訂用帳戶,請在開始前建立免費帳戶

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

您還需要 JavaScript SDK

注意

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

資料庫範例

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

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

容器範例

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

Task API 參考資料
建立容器 (如果未存在) Containers.createIfNotExists
列出帳戶的容器 Containers.readAll
讀取容器定義 Container.read
刪除容器 Container.delete

項目範例

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

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.RangeIndexingPolicyItems.query
使用預設 indexPolicy 建立容器,然後在線上加以更新 Containers.create

伺服器端程式設計範例

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

Task API 參考資料
建立預存程序 StoredProcedures.create
執行預存程序 StoredProcedure.execute

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