Partilhar via

Item class

Pacote:
@azure/cosmos

Usado para executar operações em um item específico.

Consulte Itens para operações em todos os itens; Ver container.items.

Propriedades

container
id
url

Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.

Métodos

delete<T>(RequestOptions)

Exclua o 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.

Exemplo

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" });

interface TodoItem {
  title: string;
  done: boolean;
  id: string;
}

const { resource: item } = await container.item("id", "<pkValue>").read<TodoItem>();

await container.item("id").delete<TodoItem>();
patch<T>(PatchRequestBody, RequestOptions)

Execute um JSONPatch no 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.

Exemplo

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

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

interface TodoItem {
  title: string;
  done: boolean;
  id: string;
}

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

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

const { resource: item } = await container.item("id", "<pkValue>").read<TodoItem>();

const { resource: patchedItem } = await container.item("id").patch<TodoItem>([
  {
    op: "replace", // Operation type (can be replace, add, remove, set, incr)
    path: "/title", // The path to the property to update
    value: "new-title", // New value for the property
  },
  {
    op: "remove",
    path: "/done",
  },
]);
read<T>(RequestOptions)

Leia a definição do 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. Se o tipo, T, for uma classe, ele não passará typeof comparações, porque não terá um protótipo correspondente. Recomenda-se usar apenas interfaces.

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

Exemplo

Usando o tipo personalizado para resposta

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" });

interface TodoItem {
  title: string;
  done: boolean;
  id: string;
}

const { resource: item } = await container.item("id", "<pkValue>").read<TodoItem>();
replace(ItemDefinition, RequestOptions)

Substitua a definição do item.

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

Exemplo

import { CosmosClient, ItemDefinition } 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 item: ItemDefinition = {
  id: "id",
  title: "new_title",
};

const { resource: replacedItem } = await container.item("id").replace(item);
replace<T>(T, RequestOptions)

Substitua a definição do 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.

Exemplo

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" });

interface TodoItem {
  title: string;
  done: boolean;
  id: string;
}

const { resource: item } = await container.item("id", "<pkValue>").read<TodoItem>();

item.done = true;
const { resource: replacedItem } = await container.item("id").replace<TodoItem>(item);

Detalhes de Propriedade

container 

container: Container

Valor de Propriedade

Container

id 

id: string

Valor de Propriedade

string

url

Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.

string url

Valor de Propriedade

string

Detalhes de Método

delete<T>(RequestOptions)

Exclua o 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.

Exemplo

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" });

interface TodoItem {
  title: string;
  done: boolean;
  id: string;
}

const { resource: item } = await container.item("id", "<pkValue>").read<TodoItem>();

await container.item("id").delete<TodoItem>();

function delete<T>(options?: RequestOptions): Promise<ItemResponse<T>>

Parâmetros

options
RequestOptions

Opções adicionais para o pedido

Devoluções

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Execute um JSONPatch no 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.

Exemplo

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

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

interface TodoItem {
  title: string;
  done: boolean;
  id: string;
}

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

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

const { resource: item } = await container.item("id", "<pkValue>").read<TodoItem>();

const { resource: patchedItem } = await container.item("id").patch<TodoItem>([
  {
    op: "replace", // Operation type (can be replace, add, remove, set, incr)
    path: "/title", // The path to the property to update
    value: "new-title", // New value for the property
  },
  {
    op: "remove",
    path: "/done",
  },
]);

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

Parâmetros

body
PatchRequestBody
options
RequestOptions

Opções adicionais para o pedido

Devoluções

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Leia a definição do 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. Se o tipo, T, for uma classe, ele não passará typeof comparações, porque não terá um protótipo correspondente. Recomenda-se usar apenas interfaces.

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

Exemplo

Usando o tipo personalizado para resposta

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" });

interface TodoItem {
  title: string;
  done: boolean;
  id: string;
}

const { resource: item } = await container.item("id", "<pkValue>").read<TodoItem>();

function read<T>(options?: RequestOptions): Promise<ItemResponse<T>>

Parâmetros

options
RequestOptions

Opções adicionais para o pedido

Devoluções

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Substitua a definição do item.

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

Exemplo

import { CosmosClient, ItemDefinition } 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 item: ItemDefinition = {
  id: "id",
  title: "new_title",
};

const { resource: replacedItem } = await container.item("id").replace(item);

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

Parâmetros

body
ItemDefinition

A definição para substituir a definição existente Item's por.

options
RequestOptions

Opções adicionais para o pedido

Devoluções

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Substitua a definição do 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.

Exemplo

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" });

interface TodoItem {
  title: string;
  done: boolean;
  id: string;
}

const { resource: item } = await container.item("id", "<pkValue>").read<TodoItem>();

item.done = true;
const { resource: replacedItem } = await container.item("id").replace<TodoItem>(item);

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

Parâmetros

body

T

A definição para substituir a definição existente Item's por.

options
RequestOptions

Opções adicionais para o pedido

Devoluções

Promise<ItemResponse<T>>