Dela via

Items class

Paket:
@azure/cosmos

Åtgärder för att skapa nya objekt och läsa/köra frågor mot alla objekt

Se Objekt för att läsa, ersätta eller ta bort en befintlig behållare. använda sig av .item(id).

Egenskaper

container

Metoder

batch(OperationInput[], PartitionKey, RequestOptions)

Kör transaktionella batchåtgärder på objekt.

Batch tar en matris med åtgärder som skrivs baserat på vad åtgärden gör. Batch är transaktionell och återställer alla åtgärder om ett fel uppstår. Alternativen är: Skapa, Upsert, Läsa, Ersätt och Ta bort

Användningsexempel:

import { CosmosClient, OperationInput } 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" });

// The partitionKey is a required second argument. If it’s undefined, it defaults to the expected partition key format.
const operations: OperationInput[] = [
  {
    operationType: "Create",
    resourceBody: { id: "doc1", name: "sample", key: "A" },
  },
  {
    operationType: "Upsert",
    resourceBody: { id: "doc2", name: "other", key: "A" },
  },
];

await container.items.batch(operations, "A");
bulk(OperationInput[], BulkOptions, RequestOptions)

Köra massåtgärder på objekt.
changeFeed(ChangeFeedOptions)

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar
changeFeed(PartitionKey, ChangeFeedOptions)

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar

Example

Läs från början av ändringsflödet.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
changeFeed<T>(ChangeFeedOptions)

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar
create<T>(T, RequestOptions)

Skapa ett objekt.

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.

Example

Skapa ett objekt.

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

const { resource: createdItem } = await container.items.create({
  id: "<item id>",
  properties: {},
});
executeBulkOperations(OperationInput[], RequestOptions)

Köra massåtgärder på objekt.

Example

import { CosmosClient, OperationInput } 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 operations: OperationInput[] = [
  {
    operationType: "Create",
    resourceBody: { id: "doc1", name: "sample", key: "A" },
  },
  {
    operationType: "Upsert",
    partitionKey: "A",
    resourceBody: { id: "doc2", name: "other", key: "A" },
  },
];

await container.items.executeBulkOperations(operations);
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Returnerar en iterator för att iterera över sidor med ändringar. Iteratorn som returneras kan användas för att hämta ändringar för en enda partitionsnyckel, ett flödesintervall eller en hel container.

Example

import {
  CosmosClient,
  PartitionKeyDefinitionVersion,
  PartitionKeyKind,
  ChangeFeedStartFrom,
} 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 containerDefinition = {
  id: "Test Database",
  partitionKey: {
    paths: ["/name", "/address/zip"],
    version: PartitionKeyDefinitionVersion.V2,
    kind: PartitionKeyKind.MultiHash,
  },
};
const { container } = await database.containers.createIfNotExists(containerDefinition);

const partitionKey = "some-partition-Key-value";
const options = {
  changeFeedStartFrom: ChangeFeedStartFrom.Beginning(partitionKey),
};

const iterator = container.items.getChangeFeedIterator(options);

while (iterator.hasMoreResults) {
  const response = await iterator.readNext();
  // process this response
}
getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Frågar efter alla objekt i en krypterad container.

Example

Läs alla objekt i matrisen.

import { CosmosClient, EncryptionQueryBuilder } 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 queryBuilder = new EncryptionQueryBuilder(
  `SELECT firstname FROM Families f WHERE f.lastName = @lastName`,
);
queryBuilder.addParameter("@lastName", "Hendricks", "/lastname");
const queryIterator = await container.items.getEncryptionQueryIterator(queryBuilder);
const { resources: items } = await queryIterator.fetchAll();
query(string | SqlQuerySpec, FeedOptions)

Kör frågor mot alla objekt.

Example

Läs alla objekt i matrisen.

import { CosmosClient, SqlQuerySpec } 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 querySpec: SqlQuerySpec = {
  query: `SELECT * FROM Families f WHERE f.lastName = @lastName`,
  parameters: [{ name: "@lastName", value: "Hendricks" }],
};
const { resources: items } = await container.items.query(querySpec).fetchAll();
query<T>(string | SqlQuerySpec, FeedOptions)

Kör frågor mot alla objekt.

Example

Läs alla objekt i matrisen.

import { CosmosClient, SqlQuerySpec } 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 querySpec: SqlQuerySpec = {
  query: `SELECT * FROM Families f WHERE f.lastName = @lastName`,
  parameters: [{ name: "@lastName", value: "Hendricks" }],
};
const { resources: items } = await container.items.query(querySpec).fetchAll();
readAll(FeedOptions)

Läs alla objekt.

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

Example

Läs alla objekt i matrisen.

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

const { resources: containerList } = await container.items.readAll().fetchAll();
readAll<T>(FeedOptions)

Läs alla objekt.

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.

Example

Läs alla objekt i matrisen.

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

const { resources: containerList } = await container.items.readAll().fetchAll();
readChangeFeed(ChangeFeedOptions)

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar
readChangeFeed(PartitionKey, ChangeFeedOptions)

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar

Example

Läs från början av ändringsflödet.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
readChangeFeed<T>(ChangeFeedOptions)

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar
upsert(unknown, RequestOptions)

Upsert ett objekt.

Det finns inget angivet schema för JSON-objekt. De kan innehålla valfritt antal anpassade egenskaper.
upsert<T>(T, RequestOptions)

Upsert ett objekt.

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.

Example

Upsert ett objekt.

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

const { resource: createdItem1 } = await container.items.create({
  id: "<item id 1>",
  properties: {},
});

const { resource: upsertItem1 } = await container.items.upsert({
  id: "<item id 1>",
  updated_properties: {},
});

const { resource: upsertItem2 } = await container.items.upsert({
  id: "<item id 2>",
  properties: {},
});

Egenskapsinformation

container 

container: Container

Egenskapsvärde

Container

Metodinformation

batch(OperationInput[], PartitionKey, RequestOptions)

Kör transaktionella batchåtgärder på objekt.

Batch tar en matris med åtgärder som skrivs baserat på vad åtgärden gör. Batch är transaktionell och återställer alla åtgärder om ett fel uppstår. Alternativen är: Skapa, Upsert, Läsa, Ersätt och Ta bort

Användningsexempel:

import { CosmosClient, OperationInput } 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" });

// The partitionKey is a required second argument. If it’s undefined, it defaults to the expected partition key format.
const operations: OperationInput[] = [
  {
    operationType: "Create",
    resourceBody: { id: "doc1", name: "sample", key: "A" },
  },
  {
    operationType: "Upsert",
    resourceBody: { id: "doc2", name: "other", key: "A" },
  },
];

await container.items.batch(operations, "A");

function batch(operations: OperationInput[], partitionKey?: PartitionKey, options?: RequestOptions): Promise<Response<OperationResponse[]>>

Parametrar

operations

OperationInput[]

Lista över åtgärder. Gräns 100

partitionKey
PartitionKey
options
RequestOptions

Används för att ändra begäran

Returer

Promise<Response<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Varning

Det här API:et är nu inaktuellt.

Use executeBulkOperations instead.

Bulk takes an array of Operations which are typed based on what the operation does. The choices are: Create, Upsert, Read, Replace, and Delete

Usage example:

import { CosmosClient, OperationInput } 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" });

// partitionKey is optional at the top level if present in the resourceBody
const operations: OperationInput[] = [
  {
    operationType: "Create",
    resourceBody: { id: "doc1", name: "sample", key: "A" },
  },
  {
    operationType: "Upsert",
    partitionKey: "A",
    resourceBody: { id: "doc2", name: "other", key: "A" },
  },
];

await container.items.bulk(operations);

Köra massåtgärder på objekt.

function bulk(operations: OperationInput[], bulkOptions?: BulkOptions, options?: RequestOptions): Promise<BulkOperationResponse>

Parametrar

operations

OperationInput[]

Lista över åtgärder. Gräns 100

bulkOptions
BulkOptions

Valfritt alternativobjekt för att ändra massbeteende. Skicka { continueOnError: false } för att sluta köra åtgärder när en misslyckas. (Standardvärdet är sant)

options
RequestOptions

Används för att ändra begäran.

Returer

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Varning

Det här API:et är nu inaktuellt.

Use getChangeFeedIterator instead.

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar

function changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parametrar

changeFeedOptions
ChangeFeedOptions

Returer

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Varning

Det här API:et är nu inaktuellt.

Use getChangeFeedIterator instead.

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar

Example

Läs från början av ändringsflödet.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();

function changeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parametrar

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Returer

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Varning

Det här API:et är nu inaktuellt.

Use getChangeFeedIterator instead.

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar

function changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametrar

changeFeedOptions
ChangeFeedOptions

Returer

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Varning

Det här API:et är nu inaktuellt.

Use getChangeFeedIterator instead.

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar

function changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametrar

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Returer

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Skapa ett objekt.

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.

Example

Skapa ett objekt.

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

const { resource: createdItem } = await container.items.create({
  id: "<item id>",
  properties: {},
});

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

Parametrar

body

T

Representerar objektets brödtext. Kan innehålla valfritt antal användardefinierade egenskaper.

options
RequestOptions

Används för att ändra begäran (till exempel genom att ange partitionsnyckeln).

Returer

Promise<ItemResponse<T>>

executeBulkOperations(OperationInput[], RequestOptions)

Köra massåtgärder på objekt.

Example

import { CosmosClient, OperationInput } 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 operations: OperationInput[] = [
  {
    operationType: "Create",
    resourceBody: { id: "doc1", name: "sample", key: "A" },
  },
  {
    operationType: "Upsert",
    partitionKey: "A",
    resourceBody: { id: "doc2", name: "other", key: "A" },
  },
];

await container.items.executeBulkOperations(operations);

function executeBulkOperations(operations: OperationInput[], options?: RequestOptions): Promise<BulkOperationResult[]>

Parametrar

operations

OperationInput[]

Lista över åtgärder

options
RequestOptions

Används för att ändra begäran

Returer

Promise<BulkOperationResult[]>

Lista över operationsresultat som motsvarar operationerna

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Returnerar en iterator för att iterera över sidor med ändringar. Iteratorn som returneras kan användas för att hämta ändringar för en enda partitionsnyckel, ett flödesintervall eller en hel container.

Example

import {
  CosmosClient,
  PartitionKeyDefinitionVersion,
  PartitionKeyKind,
  ChangeFeedStartFrom,
} 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 containerDefinition = {
  id: "Test Database",
  partitionKey: {
    paths: ["/name", "/address/zip"],
    version: PartitionKeyDefinitionVersion.V2,
    kind: PartitionKeyKind.MultiHash,
  },
};
const { container } = await database.containers.createIfNotExists(containerDefinition);

const partitionKey = "some-partition-Key-value";
const options = {
  changeFeedStartFrom: ChangeFeedStartFrom.Beginning(partitionKey),
};

const iterator = container.items.getChangeFeedIterator(options);

while (iterator.hasMoreResults) {
  const response = await iterator.readNext();
  // process this response
}

function getChangeFeedIterator<T>(changeFeedIteratorOptions?: ChangeFeedIteratorOptions): ChangeFeedPullModelIterator<T>

Parametrar

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Returer

ChangeFeedPullModelIterator<T>

getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Frågar efter alla objekt i en krypterad container.

Example

Läs alla objekt i matrisen.

import { CosmosClient, EncryptionQueryBuilder } 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 queryBuilder = new EncryptionQueryBuilder(
  `SELECT firstname FROM Families f WHERE f.lastName = @lastName`,
);
queryBuilder.addParameter("@lastName", "Hendricks", "/lastname");
const queryIterator = await container.items.getEncryptionQueryIterator(queryBuilder);
const { resources: items } = await queryIterator.fetchAll();

function getEncryptionQueryIterator(queryBuilder: EncryptionQueryBuilder, options?: FeedOptions): Promise<QueryIterator<ItemDefinition>>

Parametrar

queryBuilder
EncryptionQueryBuilder

Frågekonfiguration för åtgärden. Se SqlQuerySpec för mer information om hur du skapar en fråga på krypterade egenskaper.

options
FeedOptions

Används för att ändra begäran (till exempel genom att ange partitionsnyckeln).

Returer

Promise<QueryIterator<ItemDefinition>>

query(string | SqlQuerySpec, FeedOptions)

Kör frågor mot alla objekt.

Example

Läs alla objekt i matrisen.

import { CosmosClient, SqlQuerySpec } 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 querySpec: SqlQuerySpec = {
  query: `SELECT * FROM Families f WHERE f.lastName = @lastName`,
  parameters: [{ name: "@lastName", value: "Hendricks" }],
};
const { resources: items } = await container.items.query(querySpec).fetchAll();

function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parametrar

query

string | SqlQuerySpec

Frågekonfiguration för åtgärden. Se SqlQuerySpec för mer information om hur du konfigurerar en fråga.

options
FeedOptions

Används för att ändra begäran (till exempel genom att ange partitionsnyckeln).

Returer

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Kör frågor mot alla objekt.

Example

Läs alla objekt i matrisen.

import { CosmosClient, SqlQuerySpec } 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 querySpec: SqlQuerySpec = {
  query: `SELECT * FROM Families f WHERE f.lastName = @lastName`,
  parameters: [{ name: "@lastName", value: "Hendricks" }],
};
const { resources: items } = await container.items.query(querySpec).fetchAll();

function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Parametrar

query

string | SqlQuerySpec

Frågekonfiguration för åtgärden. Se SqlQuerySpec för mer information om hur du konfigurerar en fråga.

options
FeedOptions

Används för att ändra begäran (till exempel genom att ange partitionsnyckeln).

Returer

QueryIterator<T>

readAll(FeedOptions)

Läs alla objekt.

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

Example

Läs alla objekt i matrisen.

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

const { resources: containerList } = await container.items.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>

Parametrar

options
FeedOptions

Används för att ändra begäran (till exempel genom att ange partitionsnyckeln).

Returer

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Läs alla objekt.

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.

Example

Läs alla objekt i matrisen.

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

const { resources: containerList } = await container.items.readAll().fetchAll();

function readAll<T>(options?: FeedOptions): QueryIterator<T>

Parametrar

options
FeedOptions

Används för att ändra begäran (till exempel genom att ange partitionsnyckeln).

Returer

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Varning

Det här API:et är nu inaktuellt.

Use getChangeFeedIterator instead.

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar

function readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parametrar

changeFeedOptions
ChangeFeedOptions

Returer

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Varning

Det här API:et är nu inaktuellt.

Use getChangeFeedIterator instead.

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar

Example

Läs från början av ändringsflödet.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();

function readChangeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parametrar

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Returer

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Varning

Det här API:et är nu inaktuellt.

Use getChangeFeedIterator instead.

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar

function readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametrar

changeFeedOptions
ChangeFeedOptions

Returer

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Varning

Det här API:et är nu inaktuellt.

Use getChangeFeedIterator instead.

Skapa en ChangeFeedIterator för att iterera över sidor med ändringar

function readChangeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametrar

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Returer

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert ett objekt.

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

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

Parametrar

body

unknown

Representerar objektets brödtext. Kan innehålla valfritt antal användardefinierade egenskaper.

options
RequestOptions

Används för att ändra begäran (till exempel genom att ange partitionsnyckeln).

Returer

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert ett objekt.

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.

Example

Upsert ett objekt.

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

const { resource: createdItem1 } = await container.items.create({
  id: "<item id 1>",
  properties: {},
});

const { resource: upsertItem1 } = await container.items.upsert({
  id: "<item id 1>",
  updated_properties: {},
});

const { resource: upsertItem2 } = await container.items.upsert({
  id: "<item id 2>",
  properties: {},
});

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

Parametrar

body

T

Representerar objektets brödtext. Kan innehålla valfritt antal användardefinierade egenskaper.

options
RequestOptions

Används för att ändra begäran (till exempel genom att ange partitionsnyckeln).

Returer

Promise<ItemResponse<T>>