Partilhar via

Items class

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; utilização .item(id).

Propriedades

container

Métodos

batch(OperationInput[], PartitionKey, RequestOptions)

Execute operações em lote transacionais em itens.

O lote usa uma matriz de operações que são digitadas 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, Atualizar, Ler, Substituir e Excluir

Exemplo de utilização:

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

// 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 container.items.batch(operations, "A");
bulk(OperationInput[], BulkOptions, RequestOptions)

Execute operações em massa em itens.
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

Example

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 impô-las.

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

Example

Crie um item.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem } = await container.items.create({
  id: "<item id>",
  properties: {},
});
executeBulkOperations(OperationInput[], RequestOptions)

Execute operações em massa em itens.

Example

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const operations: OperationInput[] = [
  {
    operationType: "Create",
    resourceBody: { id: "doc1", name: "sample", key: "A" },
  },
  {
    operationType: "Upsert",
    partitionKey: "A",
    resourceBody: { id: "doc2", name: "other", key: "A" },
  },
];

await container.items.executeBulkOperations(operations);
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

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

Example

import {
  CosmosClient,
  PartitionKeyDefinitionVersion,
  PartitionKeyKind,
  ChangeFeedStartFrom,
} from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const containerDefinition = {
  id: "Test Database",
  partitionKey: {
    paths: ["/name", "/address/zip"],
    version: PartitionKeyDefinitionVersion.V2,
    kind: PartitionKeyKind.MultiHash,
  },
};
const { container } = await database.containers.createIfNotExists(containerDefinition);

const partitionKey = "some-partition-Key-value";
const options = {
  changeFeedStartFrom: ChangeFeedStartFrom.Beginning(partitionKey),
};

const iterator = container.items.getChangeFeedIterator(options);

while (iterator.hasMoreResults) {
  const response = await iterator.readNext();
  // process this response
}
getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Consulta todos os itens em um contêiner criptografado.

Example

Leia todos os itens para a matriz.

import { CosmosClient, EncryptionQueryBuilder } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const queryBuilder = new EncryptionQueryBuilder(
  `SELECT firstname FROM Families f WHERE f.lastName = @lastName`,
);
queryBuilder.addParameter("@lastName", "Hendricks", "/lastname");
const queryIterator = await container.items.getEncryptionQueryIterator(queryBuilder);
const { resources: items } = await queryIterator.fetchAll();
query(string | SqlQuerySpec, FeedOptions)

Consulta todos os itens.

Example

Leia todos os itens para a matriz.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

Consulta todos os itens.

Example

Leia todos os itens para a matriz.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

Leia todos os itens.

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

Example

Leia todos os itens para a matriz.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

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

Leia 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 impô-las.

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

Example

Leia todos os itens para a matriz.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resources: containerList } = await container.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

Example

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)

Upsert um item.

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

Upsert um item.

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

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

Example

Upsert um item.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem1 } = await container.items.create({
  id: "<item id 1>",
  properties: {},
});

const { resource: upsertItem1 } = await container.items.upsert({
  id: "<item id 1>",
  updated_properties: {},
});

const { resource: upsertItem2 } = await container.items.upsert({
  id: "<item id 2>",
  properties: {},
});

Detalhes de Propriedade

container 

container: Container

Valor de Propriedade

Container

Detalhes de Método

batch(OperationInput[], PartitionKey, RequestOptions)

Execute operações em lote transacionais em itens.

O lote usa uma matriz de operações que são digitadas 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, Atualizar, Ler, Substituir e Excluir

Exemplo de utilização:

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

// 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 container.items.batch(operations, "A");

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

Parâmetros

operations

OperationInput[]

Lista de operações. Limite 100

partitionKey
PartitionKey
options
RequestOptions

Usado para modificar a solicitação

Devoluções

Promise<Response<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Aviso

Esta API foi preterida.

Use executeBulkOperations instead.

Bulk takes an array of Operations which are typed based on what the operation does. The choices are: Create, Upsert, Read, Replace, and Delete

Usage example:

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

// 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 container.items.bulk(operations);

Execute operações em massa em itens.

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: false } para parar de executar operações quando uma falhar. (O padrão é true)

options
RequestOptions

Usado para modificar a solicitação.

Devoluções

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Aviso

Esta API foi preterida.

Use getChangeFeedIterator instead.

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

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

Parâmetros

changeFeedOptions
ChangeFeedOptions

Devoluções

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Aviso

Esta API foi preterida.

Use getChangeFeedIterator instead.

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

Example

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

Devoluções

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Aviso

Esta API foi preterida.

Use getChangeFeedIterator instead.

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

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

Parâmetros

changeFeedOptions
ChangeFeedOptions

Devoluções

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Aviso

Esta API foi preterida.

Use getChangeFeedIterator instead.

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

Devoluções

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 impô-las.

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

Example

Crie um item.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem } = await container.items.create({
  id: "<item id>",
  properties: {},
});

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

Devoluções

Promise<ItemResponse<T>>

executeBulkOperations(OperationInput[], RequestOptions)

Execute operações em massa em itens.

Example

import { CosmosClient, OperationInput } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const operations: OperationInput[] = [
  {
    operationType: "Create",
    resourceBody: { id: "doc1", name: "sample", key: "A" },
  },
  {
    operationType: "Upsert",
    partitionKey: "A",
    resourceBody: { id: "doc2", name: "other", key: "A" },
  },
];

await container.items.executeBulkOperations(operations);

function executeBulkOperations(operations: OperationInput[], options?: RequestOptions): Promise<BulkOperationResult[]>

Parâmetros

operations

OperationInput[]

Lista de operações

options
RequestOptions

usado para modificar a solicitação

Devoluções

Promise<BulkOperationResult[]>

Lista dos resultados das operações correspondentes às operações

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

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

Example

import {
  CosmosClient,
  PartitionKeyDefinitionVersion,
  PartitionKeyKind,
  ChangeFeedStartFrom,
} from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const containerDefinition = {
  id: "Test Database",
  partitionKey: {
    paths: ["/name", "/address/zip"],
    version: PartitionKeyDefinitionVersion.V2,
    kind: PartitionKeyKind.MultiHash,
  },
};
const { container } = await database.containers.createIfNotExists(containerDefinition);

const partitionKey = "some-partition-Key-value";
const options = {
  changeFeedStartFrom: ChangeFeedStartFrom.Beginning(partitionKey),
};

const iterator = container.items.getChangeFeedIterator(options);

while (iterator.hasMoreResults) {
  const response = await iterator.readNext();
  // process this response
}

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

Parâmetros

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Devoluções

ChangeFeedPullModelIterator<T>

getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Consulta todos os itens em um contêiner criptografado.

Example

Leia todos os itens para a matriz.

import { CosmosClient, EncryptionQueryBuilder } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const queryBuilder = new EncryptionQueryBuilder(
  `SELECT firstname FROM Families f WHERE f.lastName = @lastName`,
);
queryBuilder.addParameter("@lastName", "Hendricks", "/lastname");
const queryIterator = await container.items.getEncryptionQueryIterator(queryBuilder);
const { resources: items } = await queryIterator.fetchAll();

function getEncryptionQueryIterator(queryBuilder: EncryptionQueryBuilder, options?: FeedOptions): Promise<QueryIterator<ItemDefinition>>

Parâmetros

queryBuilder
EncryptionQueryBuilder

Configuração de consulta para a operação. Consulte SqlQuerySpec para obter mais informações sobre como criar uma consulta em propriedades criptografadas.

options
FeedOptions

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

Devoluções

Promise<QueryIterator<ItemDefinition>>

query(string | SqlQuerySpec, FeedOptions)

Consulta todos os itens.

Example

Leia todos os itens para a matriz.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM Families f WHERE f.lastName = @lastName`,
  parameters: [{ name: "@lastName", value: "Hendricks" }],
};
const { resources: items } = await container.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).

Devoluções

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Consulta todos os itens.

Example

Leia todos os itens para a matriz.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM Families f WHERE f.lastName = @lastName`,
  parameters: [{ name: "@lastName", value: "Hendricks" }],
};
const { resources: items } = await container.items.query(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).

Devoluções

QueryIterator<T>

readAll(FeedOptions)

Leia todos os itens.

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

Example

Leia todos os itens para a matriz.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resources: containerList } = await container.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).

Devoluções

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Leia 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 impô-las.

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

Example

Leia todos os itens para a matriz.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resources: containerList } = await container.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).

Devoluções

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Aviso

Esta API foi preterida.

Use getChangeFeedIterator instead.

Criar um ChangeFeedIterator para iterar em 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 getChangeFeedIterator instead.

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

Example

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

Devoluções

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Aviso

Esta API foi preterida.

Use getChangeFeedIterator instead.

Criar um ChangeFeedIterator para iterar em 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 getChangeFeedIterator 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

Devoluções

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert 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).

Devoluções

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert um item.

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

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

Example

Upsert um item.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: createdItem1 } = await container.items.create({
  id: "<item id 1>",
  properties: {},
});

const { resource: upsertItem1 } = await container.items.upsert({
  id: "<item id 1>",
  updated_properties: {},
});

const { resource: upsertItem2 } = await container.items.upsert({
  id: "<item id 2>",
  properties: {},
});

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

Devoluções

Promise<ItemResponse<T>>