Ejemplos del SDK de Azure Cosmos DB for NoSQL para JS

  • Artículo

SE APLICA A: NoSQL

En el repositorio de GitHub SDK de JavaScript para Azure Cosmos DB, se incluyen las soluciones de ejemplo que realizan operaciones CRUD y otras operaciones comunes en recursos de Azure Cosmos DB. Este artículo ofrece:

  • Vínculos a las tareas de cada uno de los archivos de proyecto de ejemplo de Node.js.
  • Vínculos al contenido de referencia de la API relacionada.

Requisitos previos

Si no tiene una suscripción a Azure, cree una cuenta gratuita de Azure antes de empezar.

Puede probar gratis Azure Cosmos DB sin una suscripción de Azure, de forma gratuita y sin compromiso. Como alternativa, puede crear una cuenta de nivel gratis de Azure Cosmos DB, con las primeras 1000 RU/s y 25 GB de almacenamiento de forma gratuita. También puede usar el emulador de Azure Cosmos DB con un identificador URI https://localhost:8081. Para obtener la clave que se va a usar con el emulador, consulte Autenticación de solicitudes.

También necesita el SDK de JavaScript.

Nota:

Cada ejemplo es independiente, es decir, se configura a sí mismo y posteriormente se limpia solo. Por tanto, los ejemplos emiten varias llamadas a Containers.create. Cada vez que esto ocurre, se cobra a la suscripción una hora de uso de acuerdo con el nivel de rendimiento del contenedor que se va a crear.

Ejemplos de base de datos

El archivo DatabaseManagement muestra cómo realizar las operaciones CRUD en la base de datos. Para obtener información sobre las bases de datos de Azure Cosmos DB antes de ejecutar los siguientes ejemplos, consulte el artículo conceptual Uso de bases de datos, contenedores y elementos.

Tarea Referencia de API
Crear una base de datos si no existe Databases.createIfNotExists
Enumeración de las bases de datos de una cuenta Databases.readAll
Lectura de una base de datos por identificador Database.read
Eliminación de una base de datos Database.delete

Ejemplos de contenedor

El archivo ContainerManagement muestra cómo realizar las operaciones CRUD en el contenedor. Para información sobre las colecciones de Azure Cosmos DB antes de ejecutar los siguientes ejemplos, consulte el artículo conceptual Uso de bases de datos, contenedores y elementos.

Tarea Referencia de API
Crear un contenedor si no existe Containers.createIfNotExists
Enumeración de contenedores de una cuenta Containers.readAll
Lectura del rendimiento de un contenedor Container.read
Eliminación de un contenedor Container.delete

Ejemplos de elementos

El archivo ItemManagement muestra cómo realizar las operaciones CRUD en el elemento. Para información sobre los documentos de Azure Cosmos DB antes de ejecutar los ejemplos siguientes, consulte el artículo conceptual Uso de bases de datos, contenedores y elementos.

Tarea Referencia de API
Creación de elementos Items.create
Lectura de todos los elementos de un contenedor Items.readAll
Lectura de un elemento por identificador Item.read
Lectura de un elemento solo si el elemento ha cambiado Item.read - RequestOptions.accessCondition
Consulta de documentos Items.query
Reemplazo de un elemento Item.replace
Reemplazo de un artículo con la comprobación de ETag condicional Item.replace - RequestOptions.accessCondition
Eliminación de un elemento Item.delete

Ejemplos de indización

El archivo IndexManagement muestra cómo administrar la indexación. Para información sobre la indexación en Azure Cosmos DB antes de ejecutar los ejemplos siguientes, consulte los artículos conceptuales sobre las directivas de indexación, los tipos de indexación y las rutas de acceso de indexación.

Tarea Referencia de API
Indexación manual de un elemento determinado RequestOptions.indexingDirective: 'include'
Exclusión manual de un elemento determinado del índice RequestOptions.indexingDirective: 'exclude'
Exclusión de una ruta de acceso del índice IndexingPolicy.ExcludedPath
Crear un índice de intervalo en una ruta de acceso de cadena IndexKind.Range, IndexingPolicy, Items.query
Crear un contenedor con el valor de indexPolicy predeterminado y, luego, actualizar el contenedor en línea Containers.create

Ejemplos de programación en el servidor

El archivo index.ts muestra cómo realizar las siguientes tareas. Para información sobre la programación del lado servidor en Azure Cosmos DB antes de ejecutar los ejemplos siguientes, consulte el artículo conceptual Procedimientos almacenados, desencadenadores y funciones definidas por el usuario.

Tarea Referencia de API
Creación de un procedimiento almacenado StoredProcedures.create
Ejecución de un procedimiento almacenado StoredProcedure.execute
Actualización masiva con procedimiento almacenado StoredProcedure.execute

Para más información sobre la programación en el servidor, consulte Programación en el servidor de Azure Cosmos DB: procedimientos almacenados, desencadenadores de base de datos y UDF.

Ejemplos de autenticación con Azure Identity (AAD)

El archivo AADAuth.ts muestra cómo realizar las siguientes tareas.

Tarea Referencia de API
Create credential object from @azure/identity API
Paso de credenciales al objeto de cliente con aadCredentials de clave API
Ejecución de un cliente de Cosmos con credenciales de aad API

Ejemplos varios

Los siguiente ejemplos seleccionados muestran escenarios comunes.

Tarea Referencia de API
Modificación del rendimiento de las consultas API
Obtención del rendimiento de las consultas API
Uso de tokens de SAS para conceder acceso con ámbito a los recursos de Cosmos DB API

Pasos siguientes

¿Intenta planear la capacidad de una migración a Azure Cosmos DB? Para ello, puede usar información sobre el clúster de bases de datos existente.