Partager via


Containers class

Opérations de création de conteneurs et de lecture/interrogation de tous les conteneurs

Consultez Conteneur pour lire, remplacer ou supprimer un conteneur existant. utilisez .container(id).

Remarque : toutes ces opérations effectuent des appels sur un budget fixe. Vous devez concevoir votre système de manière à ce que ces appels soient mis à l’échelle de manière inférieure à celle de votre application. Par exemple, n’appelez containers.readAll() pas avant chaque item.read() appel, pour vous assurer que le conteneur existe ; faites-le une fois au démarrage de l’application.

Constructeurs

Containers(Database, ClientContext)

Propriétés

database

Méthodes

create(ContainerRequest, RequestOptions)

Crée un conteneur.

Un conteneur est un conteneur logique nommé pour les éléments.

Une base de données peut contenir zéro ou plusieurs conteneurs nommés et chaque conteneur se compose de zéro ou plusieurs éléments JSON.

Étant sans schéma, les éléments d’un conteneur n’ont pas besoin de partager la même structure ou les mêmes champs.

Étant donné que les conteneurs sont des ressources d’application, ils peuvent être autorisés à l’aide de la clé principale ou des clés de ressource.

createIfNotExists(ContainerRequest, RequestOptions)

Vérifie si un conteneur existe et, si ce n’est pas le cas, le crée. Cela crée une opération de lecture basée sur l’ID dans , bodypuis, si elle est introuvable, une opération de création. Vous devez vérifier que la sortie correspond au corps que vous avez transmis pour les propriétés autres que celles par défaut (par exemple, stratégie d’indexation/etc.)

Un conteneur est un conteneur logique nommé pour les éléments.

Une base de données peut contenir zéro ou plusieurs conteneurs nommés et chaque conteneur se compose de zéro ou plusieurs éléments JSON.

Étant sans schéma, les éléments d’un conteneur n’ont pas besoin de partager la même structure ou les mêmes champs.

Étant donné que les conteneurs sont des ressources d’application, ils peuvent être autorisés à l’aide de la clé principale ou des clés de ressource.

query(SqlQuerySpec, FeedOptions)

Interroge tous les conteneurs.

Exemple

Lire tous les conteneurs dans le tableau. * 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)

Interroge tous les conteneurs.

Exemple

Lire tous les conteneurs dans le tableau. * 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)

Lire tous les conteneurs.

Exemple

Lire tous les conteneurs dans le tableau. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

Détails du constructeur

Containers(Database, ClientContext)

new Containers(database: Database, clientContext: ClientContext)

Paramètres

database
Database
clientContext

ClientContext

Détails de la propriété

database

database: Database

Valeur de propriété

Détails de la méthode

create(ContainerRequest, RequestOptions)

Crée un conteneur.

Un conteneur est un conteneur logique nommé pour les éléments.

Une base de données peut contenir zéro ou plusieurs conteneurs nommés et chaque conteneur se compose de zéro ou plusieurs éléments JSON.

Étant sans schéma, les éléments d’un conteneur n’ont pas besoin de partager la même structure ou les mêmes champs.

Étant donné que les conteneurs sont des ressources d’application, ils peuvent être autorisés à l’aide de la clé principale ou des clés de ressource.

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

Paramètres

body
ContainerRequest

Représente le corps du conteneur.

options
RequestOptions

Permet de définir des options telles que la taille de la page de réponse, les jetons de continuation, etc.

Retours

createIfNotExists(ContainerRequest, RequestOptions)

Vérifie si un conteneur existe et, si ce n’est pas le cas, le crée. Cela crée une opération de lecture basée sur l’ID dans , bodypuis, si elle est introuvable, une opération de création. Vous devez vérifier que la sortie correspond au corps que vous avez transmis pour les propriétés autres que celles par défaut (par exemple, stratégie d’indexation/etc.)

Un conteneur est un conteneur logique nommé pour les éléments.

Une base de données peut contenir zéro ou plusieurs conteneurs nommés et chaque conteneur se compose de zéro ou plusieurs éléments JSON.

Étant sans schéma, les éléments d’un conteneur n’ont pas besoin de partager la même structure ou les mêmes champs.

Étant donné que les conteneurs sont des ressources d’application, ils peuvent être autorisés à l’aide de la clé principale ou des clés de ressource.

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

Paramètres

body
ContainerRequest

Représente le corps du conteneur.

options
RequestOptions

Permet de définir des options telles que la taille de la page de réponse, les jetons de continuation, etc.

Retours

query(SqlQuerySpec, FeedOptions)

Interroge tous les conteneurs.

Exemple

Lire tous les conteneurs dans le tableau. * 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ètres

query
SqlQuerySpec

Configuration des requêtes pour l’opération. Pour plus d’informations sur la configuration d’une requête, consultez SqlQuerySpec .

options
FeedOptions

Permet de définir des options telles que la taille de la page de réponse, les jetons de continuation, etc.

Retours

QueryIterator Vous permet de retourner des conteneurs spécifiques dans un tableau ou d’itérer les uns après les autres. *

query<T>(SqlQuerySpec, FeedOptions)

Interroge tous les conteneurs.

Exemple

Lire tous les conteneurs dans le tableau. * 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ètres

query
SqlQuerySpec

Configuration des requêtes pour l’opération. Pour plus d’informations sur la configuration d’une requête, consultez SqlQuerySpec .

options
FeedOptions

Permet de définir des options telles que la taille de la page de réponse, les jetons de continuation, etc.

Retours

QueryIterator Vous permet de retourner des conteneurs spécifiques dans un tableau ou d’itérer les uns après les autres. *

readAll(FeedOptions)

Lire tous les conteneurs.

Exemple

Lire tous les conteneurs dans le tableau. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

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

Paramètres

options
FeedOptions

Permet de définir des options telles que la taille de la page de réponse, les jetons de continuation, etc.

Retours

QueryIterator Vous permet de retourner tous les conteneurs d’un tableau ou d’itérer les uns après les autres. *