Databases class

Paquet:

@azure/cosmos

Opérations de création de bases de données et de lecture/interrogation de toutes les bases de données

Consultez Base de données pour lire ou supprimer une base de données existante . utilisez client.database(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 subligne avec votre application. Par exemple, n’appelez databases.readAll() pas avant chaque item.read() appel, pour vous assurer que la base de données existe ; effectuez cette opération une fois au démarrage de l’application.

Propriétés

client

Méthodes

create(DatabaseRequest, RequestOptions)	Envoyez une demande de création d’une base de données. Une base de données gère les utilisateurs, les autorisations et un ensemble de conteneurs. Chaque compte de base de données Azure Cosmos DB peut prendre en charge plusieurs bases de données nommées indépendantes, la base de données étant le conteneur logique des données. Chaque base de données se compose d’un ou plusieurs conteneurs, chacun contenant à son tour un ou plusieurs documents. Étant donné que les bases de données sont une ressource d’administration, la clé principale de service est requise pour accéder à toute action à l’aide des API utilisateur et y effectuer correctement.
createIfNotExists(DatabaseRequest, RequestOptions)	Vérifiez si une base de données existe et si ce n’est pas le cas, créez-la. Cela permet d’effectuer une opération de lecture basée sur l’ID dans , bodypuis, s’il est introuvable, une opération de création. Une base de données gère les utilisateurs, les autorisations et un ensemble de conteneurs. Chaque compte de base de données Azure Cosmos DB peut prendre en charge plusieurs bases de données nommées indépendantes, la base de données étant le conteneur logique des données. Chaque base de données se compose d’un ou plusieurs conteneurs, chacun contenant à son tour un ou plusieurs documents. Étant donné que les bases de données sont une ressource d’administration, la clé principale de service est requise pour accéder à toute action à l’aide des API utilisateur et la mener à bien.
query(string | SqlQuerySpec, FeedOptions)	Interroge toutes les bases de données. Exemple Lisez toutes les bases de données dans le tableau. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *
query<T>(string | SqlQuerySpec, FeedOptions)	Interroge toutes les bases de données. Exemple Lisez toutes les bases de données dans le tableau. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *
readAll(FeedOptions)	Lit toutes les bases de données. Exemple Lisez toutes les bases de données dans le tableau. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

Détails de la propriété

client

client: CosmosClient

Valeur de propriété

CosmosClient

Détails de la méthode

create(DatabaseRequest, RequestOptions)

Envoyez une demande de création d’une base de données.

Une base de données gère les utilisateurs, les autorisations et un ensemble de conteneurs. Chaque compte de base de données Azure Cosmos DB peut prendre en charge plusieurs bases de données nommées indépendantes, la base de données étant le conteneur logique des données.

Chaque base de données se compose d’un ou plusieurs conteneurs, chacun contenant à son tour un ou plusieurs documents. Étant donné que les bases de données sont une ressource d’administration, la clé principale de service est requise pour accéder à toute action à l’aide des API utilisateur et y effectuer correctement.

function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Paramètres

body

DatabaseRequest

DatabaseDefinition qui représente la base de données à créer.

options

RequestOptions

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

Retours

Promise<DatabaseResponse>

createIfNotExists(DatabaseRequest, RequestOptions)

Vérifiez si une base de données existe et si ce n’est pas le cas, créez-la. Cela permet d’effectuer une opération de lecture basée sur l’ID dans , bodypuis, s’il est introuvable, une opération de création.

Une base de données gère les utilisateurs, les autorisations et un ensemble de conteneurs. Chaque compte de base de données Azure Cosmos DB peut prendre en charge plusieurs bases de données nommées indépendantes, la base de données étant le conteneur logique des données.

Chaque base de données se compose d’un ou plusieurs conteneurs, chacun contenant à son tour un ou plusieurs documents. Étant donné que les bases de données sont une ressource d’administration, la clé principale de service est requise pour accéder à toute action à l’aide des API utilisateur et la mener à bien.

function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Paramètres

body

DatabaseRequest

DatabaseDefinition qui représente la base de données à créer.

options

RequestOptions

Options supplémentaires pour la demande

Retours

Promise<DatabaseResponse>

query(string | SqlQuerySpec, FeedOptions)

Interroge toutes les bases de données.

Exemple

Lisez toutes les bases de données dans le tableau. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Paramètres

query

string | 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 la page de réponse, les jetons de continuation, etc.

Retours

QueryIterator<any>

QueryIterator Vous permet de retourner toutes les bases de données d’un tableau ou d’itérer sur celles-ci une par une. *

query<T>(string | SqlQuerySpec, FeedOptions)

Interroge toutes les bases de données.

Exemple

Lisez toutes les bases de données dans le tableau. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Paramètres

query

string | 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 la page de réponse, les jetons de continuation, etc.

Retours

QueryIterator<T>

QueryIterator Vous permet de retourner toutes les bases de données d’un tableau ou d’itérer sur celles-ci une par une. *

readAll(FeedOptions)

Lit toutes les bases de données.

Exemple

Lisez toutes les bases de données dans le tableau. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & 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<DatabaseDefinition & Resource>

QueryIterator Vous permet de retourner toutes les bases de données d’un tableau ou d’itérer sur celles-ci une par une. *