Share via

@azure/cosmos package

  • Ссылка

Классы

AbortError

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

Пример

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

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

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

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

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

Базовый класс для того, где следует запустить ChangeFeedIterator.
ClientSideMetrics
Conflict

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

См. раздел Конфликты , чтобы запросить или прочитать все конфликты.
ConflictResponse
Conflicts

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

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

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

См . статью Контейнеры для создания новых контейнеров, а также чтения и выполнения запросов ко всем контейнерам. используйте .containers.

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

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

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

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

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

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

Пример

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

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

Пример

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

const connectionPolicy = new ConnectionPolicy();
connectionPolicy.RequestTimeout = 10000;
const client = new CosmosClient({
   endpoint: "<URL HERE>",
   auth: {masterKey: "<KEY HERE>"},
   connectionPolicy
});
CosmosDiagnostics
  • Это тип диагностики Cosmos, который содержит собранные диагностические сведения во время операций клиента. Ie. Item.read(), Container.create(). Он состоит из трех членов -
  1. clientSideRequestStatistics member содержит агрегированные диагностические сведения, в том числе :
  • поиск метаданных. Здесь все серверные запросы, кроме конечного предполагаемого ресурса, считаются вызовами метаданных. т. е. для item.read(id), если клиент выполняет вызов сервера для обнаружения конечных точек, он будет рассматриваться как вызов метаданных.
  • retries
  • с контактами конечных точек.
  • запрос, статистика полезных данных ответа.
  • gatewayStatistics — сведения, соответствующие main операции. Например, во время работы Item.read() клиент может выполнять множество операций, например поиск метаданных и т. д., но gatewayStatistics представляет диагностика сведения для фактической операции чтения.
  1. diagnosticNode — древовидная структура, которая собирает подробные диагностические сведения. По умолчанию он отключен и предназначен для использования только для отладки в нерабочих средах. Тип сведений, записанных в diagnosticNode, управляется с помощью CosmosDbDiagnosticLevel.
  • CosmosDbDiagnosticLevel.info — значение по умолчанию. На этом уровне фиксируются только clientSideRequestStatistics. Предназначен для рабочих сред.
  • CosmosDbDiagnosticLevel.debug — захватывает diagnosticNode и clientConfig. Полезные данные запроса и ответа не записываются. Не предназначен для использования в рабочей среде.
  • CosmosDbDiagnosticLevel.debug-unsafe — помимо данных, захваченных в CosmosDbDiagnosticLevel.debug, также фиксирует полезные данные запросов и ответов. Не предназначен для использования в рабочей среде.
  1. clientConfig — записывает сведения, связанные с настройкой клиента во время инициализации.
Database

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

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

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

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

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

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

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

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

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

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

См . раздел Элементы для операций со всеми элементами; см. раздел container.items.
ItemResponse
Items

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

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

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

См. статью Предложения , чтобы запросить или прочитать все предложения.
OfferResponse
Offers

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

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

Класс Builder для сборки PartitionKey.
Permission

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

См . раздел Разрешения на создание, обновление, запрос или чтение всех разрешений.
PermissionResponse
Permissions

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

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

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

Пользовательский тип ошибки для неудачных запросов конвейера.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

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

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

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

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

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

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

Операции по созданию, настройке, запросу и чтению всех триггеров.

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

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

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

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

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

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

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

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

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

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

Интерфейсы

@azure/cosmos.Index
Agent
BulkOptions

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

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

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

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

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

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

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

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

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

Представляет политику подключения, связанную с CosmosClient в службе базы данных Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

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

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

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

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

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

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

Этот тип содержит диагностические сведения об одном запросе метаданных к серверу.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

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

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

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

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

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

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

Пример

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

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

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

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

Псевдонимы типа

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

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

Это тип коллекции для всех диагностических сведений на стороне клиента.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics

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

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

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

PartitionKey контейнера.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

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

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

Перечисления

ConflictResolutionMode
ConnectionMode

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

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

Уровни согласованности по упорядочению: Strong, BoundedStaleness, Session, Consistent Prefix и Eventual.

См https://aka.ms/cosmos-consistency . более подробную документацию по уровням согласованности.
CosmosDbDiagnosticLevel

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

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

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

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

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

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

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

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

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

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

См https://aka.ms/CosmosDB/PriorityBasedExecution . более подробную документацию по регулированию на основе приоритета.
SpatialType
TriggerOperation

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

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

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

Функции

createAuthorizationSasToken(string, SasTokenProperties)

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

Сведения о функции

createAuthorizationSasToken(string, SasTokenProperties)

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

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

Параметры

masterKey

string

sasTokenProperties
SasTokenProperties

Возвращаемое значение

Promise<string>