Freigeben über


Containers class

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

Informationen zum Lesen, Ersetzen oder Löschen eines vorhandenen Containers finden Sie unter Container . Verwenden Sie .container(id).

Hinweis: Alle diese Vorgänge führen Aufrufe mit einem festen Budget aus. Sie sollten Ihr System so entwerfen, dass diese Aufrufe sublinear mit Ihrer Anwendung skaliert werden. Rufen containers.readAll() Sie beispielsweise nicht vor jedem einzelnen item.read() Aufruf auf, um sicherzustellen, dass der Container vorhanden ist. Führen Sie dies einmal beim Anwendungsstart 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 0 oder mehr JSON-Elementen.

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

Da Es sich bei Containern um Anwendungsressourcen handelt, können sie entweder mit dem Hauptschlüssel oder mit Ressourcenschlüsseln autorisiert werden.

createIfNotExists(ContainerRequest, RequestOptions)

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

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

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

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

Da Es sich bei Containern um Anwendungsressourcen handelt, können sie entweder mit dem Hauptschlüssel oder mit Ressourcenschlüsseln autorisiert werden.

query(SqlQuerySpec, FeedOptions)

Fragt alle Container ab.

Beispiel

Lesen aller Container in ein Array. * 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

Lesen aller Container in ein Array. * 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

Lesen aller Container in ein Array. * 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

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 0 oder mehr JSON-Elementen.

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

Da Es sich bei Containern um Anwendungsressourcen handelt, können sie entweder mit dem Hauptschlüssel oder mit Ressourcenschlüsseln autorisiert werden.

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

Parameter

body
ContainerRequest

Stellt den Text des Containers dar.

options
RequestOptions

Verwenden Sie , um Optionen wie Die Größe der Antwortseite, Fortsetzungstoken usw. festzulegen.

Gibt zurück

createIfNotExists(ContainerRequest, RequestOptions)

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

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

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

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

Da Es sich bei Containern um Anwendungsressourcen handelt, können sie entweder mit dem Hauptschlüssel oder mit Ressourcenschlüsseln autorisiert werden.

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

Parameter

body
ContainerRequest

Stellt den Text des Containers dar.

options
RequestOptions

Verwenden Sie , um Optionen wie Die Größe der Antwortseite, Fortsetzungstoken usw. festzulegen.

Gibt zurück

query(SqlQuerySpec, FeedOptions)

Fragt alle Container ab.

Beispiel

Lesen aller Container in ein Array. * 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

Verwenden Sie , um Optionen wie Die Größe der Antwortseite, Fortsetzungstoken usw. festzulegen.

Gibt zurück

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

query<T>(SqlQuerySpec, FeedOptions)

Fragt alle Container ab.

Beispiel

Lesen aller Container in ein Array. * 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

Verwenden Sie , um Optionen wie Die Größe der Antwortseite, Fortsetzungstoken usw. festzulegen.

Gibt zurück

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

readAll(FeedOptions)

Alle Container lesen.

Beispiel

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

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

Parameter

options
FeedOptions

Verwenden Sie , um Optionen wie Die Größe der Antwortseite, Fortsetzungstoken usw. festzulegen.

Gibt zurück

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