Condividi tramite

Item class

  • Riferimento
Pacchetto:
@azure/cosmos

Utilizzato per eseguire operazioni su un elemento specifico.

Vedere elementi per le operazioni su tutti gli elementi; vedere container.items.

Proprietà

container
id
url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

Metodi

delete<T>(RequestOptions)

Eliminare l'elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

esempio di

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)

Eseguire un jsonPatch sull'elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

esempio di

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)

Leggere la definizione dell'elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica. Se il tipo, T, è una classe , non passerà typeof confronti, perché non avrà un prototipo di corrispondenza. È consigliabile usare solo le interfacce.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

esempio di

Uso del tipo personalizzato per la risposta

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)

Sostituire la definizione dell'elemento.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

esempio di

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)

Sostituire la definizione dell'elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

esempio di

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

Dettagli proprietà

container 

container: Container

Valore della proprietà

Container

id 

id: string

Valore della proprietà

string

url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

string url

Valore della proprietà

string

Dettagli metodo

delete<T>(RequestOptions)

Eliminare l'elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

esempio di

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

Parametri

options
RequestOptions

Opzioni aggiuntive per la richiesta

Restituisce

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Eseguire un jsonPatch sull'elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

esempio di

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

Parametri

body
PatchRequestBody
options
RequestOptions

Opzioni aggiuntive per la richiesta

Restituisce

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Leggere la definizione dell'elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica. Se il tipo, T, è una classe , non passerà typeof confronti, perché non avrà un prototipo di corrispondenza. È consigliabile usare solo le interfacce.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

esempio di

Uso del tipo personalizzato per la risposta

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

Parametri

options
RequestOptions

Opzioni aggiuntive per la richiesta

Restituisce

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Sostituire la definizione dell'elemento.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

esempio di

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

Parametri

body
ItemDefinition

Definizione con cui sostituire la definizione dell'elemento esistente.

options
RequestOptions

Opzioni aggiuntive per la richiesta

Restituisce

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Sostituire la definizione dell'elemento.

Qualsiasi tipo specificato, T, non viene necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è necessario applicare la logica.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

esempio di

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

Parametri

body

T

Definizione con cui sostituire la definizione dell'elemento esistente.

options
RequestOptions

Opzioni aggiuntive per la richiesta

Restituisce

Promise<ItemResponse<T>>