Container class

  • Referência
Pacote:
@azure/cosmos

Operações para ler, substituir ou excluir um contêiner existente específico por ID.

Consulte Contêineres para criar novos contêineres e ler/consultar todos os contêineres; use .containers.

Observação: todas essas operações fazem chamadas contra um orçamento fixo. Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas de forma sublinear com seu aplicativo. Por exemplo, não chame container(id).read() antes de cada item.read() chamada, para garantir que o contêiner exista; faça isso uma vez na inicialização do aplicativo.

Propriedades

conflicts

Operações para ler e consultar conflitos para o contêiner especificado.

Para ler ou excluir um conflito específico, use .conflict(id).
database
id
items

Operações para criar novos itens e ler/consultar todos os itens

Para ler, substituir ou excluir um item existente, use .item(id).

Exemplo

Criar um item

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

Todas as operações para procedimentos armazenados, gatilhos e funções definidas pelo usuário
url

Retorna uma URL de referência para o recurso. Usado para vinculação em Permissões.

Métodos

conflict(string, PartitionKey)

Usado para ler, substituir ou excluir um Conflito por ID específico existente.

Use .conflicts para criar novos conflitos ou consultar/ler todos os conflitos.
delete(RequestOptions)

Excluir o contêiner
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Excluir todos os documentos pertencem ao contêiner para o valor de chave de partição fornecido
getFeedRanges()
getPartitionKeyDefinition()

Obtém a definição da chave de partição primeiro examinando o cache caso contrário, lendo a coleção.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)

Usado para ler, substituir ou excluir um item específico existente por ID.

Use .items para criar novos itens ou consultar/ler todos os itens.

Exemplo

Substituir um item const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)

Ler a definição do contêiner
readOffer(RequestOptions)

Obtém a oferta no contêiner. Se nenhum existir, retornará um OfferResponse com indefinido.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)

Substituir a definição do contêiner

Detalhes da propriedade

conflicts

Operações para ler e consultar conflitos para o contêiner especificado.

Para ler ou excluir um conflito específico, use .conflict(id).

Conflicts conflicts

Valor da propriedade

Conflicts

database 

database: Database

Valor da propriedade

Database

id 

id: string

Valor da propriedade

string

items

Operações para criar novos itens e ler/consultar todos os itens

Para ler, substituir ou excluir um item existente, use .item(id).

Exemplo

Criar um item

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

Items items

Valor da propriedade

Items

scripts

Todas as operações para procedimentos armazenados, gatilhos e funções definidas pelo usuário

Scripts scripts

Valor da propriedade

Scripts

url

Retorna uma URL de referência para o recurso. Usado para vinculação em Permissões.

string url

Valor da propriedade

string

Detalhes do método

conflict(string, PartitionKey)

Usado para ler, substituir ou excluir um Conflito por ID específico existente.

Use .conflicts para criar novos conflitos ou consultar/ler todos os conflitos.

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

Parâmetros

id

string

A ID do Conflito.

partitionKey
PartitionKey

Retornos

Conflict

delete(RequestOptions)

Excluir o contêiner

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

Parâmetros

options
RequestOptions

Retornos

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Excluir todos os documentos pertencem ao contêiner para o valor de chave de partição fornecido

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

Parâmetros

partitionKey
PartitionKey

O valor da chave de partição dos itens a serem excluídos

options
RequestOptions

Retornos

Promise<ContainerResponse>

getFeedRanges() 

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

Retornos

Promise<readonly FeedRange[]>

todos os intervalos de feeds para os quais o feed de alterações pode ser buscado.

getPartitionKeyDefinition()

Aviso

Essa API foi preterida.

This method has been renamed to readPartitionKeyDefinition.

Obtém a definição da chave de partição primeiro examinando o cache caso contrário, lendo a coleção.

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

Retornos

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec) 

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

Parâmetros

query

string | SqlQuerySpec

Retornos

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

Usado para ler, substituir ou excluir um item específico existente por ID.

Use .items para criar novos itens ou consultar/ler todos os itens.

Exemplo

Substituir um item 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

Parâmetros

id

string

A ID do Item.

partitionKeyValue
PartitionKey

O valor da chave de partição item

Retornos

Item

read(RequestOptions)

Ler a definição do contêiner

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

Parâmetros

options
RequestOptions

Retornos

Promise<ContainerResponse>

readOffer(RequestOptions)

Obtém a oferta no contêiner. Se nenhum existir, retornará um OfferResponse com indefinido.

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

Parâmetros

options
RequestOptions

Retornos

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions) 

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

Parâmetros

feedOptions
FeedOptions

Retornos

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

Substituir a definição do contêiner

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

Parâmetros

body
ContainerDefinition
options
RequestOptions

Retornos

Promise<ContainerResponse>