Container class
Operações para ler, substituir ou eliminar um contentor existente específico por ID.
Veja Contentores para criar novos contentores e ler/consultar todos os contentores; utilize .containers.
Nota: todas estas operações fazem chamadas relativamente a um orçamento fixo.
Deve estruturar o seu sistema de modo a que estas chamadas se dimensionem sublinearmente com a sua aplicação.
Por exemplo, não chame container(id).read() antes de cada item.read() chamada, para garantir que o contentor existe; faça-o uma vez no arranque da aplicação.
Propriedades
| conflicts | Operações para ler e consultar conflitos para o contentor especificado. Para ler ou eliminar um conflito específico, utilize |
| database | |
| id | |
| items | Operações para criar novos itens e leitura/consulta de todos os itens Para ler, substituir ou eliminar um item existente, utilize Exemplo Criar um novo item |
| scripts | Todas as operações para Procedimentos Armazenados, Acionadores e Funções Definidas pelo Utilizador |
| url | Devolve um URL de referência ao recurso. Utilizado para ligar em Permissões. |
Métodos
| conflict(string, Partition |
Utilizado para ler, substituir ou eliminar um Conflito por ID específico existente. Utilize |
| delete(Request |
Eliminar o contentor |
| delete |
Eliminar todos os documentos pertencem ao contentor para o valor da chave de partição fornecida |
| get |
|
| get |
Obtém primeiro a definição da chave de partição ao analisar a cache, caso contrário, ao ler a coleção. |
| get |
|
| item(string, Partition |
Utilizado para ler, substituir ou eliminar um Item por ID específico existente. Utilize Exemplo Substituir um item |
| read(Request |
Ler a definição do contentor |
| read |
Obtém a oferta no contentor. Se não existir nenhum, devolve uma OfferResponse com indefinição. |
| read |
|
| replace(Container |
Substituir a definição do contentor |
Detalhes de Propriedade
conflicts
Operações para ler e consultar conflitos para o contentor especificado.
Para ler ou eliminar um conflito específico, utilize .conflict(id).
Conflicts conflictsValor de Propriedade
database
id
id: stringValor de Propriedade
string
items
Operações para criar novos itens e leitura/consulta de todos os itens
Para ler, substituir ou eliminar um item existente, utilize .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, Acionadores e Funções Definidas pelo Utilizador
Scripts scriptsValor de Propriedade
url
Devolve um URL de referência ao recurso. Utilizado para ligar em Permissões.
string urlValor de Propriedade
string
Detalhes de Método
conflict(string, PartitionKey)
Utilizado para ler, substituir ou eliminar um Conflito por ID específico existente.
Utilize .conflicts para criar novos conflitos ou consultar/ler todos os conflitos.
function conflict(id: string, partitionKey?: PartitionKey): ConflictParâmetros
- id
-
string
O ID do Conflito.
- partitionKey
- PartitionKey
Devoluções
delete(RequestOptions)
Eliminar o contentor
function delete(options?: RequestOptions): Promise<ContainerResponse>Parâmetros
- options
- RequestOptions
Devoluções
Promise<ContainerResponse>
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)
Eliminar todos os documentos pertencem ao contentor 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 eliminar
- options
- RequestOptions
Devoluções
Promise<ContainerResponse>
getFeedRanges()
function getFeedRanges(): Promise<readonly FeedRange[]>Devoluções
Promise<readonly FeedRange[]>
todos os intervalos de feed para os quais o changefeed pode ser obtido.
getPartitionKeyDefinition()
Aviso
Esta API foi preterida.
This method has been renamed to readPartitionKeyDefinition.
Obtém primeiro a definição da chave de partição ao analisar a cache, caso contrário, ao ler 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)
Utilizado para ler, substituir ou eliminar um Item por ID específico existente.
Utilize .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)
Ler a definição do contentor
function read(options?: RequestOptions): Promise<ContainerResponse>Parâmetros
- options
- RequestOptions
Devoluções
Promise<ContainerResponse>
readOffer(RequestOptions)
Obtém a oferta no contentor. Se não existir nenhum, devolve uma OfferResponse com indefinição.
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)
Substituir a definição do contentor
function replace(body: ContainerDefinition, options?: RequestOptions): Promise<ContainerResponse>Parâmetros
- body
- ContainerDefinition
- options
- RequestOptions
Devoluções
Promise<ContainerResponse>