Примеры для пакета SDK Для NoSQL для Azure Cosmos DB для JS

  • Статья

ОБЛАСТЬ ПРИМЕНЕНИЯ: NoSQL

Примеры решений, выполняющих операции CRUD и другие распространенные операции с ресурсами Azure Cosmos DB, включаются в репозиторий пакета SDK JavaScript для Azure Cosmos DB GitHub. Эта статья содержит:

  • Ссылки на задачи в каждом из примеров файлов проектов Node.js.
  • Ссылки на соответствующие справочные материалы по API.

Необходимые компоненты

Если у вас еще нет подписки Azure, создайте бесплатную учетную запись Azure, прежде чем начинать работу.

Пробную версию Azure Cosmos DB можно использовать бесплатно, без подписки Azure и без и каких-либо обязательств. Кроме того, вы можете создать учетную запись Azure Cosmos DB категории "Бесплатный". Для этой учетной записи бесплатно предоставляются первые 1000 ЕЗ/с и 25 ГБ пространства в хранилище. Также можно использовать эмулятор Azure Cosmos DB, который доступен по URI https://localhost:8081. Сведения о ключе для использования с эмулятором см. в этом разделе.

Вам также нужен пакет SDK для JavaScript.

Примечание.

Каждый пример является самодостаточным, он устанавливается самостоятельно и выполняет необходимую очистку после удаления. Поэтому примеры выполняют несколько вызовов метода Containers.create. Каждый раз, когда это происходит, вам будет выставляться счет за 1 час использования каждого уровня производительности создаваемого контейнера.

Примеры баз данных

В файле DatabaseManagement показано, как выполнять операции CRUD с базой данных. Дополнительные сведения о базах данных Azure Cosmos DB перед выполнением следующих примеров см . в статье "Работа с базами данных, контейнерами и элементами ".

Задача Справочник по API
Создание базы данных, если она не существует Databases.createIfNotExists
Получение списка баз данных для учетной записи Databases.readAll
Чтение базы данных по идентификатору Database.read
Удаление базы данных Database.delete

Примеры контейнеров

В файле ContainerManagement показано, как выполнять операции CRUD с контейнером. Сведения о коллекциях Azure Cosmos DB перед выполнением следующих примеров см . в статье о работе с базами данных, контейнерами и элементами .

Задача Справочник по API
Создание контейнера, если он не существует Containers.createIfNotExists
Получение списка контейнеров учетной записи Containers.readAll
Чтение определения контейнера Container.read
Удаление контейнера Container.delete

Примеры элементов

В файле ItemManagement показано, как выполнять операции CRUD с элементом. Дополнительные сведения о документах Azure Cosmos DB перед выполнением следующих примеров см . в статье "Работа с базами данных, контейнерами и элементами ".

Задача Справочник по 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 перед выполнением приведенных ниже примеров, ознакомьтесь с тематическими статьями, посвященными политикам, типам и путям индексирования.

Задача Справочник по API
Индексирование определенного элемента вручную RequestOptions.indexingDirective: 'include'
Исключение определенного элемента из индекса вручную RequestOptions.indexingDirective: 'exclude'
Исключение пути из индекса IndexingPolicy.ExcludedPath
Создание индекса диапазона строкового пути IndexKind.Range, IndexingPolicy, Items.query
Создайте контейнер с индексом indexPolicy по умолчанию, а затем обновите контейнер в Сети Containers.create

Примеры программирования на стороне сервера

В файле index.ts показано, как выполнить следующие задачи. Чтобы узнать больше о программировании на стороне сервера в Azure Cosmos DB перед выполнением приведенных ниже примеров, ознакомьтесь с тематической статьей Хранимые процедуры, триггеры и определяемые пользователем функции.

Задача Справочник по API
Создание хранимой процедуры StoredProcedures.create
Выполнение хранимой процедуры StoredProcedure.execute
Массовое обновление с помощью хранимой процедуры StoredProcedure.execute

Дополнительные сведения о программировании на стороне сервера в Azure Cosmos DB, в том числе о хранимых процедурах, триггерах баз данных и определяемых пользователем функциях, см. в этой статье.

Примеры проверки подлинности Azure Identity(AAD)

В файле AADAuth.ts показано, как выполнять следующие задачи.

Задача Справочник по API
Create credential object from @azure/identity API
Передача учетных данных в клиентский объект с ключом aadCredentials API
Выполнение клиента Cosmos с учетными данными aad API

Другие примеры

В следующих курированных примерах показаны распространенные сценарии.

Задача Справочник по API
Изменение пропускной способности запросов API
Получение пропускной способности запроса API
использование SasTokens для предоставления область доступ к ресурсам Cosmos DB API

Следующие шаги

Если вы планируете ресурсы для миграции в Azure Cosmos DB, Для планирования ресурсов можно использовать сведения об имеющемся кластере базы данных.