Przykłady dla zestawu SDK NoSQL dla usługi Azure Cosmos DB dla języka JS

DOTYCZY: NoSQL

Przykładowe rozwiązania, które wykonują operacje CRUD i inne typowe operacje na zasobach usługi Azure Cosmos DB, znajdują się w repozytorium GitHub zestawu JAVAScript SDK dla usługi Azure Cosmos DB . Ten artykuł zawiera:

  • Linki do zadań w poszczególnych przykładowych plikach projektów platformy Node.js.
  • Linki do powiązanej dokumentacji interfejsu API.

Wymagania wstępne

Jeśli nie masz subskrypcji platformy Azure, przed rozpoczęciem utwórz bezpłatne konto platformy Azure.

Możesz bezpłatnie wypróbować usługę Azure Cosmos DB bez subskrypcji platformy Azure i bez zobowiązania. Alternatywnie możesz utworzyć konto warstwy bezpłatnej usługi Azure Cosmos DB z pierwszymi 1000 RU/s i 25 GB miejsca do magazynowania bezpłatnie. Możesz również użyć emulatora usługi Azure Cosmos DB z identyfikatorem URI .https://localhost:8081 Aby uzyskać klucz do użycia z emulatorem, zobacz Uwierzytelnianie żądań.

Potrzebujesz również zestawu SDK dla języka JavaScript.

Uwaga

Przykłady są niezależne — każdy z nich jest automatycznie konfigurowany i automatycznie czyszczony po użyciu. Przykłady te obejmują wiele wywołań elementu Containers.create. W każdej takiej sytuacji w subskrypcji będzie naliczana opłata za 1 godzinę użycia na warstwę wydajności tworzonego kontenera.

Przykłady dotyczące baz danych

Plik DatabaseManagement pokazuje, jak wykonywać operacje CRUD w bazie danych. Aby dowiedzieć się więcej o bazach danych usługi Azure Cosmos DB przed uruchomieniem poniższych przykładów, zobacz Artykuł koncepcyjny Praca z bazami danych, kontenerami i elementami .

Zadanie Odwołanie do interfejsu API
Utwórz bazę danych, jeśli nie istnieje Databases.createIfNotExists
Wyświetlanie listy baz danych na koncie Databases.readAll
Odczytywanie bazy danych na podstawie identyfikatora Database.read
Usuwanie bazy danych Database.delete

Przykłady dotyczące kontenerów

Plik ContainerManagement pokazuje, jak wykonywać operacje CRUD w kontenerze. Aby dowiedzieć się więcej o kolekcjach usługi Azure Cosmos DB przed uruchomieniem poniższych przykładów, zobacz Artykuł koncepcyjny Praca z bazami danych, kontenerami i elementami .

Zadanie Odwołanie do interfejsu API
Tworzenie kontenera, jeśli nie istnieje Containers.createIfNotExists
Wyświetlanie listy kontenerów dla konta Containers.readAll
Odczytywanie definicji kontenera Container.read
Usuwanie kontenera Container.delete

Przykłady dotyczące elementów

Plik ItemManagement pokazuje, jak wykonywać operacje CRUD na elemencie. Aby dowiedzieć się więcej o dokumentach usługi Azure Cosmos DB przed uruchomieniem poniższych przykładów, zobacz Artykuł koncepcyjny Dotyczący pracy z bazami danych, kontenerami i elementami .

Zadanie Odwołanie do interfejsu API
Tworzenie elementów Items.create
Odczytywanie wszystkich elementów w kontenerze Items.readAll
Odczytywanie elementów na podstawie Identyfikatora Item.read
Odczytywanie elementów tylko wtedy, gdy zostały zmienione Item.read - RequestOptions.accessCondition
Wykonywanie zapytań dotyczących dokumentów Items.query
Zastępowanie elementu Item.replace
Zastępowanie elementu z warunkowym sprawdzaniem elementu ETag Item.replace - RequestOptions.accessCondition
Usuwanie elementu Item.delete

Przykłady dotyczące indeksowania

Plik IndexManagement pokazuje, jak zarządzać indeksowaniem. Aby dowiedzieć się więcej o indeksowaniu w usłudze Azure Cosmos DB przed uruchomieniem poniższych przykładów, zobacz artykuły koncepcyjne dotyczące zasad indeksowania, typów indeksowania i ścieżek indeksowania.

Zadanie Odwołanie do interfejsu API
Ręczne indeksowanie określonego elementu RequestOptions.indexingDirective: „include”
Ręczne wykluczanie określonego elementu z indeksu RequestOptions.indexingDirective: „exclude”
Wyłączanie ścieżki z indeksu IndexingPolicy.ExcludedPath
Tworzenie indeksu zakresu na ścieżce ciągu IndexKind.Range, IndexingPolicy, Items.query
Tworzenie kontenera z domyślnym indeksemPolicy, a następnie aktualizowanie kontenera w trybie online Containers.create

Przykłady programowania po stronie serwera

Plik index.ts pokazuje, jak wykonać następujące zadania. Aby dowiedzieć się więcej na temat programowania po stronie serwera w usłudze Azure Cosmos DB przed uruchomieniem poniższych przykładów, zobacz artykuł koncepcyjny Procedury składowane, wyzwalacze i funkcje zdefiniowane przez użytkownika.

Zadanie Odwołanie do interfejsu API
Tworzenie procedury składowanej StoredProcedures.create
Wykonywanie procedury składowanej StoredProcedure.execute
Aktualizacja zbiorcza z procedurą składowaną StoredProcedure.execute

Aby uzyskać więcej informacji na temat programowania po stronie serwera, zobacz Azure Cosmos DB server-side programming: Stored procedures, database triggers, and UDF (Programowanie po stronie serwera w usłudze Azure Cosmos DB: procedury składowane, wyzwalacze bazy danych i funkcje UDF).

Przykłady uwierzytelniania usługi Azure Identity(AAD)

Plik AADAuth.ts pokazuje, jak wykonać następujące zadania.

Zadanie Odwołanie do interfejsu API
Create credential object from @azure/identity API
Przekazywanie poświadczeń do obiektu klienta przy użyciu klucza aadCredentials API
Wykonywanie klienta usługi Cosmos przy użyciu poświadczeń usługi aad API

Różne przykłady

Poniższe wyselekcjonowane przykłady ilustrują typowe scenariusze.

Zadanie Odwołanie do interfejsu API
Zmienianie przepływności zapytania API
Uzyskiwanie przepływności zapytań API
używanie usługi SasTokens do udzielania dostępu w zakresie do zasobów usługi Cosmos DB API

Następne kroki

Próbujesz zaplanować pojemność migracji do usługi Azure Cosmos DB? Informacje o istniejącym klastrze bazy danych można użyć do planowania pojemności.