Udostępnij za pomocą

Item class

Pakiet:
@azure/cosmos

Służy do wykonywania operacji na określonym elemencie.

Zobacz Items, aby uzyskać informacje o operacjach na wszystkich elementach; zobacz container.items.

Właściwości

container
id
url

Zwraca adres URL odwołania do zasobu. Służy do łączenia w obszarze Uprawnienia.

Metody

delete<T>(RequestOptions)

Usuń element.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Przykład

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)

Wykonaj element JSONPatch.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Przykład

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)

Przeczytaj definicję elementu.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić. Jeśli typ T jest klasą, nie zostanie przekazany typeof porównania, ponieważ nie będzie miał prototypu dopasowania. Zaleca się używanie tylko interfejsów.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Przykład

Używanie typu niestandardowego dla odpowiedzi

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)

Zastąp definicję elementu.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Przykład

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)

Zastąp definicję elementu.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Przykład

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

Szczegóły właściwości

container 

container: Container

Wartość właściwości

Container

id 

id: string

Wartość właściwości

string

url

Zwraca adres URL odwołania do zasobu. Służy do łączenia w obszarze Uprawnienia.

string url

Wartość właściwości

string

Szczegóły metody

delete<T>(RequestOptions)

Usuń element.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Przykład

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

Dodatkowe opcje żądania

Zwraca

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Wykonaj element JSONPatch.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Przykład

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

Dodatkowe opcje żądania

Zwraca

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Przeczytaj definicję elementu.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić. Jeśli typ T jest klasą, nie zostanie przekazany typeof porównania, ponieważ nie będzie miał prototypu dopasowania. Zaleca się używanie tylko interfejsów.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Przykład

Używanie typu niestandardowego dla odpowiedzi

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

Dodatkowe opcje żądania

Zwraca

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Zastąp definicję elementu.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Przykład

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

Definicja zastępująca istniejącą definicję elementu .

options
RequestOptions

Dodatkowe opcje żądania

Zwraca

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Zastąp definicję elementu.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Przykład

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

Definicja zastępująca istniejącą definicję elementu .

options
RequestOptions

Dodatkowe opcje żądania

Zwraca

Promise<ItemResponse<T>>