Share via

Items class

  • Referência
Pacote:
@azure/cosmos

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

Consulte Item para ler, substituir ou excluir um contêiner existente; use .item(id).

Propriedades

container

Métodos

batch(OperationInput[], PartitionKey, RequestOptions)

Executar operações em lotes transacionais em itens.

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

Exemplo de uso:

// 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)

Executar operações em massa em itens.

Em massa usa uma matriz de Operações que são digitada com base no que a operação faz. As opções são: Criar, Upsert, Ler, Substituir e Excluir

Exemplo de uso:

// 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 em páginas de alterações
changeFeed(PartitionKey, ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar em páginas de alterações

Exemplo

Leia desde o 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 em páginas de alterações
changeFeed<T>(PartitionKey, ChangeFeedOptions)

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

Crie um item.

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

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Retorna um iterador para iterar sobre páginas de alterações. O iterador retornado pode ser usado para buscar alterações para uma única chave de partição, intervalo de feeds ou um contêiner inteiro.
query(string | SqlQuerySpec, FeedOptions)

Consulta todos os itens.

Exemplo

Ler todos os itens na 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

Ler todos os itens na 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)

Ler todos os itens.

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.

Exemplo

Ler todos os itens na matriz.

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

Ler todos os itens.

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

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.

Exemplo

Ler todos os itens na matriz.

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

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

Criar um ChangeFeedIterator para iterar em páginas de alterações

Exemplo

Leia desde o 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 em páginas de alterações
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

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

Fazer upsert de um item.

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.
upsert<T>(T, RequestOptions)

Fazer upsert de um item.

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

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.

Detalhes da propriedade

container 

container: Container

Valor da propriedade

Container

Detalhes do método

batch(OperationInput[], PartitionKey, RequestOptions)

Executar operações em lotes transacionais em itens.

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

Exemplo de uso:

// 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

Usado para modificar a solicitação

Retornos

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Executar operações em massa em itens.

Em massa usa uma matriz de Operações que são digitada com base no que a operação faz. As opções são: Criar, Upsert, Ler, Substituir e Excluir

Exemplo de uso:

// 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

Objeto de opções opcionais para modificar o comportamento em massa. Passe { continueOnError: true } para continuar executando operações quando uma falhar. (O padrão é false) ** OBSERVAÇÃO: ESSE PADRÃO SERÁ TRUE NA VERSÃO 4.0

options
RequestOptions

Usado para modificar a solicitação.

Retornos

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar em páginas de alterações

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

Parâmetros

changeFeedOptions
ChangeFeedOptions

Retornos

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar em páginas de alterações

Exemplo

Leia desde o 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

Retornos

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar em páginas de alterações

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

Parâmetros

changeFeedOptions
ChangeFeedOptions

Retornos

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Criar um ChangeFeedIterator para iterar em páginas de alterações

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

Parâmetros

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Retornos

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Crie um item.

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

Não há nenhum esquema definido para itens JSON. Eles 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 usuário.

options
RequestOptions

Usado para modificar a solicitação (por exemplo, especificando a chave de partição).

Retornos

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Retorna um iterador para iterar sobre páginas de alterações. O iterador retornado pode ser usado para buscar alterações para uma única chave de partição, intervalo de feeds ou um contêiner inteiro.

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

Parâmetros

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Retornos

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

Consulta todos os itens.

Exemplo

Ler todos os itens na 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 de consulta para a operação. Consulte SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Usado para modificar a solicitação (por exemplo, especificando a chave de partição).

Retornos

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Consulta todos os itens.

Exemplo

Ler todos os itens na 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 de consulta para a operação. Consulte SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Usado para modificar a solicitação (por exemplo, especificando a chave de partição).

Retornos

QueryIterator<T>

readAll(FeedOptions)

Ler todos os itens.

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.

Exemplo

Ler todos os itens na matriz.

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

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

Parâmetros

options
FeedOptions

Usado para modificar a solicitação (por exemplo, especificando a chave de partição).

Retornos

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Ler todos os itens.

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

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.

Exemplo

Ler todos os itens na matriz.

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

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

Parâmetros

options
FeedOptions

Usado para modificar a solicitação (por exemplo, especificando a chave de partição).

Retornos

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Aviso

Essa API foi preterida.

Use changeFeed instead.

Criar um ChangeFeedIterator para iterar em páginas de alterações

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

Parâmetros

changeFeedOptions
ChangeFeedOptions

Retornos

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Aviso

Essa API foi preterida.

Use changeFeed instead.

Criar um ChangeFeedIterator para iterar em páginas de alterações

Exemplo

Leia desde o 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

Retornos

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Aviso

Essa API foi preterida.

Use changeFeed instead.

Criar um ChangeFeedIterator para iterar em páginas de alterações

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

Parâmetros

changeFeedOptions
ChangeFeedOptions

Retornos

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Aviso

Essa API foi preterida.

Use changeFeed instead.

Criar um ChangeFeedIterator para iterar em páginas de alterações

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

Parâmetros

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Retornos

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Fazer upsert de um item.

Não há nenhum esquema definido para itens JSON. Eles 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 usuário.

options
RequestOptions

Usado para modificar a solicitação (por exemplo, especificando a chave de partição).

Retornos

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Fazer upsert de um item.

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

Não há nenhum esquema definido para itens JSON. Eles 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 usuário.

options
RequestOptions

Usado para modificar a solicitação (por exemplo, especificando a chave de partição).

Retornos

Promise<ItemResponse<T>>