Sdílet prostřednictvím

Item class

Balíček:
@azure/cosmos

Slouží k provádění operací s konkrétní položkou.

Operace se všemi položkami najdete v tématu Položky; viz container.items.

Vlastnosti

container
id
url

Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

Metody

delete<T>(RequestOptions)

Odstraňte položku.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.

příklad 

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)

Proveďte u položky jsonPatch.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.

příklad 

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)

Přečtěte si definici položky.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila. Pokud typ T je třída, nepřejde typeof porovnání, protože nebude mít prototyp shody. Doporučujeme používat pouze rozhraní.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.

příklad

Použití vlastního typu pro odpověď

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)

Nahraďte definici položky.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.

příklad 

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)

Nahraďte definici položky.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.

příklad 

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

Podrobnosti vlastnosti

container 

container: Container

Hodnota vlastnosti

Container

id 

id: string

Hodnota vlastnosti

string

url

Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

string url

Hodnota vlastnosti

string

Podrobnosti metody

delete<T>(RequestOptions)

Odstraňte položku.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.

příklad 

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

Parametry

options
RequestOptions

Další možnosti požadavku

Návraty

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Proveďte u položky jsonPatch.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.

příklad 

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

Parametry

body
PatchRequestBody
options
RequestOptions

Další možnosti požadavku

Návraty

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Přečtěte si definici položky.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila. Pokud typ T je třída, nepřejde typeof porovnání, protože nebude mít prototyp shody. Doporučujeme používat pouze rozhraní.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.

příklad

Použití vlastního typu pro odpověď

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

Parametry

options
RequestOptions

Další možnosti požadavku

Návraty

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Nahraďte definici položky.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.

příklad 

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

Parametry

body
ItemDefinition

Definice, která má nahradit existující Itemdefinici.

options
RequestOptions

Další možnosti požadavku

Návraty

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Nahraďte definici položky.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.

příklad 

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

Parametry

body

T

Definice, která má nahradit existující Itemdefinici.

options
RequestOptions

Další možnosti požadavku

Návraty

Promise<ItemResponse<T>>