Items class

  • Referens
Paket:
@azure/cosmos

Åtgärder för att skapa nya objekt och läsa/fråga alla objekt

Se Objekt för att läsa, ersätta eller ta bort en befintlig container. använd .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 en misslyckas. Alternativen är: Skapa, Upsert, Läsa, Ersätt och Ta bort

Användningsexempel:

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

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

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();
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 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.
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.
query(string | SqlQuerySpec, FeedOptions)

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();
query<T>(string | SqlQuerySpec, FeedOptions)

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();
readAll(FeedOptions)

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();
readAll<T>(FeedOptions)

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

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

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

Användningsexempel:

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

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

bulk(OperationInput[], BulkOptions, RequestOptions)

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

operations

OperationInput[]

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

bulkOptions
BulkOptions

Valfritt alternativobjekt för att ändra massbeteende. Skicka { continueOnError: true } för att fortsätta köra åtgärder när en misslyckas. (Standardvärdet är falskt) ** OBS! DETTA KOMMER SOM STANDARD ATT VARA SANT I 4.0-VERSIONEN

options
RequestOptions

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

Returer

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

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)

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

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Returer

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

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)

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

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

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.

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

Parametrar

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Returer

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

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

query

string | SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec .

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.

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

query

string | SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec .

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

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

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

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

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Returer

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Varning

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

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

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