Container class
Operações para ler, substituir ou excluir um contêiner específico existente 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 em relação a um orçamento fixo.
Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas sublinearmente com seu aplicativo.
Por exemplo, não chame container(id).read()
antes de cada chamada item.read()
, 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 fornecido. Para ler ou excluir um conflito específico, use |
database | |
id | |
items | Operações para criar novos itens e ler/consultar todos os itens Para ler, substituir ou excluir um item existente, use exemplo Criar um novo item
|
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 vincular em Permissões. |
Métodos
conflict(string, Partition |
Usado para ler, substituir ou excluir uma de conflito de específica por ID. Use |
delete(Request |
Excluir o contêiner |
delete |
Excluir todos os documentos pertencem ao contêiner para o valor de chave de partição fornecido |
get |
|
get |
Obtém a definição da chave de partição primeiro examinando o cache caso contrário, lendo a coleção. |
get |
|
item(string, Partition |
Usado para ler, substituir ou excluir um item de existente específico por ID. Use exemplo Substituir um item |
read(Request |
Ler a definição do contêiner |
read |
Obtém a oferta no contêiner. Se nenhum existir, retornará um OfferResponse com indefinido. |
read |
|
replace(Container |
Substituir a definição do contêiner |
Detalhes da propriedade
conflicts
Operações para ler e consultar conflitos para o contêiner fornecido.
Para ler ou excluir um conflito específico, use .conflict(id)
.
Conflicts conflicts
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 novo item
const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
Items items
Valor da propriedade
scripts
Todas as operações para procedimentos armazenados, gatilhos e funções definidas pelo usuário
Scripts scripts
Valor da propriedade
url
Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.
string url
Valor da propriedade
string
Detalhes do método
conflict(string, PartitionKey)
Usado para ler, substituir ou excluir uma de conflito de específica por ID.
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 de Conflito.
- partitionKey
- PartitionKey
Retornos
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 feed 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 de existente específico 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
- partitionKeyValue
- PartitionKey
O valor da chave de partição item de
Retornos
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>