Container class
Operações para ler, substituir ou excluir um contêiner específico existente por id.
Consulte Containers para criar novos contêineres e ler/consultar todos os contêineres; use .containers.
Nota: todas estas operações fazem chamadas contra um orçamento fixo.
Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas sublinearmente com seu aplicativo.
Por exemplo, não ligue para container(id).read() antes de cada item.read() chamada, para garantir que o contêiner existe; Faça isso uma vez na inicialização do aplicativo.
Propriedades
| conflicts | Operações para ler e consultar conflitos para um determinado contêiner. 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 um de conflito de específico e existente por id. Use |
| delete(Request |
Excluir o contêiner |
| delete |
Excluir todos os documentos pertencentes ao contêiner para o valor da chave de partição fornecida |
| 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 de Item de específico e existente por id. Use Exemplo Substituir um item |
| read(Request |
Leia a definição do recipiente |
| read |
Recebe oferta no contêiner. Se não existir, retorna um OfferResponse com undefined. |
| read |
|
| replace(Container |
Substitua a definição do contêiner |
Detalhes de Propriedade
conflicts
Operações para ler e consultar conflitos para um determinado contêiner.
Para ler ou excluir um conflito específico, use .conflict(id).
Conflicts conflictsValor de Propriedade
database
id
id: stringValor de 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 itemsValor de Propriedade
scripts
Todas as operações para procedimentos armazenados, gatilhos e funções definidas pelo usuário
Scripts scriptsValor de Propriedade
url
Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.
string urlValor de Propriedade
string
Detalhes de Método
conflict(string, PartitionKey)
Usado para ler, substituir ou excluir um de conflito de específico e existente por id.
Use .conflicts para criar novos conflitos ou consultar/ler todos os conflitos.
function conflict(id: string, partitionKey?: PartitionKey): ConflictParâmetros
- partitionKey
- PartitionKey
Devoluções
delete(RequestOptions)
Excluir o contêiner
function delete(options?: RequestOptions): Promise<ContainerResponse>Parâmetros
- options
- RequestOptions
Devoluções
Promise<ContainerResponse>
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)
Excluir todos os documentos pertencentes ao contêiner para o valor da chave de partição fornecida
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
Devoluções
Promise<ContainerResponse>
getFeedRanges()
function getFeedRanges(): Promise<readonly FeedRange[]>Devoluções
Promise<readonly FeedRange[]>
todas as gamas de alimentação para as quais o changefeed pode ser obtido.
getPartitionKeyDefinition()
Aviso
Esta 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>>Devoluções
Promise<ResourceResponse<PartitionKeyDefinition>>
getQueryPlan(string | SqlQuerySpec)
function getQueryPlan(query: string | SqlQuerySpec): Promise<Response_2<PartitionedQueryExecutionInfo>>Parâmetros
- query
-
string | SqlQuerySpec
Devoluções
Promise<Response_2<PartitionedQueryExecutionInfo>>
item(string, PartitionKey)
Usado para ler, substituir ou excluir um de Item de específico e 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): ItemParâmetros
- id
-
string
O id do Item.
- partitionKeyValue
- PartitionKey
O valor da chave de partição Item
Devoluções
read(RequestOptions)
Leia a definição do recipiente
function read(options?: RequestOptions): Promise<ContainerResponse>Parâmetros
- options
- RequestOptions
Devoluções
Promise<ContainerResponse>
readOffer(RequestOptions)
Recebe oferta no contêiner. Se não existir, retorna um OfferResponse com undefined.
function readOffer(options?: RequestOptions): Promise<OfferResponse>Parâmetros
- options
- RequestOptions
Devoluções
Promise<OfferResponse>
readPartitionKeyRanges(FeedOptions)
function readPartitionKeyRanges(feedOptions?: FeedOptions): QueryIterator<PartitionKeyRange>Parâmetros
- feedOptions
- FeedOptions
Devoluções
QueryIterator<PartitionKeyRange>
replace(ContainerDefinition, RequestOptions)
Substitua a definição do contêiner
function replace(body: ContainerDefinition, options?: RequestOptions): Promise<ContainerResponse>Parâmetros
- body
- ContainerDefinition
- options
- RequestOptions
Devoluções
Promise<ContainerResponse>