Containers class

Paket:

@azure/cosmos

Vorgänge zum Erstellen neuer Container und Lesen/Abfragen aller Container

Siehe Container- zum Lesen, Ersetzen oder Löschen eines vorhandenen Containers; verwenden Sie .container(id).

Hinweis: Alle diese Vorgänge führen Aufrufe für ein festes Budget aus. Sie sollten Ihr System so entwerfen, dass diese Aufrufe mit Ihrer Anwendung sublinear skaliert werden. Rufen Sie z. B. vor jedem einzelnen item.read() Aufruf nicht containers.readAll() auf, um sicherzustellen, dass der Container vorhanden ist; Führen Sie dies einmal beim Starten der Anwendung aus.

Konstruktoren

Containers(Database, ClientContext)

Eigenschaften

database

Methoden

create(ContainerRequest, RequestOptions)	Erstellt einen Container. Ein Container ist ein benannter logischer Container für Elemente. Eine Datenbank kann null oder mehr benannte Container enthalten, und jeder Container besteht aus null oder mehr JSON-Elementen. Wenn sie schemafrei sind, müssen die Elemente in einem Container nicht dieselbe Struktur oder felder gemeinsam verwenden. Da Container Anwendungsressourcen sind, können sie entweder mithilfe des Hauptschlüssels oder der Ressourcenschlüssel autorisiert werden.
createIfNotExists(ContainerRequest, RequestOptions)	Überprüft, ob ein Container vorhanden ist, und erstellt ihn, wenn er nicht. Dadurch wird ein Lesevorgang basierend auf der ID im bodyerstellt, und wenn er nicht gefunden wird, wird ein Erstellungsvorgang ausgeführt. Sie sollten bestätigen, dass die Ausgabe dem Text entspricht, den Sie für nicht standardmäßige Eigenschaften übergeben haben (z. B. Indizierungsrichtlinie/usw.) Ein Container ist ein benannter logischer Container für Elemente. Eine Datenbank kann null oder mehr benannte Container enthalten, und jeder Container besteht aus null oder mehr JSON-Elementen. Wenn sie schemafrei sind, müssen die Elemente in einem Container nicht dieselbe Struktur oder felder gemeinsam verwenden. Da Container Anwendungsressourcen sind, können sie entweder mithilfe des Hauptschlüssels oder der Ressourcenschlüssel autorisiert werden.
query(SqlQuerySpec, FeedOptions)	Fragt alle Container ab. Beispiel Alle Container in Array lesen. * 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)	Fragt alle Container ab. Beispiel Alle Container in Array lesen. * 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)	Alle Container lesen. Beispiel Alle Container in Array lesen. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

Details zum Konstruktor

Containers(Database, ClientContext)

new Containers(database: Database, clientContext: ClientContext)

Parameter

database

Database

clientContext

ClientContext

Details zur Eigenschaft

database

database: Database

Eigenschaftswert

Database

Details zur Methode

create(ContainerRequest, RequestOptions)

Erstellt einen Container.

Ein Container ist ein benannter logischer Container für Elemente.

Eine Datenbank kann null oder mehr benannte Container enthalten, und jeder Container besteht aus null oder mehr JSON-Elementen.

Wenn sie schemafrei sind, müssen die Elemente in einem Container nicht dieselbe Struktur oder felder gemeinsam verwenden.

Da Container Anwendungsressourcen sind, können sie entweder mithilfe des Hauptschlüssels oder der Ressourcenschlüssel autorisiert werden.

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

Parameter

body

ContainerRequest

Stellt den Textkörper des Containers dar.

options

RequestOptions

Wird verwendet, um Optionen wie Antwortseitengröße, Fortsetzungstoken usw. festzulegen.

Gibt zurück

Promise<ContainerResponse>

createIfNotExists(ContainerRequest, RequestOptions)

Überprüft, ob ein Container vorhanden ist, und erstellt ihn, wenn er nicht. Dadurch wird ein Lesevorgang basierend auf der ID im bodyerstellt, und wenn er nicht gefunden wird, wird ein Erstellungsvorgang ausgeführt. Sie sollten bestätigen, dass die Ausgabe dem Text entspricht, den Sie für nicht standardmäßige Eigenschaften übergeben haben (z. B. Indizierungsrichtlinie/usw.)

Ein Container ist ein benannter logischer Container für Elemente.

Eine Datenbank kann null oder mehr benannte Container enthalten, und jeder Container besteht aus null oder mehr JSON-Elementen.

Wenn sie schemafrei sind, müssen die Elemente in einem Container nicht dieselbe Struktur oder felder gemeinsam verwenden.

Da Container Anwendungsressourcen sind, können sie entweder mithilfe des Hauptschlüssels oder der Ressourcenschlüssel autorisiert werden.

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

Parameter

body

ContainerRequest

Stellt den Textkörper des Containers dar.

options

RequestOptions

Wird verwendet, um Optionen wie Antwortseitengröße, Fortsetzungstoken usw. festzulegen.

Gibt zurück

Promise<ContainerResponse>

query(SqlQuerySpec, FeedOptions)

Fragt alle Container ab.

Beispiel

Alle Container in Array lesen. * 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>

Parameter

query

SqlQuerySpec

Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.

options

FeedOptions

Wird verwendet, um Optionen wie Antwortseitengröße, Fortsetzungstoken usw. festzulegen.

Gibt zurück

QueryIterator<any>

QueryIterator Ermöglicht es Ihnen, bestimmte Container in einem Array zurückzugeben oder jeweils einzeln zu durchlaufen. *

query<T>(SqlQuerySpec, FeedOptions)

Fragt alle Container ab.

Beispiel

Alle Container in Array lesen. * 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>

Parameter

query

SqlQuerySpec

Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.

options

FeedOptions

Wird verwendet, um Optionen wie Antwortseitengröße, Fortsetzungstoken usw. festzulegen.

Gibt zurück

QueryIterator<T>

QueryIterator Ermöglicht es Ihnen, bestimmte Container in einem Array zurückzugeben oder jeweils einzeln zu durchlaufen. *

readAll(FeedOptions)

Alle Container lesen.

Beispiel

Alle Container in Array lesen. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

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

Parameter

options

FeedOptions

Wird verwendet, um Optionen wie Antwortseitengröße, Fortsetzungstoken usw. festzulegen.

Gibt zurück

QueryIterator<ContainerDefinition & Resource>

QueryIterator- Ermöglicht es Ihnen, alle Container in einem Array zurückzugeben oder jeweils einzeln zu durchlaufen. *