Поделиться через

@azure/cosmos package

Классы

AbortError

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

Пример

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

Реализация EncryptionKeyResolver, который использует Azure Key Vault для ключей, управляемых клиентом.
ChangeFeedIterator

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Пример

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

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

Пример

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

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({
  endpoint,
  key,
  connectionPolicy: {
    requestTimeout: 10000,
  },
});

Пример

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

import { DefaultAzureCredential } from "@azure/identity";
import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const aadCredentials = new DefaultAzureCredential();
const client = new CosmosClient({
  endpoint,
  aadCredentials,
  aadScope: "https://cosmos.azure.com/.default", // Optional custom scope
});
CosmosDiagnostics
  • Это тип диагностики Cosmos, содержащий собранные диагностические сведения во время клиентских операций. т. е. Item.read(), Container.create(). Он имеет три члена -
  1. элемент clientSideRequestStatistics содержит статистические диагностические сведения, в том числе —
  • Поиск метаданных. Здесь все запросы сервера, кроме окончательного предполагаемого ресурса, считаются вызовами метаданных. т. е. для item.read(id), если клиент вызывает сервер для обнаружения конечных точек, он будет считаться вызовом метаданных.
  • Повторных попыток
  • контактные точки.
  • статистика полезных данных запроса, ответа.
  • gatewayStatistics — сведения, соответствующие основной операции. Например, во время item.read() клиент может выполнять множество операций, т. е. подстановки метаданных и т. д., но gatewayStatistics представляет сведения о диагностике для фактической операции чтения.
  1. diagnosticNode — это дерево, например структура, которая записывает подробные диагностические сведения. По умолчанию он отключен и предназначен для отладки только в рабочих средах. Тип сведений, записанных в диагностикеNode, управляется CosmosDbDiagnosticLevel.
  • CosmosDbDiagnosticLevel.info — значение по умолчанию. На этом уровне фиксируются только clientSideRequestStatistics. Предназначен для рабочих сред.
  • CosmosDbDiagnosticLevel.debug — записывает диагностические данные и clientConfig. Полезные данные запроса и ответа не записываются. Не предназначено для использования в рабочей среде.
  • CosmosDbDiagnosticLevel.debug-unsafe — помимо данных, захваченных в CosmosDbDiagnosticLevel.debug, также записывает полезные данные запросов и ответов. Не предназначено для использования в рабочей среде.
  1. clientConfig — записывает сведения, связанные с настройкой клиента во время инициализации.
Database

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

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

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

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

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

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

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

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

Представляет класс построителя для построения зашифрованных параметров в параметризованном запросе.
ErrorResponse

Представляет собой ответ об ошибке, возвращенный в операциях.
FeedRange

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Интерфейсы

@azure/cosmos.Index
Agent
BulkOperationResult

представляет ответ на операцию в массовом порядке с помощью executeBulkOperations API
BulkOptions

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

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

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

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

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

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

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

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

Представляет путь для шифрования и связанные с ним параметры.
ClientEncryptionKeyProperties

Сведения о ключе шифрования клиента для использования со службой Azure Cosmos DB.
ClientEncryptionKeyRequest

Интерфейс, представляющий запрос ключа шифрования клиента в Cosmos DB.
ClientEncryptionOptions

Представляет параметры шифрования, связанные с CosmosClient.
ClientEncryptionPolicy

Представляет политику шифрования клиента, связанную с контейнером.
CompositePath

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

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

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

Этот интерфейс представляет собой зашифрованное число в Cosmos DB SDK.

Пример

import { CosmosEncryptedNumber, CosmosEncryptedNumberType } from "@azure/cosmos";

const encryptedNumber1: CosmosEncryptedNumber = {
  value: 4,
  numberType: CosmosEncryptedNumberType.Integer,
};
const encryptedNumber2: CosmosEncryptedNumber = {
  value: 4.1,
  numberType: CosmosEncryptedNumberType.Float,
};
const encryptedNumber3: CosmosEncryptedNumber = {
  value: 4,
  numberType: CosmosEncryptedNumberType.Float, // represents 4.0
};
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

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

Предоставляет интерфейс для преобразователя ключей для различных поставщиков ключей. Все резолверы должны реализовывать этот интерфейс.
EncryptionKeyWrapMetadata

Метаданные, используемые для упаковки и распаковки ключа шифрования данных с помощью ключа, управляемого клиентом
ErrorBody
ExtendedOperationResponse

ответ на успешную операцию в массовом порядке с помощью executeBulkOperations API
FailedRequestAttemptDiagnostic

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

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

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

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

Представляет полную текстовую политику для коллекции в службе Azure Cosmos DB.
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
RestError

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

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

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

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

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

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

Пример

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

import { SqlQuerySpec } from "@azure/cosmos";

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
VectorEmbedding

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

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

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

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

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

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

ChangeFeedMode
ConflictResolutionMode
ConnectionMode

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

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

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

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

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

Это перечисление представляет собой тип числа в пакете SDK для Cosmos DB.
DataType

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

Алгоритмы шифрования, поддерживаемые для шифрования данных
EncryptionKeyResolverName

Названия реализаций

Смотрите EncryptionKeyResolver
EncryptionType

Тип выполняемого шифрования.
GeospatialType
IndexKind

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

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

Алгоритмы, используемые для упаковки/распаковки ключа шифрования данных с ключом шифрования ключа.
MetadataLookUpType

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

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

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

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

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

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

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

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

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

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

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

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

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

Функции

createAuthorizationSasToken(string, SasTokenProperties)

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

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

createAuthorizationSasToken(string, SasTokenProperties)

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

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

Параметры

masterKey

string

sasTokenProperties
SasTokenProperties

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

Promise<string>