@azure/cosmos package

Эта ошибка возникает при прерывании асинхронной операции. Проверьте эту ошибку, проверив name, что свойство имени ошибки соответствует "AbortError".

пример

const controller = new AbortController();
controller.abort();
try {
  doAsyncWork(controller.signal)
} catch (e) {
  if (e.name === 'AbortError') {
    // handle abort error here.
  }
}

Предоставляет итератор для канала изменений.

Используйте Items.changeFeed() для получения экземпляра итератора.

Одна страница ответа из канала изменений Azure Cosmos DB

Представляет конфигурацию политики канала изменений для контейнера в службе Azure Cosmos DB.

Одна страница ответа из канала изменений Azure Cosmos DB

Базовый класс для запуска ChangeFeedIterator.

Используется для чтения или удаления заданного конфликта по идентификатору.

Чтобы запросить или прочитать все конфликты, ознакомьтесь с конфликтами.

Используется для запроса или чтения всех конфликтов.

Чтобы прочитать или удалить заданный конфликт по идентификатору, см. конфликтов конфликтов.

Операции чтения, замены или удаления определенного существующего контейнера по идентификатору.

Ознакомьтесь с контейнерами для создания новых контейнеров и чтения и запроса всех контейнеров; используйте .containers.

Примечание. Все эти операции выполняют вызовы к фиксированному бюджету. Вы должны разработать систему таким образом, чтобы эти вызовы масштабировать подстроки с приложением. Например, не вызывайте container(id).read() перед каждым вызовом item.read(), чтобы убедиться, что контейнер существует; Выполните это один раз при запуске приложения.

Объект ответа для операций контейнера

Операции для создания контейнеров и чтения и запроса всех контейнеров

Сведения о чтении, замене или удалении существующего контейнера см. в контейнера; используйте .container(id).

Примечание. Все эти операции выполняют вызовы к фиксированному бюджету. Вы должны разработать систему таким образом, чтобы эти вызовы масштабировать подстроки с приложением. Например, не вызывайте containers.readAll() перед каждым вызовом item.read(), чтобы убедиться, что контейнер существует; Выполните это один раз при запуске приложения.

Предоставляет логическое представление учетной записи базы данных Azure Cosmos DB на стороне клиента. Этот клиент используется для настройки и выполнения запросов в службе базы данных Azure Cosmos DB.

пример

Создание экземпляра клиента и создание новой базы данных

const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});

пример

Создание экземпляра клиента с помощью настраиваемой политики подключения

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});

• Это тип диагностики Cosmos, содержащий собранные диагностические сведения во время клиентских операций. т. е. Item.read(), Container.create(). Он имеет три члена -

1. элемент clientSideRequestStatistics содержит статистические диагностические сведения, в том числе —

• Поиск метаданных. Здесь все запросы сервера, кроме окончательного предполагаемого ресурса, считаются вызовами метаданных. т. е. для item.read(id), если клиент вызывает сервер для обнаружения конечных точек, он будет считаться вызовом метаданных.
• Повторных попыток
• контактные точки.
• статистика полезных данных запроса, ответа.
• gatewayStatistics — сведения, соответствующие основной операции. Например, во время item.read() клиент может выполнять множество операций, т. е. подстановки метаданных и т. д., но gatewayStatistics представляет сведения о диагностике для фактической операции чтения.

2. diagnosticNode — это дерево, например структура, которая записывает подробные диагностические сведения. По умолчанию он отключен и предназначен для отладки только в рабочих средах. Тип сведений, записанных в диагностикеNode, управляется CosmosDbDiagnosticLevel.

• CosmosDbDiagnosticLevel.info — значение по умолчанию. На этом уровне фиксируются только clientSideRequestStatistics. Предназначен для рабочих сред.
• CosmosDbDiagnosticLevel.debug — записывает диагностические данные и clientConfig. Полезные данные запроса и ответа не записываются. Не предназначено для использования в рабочей среде.
• CosmosDbDiagnosticLevel.debug-unsafe — помимо данных, захваченных в CosmosDbDiagnosticLevel.debug, также записывает полезные данные запросов и ответов. Не предназначено для использования в рабочей среде.

3. clientConfig — записывает сведения, связанные с настройкой клиента во время инициализации.

Операции чтения или удаления существующей базы данных.

Ознакомьтесь с базами данных для создания новых баз данных и чтения и запроса всех баз данных; используйте client.databases.

Примечание. Все эти операции выполняют вызовы к фиксированному бюджету. Вы должны разработать систему таким образом, чтобы эти вызовы масштабировать подстроки с приложением. Например, не вызывайте database.read() перед каждым вызовом item.read(), чтобы убедиться, что база данных существует; Выполните это один раз при запуске приложения.

Представляет DatabaseAccount в службе базы данных Azure Cosmos DB.

Объект ответа для операций базы данных

Операции по созданию новых баз данных и чтению и запросу всех баз данных

Сведения о чтении или удалении существующей базы данных см. в базы данных; используйте client.database(id).

Примечание. Все эти операции выполняют вызовы к фиксированному бюджету. Вы должны разработать систему таким образом, чтобы эти вызовы масштабировать подстроки с приложением. Например, не вызывайте databases.readAll() перед каждым вызовом item.read(), чтобы убедиться, что база данных существует; Выполните это один раз при запуске приложения.

Задает диапазон канала для канала изменений.

Используется для выполнения операций с определенным элементом.

Сведения об операциях со всеми элементами см. в элементов; см. container.items.

Операции для создания новых элементов и чтения и запроса всех элементов

Сведения о чтении, замене или удалении существующего контейнера см. в элементе; используйте .item(id).

Используется для чтения или замены существующего предложения по идентификатору.

Ознакомьтесь с предложениями для запроса или чтения всех предложений.

Используется для запроса или чтения всех предложений.

См. предложения для чтения или замены существующего предложения по идентификатору.

Класс Builder для создания PartitionKey.

Используется для чтения, замены или удаления заданного разрешения по идентификатору.

Ознакомьтесь с разрешениями для создания, upsert, запроса или чтения всех разрешений.

Используется для создания, замены, запроса и чтения всех разрешений.

См. разрешения для чтения, замены или удаления определенного разрешения по идентификатору.

Представляет объект QueryIterator, реализацию веб-канала или ответа запроса, которая включает обход и итерацию ответа в службе базы данных Azure Cosmos DB.

Настраиваемый тип ошибки для неудачных запросов конвейера.

Операции чтения, замены, удаления или выполнения определенной хранимой процедуры по идентификатору.

Для операций для создания, чтения всех или запроса хранимых процедур

Операции для создания, переключения или чтения и запроса всех хранимых процедур.

Операции для чтения, замены, удаления или выполнения определенной хранимой процедуры по идентификатору см. в container.storedProcedure().

Операции для чтения, замены или удаления триггера.

Используйте container.triggers для создания, upsert, запроса или чтения всех.

Операции для создания, upsert, запроса и чтения всех триггеров.

Используйте container.triggers для чтения, замены или удаления триггера.

Используется для чтения, замены и удаления пользователей.

Кроме того, вы можете получить доступ к разрешениям для данного пользователя с помощью user.permission и user.permissions.

См. пользователи, чтобы создать, upsert, query или прочитать все.

Используется для чтения, замены или удаления указанной определяемой пользователем функции по идентификатору.

См. раздел UserDefinedFunction для создания, upsert, запроса, чтения всех пользовательских функций.

Используется для создания, upsert, запроса или чтения всех пользовательских функций.

См. UserDefinedFunction для чтения, замены или удаления определенной определяемой пользователем функции по идентификатору.

Используется для создания, upsert, запроса и чтения всех пользователей.

См. пользователя для чтения, замены или удаления определенного пользователя по идентификатору.

Объект Options, используемый для изменения массового выполнения. continueOnError (значение по умолчанию: false) — продолжает массовое выполнение при сбое операции ** ОБРАТИТЕ ВНИМАНИЕ, ЧТО ЗНАЧЕНИЕ ПО УМОЛЧАНИЮ РАВНО TRUE В ВЫПУСКе 4.0

Указывает параметры канала изменений

Если ни один из этих параметров не задан, он начнет чтение изменений в настоящее время для всего контейнера.

Указывает параметры канала изменений

Некоторые из этих параметров определяют, где и когда начинается чтение из канала изменений. Порядок приоритета:

• продолжение
• startTime
• startFromBeginning

Если ни один из этих параметров не задан, он начнет чтение изменений из первого вызова ChangeFeedIterator.fetchNext().

Используйте Items.getChangeFeedIterator() для возврата итератора, который может выполнять итерацию по всем изменениям ключа секции, диапазона веб-каналов или всего контейнера.

Представляет составной путь в политике индексирования.

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

Представляет политику подключения, связанную с CosmosClient в службе базы данных Azure Cosmos DB.

Представляет дерево, например структуру, для записи диагностических сведений.

Этот тип записывает диагностические сведения о неудачном запросе к API сервера.

Параметры веб-канала и методы запроса.

Элементы в Cosmos DB — это просто объекты JSON. Большинство операций item позволяют предоставить собственный тип, который расширяет очень простое itemDefinition.

Вы не можете использовать зарезервированные ключи. Список зарезервированных ключей можно просмотреть в <xref:ItemBody>

Используется для указания доступных расположений, чтение — индекс 1, а запись — индекс 0.

Этот тип содержит диагностические сведения об одном запросе метаданных на сервер.

Параметры, которые можно указать для запрошенного сервера Azure Cosmos DB.=

Представляет политику повторных попыток с регулированием запросов в службе базы данных Azure Cosmos DB.

Параметры, которые можно указать для запрошенного сервера Azure Cosmos DB.=

Представляет параметр в параметризованном SQL-запросе, указанном в SqlQuerySpec

Представляет SQL-запрос в службе Azure Cosmos DB.

Запросы с входными данными должны быть параметризованы для защиты от внедрения SQL.

пример

Параметризованный SQL-запрос

const query: SqlQuerySpec = {
  query: "SELECT * FROM Families f where f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Wakefield"}
  ]
};

Интерфейс для единого уникального ключа, переданного в рамках UniqueKeyPolicy

Интерфейс для задания уникальных ключей при создании контейнера

Представляет вектор внедрения. Внедрение вектора используется для определения поля вектора в документах.

Представляет конфигурацию политики для внедрения векторов в службе Azure Cosmos DB.

Представляет векторный индекс в службе Azure Cosmos DB. Индекс вектора используется для индексирования полей векторов в документах.

Этот тип содержит сведения, связанные с инициализацией CosmosClient

Это тип коллекции для всех диагностических сведений на стороне клиента.

Этот тип содержит диагностические сведения о всех запросах метаданных на сервер во время клиентской операции CosmosDB.

Возвращаемый объект представляет значение ключа секции, позволяющее создавать и получать доступ к элементам без значения ключа секции.

Возвращаемый объект представляет значение ключа секции, позволяющее создавать и получать доступ к элементам со значением NULL для ключа секции.

PartitionKey контейнера.

Примитивное значение ключа секции.

Этот тип записывает диагностические сведения о попытке повторных попыток во время клиентской операции CosmosDB.

Определяет поведение подключения CosmosClient. Обратите внимание, что в настоящее время поддерживается только режим шлюза.

Представляет уровни согласованности, поддерживаемые для клиентских операций Azure Cosmos DB.
Запрошенная согласованностьLevel должна соответствовать или быть слабее, чем подготовленная для учетной записи базы данных. Уровни согласованности.

Уровни согласованности по порядку силы: Strong, BoundedStaleness, Session, Согласованный префикс и в конечном итоге.

Дополнительные сведения о уровнях согласованности см. в https://aka.ms/cosmos-consistency.

Уровень диагностики Cosmos DB

Определяет целевой тип данных спецификации пути индекса в службе Azure Cosmos DB.

Указывает поддерживаемые типы индексов.

Задает поддерживаемые режимы индексирования.

Это перечисление для поиска метаданных типа.

Версия определения PartitionKey

Тип PartitionKey, т. е. хэш, MultiHash

Перечисление значений режима разрешений.

Представляет уровень приоритета, связанный с каждым запросом клиента Azure Cosmos DB.
Запросы с низким приоритетом всегда регулируются перед любыми запросами высокого приоритета.

По умолчанию все запросы считаются запросами высокого приоритета.

Дополнительные сведения о регулировании на основе приоритета см. в https://aka.ms/CosmosDB/PriorityBasedExecution.

Перечисление значений операций триггера. указывает операции, для которых должен выполняться триггер.

Перечисление для значений типа триггера. Указывает тип триггера.

Перечисление значений типов udf. Задает типы определяемых пользователем функций.

Представляет тип данных вектора.

Представляет функцию расстояния, используемую для вычисления расстояния между векторами.

Представляет тип индекса вектора.

Экспериментальный внутренний только создает полезные данные, представляющие конфигурацию разрешений для маркера SAS.