Item class

container: Container

Egenskapsvärde

id: string

Egenskapsvärde

Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

string url

Egenskapsvärde

Ta bort objektet.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller mindre egenskaper och det är upp till din logik att framtvinga det.

Exempel

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

Parametrar

Returer

Utför en JSONPatch på objektet.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller mindre egenskaper och det är upp till din logik att framtvinga det.

Exempel

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

Parametrar

Returer

Läs objektets definition.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller mindre egenskaper och det är upp till din logik att framtvinga det. Om typen T är en klass godkänns den inte typeof jämförelser eftersom den inte har någon matchningsprototyp. Vi rekommenderar att du endast använder gränssnitt.

Det finns inget angivet schema för JSON-objekt. De kan innehålla valfritt antal anpassade egenskaper.

Exempel

Använda anpassad typ för svar

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

Parametrar

Returer

Ersätt objektets definition.

Det finns inget angivet schema för JSON-objekt. De kan innehålla valfritt antal anpassade egenskaper.

Exempel

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

Parametrar

Returer

Ersätt objektets definition.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller mindre egenskaper och det är upp till din logik att framtvinga det.

Det finns inget angivet schema för JSON-objekt. De kan innehålla valfritt antal anpassade egenskaper.

Exempel

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

Parametrar

Returer