CosmosClient class
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.
de ejemplo de
Creación de instancias de un cliente y creación de una base de datos
const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});
de ejemplo de
Creación de instancias de un cliente con una directiva de conexión personalizada
const client = new CosmosClient({
endpoint: "<URL HERE>",
key: "<KEY HERE>",
connectionPolicy: {
requestTimeout: 10000,
},
});
Constructores
Cosmos |
Crea un nuevo objeto CosmosClient. Consulte CosmosClientOptions para obtener más información sobre las opciones que puede usar. |
Cosmos |
Crea un nuevo objeto CosmosClient a partir de una cadena de conexión. La cadena de conexión de la base de datos 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 de ejemplo de Creación de una nueva base de datos
|
offers | Se usa para consultar & leer todas las ofertas. Use |
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 de ejemplo de Creación de un nuevo contenedor fuera de una base de datos existente
de ejemplo de Eliminación de una base de datos existente
|
dispose() | Borra el actualizador de puntos de conexión en segundo plano. Use client.dispose() al destruir CosmosClient dentro de otro proceso. |
get |
Obtenga información sobre el DatabaseAccount actual de (incluidas las regiones admitidas, etc.) |
get |
Obtiene el punto de conexión de lectura usado actualmente. Útil para la solución de 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. |
get |
Obtiene el punto de conexión de lectura usado actualmente. Útil para la solución de 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. |
get |
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 usamos puntos de conexión específicos de ubicación. |
get |
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 usamos puntos de conexión específicos de 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 una cadena de conexión. La cadena de conexión de la base de datos 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.
de ejemplo de
Creación de una nueva base de datos
const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
databases: Databases
Valor de propiedad
offers
Se usa para consultar & leer todas las ofertas.
Use .offer(id)
para leer o reemplazar las ofertas existentes.
offers: Offers
Valor de propiedad
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 de.
de ejemplo de
Creación de un nuevo contenedor fuera de una base de datos existente
const container = client.database("<database id>").containers.create("<container id>");
de ejemplo de
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
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 el DatabaseAccount actual de (incluidas las regiones admitidas, 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. Útil para la solución de 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. Útil para la solución de 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 usamos puntos de conexión específicos de 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 usamos puntos de conexión específicos de 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.