Items class

container: Container

Eigenschaftswert

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:

// 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 database.container.items.batch(operations, "A")

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

Parameter

Gibt zurück

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

Bulk akzeptiert ein Array von Vorgängen, die basierend auf der Funktionsweise des Vorgangs eingegeben 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

Gibt zurück

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

Gibt zurück

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Ä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

Gibt zurück

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

Gibt zurück

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

Gibt zurück

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.

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

Parameter

Gibt zurück

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

Gibt zurück

Fragt alle Elemente ab.

Beispiel

Alle Elemente in Array lesen.

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

Gibt zurück

Fragt alle Elemente ab.

Beispiel

Alle Elemente in Array lesen.

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

Gibt zurück

Alle Elemente lesen.

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

Beispiel

Alle Elemente in Array lesen.

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

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

Parameter

Gibt zurück

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.

Beispiel

Alle Elemente in Array lesen.

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

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

Parameter

Gibt zurück

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

Gibt zurück

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Ä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

Gibt zurück

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

Gibt zurück

Erstellen einer ChangeFeedIterator zum Durchlaufen von Seiten von Änderungen

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

Parameter

Gibt zurück

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

Gibt zurück

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.

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

Parameter

Gibt zurück