Items class

  • Referencia
Csomag:
@azure/cosmos

Új elemek létrehozására és az összes elem olvasására/lekérdezésére szolgáló műveletek

A meglévő tárolók olvasásához, cseréjéhez vagy törléséhez lásd: Elem ; használja a következőt .item(id): .

Tulajdonságok

container

Metódusok

batch(OperationInput[], PartitionKey, RequestOptions)

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

A Batch egy művelettömböt használ, amely a művelet működése alapján van begépelve. A Batch tranzakciós, és az összes műveletet visszaállítja, ha az egyik sikertelen. A következő lehetőségek közül választhat: Létrehozás, Frissítés, Olvasás, Csere és Törlés

Példa használati adatokra:

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

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

A Tömeges művelet művelettömböt használ, amely a művelet működése alapján van begépelve. A következő lehetőségek közül választhat: Létrehozás, Frissítés, Olvasás, Csere és Törlés

Példa használati adatokra:

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

Create a ChangeFeedIterator to iterate over pages of changes
changeFeed(PartitionKey, ChangeFeedOptions)

Create a ChangeFeedIterator to iterate over pages of changes

Példa

Olvasson a változáscsatorna elejéről.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
changeFeed<T>(ChangeFeedOptions)

Create a ChangeFeedIterator to iterate over pages of changes
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Create a ChangeFeedIterator to iterate over pages of changes
create<T>(T, RequestOptions)

Hozzon létre egy elemet.

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

A JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

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

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

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

Olvassa el az összes elemet.

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

Olvassa el az összes elemet.

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

A 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();
readChangeFeed(ChangeFeedOptions)

Create a ChangeFeedIterator to iterate over pages of changes
readChangeFeed(PartitionKey, ChangeFeedOptions)

Create a ChangeFeedIterator to iterate over pages of changes

Példa

Olvasson a változáscsatorna elejéről.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
readChangeFeed<T>(ChangeFeedOptions)

Create a ChangeFeedIterator to iterate over pages of changes
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Create a ChangeFeedIterator to iterate over pages of changes
upsert(unknown, RequestOptions)

Elem beszúrása.

A JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.
upsert<T>(T, RequestOptions)

Elem beszúrása.

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

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

Tulajdonság adatai

container 

container: Container

Tulajdonság értéke

Container

Metódus adatai

batch(OperationInput[], PartitionKey, RequestOptions)

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

A Batch egy művelettömböt használ, amely a művelet működése alapján van begépelve. A Batch tranzakciós, és az összes műveletet visszaállítja, ha az egyik sikertelen. A következő lehetőségek közül választhat: Létrehozás, Frissítés, Olvasás, Csere és Törlés

Példa használati adatokra:

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

Paraméterek

operations

OperationInput[]

Műveletek listája. Korlát 100

partitionKey
PartitionKey
options
RequestOptions

A kérelem módosítására szolgál

Válaszok

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

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

A Tömeges művelet művelettömböt használ, amely a művelet működése alapján van begépelve. A következő lehetőségek közül választhat: Létrehozás, Frissítés, Olvasás, Csere és Törlés

Példa használati adatokra:

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

operations

OperationInput[]

Műveletek listája. Korlát 100

bulkOptions
BulkOptions

Választható beállításobjektum a tömeges viselkedés módosításához. A { continueOnError: true } átadásával folytathatja a műveletek végrehajtását, ha az egyik meghibásodik. (Alapértelmezés szerint hamis) ** MEGJEGYZÉS: EZ ALAPÉRTELMEZÉS SZERINT IGAZ LESZ A 4.0-S KIADÁSBAN

options
RequestOptions

A kérelem módosítására szolgál.

Válaszok

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Create a ChangeFeedIterator to iterate over pages of changes

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

Paraméterek

changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Create a ChangeFeedIterator to iterate over pages of changes

Példa

Olvasson a változáscsatorna elejérő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

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Create a ChangeFeedIterator to iterate over pages of changes

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

Paraméterek

changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Create a ChangeFeedIterator to iterate over pages of changes

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

Paraméterek

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Hozzon létre egy elemet.

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

A 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

body

T

Az elem törzsét jelöli. Tetszőleges számú felhasználó által definiált tulajdonságot tartalmazhat.

options
RequestOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

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

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Válaszok

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

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

query

string | SqlQuerySpec

A művelet lekérdezési konfigurációja. A lekérdezés konfigurálásával kapcsolatos további információkért lásd: SqlQuerySpec .

options
FeedOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

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

query

string | SqlQuerySpec

A művelet lekérdezési konfigurációja. A lekérdezés konfigurálásával kapcsolatos további információkért lásd: SqlQuerySpec .

options
FeedOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

QueryIterator<T>

readAll(FeedOptions)

Olvassa el az összes elemet.

A 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

options
FeedOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Olvassa el az összes elemet.

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

A 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

options
FeedOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use changeFeed instead.

Create a ChangeFeedIterator to iterate over pages of changes

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

Paraméterek

changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use changeFeed instead.

Create a ChangeFeedIterator to iterate over pages of changes

Példa

Olvasson a változáscsatorna elejérő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

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use changeFeed instead.

Create a ChangeFeedIterator to iterate over pages of changes

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

Paraméterek

changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Figyelmeztetés

Ez az API már elavult.

Use changeFeed instead.

Create a ChangeFeedIterator to iterate over pages of changes

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

Paraméterek

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Válaszok

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Elem beszúrása.

A 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

body

unknown

Az elem törzsét jelöli. Tetszőleges számú felhasználó által definiált tulajdonságot tartalmazhat.

options
RequestOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Elem beszúrása.

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

A 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

body

T

Az elem törzsét jelöli. Tetszőleges számú felhasználó által definiált tulajdonságot tartalmazhat.

options
RequestOptions

A kérés módosítására szolgál (például a partíciókulcs megadására).

Válaszok

Promise<ItemResponse<T>>