Ejemplos de Node.js para administrar datos en Azure Cosmos DBNode.js examples to manage data in Azure Cosmos DB

SE APLICA A: SQL API

En el repositorio de GitHub azure-cosmos-js se incluyen soluciones de ejemplo que realizan operaciones CRUD y otras operaciones comunes en recursos de Azure Cosmos DB.Sample solutions that perform CRUD operations and other common operations on Azure Cosmos DB resources are included in the azure-cosmos-js GitHub repository. Este artículo ofrece:This article provides:

  • Vínculos a las tareas de cada uno de los archivos de proyecto de ejemplo de Node.js.Links to the tasks in each of the Node.js example project files.
  • Vínculos al contenido de referencia de la API relacionada.Links to the related API reference content.

Requisitos previosPrerequisites

Si no tiene una suscripción a Azure, cree una cuenta gratuita antes de empezar.If you don't have an Azure subscription, create a free account before you begin.

Puede probar Azure Cosmos DB de forma gratuita sin necesidad de una suscripción de Azure y sin compromisos, o bien crear una cuenta de nivel Gratis de Azure Cosmos DB, con los primeros 400 RU/s y 5 GB de almacenamiento totalmente gratis.You can Try Azure Cosmos DB for free without an Azure subscription, free of charge and commitments, or create an Azure Cosmos DB free tier account, with the first 400 RU/s and 5 GB of storage for free. También puede usar el emulador de Azure Cosmos DB con un identificador URI https://localhost:8081.You can also use the Azure Cosmos DB Emulator with a URI of https://localhost:8081. Para obtener la clave que se va a usar con el emulador, consulte Autenticación de solicitudes.For the key to use with the emulator, see Authenticating requests.

También necesita el SDK de JavaScript.You also need the JavaScript SDK.

Nota

Cada ejemplo es independiente, es decir, se configura a sí mismo y posteriormente se limpia solo.Each sample is self-contained, it sets itself up and cleans up after itself. Por tanto, los ejemplos emiten varias llamadas a Containers.create.As such, the samples issue multiple calls to 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.Each time this is done your subscription will be billed for 1 hour of usage per the performance tier of the container being created.

Ejemplos de base de datosDatabase examples

El archivo DatabaseManagement muestra cómo realizar las operaciones CRUD en la base de datos.The DatabaseManagement file shows how to perform the CRUD operations on the database. Para información sobre las bases de datos de Azure Cosmos antes de ejecutar los siguientes ejemplos, consulte el artículo conceptual Uso de bases de datos, contenedores y elementos.To learn about the Azure Cosmos databases before running the following samples, see Working with databases, containers, and items conceptual article.

TareaTask Referencia de APIAPI reference
Creación de una base de datos si no hay unaCreate a database if it does not exist Databases.createIfNotExistsDatabases.createIfNotExists
Enumeración de las bases de datos de una cuentaList databases for an account Databases.readAllDatabases.readAll
Lectura de una base de datos por identificadorRead a database by ID Database.readDatabase.read
Eliminación de una base de datosDelete a database Database.deleteDatabase.delete

Ejemplos de contenedorContainer examples

El archivo ContainerManagement muestra cómo realizar las operaciones CRUD en el contenedor.The ContainerManagement file shows how to perform the CRUD operations on the container. Para información sobre las colecciones de Azure Cosmos antes de ejecutar los siguientes ejemplos, consulte el artículo conceptual Uso de bases de datos, contenedores y elementos.To learn about the Azure Cosmos collections before running the following samples, see Working with databases, containers, and items conceptual article.

TareaTask Referencia de APIAPI reference
Creación de un contenedor si no hay unoCreate a container if it does not exist Containers.createIfNotExistsContainers.createIfNotExists
Enumeración de contenedores de una cuentaList containers for an account Containers.readAllContainers.readAll
Lectura del rendimiento de un contenedorRead a container definition Container.readContainer.read
Eliminación de un contenedorDelete a container Container.deleteContainer.delete

Ejemplos de elementosItem examples

El archivo ItemManagement muestra cómo realizar las operaciones CRUD en el elemento.The ItemManagement file shows how to perform the CRUD operations on the item. Para información sobre los documentos de Azure Cosmos antes de ejecutar los ejemplos siguientes, consulte el artículo conceptual Uso de bases de datos, contenedores y elementos.To learn about the Azure Cosmos documents before running the following samples, see Working with databases, containers, and items conceptual article.

TareaTask Referencia de APIAPI reference
Creación de elementosCreate items Items.createItems.create
Lectura de todos los elementos de un contenedorRead all items in a container Items.readAllItems.readAll
Lectura de un elemento por identificadorRead an item by ID Item.readItem.read
Lectura de un elemento solo si el elemento ha cambiadoRead item only if item has changed Item.readItem.read
RequestOptions.accessConditionRequestOptions.accessCondition
Consulta de documentosQuery for documents Items.queryItems.query
Reemplazo de un elementoReplace an item Item.replaceItem.replace
Reemplazo de un artículo con la comprobación de ETag condicionalReplace item with conditional ETag check Item.replaceItem.replace
RequestOptions.accessConditionRequestOptions.accessCondition
Eliminación de un elementoDelete an item Item.deleteItem.delete

Ejemplos de indizaciónIndexing examples

El archivo IndexManagement muestra cómo administrar la indexación.The IndexManagement file shows how to manage indexing. 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.To learn about indexing in Azure Cosmos DB before running the following samples, see indexing policies, indexing types, and indexing paths conceptual articles.

TareaTask Referencia de APIAPI reference
Indexación manual de un elemento determinadoManually index a specific item RequestOptions.indexingDirective: 'include'RequestOptions.indexingDirective: 'include'
Exclusión manual de un elemento determinado del índiceManually exclude a specific item from the index RequestOptions.indexingDirective: 'exclude'RequestOptions.indexingDirective: 'exclude'
Exclusión de una ruta de acceso del índiceExclude a path from the index IndexingPolicy.ExcludedPathIndexingPolicy.ExcludedPath
Crear un índice de intervalo en una ruta de acceso de cadenaCreate a range index on a string path IndexKind.Range, IndexingPolicy, Items.queryIndexKind.Range, IndexingPolicy, Items.query
Creación de un contenedor con indexPolicy de forma predeterminada y posterior actualización en líneaCreate a container with default indexPolicy, then update this online Containers.createContainers.create

Ejemplos de programación en el servidorServer-side programming examples

El archivo index.ts del proyecto ServerSideScripts muestra cómo realizar las siguientes tareas.The index.ts file of the ServerSideScripts project shows how to perform the following tasks. 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.To learn about Server-side programming in Azure Cosmos DB before running the following samples, see Stored procedures, triggers, and user-defined functions conceptual article.

TareaTask Referencia de APIAPI reference
Creación de un procedimiento almacenadoCreate a stored procedure StoredProcedures.createStoredProcedures.create
Ejecución de un procedimiento almacenadoExecute a stored procedure StoredProcedure.executeStoredProcedure.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.For more information about server-side programming, see Azure Cosmos DB server-side programming: Stored procedures, database triggers, and UDFs.