Containers class
Opérations de création de nouveaux conteneurs et lecture/interrogation de tous les conteneurs
Consultez conteneur pour la lecture, le remplacement ou la suppression d’un conteneur existant ; utilisez .container(id).
Remarque : toutes ces opérations effectuent des appels sur un budget fixe.
Vous devez concevoir votre système afin que ces appels soient mis à l’échelle sous-linéairement avec votre application.
Par exemple, n’appelez pas containers.readAll() avant chaque appel de item.read() unique, pour vous assurer que le conteneur existe ; effectuez cette opération une fois sur le démarrage de l’application.
Constructeurs
| Containers(Database, Client |
Propriétés
| database |
Méthodes
| create(Container |
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 plus d’é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. |
| create |
Vérifie si un conteneur existe et, si ce n’est pas le cas, il le crée.
Une opération de lecture est effectuée en fonction de l’ID de l' 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 plus d’é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(Sql |
Interroge tous les conteneurs. exemple de Lisez tous les conteneurs dans le tableau.
* |
| query<T>(Sql |
Interroge tous les conteneurs. exemple de Lisez tous les conteneurs dans le tableau.
* |
| read |
Lisez tous les conteneurs. exemple de Lisez tous les conteneurs dans le tableau.
* |
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
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 plus d’é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 page de réponse, les jetons de continuation, etc.
Retours
Promise<ContainerResponse>
createIfNotExists(ContainerRequest, RequestOptions)
Vérifie si un conteneur existe et, si ce n’est pas le cas, il le crée.
Une opération de lecture est effectuée en fonction de l’ID de l'body, puis, si elle est introuvable, une opération de création.
Vous devez confirmer que la sortie correspond au corps que vous avez passé pour les propriétés non par défaut (par exemple, la 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 plus d’é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 page de réponse, les jetons de continuation, etc.
Retours
Promise<ContainerResponse>
query(SqlQuerySpec, FeedOptions)
Interroge tous les conteneurs.
exemple de
Lisez 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 de requête 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 page de réponse, les jetons de continuation, etc.
Retours
QueryIterator<any>
QueryIterator vous permet de retourner des conteneurs spécifiques dans un tableau ou d’effectuer une itération sur eux un par un. *
query<T>(SqlQuerySpec, FeedOptions)
Interroge tous les conteneurs.
exemple de
Lisez 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 de requête 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 page de réponse, les jetons de continuation, etc.
Retours
QueryIterator vous permet de retourner des conteneurs spécifiques dans un tableau ou d’effectuer une itération sur eux un par un. *
readAll(FeedOptions)
Lisez tous les conteneurs.
exemple de
Lisez 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 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 sur eux un par un. *