Database class

Paquete:

@azure/cosmos

Operaciones para leer o eliminar una base de datos existente.

Consulte Bases de datos para crear nuevas bases de datos y leer y consultar todas las bases de datos; use client.databases.

Nota: todas estas operaciones realizan llamadas con un presupuesto fijo. Debe diseñar el sistema de forma que estas llamadas escalen de forma sublineal con la aplicación. Por ejemplo, no llame a database.read() antes de cada item.read() llamada, para asegurarse de que la base de datos existe; hála una vez en el inicio de la aplicación.

Constructores

Database(CosmosClient, string, ClientContext)

Devuelve una nueva instancia de base de datos . Nota: la intención es obtener este objeto de CosmosClient a través client.database(id)de , no crear instancias de él mismo.

Propiedades

client
containers	Se usa para crear nuevos contenedores o consultar o leer todos los contenedores. Use .database(id) para leer, reemplazar o eliminar una base de datos específica existente por identificador. Ejemplo Crear un contenedor nuevo const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url	Devuelve una dirección URL de referencia al recurso. Se usa para vincular en Permisos.
users	Se usa para crear nuevos usuarios o consultar o leer todos los usuarios. Use .user(id) para leer, reemplazar o eliminar un usuario específico existente por identificador.

Métodos

container(string)	Se usa para leer, reemplazar o eliminar una base de datos específica existente por identificador. Use .containers la creación de nuevos contenedores o la consulta o lectura de todos los contenedores. Ejemplo Eliminación de un contenedor await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)	Elimine la base de datos especificada.
read(RequestOptions)	Lea la definición de la base de datos especificada.
readOffer(RequestOptions)	Obtiene la oferta en la base de datos. Si no existe ninguno, devuelve una offerResponse con undefined.
user(string)	Se usa para leer, reemplazar o eliminar un usuario específico existente por identificador. Use .users para crear nuevos usuarios o consultar o leer todos los usuarios.

Detalles del constructor

Database(CosmosClient, string, ClientContext)

Devuelve una nueva instancia de base de datos .

Nota: la intención es obtener este objeto de CosmosClient a través client.database(id)de , no crear instancias de él mismo.

new Database(client: CosmosClient, id: string, clientContext: ClientContext)

Parámetros

client

CosmosClient

id

string

clientContext

ClientContext

Detalles de las propiedades

client

client: CosmosClient

Valor de propiedad

CosmosClient

containers

Se usa para crear nuevos contenedores o consultar o leer todos los contenedores.

Use .database(id) para leer, reemplazar o eliminar una base de datos específica existente por identificador.

Ejemplo

Crear un contenedor nuevo

const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});

containers: Containers

Valor de propiedad

Containers

id

id: string

Valor de propiedad

string

url

Devuelve una dirección URL de referencia al recurso. Se usa para vincular en Permisos.

string url

Valor de propiedad

string

users

Se usa para crear nuevos usuarios o consultar o leer todos los usuarios.

Use .user(id) para leer, reemplazar o eliminar un usuario específico existente por identificador.

users: Users

Valor de propiedad

Users

Detalles del método

container(string)

Se usa para leer, reemplazar o eliminar una base de datos específica existente por identificador.

Use .containers la creación de nuevos contenedores o la consulta o lectura de todos los contenedores.

Ejemplo

Eliminación de un contenedor

await client.database("<db id>").container("<container id>").delete();

function container(id: string): Container

Parámetros

id

string

Devoluciones

Container

delete(RequestOptions)

Elimine la base de datos especificada.

function delete(options?: RequestOptions): Promise<DatabaseResponse>

Parámetros

options

RequestOptions

Devoluciones

Promise<DatabaseResponse>

read(RequestOptions)

Lea la definición de la base de datos especificada.

function read(options?: RequestOptions): Promise<DatabaseResponse>

Parámetros

options

RequestOptions

Devoluciones

Promise<DatabaseResponse>

readOffer(RequestOptions)

Obtiene la oferta en la base de datos. Si no existe ninguno, devuelve una offerResponse con undefined.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

Parámetros

options

RequestOptions

Devoluciones

Promise<OfferResponse>

user(string)

Se usa para leer, reemplazar o eliminar un usuario específico existente por identificador.

Use .users para crear nuevos usuarios o consultar o leer todos los usuarios.

function user(id: string): User

Parámetros

id

string

Devoluciones

User