Container class

Pakiet:

@azure/cosmos

Operacje odczytu, zastępowania lub usuwania określonego istniejącego kontenera według identyfikatora.

Zobacz Containers na potrzeby tworzenia nowych kontenerów i odczytywania/wykonywania zapytań dotyczących wszystkich kontenerów; użyj .containers.

Uwaga: wszystkie te operacje tworzą wywołania względem stałego budżetu. Należy zaprojektować system tak, aby te wywołania były skalowane podlinearnie z aplikacją. Na przykład nie należy wywoływać container(id).read() przed każdym wywołaniem item.read(), aby upewnić się, że kontener istnieje; zrób to raz podczas uruchamiania aplikacji.

Właściwości

conflicts	Operacje odczytu i wykonywania zapytań dotyczących konfliktów dla danego kontenera. Aby odczytać lub usunąć określony konflikt, użyj .conflict(id).
database
id
items	Operacje tworzenia nowych elementów i odczytywania/wykonywania zapytań dotyczących wszystkich elementów Aby odczytywać, zastępować lub usuwać istniejący element, użyj polecenia .item(id). Przykład Tworzenie nowego elementu const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts	Wszystkie operacje dla procedur składowanych, wyzwalaczy i funkcji zdefiniowanych przez użytkownika
url	Zwraca adres URL odwołania do zasobu. Służy do łączenia w obszarze Uprawnienia.

Metody

conflict(string, PartitionKey)	Służy do odczytywania, zastępowania lub usuwania określonego istniejącego Konflikt według identyfikatora. Użyj .conflicts do tworzenia nowych konfliktów lub wykonywania zapytań/odczytywania wszystkich konfliktów.
delete(RequestOptions)	Usuwanie kontenera
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)	Usuń wszystkie dokumenty należą do kontenera dla podanej wartości klucza partycji
getFeedRanges()
getPartitionKeyDefinition()	Najpierw pobiera definicję klucza partycji, przeglądając pamięć podręczną w przeciwnym razie, odczytując kolekcję.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)	Służy do odczytywania, zastępowania lub usuwania określonego istniejącego elementu według identyfikatora. Użyj .items do tworzenia nowych elementów lub wykonywania zapytań/odczytywania wszystkich elementów. Przykład Zastępowanie const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5}); elementu
read(RequestOptions)	Odczytywanie definicji kontenera
readOffer(RequestOptions)	Pobiera ofertę w kontenerze. Jeśli żadna z nich nie istnieje, zwraca element OfferResponse z niezdefiniowanym.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	Zastępowanie definicji kontenera

Szczegóły właściwości

conflicts

Operacje odczytu i wykonywania zapytań dotyczących konfliktów dla danego kontenera.

Aby odczytać lub usunąć określony konflikt, użyj .conflict(id).

Conflicts conflicts

Wartość właściwości

Conflicts

database

database: Database

Wartość właściwości

Database

id

id: string

Wartość właściwości

string

items

Operacje tworzenia nowych elementów i odczytywania/wykonywania zapytań dotyczących wszystkich elementów

Aby odczytywać, zastępować lub usuwać istniejący element, użyj polecenia .item(id).

Przykład

Tworzenie nowego elementu

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

Items items

Wartość właściwości

Items

scripts

Wszystkie operacje dla procedur składowanych, wyzwalaczy i funkcji zdefiniowanych przez użytkownika

Scripts scripts

Wartość właściwości

Scripts

url

Zwraca adres URL odwołania do zasobu. Służy do łączenia w obszarze Uprawnienia.

string url

Wartość właściwości

string

Szczegóły metody

conflict(string, PartitionKey)

Służy do odczytywania, zastępowania lub usuwania określonego istniejącego Konflikt według identyfikatora.

Użyj .conflicts do tworzenia nowych konfliktów lub wykonywania zapytań/odczytywania wszystkich konfliktów.

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

Parametry

id

string

Identyfikator Conflict.

partitionKey

PartitionKey

Zwraca

Conflict

delete(RequestOptions)

Usuwanie kontenera

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

Parametry

options

RequestOptions

Zwraca

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Usuń wszystkie dokumenty należą do kontenera dla podanej wartości klucza partycji

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

Parametry

partitionKey

PartitionKey

Wartość klucza partycji elementów do usunięcia

options

RequestOptions

Zwraca

Promise<ContainerResponse>

getFeedRanges()

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

Zwraca

Promise<readonly FeedRange[]>

wszystkie zakresy kanałów informacyjnych, dla których można pobrać kanał zmian.

getPartitionKeyDefinition()

Ostrzeżenie

Ten interfejs API jest już przestarzały.

This method has been renamed to readPartitionKeyDefinition.

Najpierw pobiera definicję klucza partycji, przeglądając pamięć podręczną w przeciwnym razie, odczytując kolekcję.

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

Zwraca

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec)

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

Parametry

query

string | SqlQuerySpec

Zwraca

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

Służy do odczytywania, zastępowania lub usuwania określonego istniejącego elementu według identyfikatora.

Użyj .items do tworzenia nowych elementów lub wykonywania zapytań/odczytywania wszystkich elementów.

Przykład

Zastępowanie const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5}); elementu

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

Parametry

id

string

Identyfikator elementu .

partitionKeyValue

PartitionKey

Wartość klucza partycji Item

Zwraca

Item

read(RequestOptions)

Odczytywanie definicji kontenera

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

Parametry

options

RequestOptions

Zwraca

Promise<ContainerResponse>

readOffer(RequestOptions)

Pobiera ofertę w kontenerze. Jeśli żadna z nich nie istnieje, zwraca element OfferResponse z niezdefiniowanym.

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

Parametry

options

RequestOptions

Zwraca

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions)

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

Parametry

feedOptions

FeedOptions

Zwraca

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

Zastępowanie definicji kontenera

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

Parametry

body

ContainerDefinition

options

RequestOptions

Zwraca

Promise<ContainerResponse>