Container class

Пакет:

@azure/cosmos

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

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

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

Свойства

conflicts	Операции чтения и запроса конфликтов для заданного контейнера. Для чтения или удаления определенного конфликта используйте ..conflict(id)
database
id
items	Операции по созданию новых элементов, чтению и выполнению запросов ко всем элементам Для чтения, замены или удаления существующего элемента используйте ..item(id) Пример Создайте элемент. const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts	Все операции для хранимых процедур, триггеров и определяемых пользователем функций
url	Возвращает URL-адрес ссылки на ресурс. Используется для связывания в разрешениях.

Методы

conflict(string, PartitionKey)	Используется для чтения, замены или удаления определенного существующего конфликта по идентификатору. Используйте .conflicts для создания новых конфликтов, а также для запроса или чтения всех конфликтов.
delete(RequestOptions)	Удалить контейнер.
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)	Удаление всех документов, принадлежащих контейнеру для указанного значения ключа секции
getFeedRanges()
getPartitionKeyDefinition()	Сначала получает определение ключа секции, просматривая кэш, в противном случае считывая коллекцию.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)	Используется для чтения, замены или удаления определенного существующего элемента по идентификатору. Используйте .items для создания новых элементов, а также для запроса или чтения всех элементов. Пример Замена элемента const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)	Чтение определения контейнера
readOffer(RequestOptions)	Возвращает предложение в контейнере. Если его нет, возвращает offerResponse с неопределенным значением.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	Замена определения контейнера

Сведения о свойстве

conflicts

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

Для чтения или удаления определенного конфликта используйте ..conflict(id)

Conflicts conflicts

Значение свойства

Conflicts

database

database: Database

Значение свойства

Database

id

id: string

Значение свойства

string

items

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

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

Пример

Создайте элемент.

const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});

Items items

Значение свойства

Items

scripts

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

Scripts scripts

Значение свойства

Scripts

url

Возвращает URL-адрес ссылки на ресурс. Используется для связывания в разрешениях.

string url

Значение свойства

string

Сведения о методе

conflict(string, PartitionKey)

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

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

function conflict(id: string, partitionKey?: PartitionKey): Conflict

Параметры

id

string

Идентификатор конфликта.

partitionKey

PartitionKey

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

Conflict

delete(RequestOptions)

Удалить контейнер.

function delete(options?: RequestOptions): Promise<ContainerResponse>

Параметры

options

RequestOptions

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

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Удаление всех документов, принадлежащих контейнеру для указанного значения ключа секции

function deleteAllItemsForPartitionKey(partitionKey: PartitionKey, options?: RequestOptions): Promise<ContainerResponse>

Параметры

partitionKey

PartitionKey

Значение ключа секции удаляемых элементов

options

RequestOptions

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

Promise<ContainerResponse>

getFeedRanges()

function getFeedRanges(): Promise<readonly FeedRange[]>

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

Promise<readonly FeedRange[]>

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

getPartitionKeyDefinition()

Предупреждение

Теперь этот API является нерекомендуемым.

This method has been renamed to readPartitionKeyDefinition.

Сначала получает определение ключа секции, просматривая кэш, в противном случае считывая коллекцию.

function getPartitionKeyDefinition(): Promise<ResourceResponse<PartitionKeyDefinition>>

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

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec)

function getQueryPlan(query: string | SqlQuerySpec): Promise<Response_2<PartitionedQueryExecutionInfo>>

Параметры

query

string | SqlQuerySpec

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

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

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

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

Пример

Замена элемента const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});

function item(id: string, partitionKeyValue?: PartitionKey): Item

Параметры

id

string

Идентификатор элемента.

partitionKeyValue

PartitionKey

Значение ключа секции Item

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

Item

read(RequestOptions)

Чтение определения контейнера

function read(options?: RequestOptions): Promise<ContainerResponse>

Параметры

options

RequestOptions

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

Promise<ContainerResponse>

readOffer(RequestOptions)

Возвращает предложение в контейнере. Если его нет, возвращает offerResponse с неопределенным значением.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

Параметры

options

RequestOptions

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

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions)

function readPartitionKeyRanges(feedOptions?: FeedOptions): QueryIterator<PartitionKeyRange>

Параметры

feedOptions

FeedOptions

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

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

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

function replace(body: ContainerDefinition, options?: RequestOptions): Promise<ContainerResponse>

Параметры

body

ContainerDefinition

options

RequestOptions

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

Promise<ContainerResponse>