Sdílet prostřednictvím

Items class

  • Reference
Balíček:
@azure/cosmos

Operace pro vytváření nových položek a čtení/dotazování všech položek

Viz Položka pro čtení, nahrazení nebo odstranění existujícího kontejneru; použijte .item(id).

Vlastnosti

container

Metody

batch(OperationInput[], PartitionKey, RequestOptions)

Spouštět transakční dávkové operace s položkami.

Batch přebírá pole operací, které se zadává na základě toho, co operace dělá. Služba Batch je transakční a v případě selhání vrátí zpět všechny operace. Možnosti jsou: Vytvořit, Upsertovat, Číst, Nahradit a Odstranit.

Příklad použití:

// 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")
bulk(OperationInput[], BulkOptions, RequestOptions)

Provádět hromadné operace s položkami.

Hromadně přebírá pole operací, které se zapisují na základě toho, co operace dělá. Možnosti jsou: Vytvořit, Upsertovat, Číst, Nahradit a Odstranit.

Příklad použití:

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

Vytvoření iterace ChangeFeedIterator po stránkách změn
changeFeed(PartitionKey, ChangeFeedOptions)

Vytvoření iterace ChangeFeedIterator po stránkách změn

Příklad

Číst od začátku kanálu změn.

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

Vytvoření iterace ChangeFeedIterator po stránkách změn
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Vytvoření iterace ChangeFeedIterator po stránkách změn
create<T>(T, RequestOptions)

Vytvořte položku.

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.

Pro položky JSON neexistuje žádné nastavené schéma. Mohou obsahovat libovolný počet vlastních vlastností.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Vrátí iterátor pro iteraci po stránkách změn. Vrácený iterátor lze použít k načtení změn pro jeden klíč oddílu, rozsah kanálu nebo celý kontejner.
query(string | SqlQuerySpec, FeedOptions)

Dotazuje se na všechny položky.

Příklad

Číst všechny položky do pole.

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)

Dotazuje se na všechny položky.

Příklad

Číst všechny položky do pole.

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)

Číst všechny položky.

Pro položky JSON neexistuje žádné nastavené schéma. Mohou obsahovat libovolný počet vlastních vlastností.

Příklad

Číst všechny položky do pole.

const {body: containerList} = await items.readAll().fetchAll();
readAll<T>(FeedOptions)

Číst všechny položky.

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.

Pro položky JSON neexistuje žádné nastavené schéma. Mohou obsahovat libovolný počet vlastních vlastností.

Příklad

Číst všechny položky do pole.

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

Vytvoření iterace ChangeFeedIterator po stránkách změn
readChangeFeed(PartitionKey, ChangeFeedOptions)

Vytvoření iterace ChangeFeedIterator po stránkách změn

Příklad

Číst od začátku kanálu změn.

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

Vytvoření iterace ChangeFeedIterator po stránkách změn
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Vytvoření iterace ChangeFeedIterator po stránkách změn
upsert(unknown, RequestOptions)

Upsertování položky

Pro položky JSON neexistuje žádné nastavené schéma. Mohou obsahovat libovolný počet vlastních vlastností.
upsert<T>(T, RequestOptions)

Upsertování položky

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.

Pro položky JSON neexistuje žádné nastavené schéma. Mohou obsahovat libovolný počet vlastních vlastností.

Podrobnosti vlastnosti

container 

container: Container

Hodnota vlastnosti

Container

Podrobnosti metody

batch(OperationInput[], PartitionKey, RequestOptions)

Spouštět transakční dávkové operace s položkami.

Batch přebírá pole operací, které se zadává na základě toho, co operace dělá. Služba Batch je transakční a v případě selhání vrátí zpět všechny operace. Možnosti jsou: Vytvořit, Upsertovat, Číst, Nahradit a Odstranit.

Příklad použití:

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

Parametry

operations

OperationInput[]

Seznam operací Limit 100

partitionKey
PartitionKey
options
RequestOptions

Používá se k úpravě požadavku.

Návraty

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Provádět hromadné operace s položkami.

Hromadně přebírá pole operací, které se zapisují na základě toho, co operace dělá. Možnosti jsou: Vytvořit, Upsertovat, Číst, Nahradit a Odstranit.

Příklad použití:

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

Parametry

operations

OperationInput[]

Seznam operací Limit 100

bulkOptions
BulkOptions

Volitelné možnosti objektu pro úpravu hromadného chování. Pokud chcete pokračovat v provádění operací v případě selhání, pass { continueOnError: true} (Výchozí hodnota je false) ** POZNÁMKA: VE VERZI 4.0 SE VE VÝCHOZÍM NASTAVENÍ POUŽIJE HODNOTA TRUE.

options
RequestOptions

Slouží k úpravě požadavku.

Návraty

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Vytvoření iterace ChangeFeedIterator po stránkách změn

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

Parametry

changeFeedOptions
ChangeFeedOptions

Návraty

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Vytvoření iterace ChangeFeedIterator po stránkách změn

Příklad

Číst od začátku kanálu změn.

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>

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Návraty

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Vytvoření iterace ChangeFeedIterator po stránkách změn

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

Parametry

changeFeedOptions
ChangeFeedOptions

Návraty

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Vytvoření iterace ChangeFeedIterator po stránkách změn

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

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Návraty

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Vytvořte položku.

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.

Pro položky JSON neexistuje žádné nastavené schéma. Mohou obsahovat libovolný počet vlastních vlastností.

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

Parametry

body

T

Představuje tělo položky. Může obsahovat libovolný počet uživatelem definovaných vlastností.

options
RequestOptions

Používá se k úpravě požadavku (například k zadání klíče oddílu).

Návraty

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Vrátí iterátor pro iteraci po stránkách změn. Vrácený iterátor lze použít k načtení změn pro jeden klíč oddílu, rozsah kanálu nebo celý kontejner.

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

Parametry

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Návraty

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

Dotazuje se na všechny položky.

Příklad

Číst všechny položky do pole.

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>

Parametry

query

string | SqlQuerySpec

Konfigurace dotazu pro operaci Další informace o konfiguraci dotazu najdete v tématu SqlQuerySpec .

options
FeedOptions

Používá se k úpravě požadavku (například k zadání klíče oddílu).

Návraty

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Dotazuje se na všechny položky.

Příklad

Číst všechny položky do pole.

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>

Parametry

query

string | SqlQuerySpec

Konfigurace dotazu pro operaci Další informace o konfiguraci dotazu najdete v tématu SqlQuerySpec .

options
FeedOptions

Používá se k úpravě požadavku (například k zadání klíče oddílu).

Návraty

QueryIterator<T>

readAll(FeedOptions)

Číst všechny položky.

Pro položky JSON neexistuje žádné nastavené schéma. Mohou obsahovat libovolný počet vlastních vlastností.

Příklad

Číst všechny položky do pole.

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

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

Parametry

options
FeedOptions

Používá se k úpravě požadavku (například k zadání klíče oddílu).

Návraty

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Číst všechny položky.

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.

Pro položky JSON neexistuje žádné nastavené schéma. Mohou obsahovat libovolný počet vlastních vlastností.

Příklad

Číst všechny položky do pole.

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

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

Parametry

options
FeedOptions

Používá se k úpravě požadavku (například k zadání klíče oddílu).

Návraty

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Upozornění

Toto rozhraní API je teď zastaralé.

Use changeFeed instead.

Vytvoření iterace ChangeFeedIterator po stránkách změn

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

Parametry

changeFeedOptions
ChangeFeedOptions

Návraty

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Upozornění

Toto rozhraní API je teď zastaralé.

Use changeFeed instead.

Vytvoření iterace ChangeFeedIterator po stránkách změn

Příklad

Číst od začátku kanálu změn.

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>

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Návraty

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Upozornění

Toto rozhraní API je teď zastaralé.

Use changeFeed instead.

Vytvoření iterace ChangeFeedIterator po stránkách změn

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

Parametry

changeFeedOptions
ChangeFeedOptions

Návraty

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Upozornění

Toto rozhraní API je teď zastaralé.

Use changeFeed instead.

Vytvoření iterace ChangeFeedIterator po stránkách změn

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

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Návraty

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsertování položky

Pro položky JSON neexistuje žádné nastavené schéma. Mohou obsahovat libovolný počet vlastních vlastností.

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

Parametry

body

unknown

Představuje tělo položky. Může obsahovat libovolný počet uživatelem definovaných vlastností.

options
RequestOptions

Používá se k úpravě požadavku (například k zadání klíče oddílu).

Návraty

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsertování položky

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.

Pro položky JSON neexistuje žádné nastavené schéma. Mohou obsahovat libovolný počet vlastních vlastností.

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

Parametry

body

T

Představuje tělo položky. Může obsahovat libovolný počet uživatelem definovaných vlastností.

options
RequestOptions

Používá se k úpravě požadavku (například k zadání klíče oddílu).

Návraty

Promise<ItemResponse<T>>