Freigeben über

Items class

Paket:
@azure/cosmos

Vorgänge zum Erstellen neuer Elemente und Lesen/Abfragen aller Elemente

Weitere Informationen finden Sie unter Element zum Lesen, Ersetzen oder Löschen eines vorhandenen Containers. Verwenden Sie .item(id).

Eigenschaften

container

Methoden

batch(OperationInput[], PartitionKey, RequestOptions)

Führen Sie Transaktionsbatchvorgänge für Elemente aus.

Batch verwendet ein Array von Vorgängen, die basierend auf der Funktionsweise des Vorgangs eingegeben werden. Batch ist transaktional und führt einen Rollback aller Vorgänge durch, wenn ein Vorgang fehlschlägt. Die Optionen sind: Erstellen, Upsert, Lesen, Ersetzen und Löschen

Verwendungsbeispiel:

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)

Ausführen von Massenvorgängen für Elemente.
changeFeed(ChangeFeedOptions)

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen
changeFeed(PartitionKey, ChangeFeedOptions)

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

Example

Lesen sie vom Anfang des Änderungsfeeds.

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

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen
create<T>(T, RequestOptions)

Erstellen Sie ein Element.

Jeder bereitgestellte Typ T wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

Example

Erstellen Sie ein Element.

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)

Ausführen von Massenvorgängen für Elemente.

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)

Gibt einen Iterator zurück, um seiten von Änderungen zu durchlaufen. Der zurückgegebene Iterator kann verwendet werden, um Änderungen für einen einzelnen Partitionsschlüssel, Feedbereich oder einen gesamten Container abzurufen.

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)

Fragt alle Elemente in einem verschlüsselten Container ab.

Example

Alle Elemente in Array lesen.

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)

Fragt alle Elemente ab.

Example

Alle Elemente in Array lesen.

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)

Fragt alle Elemente ab.

Example

Alle Elemente in Array lesen.

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)

Alle Elemente lesen.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

Example

Alle Elemente in Array lesen.

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)

Alle Elemente lesen.

Jeder bereitgestellte Typ T wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

Example

Alle Elemente in Array lesen.

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)

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen
readChangeFeed(PartitionKey, ChangeFeedOptions)

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

Example

Lesen sie vom Anfang des Änderungsfeeds.

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

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen
upsert(unknown, RequestOptions)

Upsert ein Element.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.
upsert<T>(T, RequestOptions)

Upsert ein Element.

Jeder bereitgestellte Typ T wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

Example

Upsert ein Element.

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: {},
});

Details zur Eigenschaft

container 

container: Container

Eigenschaftswert

Container

Details zur Methode

batch(OperationInput[], PartitionKey, RequestOptions)

Führen Sie Transaktionsbatchvorgänge für Elemente aus.

Batch verwendet ein Array von Vorgängen, die basierend auf der Funktionsweise des Vorgangs eingegeben werden. Batch ist transaktional und führt einen Rollback aller Vorgänge durch, wenn ein Vorgang fehlschlägt. Die Optionen sind: Erstellen, Upsert, Lesen, Ersetzen und Löschen

Verwendungsbeispiel:

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

Parameter

operations

OperationInput[]

Liste der Vorgänge. Limit 100

partitionKey
PartitionKey
options
RequestOptions

Wird zum Ändern der Anforderung verwendet.

Gibt zurück

Promise<Response<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Warnung

Diese API ist nun veraltet.

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

Ausführen von Massenvorgängen für Elemente.

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

Parameter

operations

OperationInput[]

Liste der Vorgänge. Limit 100

bulkOptions
BulkOptions

Optionales Optionsobjekt zum Ändern des Massenverhaltens. Übergeben Sie {continueOnError: false }, um die Ausführung von Vorgängen zu beenden, wenn ein Fehler auftritt. (Standardwert ist "true"

options
RequestOptions

Wird zum Ändern der Anforderung verwendet.

Gibt zurück

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Warnung

Diese API ist nun veraltet.

Use getChangeFeedIterator instead.

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

changeFeedOptions
ChangeFeedOptions

Gibt zurück

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Warnung

Diese API ist nun veraltet.

Use getChangeFeedIterator instead.

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

Example

Lesen sie vom Anfang des Änderungsfeeds.

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>

Parameter

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Gibt zurück

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Warnung

Diese API ist nun veraltet.

Use getChangeFeedIterator instead.

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

changeFeedOptions
ChangeFeedOptions

Gibt zurück

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Warnung

Diese API ist nun veraltet.

Use getChangeFeedIterator instead.

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Gibt zurück

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Erstellen Sie ein Element.

Jeder bereitgestellte Typ T wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

Example

Erstellen Sie ein Element.

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

Parameter

body

T

Stellt den Textkörper des Elements dar. Kann eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

options
RequestOptions

Wird zum Ändern der Anforderung verwendet (z. B. angeben des Partitionsschlüssels).

Gibt zurück

Promise<ItemResponse<T>>

executeBulkOperations(OperationInput[], RequestOptions)

Ausführen von Massenvorgängen für Elemente.

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

Parameter

operations

OperationInput[]

Liste der Vorgänge

options
RequestOptions

Wird zum Ändern der Anforderung verwendet

Gibt zurück

Promise<BulkOperationResult[]>

Liste der Arbeitsgangergebnisse, die den Arbeitsgängen

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Gibt einen Iterator zurück, um seiten von Änderungen zu durchlaufen. Der zurückgegebene Iterator kann verwendet werden, um Änderungen für einen einzelnen Partitionsschlüssel, Feedbereich oder einen gesamten Container abzurufen.

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>

Parameter

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Gibt zurück

ChangeFeedPullModelIterator<T>

getEncryptionQueryIterator(EncryptionQueryBuilder, FeedOptions)

Fragt alle Elemente in einem verschlüsselten Container ab.

Example

Alle Elemente in Array lesen.

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

Parameter

queryBuilder
EncryptionQueryBuilder

Abfragekonfiguration für den Vorgang. Weitere Informationen zum Erstellen einer Abfrage für verschlüsselte Eigenschaften finden Sie unter SqlQuerySpec .

options
FeedOptions

Wird zum Ändern der Anforderung verwendet (z. B. angeben des Partitionsschlüssels).

Gibt zurück

Promise<QueryIterator<ItemDefinition>>

query(string | SqlQuerySpec, FeedOptions)

Fragt alle Elemente ab.

Example

Alle Elemente in Array lesen.

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>

Parameter

query

string | SqlQuerySpec

Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec .

options
FeedOptions

Wird zum Ändern der Anforderung verwendet (z. B. angeben des Partitionsschlüssels).

Gibt zurück

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Fragt alle Elemente ab.

Example

Alle Elemente in Array lesen.

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>

Parameter

query

string | SqlQuerySpec

Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec .

options
FeedOptions

Wird zum Ändern der Anforderung verwendet (z. B. angeben des Partitionsschlüssels).

Gibt zurück

QueryIterator<T>

readAll(FeedOptions)

Alle Elemente lesen.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

Example

Alle Elemente in Array lesen.

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>

Parameter

options
FeedOptions

Wird zum Ändern der Anforderung verwendet (z. B. angeben des Partitionsschlüssels).

Gibt zurück

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Alle Elemente lesen.

Jeder bereitgestellte Typ T wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

Example

Alle Elemente in Array lesen.

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>

Parameter

options
FeedOptions

Wird zum Ändern der Anforderung verwendet (z. B. angeben des Partitionsschlüssels).

Gibt zurück

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Warnung

Diese API ist nun veraltet.

Use getChangeFeedIterator instead.

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

changeFeedOptions
ChangeFeedOptions

Gibt zurück

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Warnung

Diese API ist nun veraltet.

Use getChangeFeedIterator instead.

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

Example

Lesen sie vom Anfang des Änderungsfeeds.

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>

Parameter

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Gibt zurück

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Warnung

Diese API ist nun veraltet.

Use getChangeFeedIterator instead.

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

changeFeedOptions
ChangeFeedOptions

Gibt zurück

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Warnung

Diese API ist nun veraltet.

Use getChangeFeedIterator instead.

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Gibt zurück

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert ein Element.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

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

Parameter

body

unknown

Stellt den Textkörper des Elements dar. Kann eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

options
RequestOptions

Wird zum Ändern der Anforderung verwendet (z. B. angeben des Partitionsschlüssels).

Gibt zurück

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert ein Element.

Jeder bereitgestellte Typ T wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

Example

Upsert ein Element.

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

Parameter

body

T

Stellt den Textkörper des Elements dar. Kann eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

options
RequestOptions

Wird zum Ändern der Anforderung verwendet (z. B. angeben des Partitionsschlüssels).

Gibt zurück

Promise<ItemResponse<T>>