Items class

container: Container

Egenskapsvärde

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 en misslyckas. Alternativen är: Skapa, Upsert, Läsa, Ersätt och Ta bort

Användningsexempel:

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

Parametrar

Returer

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

Bulk tar en matris med åtgärder som skrivs baserat på vad åtgärden gör. Alternativen är: Skapa, Upsert, Läsa, Ersätt och Ta bort

Användningsexempel:

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

Parametrar

Returer

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

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

Parametrar

Returer

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

Exempel

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

Returer

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

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

Parametrar

Returer

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

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

Parametrar

Returer

Skapa ett objekt.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller färre egenskaper och det är upp till din logik att tillämpa den.

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

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

Parametrar

Returer

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.

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

Parametrar

Returer

Kör frågor mot alla objekt.

Exempel

Läs alla objekt i matrisen.

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>

Parametrar

Returer

Kör frågor mot alla objekt.

Exempel

Läs alla objekt i matrisen.

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>

Parametrar

Returer

Läs alla objekt.

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

Exempel

Läs alla objekt i matrisen.

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

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

Parametrar

Returer

Läs alla objekt.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller färre egenskaper och det är upp till din logik att tillämpa den.

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

Exempel

Läs alla objekt i matrisen.

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

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

Parametrar

Returer

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

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

Parametrar

Returer

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

Exempel

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

Returer

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

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

Parametrar

Returer

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

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

Parametrar

Returer

Upsert ett objekt.

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

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

Parametrar

Returer

Upsert ett objekt.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller färre egenskaper och det är upp till din logik att tillämpa den.

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

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

Parametrar

Returer