Containers class

Pakiet:

@azure/cosmos

Operacje tworzenia nowych kontenerów i odczytywania/wykonywania zapytań względem wszystkich kontenerów

Zobacz Kontener do odczytywania, zastępowania lub usuwania istniejącego kontenera; użyj polecenia .container(id).

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 podlinijnie przy użyciu aplikacji. Na przykład nie należy wywoływać containers.readAll() przed każdym wywołaniem item.read() , aby upewnić się, że kontener istnieje. Zrób to raz na uruchomieniu aplikacji.

Konstruktory

Containers(Database, ClientContext)

Właściwości

database

Metody

create(ContainerRequest, RequestOptions)	Tworzy kontener. Kontener jest nazwanym kontenerem logicznym dla elementów. Baza danych może zawierać zero lub więcej nazwanych kontenerów, a każdy kontener składa się z co najmniej zera elementów JSON. Bez schematu elementy w kontenerze nie muszą współużytkować tej samej struktury ani pól. Ponieważ kontenery są zasobami aplikacji, można je autoryzować przy użyciu klucza głównego lub kluczy zasobów.
createIfNotExists(ContainerRequest, RequestOptions)	Sprawdza, czy kontener istnieje, a jeśli nie, tworzy go. Spowoduje to wykonanie operacji odczytu na podstawie identyfikatora w elemecie body, a jeśli nie zostanie znaleziona, operacja tworzenia. Należy potwierdzić, że dane wyjściowe są zgodne z treścią przekazaną dla właściwości innych niż domyślne (np. zasady indeksowania itp.) Kontener jest nazwanym kontenerem logicznym dla elementów. Baza danych może zawierać zero lub więcej nazwanych kontenerów, a każdy kontener składa się z co najmniej zera elementów JSON. Bez schematu elementy w kontenerze nie muszą współużytkować tej samej struktury ani pól. Ponieważ kontenery są zasobami aplikacji, można je autoryzować przy użyciu klucza głównego lub kluczy zasobów.
query(SqlQuerySpec, FeedOptions)	Wykonuje zapytania dotyczące wszystkich kontenerów. Przykład Odczytywanie wszystkich kontenerów do tablicy. * 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)	Wykonuje zapytania dotyczące wszystkich kontenerów. Przykład Odczytywanie wszystkich kontenerów do tablicy. * 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)	Odczytywanie wszystkich kontenerów. Przykład Odczytywanie wszystkich kontenerów do tablicy. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

Szczegóły konstruktora

Containers(Database, ClientContext)

new Containers(database: Database, clientContext: ClientContext)

Parametry

database

Database

clientContext

ClientContext

Szczegóły właściwości

database

database: Database

Wartość właściwości

Database

Szczegóły metody

create(ContainerRequest, RequestOptions)

Tworzy kontener.

Kontener jest nazwanym kontenerem logicznym dla elementów.

Baza danych może zawierać zero lub więcej nazwanych kontenerów, a każdy kontener składa się z co najmniej zera elementów JSON.

Bez schematu elementy w kontenerze nie muszą współużytkować tej samej struktury ani pól.

Ponieważ kontenery są zasobami aplikacji, można je autoryzować przy użyciu klucza głównego lub kluczy zasobów.

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

Parametry

body

ContainerRequest

Reprezentuje treść kontenera.

options

RequestOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

Promise<ContainerResponse>

createIfNotExists(ContainerRequest, RequestOptions)

Sprawdza, czy kontener istnieje, a jeśli nie, tworzy go. Spowoduje to wykonanie operacji odczytu na podstawie identyfikatora w elemecie body, a jeśli nie zostanie znaleziona, operacja tworzenia. Należy potwierdzić, że dane wyjściowe są zgodne z treścią przekazaną dla właściwości innych niż domyślne (np. zasady indeksowania itp.)

Kontener jest nazwanym kontenerem logicznym dla elementów.

Baza danych może zawierać zero lub więcej nazwanych kontenerów, a każdy kontener składa się z co najmniej zera elementów JSON.

Bez schematu elementy w kontenerze nie muszą współużytkować tej samej struktury ani pól.

Ponieważ kontenery są zasobami aplikacji, można je autoryzować przy użyciu klucza głównego lub kluczy zasobów.

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

Parametry

body

ContainerRequest

Reprezentuje treść kontenera.

options

RequestOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

Promise<ContainerResponse>

query(SqlQuerySpec, FeedOptions)

Wykonuje zapytania dotyczące wszystkich kontenerów.

Przykład

Odczytywanie wszystkich kontenerów do tablicy. * 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

Konfiguracja kwerendy dla operacji. Aby uzyskać więcej informacji na temat konfigurowania zapytania, zobacz SqlQuerySpec .

options

FeedOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

QueryIterator<any>

QueryIterator Umożliwia zwrócenie określonych kontenerów w tablicy lub iterowanie ich pojedynczo. *

query<T>(SqlQuerySpec, FeedOptions)

Wykonuje zapytania dotyczące wszystkich kontenerów.

Przykład

Odczytywanie wszystkich kontenerów do tablicy. * 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

Konfiguracja kwerendy dla operacji. Aby uzyskać więcej informacji na temat konfigurowania zapytania, zobacz SqlQuerySpec .

options

FeedOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

QueryIterator<T>

QueryIterator Umożliwia zwrócenie określonych kontenerów w tablicy lub iterowanie ich pojedynczo. *

readAll(FeedOptions)

Odczytywanie wszystkich kontenerów.

Przykład

Odczytywanie wszystkich kontenerów do tablicy. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

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

Parametry

options

FeedOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

QueryIterator<ContainerDefinition & Resource>

QueryIterator Umożliwia zwrócenie wszystkich kontenerów w tablicy lub iterowanie ich pojedynczo. *