Items class

  • Referência
Pacote:
@azure/cosmos

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

Veja Item para ler, substituir ou eliminar um contentor existente; utilizar .item(id).

Propriedades

container

Métodos

batch(OperationInput[], PartitionKey, RequestOptions)

Execute operações de lote transacional em itens.

O Batch utiliza uma matriz de Operações que são escritas com base no que a operação faz. O Batch é transacional e reverterá todas as operações se uma falhar. As opções são: Criar, Upsert, Ler, Substituir e Eliminar

Exemplo de utilização:

// partitionKey is required as a second argument to batch, but defaults to the default partition key
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.batch(operations)
bulk(OperationInput[], BulkOptions, RequestOptions)

Execute operações em massa em itens.

O volume utiliza uma matriz de Operações que são escritas com base no que a operação faz. As opções são: Criar, Upsert, Ler, Substituir e Eliminar

Exemplo de utilização:

// partitionKey is optional at the top level if present in the resourceBody
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.bulk(operations)
changeFeed(ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações
changeFeed(PartitionKey, ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações

Exemplo

Leia a partir do início do feed de alterações.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
changeFeed<T>(ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações
create<T>(T, RequestOptions)

Criar um item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Pode obter mais ou menos propriedades e cabe-lhe à sua lógica aplicá-la.

Não existe um esquema definido para itens JSON. Podem conter qualquer número de propriedades personalizadas.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Devolve um iterador para iterar através de páginas de alterações. O iterador devolvido pode ser utilizado para obter alterações para uma única chave de partição, intervalo de feed ou um contentor inteiro.
query(string | SqlQuerySpec, FeedOptions)

Consulta todos os itens.

Exemplo

Leia todos os itens para a matriz.

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query(querySpec).fetchAll();
query<T>(string | SqlQuerySpec, FeedOptions)

Consulta todos os itens.

Exemplo

Leia todos os itens para a matriz.

const querySpec: SqlQuerySpec = {
  query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query<{firstName: string}>(querySpec).fetchAll();
readAll(FeedOptions)

Leia todos os itens.

Não existe um esquema definido para itens JSON. Podem conter qualquer número de propriedades personalizadas.

Exemplo

Leia todos os itens para a matriz.

const {body: containerList} = await items.readAll().fetchAll();
readAll<T>(FeedOptions)

Leia todos os itens.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Pode obter mais ou menos propriedades e cabe-lhe à sua lógica aplicá-la.

Não existe um esquema definido para itens JSON. Podem conter qualquer número de propriedades personalizadas.

Exemplo

Leia todos os itens para a matriz.

const {body: containerList} = await items.readAll().fetchAll();
readChangeFeed(ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações
readChangeFeed(PartitionKey, ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações

Exemplo

Leia a partir do início do feed de alterações.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
readChangeFeed<T>(ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações
upsert(unknown, RequestOptions)

Inseria um item.

Não existe um esquema definido para itens JSON. Podem conter qualquer número de propriedades personalizadas.
upsert<T>(T, RequestOptions)

Inseria um item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Pode obter mais ou menos propriedades e cabe-lhe à sua lógica aplicá-la.

Não existe um esquema definido para itens JSON. Podem conter qualquer número de propriedades personalizadas.

Detalhes de Propriedade

container 

container: Container

Valor de Propriedade

Container

Detalhes de Método

batch(OperationInput[], PartitionKey, RequestOptions)

Execute operações de lote transacional em itens.

O Batch utiliza uma matriz de Operações que são escritas com base no que a operação faz. O Batch é transacional e reverterá todas as operações se uma falhar. As opções são: Criar, Upsert, Ler, Substituir e Eliminar

Exemplo de utilização:

// partitionKey is required as a second argument to batch, but defaults to the default partition key
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.batch(operations)

function batch(operations: OperationInput[], partitionKey?: PartitionKey, options?: RequestOptions): Promise<Response_2<OperationResponse[]>>

Parâmetros

operations

OperationInput[]

Lista de operações. Limite 100

partitionKey
PartitionKey
options
RequestOptions

Utilizado para modificar o pedido

Devoluções

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Execute operações em massa em itens.

O volume utiliza uma matriz de Operações que são escritas com base no que a operação faz. As opções são: Criar, Upsert, Ler, Substituir e Eliminar

Exemplo de utilização:

// partitionKey is optional at the top level if present in the resourceBody
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.bulk(operations)

function bulk(operations: OperationInput[], bulkOptions?: BulkOptions, options?: RequestOptions): Promise<BulkOperationResponse>

Parâmetros

operations

OperationInput[]

Lista de operações. Limite 100

bulkOptions
BulkOptions

Opções opcionais objeto para modificar o comportamento em massa. Passe { continueOnError: true } para continuar a executar operações quando uma falha. (Predefinição para falso) ** NOTA: ESTA AÇÃO SERÁ PREDEFINIDA PARA VERDADEIRO NA VERSÃO 4.0

options
RequestOptions

Utilizado para modificar o pedido.

Devoluções

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações

function changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parâmetros

changeFeedOptions
ChangeFeedOptions

Devoluções

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações

Exemplo

Leia a partir do início do feed de alterações.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();

function changeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parâmetros

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Devoluções

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações

function changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parâmetros

changeFeedOptions
ChangeFeedOptions

Devoluções

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar através de páginas de alterações

function changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parâmetros

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Devoluções

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Criar um item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Pode obter mais ou menos propriedades e cabe-lhe à sua lógica aplicá-la.

Não existe um esquema definido para itens JSON. Podem conter qualquer número de propriedades personalizadas.

function create<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

Parâmetros

body

T

Representa o corpo do item. Pode conter qualquer número de propriedades definidas pelo utilizador.

options
RequestOptions

Utilizado para modificar o pedido (por exemplo, especificar a chave de partição).

Devoluções

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Devolve um iterador para iterar através de páginas de alterações. O iterador devolvido pode ser utilizado para obter alterações para uma única chave de partição, intervalo de feed ou um contentor inteiro.

function getChangeFeedIterator<T>(changeFeedIteratorOptions?: ChangeFeedIteratorOptions): ChangeFeedPullModelIterator<T>

Parâmetros

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Devoluções

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

Consulta todos os itens.

Exemplo

Leia todos os itens para a matriz.

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query(querySpec).fetchAll();

function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parâmetros

query

string | SqlQuerySpec

Configuração da consulta para a operação. Veja SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Utilizado para modificar o pedido (por exemplo, especificar a chave de partição).

Devoluções

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Consulta todos os itens.

Exemplo

Leia todos os itens para a matriz.

const querySpec: SqlQuerySpec = {
  query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query<{firstName: string}>(querySpec).fetchAll();

function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Parâmetros

query

string | SqlQuerySpec

Configuração da consulta para a operação. Veja SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Utilizado para modificar o pedido (por exemplo, especificar a chave de partição).

Devoluções

QueryIterator<T>

readAll(FeedOptions)

Leia todos os itens.

Não existe um esquema definido para itens JSON. Podem conter qualquer número de propriedades personalizadas.

Exemplo

Leia todos os itens para a matriz.

const {body: containerList} = await items.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>

Parâmetros

options
FeedOptions

Utilizado para modificar o pedido (por exemplo, especificar a chave de partição).

Devoluções

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Leia todos os itens.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Pode obter mais ou menos propriedades e cabe-lhe à sua lógica aplicá-la.

Não existe um esquema definido para itens JSON. Podem conter qualquer número de propriedades personalizadas.

Exemplo

Leia todos os itens para a matriz.

const {body: containerList} = await items.readAll().fetchAll();

function readAll<T>(options?: FeedOptions): QueryIterator<T>

Parâmetros

options
FeedOptions

Utilizado para modificar o pedido (por exemplo, especificar a chave de partição).

Devoluções

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Aviso

Esta API foi preterida.

Use changeFeed instead.

Criar um ChangeFeedIterator para iterar através de páginas de alterações

function readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parâmetros

changeFeedOptions
ChangeFeedOptions

Devoluções

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Aviso

Esta API foi preterida.

Use changeFeed instead.

Criar um ChangeFeedIterator para iterar através de páginas de alterações

Exemplo

Leia a partir do início do feed de alterações.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();

function readChangeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parâmetros

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Devoluções

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Aviso

Esta API foi preterida.

Use changeFeed instead.

Criar um ChangeFeedIterator para iterar através de páginas de alterações

function readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parâmetros

changeFeedOptions
ChangeFeedOptions

Devoluções

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Aviso

Esta API foi preterida.

Use changeFeed instead.

Criar um ChangeFeedIterator para iterar através de páginas de alterações

function readChangeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parâmetros

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Devoluções

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Inseria um item.

Não existe um esquema definido para itens JSON. Podem conter qualquer número de propriedades personalizadas.

function upsert(body: unknown, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>

Parâmetros

body

unknown

Representa o corpo do item. Pode conter qualquer número de propriedades definidas pelo utilizador.

options
RequestOptions

Utilizado para modificar o pedido (por exemplo, especificar a chave de partição).

Devoluções

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Inseria um item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Pode obter mais ou menos propriedades e cabe-lhe à sua lógica aplicá-la.

Não existe um esquema definido para itens JSON. Podem conter qualquer número de propriedades personalizadas.

function upsert<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

Parâmetros

body

T

Representa o corpo do item. Pode conter qualquer número de propriedades definidas pelo utilizador.

options
RequestOptions

Utilizado para modificar o pedido (por exemplo, especificar a chave de partição).

Devoluções

Promise<ItemResponse<T>>