Container class

  • Reference
Balíček:
@azure/cosmos

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

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

Poznámka: Všechny tyto operace můžou provádět volání do pevného rozpočtu. Systém byste měli navrhnout tak, aby volaly dílčí měřítko s vaší aplikací. Například nevolejte container(id).read() před každým jedním item.read() voláním, aby se zajistilo, že kontejner existuje. To udělejte jednou při spuštění aplikace.

Vlastnosti

conflicts

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

Ke čtení nebo odstranění konkrétního konfliktu použijte .conflict(id).
database
id
items

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

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

Příklad

Vytvořit novou položku

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í referenční adresu URL prostředku. Používá se pro propojení v oprávněních.

Metody

conflict(string, PartitionKey)

Slouží ke čtení, nahrazení nebo odstranění konkrétního existujícího konfliktu podle ID.

Slouží .conflicts k vytváření nových konfliktů nebo dotazování/čtení všech konfliktů.
delete(RequestOptions)

Odstranění kontejneru
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Odstranit všechny dokumenty, které patří do kontejneru pro zadanou hodnotu klíče oddílu
getFeedRanges()
getPartitionKeyDefinition()

Získá definici klíče oddílu nejprve tak, že se podíváte do mezipaměti, jinak čtením kolekce.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)

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

Slouží .items k vytváření nových položek nebo dotazování/čtení všech položek.

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)

Přečtení definice kontejneru
readOffer(RequestOptions)

Získá nabídku pro kontejner. Pokud žádná neexistuje, vrátí Hodnotu OfferResponse s undefined.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)

Nahrazení definice kontejneru

Podrobnosti vlastnosti

conflicts

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

Ke čtení nebo odstranění konkrétní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í/dotazování všech položek

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

Příklad

Vytvořit novou položku

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í referenční adresu URL prostředku. Používá se pro propojení v oprávněních.

string url

Hodnota vlastnosti

string

Podrobnosti metody

conflict(string, PartitionKey)

Slouží ke čtení, nahrazení nebo odstranění konkrétního existujícího konfliktu podle ID.

Slouží .conflicts k vytváření nových konfliktů nebo dotazování/čtení všech konfliktů.

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)

Odstranit všechny dokumenty, které patří 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 podávání, pro které bylo 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á definici klíče oddílu nejprve tak, že se podíváte 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í existující položky podle ID.

Slouží .items k vytváření nových položek nebo dotazování/čtení všech položek.

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 položky

Návraty

Item

read(RequestOptions)

Přečtení definice kontejneru

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

Parametry

options
RequestOptions

Návraty

Promise<ContainerResponse>

readOffer(RequestOptions)

Získá nabídku pro kontejner. Pokud žádná neexistuje, vrátí Hodnotu OfferResponse s undefined.

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>