CosmosClient class

Paquete:

@azure/cosmos

Proporciona una representación lógica del lado cliente de la cuenta de base de datos de Azure Cosmos DB. Este cliente se usa para configurar y ejecutar solicitudes en el servicio de base de datos de Azure Cosmos DB.

Ejemplo

Creación de una instancia de un cliente y creación de una base de datos

const client = new CosmosClient({endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}});
await client.databases.create({id: "<datbase name here>"});

Ejemplo

Creación de una instancia de un cliente con una directiva de conexión personalizada

const connectionPolicy = new ConnectionPolicy();
connectionPolicy.RequestTimeout = 10000;
const client = new CosmosClient({
   endpoint: "<URL HERE>",
   auth: {masterKey: "<KEY HERE>"},
   connectionPolicy
});

Constructores

CosmosClient(CosmosClientOptions)	Crea un nuevo objeto CosmosClient . Consulte CosmosClientOptions para obtener más información sobre las opciones que puede usar.
CosmosClient(string)	Crea un nuevo objeto CosmosClient a partir de un cadena de conexión. La base de datos cadena de conexión se puede encontrar en Azure Portal.

Propiedades

databases	Se usa para crear nuevas bases de datos o consultar o leer todas las bases de datos. Use .database(id) para leer, reemplazar o eliminar una base de datos específica existente por identificador. Ejemplo Creación de una base de datos const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers	Se usa para consultar & leer todas las ofertas. Use .offer(id) para leer o reemplazar las ofertas existentes.

Métodos

database(string)	Se usa para leer, actualizar o eliminar una base de datos existente mediante el identificador o el acceso a contenedores que pertenecen a esa base de datos. Esto no realiza una llamada de red. Use .read para obtener información sobre la base de datos después de obtener el objeto Database . Ejemplo Creación de un nuevo contenedor fuera de una base de datos existente const container = client.database("<database id>").containers.create("<container id>"); Ejemplo Eliminación de una base de datos existente await client.database("<id here>").delete();
dispose()	Borra el actualizador de puntos de conexión en segundo plano. Use client.dispose() al destruir CosmosClient dentro de otro proceso.
getDatabaseAccount(RequestOptions)	Obtenga información sobre databaseAccount actual (incluidas las regiones que se admiten, etc.)
getReadEndpoint()	Obtiene el punto de conexión de lectura usado actualmente. Resulta útil para solucionar problemas. La dirección URL puede contener un sufijo de región (por ejemplo, "-eastus") si usamos puntos de conexión específicos de ubicación.
getReadEndpoints()	Obtiene el punto de conexión de lectura usado actualmente. Resulta útil para solucionar problemas. La dirección URL puede contener un sufijo de región (por ejemplo, "-eastus") si usamos puntos de conexión específicos de ubicación.
getWriteEndpoint()	Obtiene la dirección URL del punto de conexión de escritura usada actualmente. Útil para la solución de problemas. La dirección URL puede contener un sufijo de región (por ejemplo, "-eastus") si se usan puntos de conexión específicos de la ubicación.
getWriteEndpoints()	Obtiene los puntos de conexión de escritura conocidos. Útil para la solución de problemas. Las direcciones URL pueden contener un sufijo de región (por ejemplo, "-eastus") si se usan puntos de conexión específicos de la ubicación.
offer(string)	Se usa para leer o actualizar una oferta existente por identificador.

Detalles del constructor

CosmosClient(CosmosClientOptions)

Crea un nuevo objeto CosmosClient . Consulte CosmosClientOptions para obtener más información sobre las opciones que puede usar.

new CosmosClient(options: CosmosClientOptions)

Parámetros

options

CosmosClientOptions

bolsa de opciones; requerir que se configure al menos el punto de conexión y la autenticación

CosmosClient(string)

Crea un nuevo objeto CosmosClient a partir de un cadena de conexión. La base de datos cadena de conexión se puede encontrar en Azure Portal.

new CosmosClient(connectionString: string)

Parámetros

connectionString

string

Detalles de las propiedades

databases

Se usa para crear nuevas bases de datos o consultar o leer todas las bases de datos.

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

Ejemplo

Creación de una base de datos

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});

databases: Databases

Valor de propiedad

Databases

offers

Se usa para consultar & leer todas las ofertas.

Use .offer(id) para leer o reemplazar las ofertas existentes.

offers: Offers

Valor de propiedad

Offers

Detalles del método

database(string)

Se usa para leer, actualizar o eliminar una base de datos existente mediante el identificador o el acceso a contenedores que pertenecen a esa base de datos.

Esto no realiza una llamada de red. Use .read para obtener información sobre la base de datos después de obtener el objeto Database .

Ejemplo

Creación de un nuevo contenedor fuera de una base de datos existente

const container = client.database("<database id>").containers.create("<container id>");

Ejemplo

Eliminación de una base de datos existente

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

function database(id: string): Database

Parámetros

id

string

Identificador de la base de datos.

Devoluciones

Database

dispose()

Borra el actualizador de puntos de conexión en segundo plano. Use client.dispose() al destruir CosmosClient dentro de otro proceso.

function dispose()

getDatabaseAccount(RequestOptions)

Obtenga información sobre databaseAccount actual (incluidas las regiones que se admiten, etc.)

function getDatabaseAccount(options?: RequestOptions): Promise<ResourceResponse<DatabaseAccount>>

Parámetros

options

RequestOptions

Devoluciones

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Obtiene el punto de conexión de lectura usado actualmente. Resulta útil para solucionar problemas.

La dirección URL puede contener un sufijo de región (por ejemplo, "-eastus") si usamos puntos de conexión específicos de ubicación.

function getReadEndpoint(): Promise<string>

Devoluciones

Promise<string>

getReadEndpoints()

Obtiene el punto de conexión de lectura usado actualmente. Resulta útil para solucionar problemas.

La dirección URL puede contener un sufijo de región (por ejemplo, "-eastus") si usamos puntos de conexión específicos de ubicación.

function getReadEndpoints(): Promise<readonly string[]>

Devoluciones

Promise<readonly string[]>

getWriteEndpoint()

Obtiene la dirección URL del punto de conexión de escritura usada actualmente. Útil para la solución de problemas.

La dirección URL puede contener un sufijo de región (por ejemplo, "-eastus") si se usan puntos de conexión específicos de la ubicación.

function getWriteEndpoint(): Promise<string>

Devoluciones

Promise<string>

getWriteEndpoints()

Obtiene los puntos de conexión de escritura conocidos. Útil para la solución de problemas.

Las direcciones URL pueden contener un sufijo de región (por ejemplo, "-eastus") si se usan puntos de conexión específicos de la ubicación.

function getWriteEndpoints(): Promise<readonly string[]>

Devoluciones

Promise<readonly string[]>

offer(string)

Se usa para leer o actualizar una oferta existente por identificador.

function offer(id: string): Offer

Parámetros

id

string

Identificador de la oferta.

Devoluciones

Offer