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)	Возвращает предложение в контейнере. Если нет, возвращает предложениеResponse с неопределенным значением.
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

read(RequestOptions)

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

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

Параметры

options

RequestOptions

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

Promise<ContainerResponse>

readOffer(RequestOptions)

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

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>