Container class

Balíček:

@azure/cosmos

Operace čtení, nahrazení nebo odstranění konkrétního existujícího kontejneru podle ID

Viz Kontejnery pro vytváření nových kontejnerů a čtení a dotazování všech kontejnerů; použít .containers.

Poznámka: Všechny tyto operace vyžadují pevné rozpočty. Systém byste měli navrhnout tak, aby tato volání škálovat podlineárně s vaší aplikací. Například nevolejte container(id).read() před každým voláním item.read(), aby se zajistilo, že kontejner existuje; proveďte to jednou při spuštění aplikace.

Vlastnosti

conflicts	Operace pro čtení a dotazování konfliktů pro daný kontejner Ke čtení nebo odstranění určitého konfliktu použijte .conflict(id).
database
id
items	Operace pro vytváření nových položek a čtení a dotazování všech položek Pro čtení, nahrazení nebo odstranění existující položky použijte .item(id). příklad Vytvoření nové položky const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts	Všechny operace pro uložené procedury, triggery a uživatelem definované funkce
url	Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

Metody

conflict(string, PartitionKey)	Používá se ke čtení, nahrazení nebo odstranění konkrétního existujícího Konflikt podle ID. Pomocí .conflicts můžete vytvářet nové konflikty nebo dotazovat nebo číst všechny konflikty.
delete(RequestOptions)	Odstranění kontejneru
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)	Odstranění všech dokumentů patřících do kontejneru pro zadanou hodnotu klíče oddílu
getFeedRanges()
getPartitionKeyDefinition()	Získá nejprve definici klíče oddílu tak, že se podívá do mezipaměti jinak čtením kolekce.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)	Slouží ke čtení, nahrazení nebo odstranění konkrétní položky podle ID. Pomocí .items můžete vytvářet nové položky nebo dotazovat nebo číst všechny položky. příklad Nahrazení položky const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)	Čtení definice kontejneru
readOffer(RequestOptions)	Získá nabídku v kontejneru. Pokud žádný neexistuje, vrátí offerResponse s nedefinovaným.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	Nahrazení definice kontejneru

Podrobnosti vlastnosti

conflicts

Operace pro čtení a dotazování konfliktů pro daný kontejner

Ke čtení nebo odstranění určitého konfliktu použijte .conflict(id).

Conflicts conflicts

Hodnota vlastnosti

Conflicts

database

database: Database

Hodnota vlastnosti

Database

id

id: string

Hodnota vlastnosti

string

items

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

Pro čtení, nahrazení nebo odstranění existující položky použijte .item(id).

příklad

Vytvoření nové položky

const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});

Items items

Hodnota vlastnosti

Items

scripts

Všechny operace pro uložené procedury, triggery a uživatelem definované funkce

Scripts scripts

Hodnota vlastnosti

Scripts

url

Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

string url

Hodnota vlastnosti

string

Podrobnosti metody

conflict(string, PartitionKey)

Používá se ke čtení, nahrazení nebo odstranění konkrétního existujícího Konflikt podle ID.

Pomocí .conflicts můžete vytvářet nové konflikty nebo dotazovat nebo číst všechny konflikty.

function conflict(id: string, partitionKey?: PartitionKey): Conflict

Parametry

id

string

ID konfliktu.

partitionKey

PartitionKey

Návraty

Conflict

delete(RequestOptions)

Odstranění kontejneru

function delete(options?: RequestOptions): Promise<ContainerResponse>

Parametry

options

RequestOptions

Návraty

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Odstranění všech dokumentů patřících do kontejneru pro zadanou hodnotu klíče oddílu

function deleteAllItemsForPartitionKey(partitionKey: PartitionKey, options?: RequestOptions): Promise<ContainerResponse>

Parametry

partitionKey

PartitionKey

Hodnota klíče oddílu položek, které se mají odstranit

options

RequestOptions

Návraty

Promise<ContainerResponse>

getFeedRanges()

function getFeedRanges(): Promise<readonly FeedRange[]>

Návraty

Promise<readonly FeedRange[]>

všechny oblasti informačního kanálu, pro které je možné načíst kanál změn.

getPartitionKeyDefinition()

Upozornění

Toto rozhraní API je teď zastaralé.

This method has been renamed to readPartitionKeyDefinition.

Získá nejprve definici klíče oddílu tak, že se podívá do mezipaměti jinak čtením kolekce.

function getPartitionKeyDefinition(): Promise<ResourceResponse<PartitionKeyDefinition>>

Návraty

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec)

function getQueryPlan(query: string | SqlQuerySpec): Promise<Response_2<PartitionedQueryExecutionInfo>>

Parametry

query

string | SqlQuerySpec

Návraty

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

Slouží ke čtení, nahrazení nebo odstranění konkrétní položky podle ID.

Pomocí .items můžete vytvářet nové položky nebo dotazovat nebo číst všechny položky.

příklad

Nahrazení položky const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});

function item(id: string, partitionKeyValue?: PartitionKey): Item

Parametry

id

string

ID položky.

partitionKeyValue

PartitionKey

Hodnota klíče oddílu Item

Návraty

Item

read(RequestOptions)

Čtení definice kontejneru

function read(options?: RequestOptions): Promise<ContainerResponse>

Parametry

options

RequestOptions

Návraty

Promise<ContainerResponse>

readOffer(RequestOptions)

Získá nabídku v kontejneru. Pokud žádný neexistuje, vrátí offerResponse s nedefinovaným.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

Parametry

options

RequestOptions

Návraty

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions)

function readPartitionKeyRanges(feedOptions?: FeedOptions): QueryIterator<PartitionKeyRange>

Parametry

feedOptions

FeedOptions

Návraty

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

Nahrazení definice kontejneru

function replace(body: ContainerDefinition, options?: RequestOptions): Promise<ContainerResponse>

Parametry

body

ContainerDefinition

options

RequestOptions

Návraty

Promise<ContainerResponse>