Containers class

Csomag:

@azure/cosmos

Új tárolók létrehozására és az összes tároló 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: Tároló; használja a következőt .container(id): .

Megjegyzés: ezek a műveletek rögzített költségvetéssel indítják a hívásokat. Úgy kell megterveznie a rendszert, hogy ezek a hívások az alkalmazással egy vonalban skálázhatók legyenek. Például ne hívjon containers.readAll() minden egyes item.read() hívás előtt, hogy a tároló létezik-e. Ezt egyszer tegye meg az alkalmazás indításakor.

Konstruktorok

Containers(Database, ClientContext)

Tulajdonságok

database

Metódusok

create(ContainerRequest, RequestOptions)	Létrehoz egy tárolót. A tárolók az elemek nevesített logikai tárolói. Az adatbázisok nulla vagy több elnevezett tárolót tartalmazhatnak, és minden tároló nulla vagy több JSON-elemből állhat. Sémamentesség esetén a tároló elemeinek nem kell azonos struktúrát vagy mezőket megosztaniuk. Mivel a tárolók alkalmazáserőforrások, a főkulcs vagy az erőforráskulcsok használatával engedélyezhetők.
createIfNotExists(ContainerRequest, RequestOptions)	Ellenőrzi, hogy létezik-e tároló, és ha nem, létrehozza azt. Ez egy olvasási műveletet fog végrehajtani a azonosító alapján a bodyfájlban, majd ha nem található, hozzon létre egy létrehozási műveletet. Győződjön meg arról, hogy a kimenet megegyezik a nem alapértelmezett tulajdonságok (például indexelési szabályzat/stb.) esetében megadott törzstel. A tárolók az elemek nevesített logikai tárolói. Az adatbázisok nulla vagy több elnevezett tárolót tartalmazhatnak, és minden tároló nulla vagy több JSON-elemből állhat. Sémamentesség esetén a tároló elemeinek nem kell azonos struktúrát vagy mezőket megosztaniuk. Mivel a tárolók alkalmazáserőforrások, a főkulcs vagy az erőforráskulcsok használatával engedélyezhetők.
query(SqlQuerySpec, FeedOptions)	Az összes tárolót lekérdezi. Példa Olvassa be az összes tárolót a tömbbe. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
query<T>(SqlQuerySpec, FeedOptions)	Az összes tárolót lekérdezi. Példa Olvassa be az összes tárolót a tömbbe. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
readAll(FeedOptions)	Olvassa el az összes tárolót. Példa Olvassa be az összes tárolót a tömbbe. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

Konstruktor adatai

Containers(Database, ClientContext)

new Containers(database: Database, clientContext: ClientContext)

Paraméterek

database

Database

clientContext

ClientContext

Tulajdonság adatai

database

database: Database

Tulajdonság értéke

Database

Metódus adatai

create(ContainerRequest, RequestOptions)

Létrehoz egy tárolót.

A tárolók az elemek nevesített logikai tárolói.

Az adatbázisok nulla vagy több elnevezett tárolót tartalmazhatnak, és minden tároló nulla vagy több JSON-elemből állhat.

Sémamentesség esetén a tároló elemeinek nem kell azonos struktúrát vagy mezőket megosztaniuk.

Mivel a tárolók alkalmazáserőforrások, a főkulcs vagy az erőforráskulcsok használatával engedélyezhetők.

function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

Paraméterek

body

ContainerRequest

A tároló törzsét jelöli.

options

RequestOptions

Olyan beállítások beállítására használható, mint a válaszoldal mérete, a folytatási jogkivonatok stb.

Válaszok

Promise<ContainerResponse>

createIfNotExists(ContainerRequest, RequestOptions)

Ellenőrzi, hogy létezik-e tároló, és ha nem, létrehozza azt. Ez egy olvasási műveletet fog végrehajtani a azonosító alapján a bodyfájlban, majd ha nem található, hozzon létre egy létrehozási műveletet. Győződjön meg arról, hogy a kimenet megegyezik a nem alapértelmezett tulajdonságok (például indexelési szabályzat/stb.) esetében megadott törzstel.

A tárolók az elemek nevesített logikai tárolói.

Az adatbázisok nulla vagy több elnevezett tárolót tartalmazhatnak, és minden tároló nulla vagy több JSON-elemből állhat.

Sémamentesség esetén a tároló elemeinek nem kell azonos struktúrát vagy mezőket megosztaniuk.

Mivel a tárolók alkalmazáserőforrások, a főkulcs vagy az erőforráskulcsok használatával engedélyezhetők.

function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

Paraméterek

body

ContainerRequest

A tároló törzsét jelöli.

options

RequestOptions

Olyan beállítások beállítására használható, mint a válaszoldal mérete, a folytatási jogkivonatok stb.

Válaszok

Promise<ContainerResponse>

query(SqlQuerySpec, FeedOptions)

Az összes tárolót lekérdezi.

Példa

Olvassa be az összes tárolót a tömbbe. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Paraméterek

query

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

Olyan beállítások beállítására használható, mint a válaszoldal mérete, a folytatási jogkivonatok stb.

Válaszok

QueryIterator<any>

QueryIterator Lehetővé teszi, hogy adott tárolókat adjon vissza egy tömbben, vagy egyenként iterálja őket. *

query<T>(SqlQuerySpec, FeedOptions)

Az összes tárolót lekérdezi.

Példa

Olvassa be az összes tárolót a tömbbe. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Paraméterek

query

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

Olyan beállítások beállítására használható, mint a válaszoldal mérete, a folytatási jogkivonatok stb.

Válaszok

QueryIterator<T>

QueryIterator Lehetővé teszi, hogy adott tárolókat adjon vissza egy tömbben, vagy egyenként iterálja őket. *

readAll(FeedOptions)

Olvassa el az összes tárolót.

Példa

Olvassa be az összes tárolót a tömbbe. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

function readAll(options?: FeedOptions): QueryIterator<ContainerDefinition & Resource>

Paraméterek

options

FeedOptions

Olyan beállítások beállítására használható, mint a válaszoldal mérete, a folytatási jogkivonatok stb.

Válaszok

QueryIterator<ContainerDefinition & Resource>

QueryIterator Lehetővé teszi, hogy egy tömbben lévő összes tárolót visszaadja, vagy egyenként iterálja át őket. *