Items class

container: Container

Tulajdonság értéke

Tranzakciós kötegműveletek végrehajtása elemeken.

A Batch egy művelettömböt vesz fel, amely a művelet működése alapján van begépelve. A Batch tranzakciós, és minden műveletet visszaállít, ha az egyik sikertelen. A lehetőségek a következők: Létrehozás, Felolvasás, Olvasás, Csere és Törlés

Használati példa:

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

Paraméterek

Válaszok

Tömeges műveletek végrehajtása elemeken.

A Tömeges művelet a művelet végrehajtása alapján beírt műveletek tömbje. A lehetőségek a következők: Létrehozás, Felolvasás, Olvasás, Csere és Törlés

Használati példa:

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

Paraméterek

Válaszok

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

Válaszok

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

példa

Olvasás a változáscsatorna elejétől.

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>

Paraméterek

Válaszok

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

Válaszok

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

Válaszok

Hozzon létre egy elemet.

A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

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

Paraméterek

Válaszok

Egy iterátort ad vissza a módosítások oldalainak iterálásához. A visszaadott iterátor egy partíciókulcs, adatcsatornatartomány vagy egy teljes tároló módosításainak beolvasására használható.

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

Paraméterek

Válaszok

Az összes elemet lekérdezi.

példa

Olvassa el az összes elemet a tömbben.

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>

Paraméterek

Válaszok

Az összes elemet lekérdezi.

példa

Olvassa el az összes elemet a tömbben.

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>

Paraméterek

Válaszok

Olvassa el az összes elemet.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

példa

Olvassa el az összes elemet a tömbben.

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

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

Paraméterek

Válaszok

Olvassa el az összes elemet.

A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

példa

Olvassa el az összes elemet a tömbben.

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

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

Paraméterek

Válaszok

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

Válaszok

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

példa

Olvasás a változáscsatorna elejétől.

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>

Paraméterek

Válaszok

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

Válaszok

ChangeFeedIterator létrehozása a módosítások oldalainak iterálásához

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

Paraméterek

Válaszok

Elem beszúrása.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

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

Paraméterek

Válaszok

Elem beszúrása.

A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

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

Paraméterek

Válaszok