Items class

  • Referenz
Paket:
@azure/cosmos

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

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

Eigenschaften

container

Methoden

batch(OperationInput[], PartitionKey, RequestOptions)

Führen Sie transaktionale Batchvorgänge für Elemente aus.

Batch verwendet ein Array von Vorgängen, die basierend auf der Ausführung des Vorgangs typisiert werden. Batch ist transaktional und führt ein Rollback für alle Vorgänge aus, wenn ein Vorgang fehlschlägt. Die Optionen sind: Erstellen, Upsert, Lesen, Ersetzen und Löschen

Verwendungsbeispiel:

// partitionKey is required as a second argument to batch, but defaults to the default partition key
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.batch(operations)
bulk(OperationInput[], BulkOptions, RequestOptions)

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

Bulk verwendet ein Array von Vorgängen, die basierend auf der Ausführung des Vorgangs typisiert werden. Die Optionen sind: Erstellen, Upsert, Lesen, Ersetzen und Löschen

Verwendungsbeispiel:

// 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 database.container.items.bulk(operations)
changeFeed(ChangeFeedOptions)

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

Erstellen eines ChangeFeedIterator zum Durchlaufen von Seiten mit Änderungen

Beispiel

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 eines ChangeFeedIterator zum Durchlaufen von Seiten mit Änderungen
changeFeed<T>(PartitionKey, ChangeFeedOptions)

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

Erstellen Sie ein Element.

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

Es gibt kein festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl benutzerdefinierter Eigenschaften enthalten.
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.
query(string | SqlQuerySpec, FeedOptions)

Fragt alle Elemente ab.

Beispiel

Liest alle Elemente in ein Array.

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query(querySpec).fetchAll();
query<T>(string | SqlQuerySpec, FeedOptions)

Fragt alle Elemente ab.

Beispiel

Liest alle Elemente in ein Array.

const querySpec: SqlQuerySpec = {
  query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query<{firstName: string}>(querySpec).fetchAll();
readAll(FeedOptions)

Alle Elemente lesen.

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

Beispiel

Liest alle Elemente in ein Array.

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

Alle Elemente lesen.

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

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

Beispiel

Liest alle Elemente in ein Array.

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

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

Erstellen eines ChangeFeedIterator zum Durchlaufen von Seiten mit Änderungen

Beispiel

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 eines ChangeFeedIterator zum Durchlaufen von Seiten mit Änderungen
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

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

Upsert für ein Element.

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

Upsert für ein Element.

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

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

Details zur Eigenschaft

container 

container: Container

Eigenschaftswert

Container

Details zur Methode

batch(OperationInput[], PartitionKey, RequestOptions)

Führen Sie transaktionale Batchvorgänge für Elemente aus.

Batch verwendet ein Array von Vorgängen, die basierend auf der Ausführung des Vorgangs typisiert werden. Batch ist transaktional und führt ein Rollback für alle Vorgänge aus, wenn ein Vorgang fehlschlägt. Die Optionen sind: Erstellen, Upsert, Lesen, Ersetzen und Löschen

Verwendungsbeispiel:

// partitionKey is required as a second argument to batch, but defaults to the default partition key
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.batch(operations)

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

Parameter

operations

OperationInput[]

Liste der Vorgänge. Grenzwert 100

partitionKey
PartitionKey
options
RequestOptions

Wird zum Ändern der Anforderung verwendet.

Gibt zurück

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

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

Bulk verwendet ein Array von Vorgängen, die basierend auf der Ausführung des Vorgangs typisiert werden. Die Optionen sind: Erstellen, Upsert, Lesen, Ersetzen und Löschen

Verwendungsbeispiel:

// 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 database.container.items.bulk(operations)

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

Parameter

operations

OperationInput[]

Liste der Vorgänge. Grenzwert 100

bulkOptions
BulkOptions

Optionales Optionsobjekt zum Ändern des Massenverhaltens. Übergeben Sie {continueOnError: true }, um die Ausführung von Vorgängen fortzusetzen, wenn ein Fehler auftritt. (Standardwert: FALSE) ** HINWEIS: DIES WIRD STANDARDMÄßIG AUF TRUE IN DER VERSION 4.0 FESTGELEGT.

options
RequestOptions

Wird zum Ändern der Anforderung verwendet.

Gibt zurück

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Erstellen eines ChangeFeedIterator zum Durchlaufen von Seiten mit Änderungen

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

Parameter

changeFeedOptions
ChangeFeedOptions

Gibt zurück

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Erstellen eines ChangeFeedIterator zum Durchlaufen von Seiten mit Änderungen

Beispiel

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)

Erstellen eines ChangeFeedIterator zum Durchlaufen von Seiten mit Änderungen

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

Parameter

changeFeedOptions
ChangeFeedOptions

Gibt zurück

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Erstellen eines ChangeFeedIterator zum Durchlaufen von Seiten mit Ä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 notwendigerweise vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, dies zu erzwingen.

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

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

Parameter

body

T

Stellt den Text des Elements dar. Kann eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

options
RequestOptions

Wird zum Ändern der Anforderung verwendet (für instance unter Angabe des Partitionsschlüssels).

Gibt zurück

Promise<ItemResponse<T>>

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.

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

Parameter

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Gibt zurück

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

Fragt alle Elemente ab.

Beispiel

Liest alle Elemente in ein Array.

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await 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 (für instance unter Angabe des Partitionsschlüssels).

Gibt zurück

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Fragt alle Elemente ab.

Beispiel

Liest alle Elemente in ein Array.

const querySpec: SqlQuerySpec = {
  query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query<{firstName: string}>(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 (für instance unter Angabe 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 benutzerdefinierter Eigenschaften enthalten.

Beispiel

Liest alle Elemente in ein Array.

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

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

Parameter

options
FeedOptions

Wird zum Ändern der Anforderung verwendet (für instance unter Angabe des Partitionsschlüssels).

Gibt zurück

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Alle Elemente lesen.

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

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

Beispiel

Liest alle Elemente in ein Array.

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

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

Parameter

options
FeedOptions

Wird zum Ändern der Anforderung verwendet (für instance unter Angabe des Partitionsschlüssels).

Gibt zurück

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Warnung

Diese API ist nun veraltet.

Use changeFeed instead.

Erstellen eines ChangeFeedIterator zum Durchlaufen von Seiten mit Ä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 changeFeed instead.

Erstellen eines ChangeFeedIterator zum Durchlaufen von Seiten mit Änderungen

Beispiel

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 changeFeed instead.

Erstellen eines ChangeFeedIterator zum Durchlaufen von Seiten mit Ä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 changeFeed instead.

Erstellen eines ChangeFeedIterator zum Durchlaufen von Seiten mit Änderungen

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

Parameter

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Gibt zurück

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert für ein Element.

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

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

Parameter

body

unknown

Stellt den Text des Elements dar. Kann eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

options
RequestOptions

Wird zum Ändern der Anforderung verwendet (für instance unter Angabe des Partitionsschlüssels).

Gibt zurück

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert für ein Element.

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

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

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

Parameter

body

T

Stellt den Text des Elements dar. Kann eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

options
RequestOptions

Wird zum Ändern der Anforderung verwendet (für instance unter Angabe des Partitionsschlüssels).

Gibt zurück

Promise<ItemResponse<T>>