Items class

container: Container

Valor da propriedade

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:

// The partitionKey is a required second argument. If it’s undefined, it defaults to the expected partition key format.
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.batch(operations, "A")

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

Parâmetros

Retornos

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

Retornos

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

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

Parâmetros

Retornos

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

Retornos

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

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

Parâmetros

Retornos

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

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

Parâmetros

Retornos

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

Retornos

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

Retornos

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

Retornos

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

Retornos

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

Retornos

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

Retornos

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

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

Parâmetros

Retornos

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

Retornos

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

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

Parâmetros

Retornos

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

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

Parâmetros

Retornos

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

Retornos

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

Retornos