Inicio rápido: Biblioteca de Azure Cosmos DB for NoSQL para Node.js

Introducción a la biblioteca cliente de Azure Cosmos DB for NoSQL para Node.js para consultar datos en los contenedores y realizar operaciones comunes en elementos individuales. Siga estos pasos para implementar una solución mínima en su entorno mediante Azure Developer CLI.

Documentación de referencia de la API | Código fuente de la biblioteca | Paquete (npm) | Azure Developer CLI

Requisitos previos

Instalación

Implemente el contenedor de desarrollo de este proyecto en su entorno. A continuación, use la Azure Developer CLI (azd) para crear una cuenta de Azure Cosmos DB for NoSQL e implementar una aplicación de ejemplo en contenedor. La aplicación de ejemplo usa la biblioteca cliente para administrar, crear, leer y consultar datos de ejemplo.

1. Abra un terminal en el directorio raíz del proyecto.

2. Autentíquese en Azure Developer CLI mediante azd auth login. Siga los pasos especificados por la herramienta para autenticarse en la CLI mediante sus credenciales de Azure preferidas.

   azd auth login
   

3. Ejecute azd init para inicializar el proyecto.

   azd init --template cosmos-db-nosql-dotnet-quickstart
   

   Nota:

   En este inicio rápido se usa el repositorio de GitHub azure-samples/cosmos-db-nosql-dotnet-quickstart plantilla. La Azure Developer CLI clonará automáticamente este proyecto en la máquina si aún no lo está.

4. Durante la inicialización, configure un nombre de entorno único.

   Sugerencia

   El nombre del entorno también se usará como nombre del grupo de recursos de destino. Para este inicio rápido, considere la posibilidad de usar msdocs-cosmos-db.

5. Implemente la cuenta de Azure Cosmos DB mediante azd up. Las plantillas de Bicep también implementan una aplicación web de muestra.

   azd up
   

6. Durante el proceso de aprovisionamiento, seleccione la suscripción y la ubicación deseada. Espere a que se complete el proceso de aprovisionamiento. El proceso puede tardar aproximadamente cinco minutos.

7. Una vez realizado el aprovisionamiento de los recursos de Azure, se incluye una dirección URL a la aplicación web en ejecución en la salida.

   Deploying services (azd deploy)
   
     (✓) Done: Deploying service web
   - Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>
   
   SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.
   

8. Use la dirección URL de la consola para ir a la aplicación web en el explorador. Observe la salida de la aplicación en ejecución.

   

Instalación de la biblioteca cliente

La biblioteca cliente está disponible a través del Administrador de paquetes de Node, como paquete @azure/cosmos.

1. Abra un terminal y vaya a la carpeta /src.

   cd ./src
   

2. Si aún no está instalado, instale el paquete @azure/cosmos mediante npm install.

   npm install --save @azure/cosmos
   

3. Además, instale el paquete @azure/identity si aún no está instalado.

   npm install --save @azure/identity
   

4. Abra y revise el archivo src/package.json para validar que existen las entradas azure-cosmos y azure-identity.

Modelo de objetos

Ejemplos de código

• Autenticar el cliente
• Obtención de una base de datos
• Obtención de un contenedor
• Creación de un elemento
• Obtención de un elemento
• Elementos de consulta

El código de ejemplo de la plantilla usa una base de datos denominada cosmicworks y un contenedor denominado products. El contenedor products contiene detalles como el nombre, la categoría, la cantidad, un identificador único y una marca de venta para cada producto. El contenedor usa la propiedad /category como clave de partición lógica.

Autenticar el cliente

Deben autorizarse las solicitudes de aplicación a la mayor parte de servicios de Azure. Use el tipo DefaultAzureCredential como forma preferida de implementar una conexión sin contraseña entre las aplicaciones y Azure Cosmos DB for NoSQL. DefaultAzureCredential admite varios métodos de autenticación y determina el que se debe usar en tiempo de ejecución.

En este ejemplo se crea una nueva instancia del tipo CosmosClient y se autentica mediante una instancia de DefaultAzureCredential.

const credential = new DefaultAzureCredential();

const client = new CosmosClient({
    '<azure-cosmos-db-nosql-account-endpoint>',
    aadCredentials: credential
});

const credential: TokenCredential = new DefaultAzureCredential();

const client = new CosmosClient({
    '<azure-cosmos-db-nosql-account-endpoint>',
    aadCredentials: credential
});

Obtención de una base de datos

Use client.database para recuperar la base de datos existente denominada cosmicworks.

const database = client.database('cosmicworks');

const database: Database = client.database('cosmicworks');

Obtención de un contenedor

Recupere el contenedor existente products mediante database.container.

const container = database.container('products');

const container: Container = database.container('products');

Crear un elemento

Compile un nuevo objeto con todos los miembros que desea serializar en JSON. En este ejemplo, el tipo tiene un identificador único y campos para categoría, nombre, cantidad, precio y venta. Cree un elemento en el contenedor mediante container.items.upsert. Este método "actualiza" eficazmente el elemento si ya existe.

const item = {
    'id': 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    'category': 'gear-surf-surfboards',
    'name': 'Yamba Surfboard',
    'quantity': 12,
    'price': 850.00,
    'clearance': false
};

let response = await container.items.upsert(item);

const item: Product = {
    'id': 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    'category': 'gear-surf-surfboards',
    'name': 'Yamba Surfboard',
    'quantity': 12,
    'price': 850.00,
    'clearance': false
};

let response: ItemResponse<Product> = await container.items.upsert<Product>(item);

Lectura de un elemento

Se puede realizar una operación de lectura de punto mediante el identificador único (id) y los campos de clave de partición. Use container.item para obtener un puntero a un elemento y item.read para recuperar eficazmente el elemento específico.

const id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb';
const partitionKey = 'gear-surf-surfboards';

let response = await container.item(id, partitionKey).read();
let read_item = response.resource;

const id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb';
const partitionKey = 'gear-surf-surfboards';

let response: ItemResponse<Product> = await container.item(id, partitionKey).read<Product>();
let read_item: Product = response.resource!;

Elementos de consulta

Realice una consulta en varios elementos de un contenedor mediante container.items.query. Busque todos los elementos de una categoría especificada mediante esta consulta con parámetros:

SELECT * FROM products p WHERE p.category = @category

Capture todos los resultados de la consulta mediante query.fetchAll. Recorra los resultados de la consulta.

const querySpec = {
    query: 'SELECT * FROM products p WHERE p.category = @category',
    parameters: [
        {
            name: '@category',
            value: 'gear-surf-surfboards'
        }
    ]
};

let response = await container.items.query(querySpec).fetchAll();
for (let item of response.resources) {
    // Do something
}

const querySpec: SqlQuerySpec = {
    query: 'SELECT * FROM products p WHERE p.category = @category',
    parameters: [
        {
            name: '@category',
            value: 'gear-surf-surfboards'
        }
    ]
};

let response: FeedResponse<Product> = await container.items.query<Product>(querySpec).fetchAll();
for (let item of response.resources) {
    // Do something
}

Contenido relacionado

• Inicio rápido de .NET
• Inicio rápido de Java
• Inicio rápido de Python
• Ir a Inicio rápido