Sdílet prostřednictvím


Containers class

Operace pro vytváření nových kontejnerů a čtení/dotazování všech kontejnerů

Viz Kontejner pro čtení, nahrazení nebo odstranění existujícího kontejneru. použijte .container(id).

Poznámka: Všechny tyto operace můžou volat pevný rozpočet. Systém byste měli navrhnout tak, aby volaly dílčí měřítko s vaší aplikací. Například nevolejte containers.readAll() 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.

Konstruktory

Containers(Database, ClientContext)

Vlastnosti

database

Metody

create(ContainerRequest, RequestOptions)

Vytvoří kontejner.

Kontejner je pojmenovaný logický kontejner pro položky.

Databáze může obsahovat nula nebo více pojmenovaných kontejnerů a každý kontejner se skládá z nuly nebo více položek JSON.

Položky v kontejneru bez schématu nemusí sdílet stejnou strukturu nebo pole.

Vzhledem k tomu, že kontejnery jsou prostředky aplikace, je možné je autorizovat pomocí hlavního klíče nebo klíčů prostředků.

createIfNotExists(ContainerRequest, RequestOptions)

Zkontroluje, jestli kontejner existuje, a pokud ne, vytvoří ho. Tím se provede operace čtení na základě ID v body, a pokud se nenajde, operace vytvoření. Měli byste ověřit, že výstup odpovídá textu, který jste předali pro nevýchozí vlastnosti (tj. zásady indexování atd.).

Kontejner je pojmenovaný logický kontejner pro položky.

Databáze může obsahovat nula nebo více pojmenovaných kontejnerů a každý kontejner se skládá z nuly nebo více položek JSON.

Položky v kontejneru bez schématu nemusí sdílet stejnou strukturu nebo pole.

Vzhledem k tomu, že kontejnery jsou prostředky aplikace, je možné je autorizovat pomocí hlavního klíče nebo klíčů prostředků.

query(SqlQuerySpec, FeedOptions)

Dotazuje se na všechny kontejnery.

Příklad

Číst všechny kontejnery do pole. * 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)

Dotazuje se na všechny kontejnery.

Příklad

Číst všechny kontejnery do pole. * 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)

Čtení všech kontejnerů

Příklad

Číst všechny kontejnery do pole. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

Podrobnosti konstruktoru

Containers(Database, ClientContext)

new Containers(database: Database, clientContext: ClientContext)

Parametry

database
Database
clientContext

ClientContext

Podrobnosti vlastnosti

database

database: Database

Hodnota vlastnosti

Podrobnosti metody

create(ContainerRequest, RequestOptions)

Vytvoří kontejner.

Kontejner je pojmenovaný logický kontejner pro položky.

Databáze může obsahovat nula nebo více pojmenovaných kontejnerů a každý kontejner se skládá z nuly nebo více položek JSON.

Položky v kontejneru bez schématu nemusí sdílet stejnou strukturu nebo pole.

Vzhledem k tomu, že kontejnery jsou prostředky aplikace, je možné je autorizovat pomocí hlavního klíče nebo klíčů prostředků.

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

Parametry

body
ContainerRequest

Představuje tělo kontejneru.

options
RequestOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, pokračovací tokeny atd.

Návraty

createIfNotExists(ContainerRequest, RequestOptions)

Zkontroluje, jestli kontejner existuje, a pokud ne, vytvoří ho. Tím se provede operace čtení na základě ID v body, a pokud se nenajde, operace vytvoření. Měli byste ověřit, že výstup odpovídá textu, který jste předali pro nevýchozí vlastnosti (tj. zásady indexování atd.).

Kontejner je pojmenovaný logický kontejner pro položky.

Databáze může obsahovat nula nebo více pojmenovaných kontejnerů a každý kontejner se skládá z nuly nebo více položek JSON.

Položky v kontejneru bez schématu nemusí sdílet stejnou strukturu nebo pole.

Vzhledem k tomu, že kontejnery jsou prostředky aplikace, je možné je autorizovat pomocí hlavního klíče nebo klíčů prostředků.

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

Parametry

body
ContainerRequest

Představuje tělo kontejneru.

options
RequestOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, pokračovací tokeny atd.

Návraty

query(SqlQuerySpec, FeedOptions)

Dotazuje se na všechny kontejnery.

Příklad

Číst všechny kontejnery do pole. * 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>

Parametry

query
SqlQuerySpec

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

options
FeedOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, pokračovací tokeny atd.

Návraty

QueryIterator Umožňuje vracet konkrétní kontejnery v poli nebo je postupně iterovat. *

query<T>(SqlQuerySpec, FeedOptions)

Dotazuje se na všechny kontejnery.

Příklad

Číst všechny kontejnery do pole. * 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>

Parametry

query
SqlQuerySpec

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

options
FeedOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, pokračovací tokeny atd.

Návraty

QueryIterator Umožňuje vracet konkrétní kontejnery v poli nebo je postupně iterovat. *

readAll(FeedOptions)

Čtení všech kontejnerů

Příklad

Číst všechny kontejnery do pole. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

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

Parametry

options
FeedOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, pokračovací tokeny atd.

Návraty

QueryIterator Umožňuje vrátit všechny kontejnery v poli nebo je postupně iterovat. *