Query JSON Data Using SQL++ for Node.js with JavaScript

Hoy es el día tu aplicación Node.js aprende "go fetch".

Siguiendo este tutorial básico, aprenderás a construir una API REST para tu aplicación Node.js que envíe consultas SQL++ (también conocidas como N1QL) para recuperar datos de Couchbase.

Este post continúa mi serie introductoria sobre usando Node.js con Couchbaseincluyendo funciones asíncronas y Creación de una API REST con Node.js y Express.

El post de hoy continúa donde lo dejaron los anteriores tras construir una API REST para la recuperación directa de documentos.

Configuración de la base de datos Couchbase

Este post asume que usted ha instalado el viaje-muestra Cubo que viene con todo Couchbase instalaciones. Es importante que tenga instalado este conjunto de datos porque utilizaremos índices que se crean automáticamente y se utilizarán criterios específicos de documentos que son totalmente repetibles.

La conectividad básica y los cimientos de la API REST ya están establecidos en el guión que creamos juntos la semana pasada. Lo incluiré en el ejemplo de código de hoy, pero tendrás que leer todas las entradas anteriores (enlazadas más arriba) para obtener una explicación completa.

Además, en aras de la simplicidad en el ejemplo de hoy, usaremos los Scopes y Collections por defecto. Como de costumbre, cuando se trata de Query JSON data, también asumiré que tienes una familiaridad básica con JavaScript, Node.js y bases de datos de documentos NoSQL.

Entender las consultas N1QL

En Lenguaje de consulta N1QL para Couchbase es casi exactamente como SQL, con unas pocas excepciones.

Cuando una consulta N1QL solicita una columna específica de un Bucket, devuelve una lista de todos los documentos JSON coincidentes en el Bucket. Si no hay datos en el documento para la columna entonces se obtiene un NULL a menos que se filtre con un valor DONDE cláusula.

Como mínimo, debe existir un índice primario en los documentos para que éstos puedan consultarse. Sin embargo, el rendimiento de las consultas mejora cuando existe un índice secundario definido para una columna determinada.

Ambos índices pueden crearse con una consulta propiamente dicha y pueden hacerse mediante un script o a través de la función Consola web de Couchbase. De hecho, puedes conocer estos índices y ver la consulta utilizada para crearlos explorándolos en la consola web.

En el ejemplo anterior, se ha creado un índice en la columna denominada ciudad dentro de cualquier documento que se encuentre en el viaje-muestra Cubo.

Ejemplo de consulta

Antes de sumergirte en el código, puedes ejecutar consultas directamente en la consola web para asegurarte de que devuelven lo que esperas. Cambie a la función Consulta e introduzca la siguiente consulta, después pulse Ejecute.

SELECT * FROM `travel-sample` WHERE city = 'Los Angeles';

1	SELECCIONAR * DESDE `viaje-muestra` DONDE ciudad = Los Ángeles;

Los resultados muestran en la consola que 323 documentos coinciden. Observe que se devuelve una mezcla de documentos: hoteles, aeropuertos, etc., como se muestra en el gráfico tipo columna. (Ahora, estoy diciendo "columnas" pero por supuesto estos son en realidad objetos/elementos JSON que podrían estar incrustados dentro de otros objetos).

Modifique su consulta para que sólo devuelva unas pocas columnas, como en el ejemplo siguiente.

SELECT type, name, city FROM `travel-sample` WHERE city = 'Los Angeles';

1	SELECCIONE tipo, nombre, ciudad DESDE `viaje-muestra` DONDE ciudad = Los Ángeles;

Creación de una función de consulta

Antes de sumergirnos en el resto del código, empezaremos por ver lo básico de pasar consultas utilizando el SDK de Node.js.

En lugar de pasar una cadena de consulta completamente formada, querrás utilizar los marcadores de posición incorporados para que sea código reutilizable. En este caso, utiliza parámetros con nombre: Su consulta tendrá una variable de marcador de posición, y usted pasará una variable con los valores a utilizar.

En primer lugar, cree la variable de consulta:

const querystr = `SELECT type, name, city FROM `travel-sample` WHERE city = $CITY;`

1	const querystr = `SELECCIONE tipo, nombre, ciudad DESDE `viaje-muestra` DONDE ciudad = $CIUDAD;`

A continuación, cree la variable de parámetros de entrada:

const params = { parameters: { CITY: 'Los Angeles' }}

1	const parámetros = { parámetros: { CIUDAD: Los Ángeles }}

A continuación, pasa ambos datos a la función de consulta del clúster para que inicie y devuelva los resultados:

  let result = await cluster.query(querystr, params)

1	deje resultado = await grupo.consulta(querystr, parámetros)

La función completa que crea ahora es posible:

  async function getQuery(){
    const querystr = `SELECT type, name, city FROM `travel-sample` WHERE city = $CITY;`
    const params = { parameters: { CITY: 'Los Angeles' }}

    try {
      let result = await cluster.query(querystr, params)
      console.log("Result:", result)
      return result
    } catch (error) {
      console.error("Query failed: ", error)
    }
  };

async función getQuery(){

const querystr = `SELECCIONE tipo, nombre, ciudad DESDE `viaje-muestra` DONDE ciudad = $CIUDAD;`

const parámetros = { parámetros: { CIUDAD: Los Ángeles }}

pruebe {

deje resultado = await grupo.consulta(querystr, parámetros)

consola.registro("Resultado:", resultado)

devolver resultado

} captura (error) {

consola.error("Consulta fallida: ", error)

}

};

REST-ificar su consulta

El siguiente paso es añadir esta función de consulta a nuestro anterior ejemplo de código de la API REST para poder introducir el nombre de una ciudad y devolver los resultados HTTP al navegador.

En primer lugar, haga que la función pase una variable para el nombre de la ciudad, como se indica a continuación:

  async function getQuery(cityname){...

1	async función getQuery(nombre de la ciudad){...

A continuación, cree un punto final de consulta (en lugar del archivo consiga que usamos en un post anterior) y mover la lógica de la respuesta REST a esa función.

  app.get('/query/:cityname',
    runAsync(async (req, res) =&gt; {
      var cityname = req.params.cityname;

      var querystr = `SELECT type, name, city FROM `travel-sample` WHERE city = $CITY;`
      var params = { parameters: { CITY: cityname}}

      await cluster.query(querystr, params, function(err, result){
        res.json(result)
      })
  }));

aplicación.consiga(/consulta/:nombreciudad,

runAsync(async (consulte, res) => {

var nombre de la ciudad = consulte.parámetros.nombre de la ciudad;

var querystr = `SELECCIONE tipo, nombre, ciudad DESDE `viaje-muestra` DONDE ciudad = $CIUDAD;`

var parámetros = { parámetros: { CIUDAD: nombre de la ciudad}}

await grupo.consulta(querystr, parámetros, función(err, resultado){

res.json(resultado)

})

}));

Esto devuelve el RAW JSON de la llamada REST, como se muestra en la imagen de abajo en el navegador web o en la herramienta Postman REST API.

Ejemplo de código completo

Aquí está el resultado completo del código de ejemplo. Tenga en cuenta que algunos códigos anteriores de otros artículos se mantienen para su referencia.

var app = require('express')();
var couchbase = require("couchbase");

async function main(){
  app.get('/get/:docid',
    runAsync(async (req, res) =&gt; {
      var docid = req.params.docid;
      var docjson = await getDoc(docid, function(err, result){
        res.json(result.content)
      });
  }));

  app.get('/query/:cityname',
    runAsync(async (req, res) =&gt; {
      var cityname = req.params.cityname;
      var querystr = `SELECT type, name, city FROM `travel-sample` WHERE city = $CITY;`
      var params = { parameters: { CITY: cityname}}
      await cluster.query(querystr, params, function(err, result){
        res.json(result)
      })
  }));

  app.listen(3000, () =&gt; console.log('Listening on port 3000'));

  function runAsync (callback) {
    return function (req, res, next) {
      callback(req, res, next)
      .catch(next)
    }
  }

  var cluster = new couchbase.Cluster("couchbase://localhost", {
    username: "Administrator",
    password: "Administrator"
  });

  var bucket = cluster.bucket("travel-sample");
  var collection = bucket.defaultCollection();

  var getDoc = async (key) =&gt; {
      var result = await collection.get(key);
      console.log(result)
      return result
  }
}

main();

var aplicación = requiere(exprés)();

var couchbase = requiere("couchbase");

async función principal(){

aplicación.consiga('/get/:docid',

runAsync(async (consulte, res) => {

var docid = consulte.parámetros.docid;

var docjson = await getDoc(docid, función(err, resultado){

res.json(resultado.contenido)

});

}));

aplicación.consiga(/consulta/:nombreciudad,

runAsync(async (consulte, res) => {

var nombre de la ciudad = consulte.parámetros.nombre de la ciudad;

var querystr = `SELECCIONE tipo, nombre, ciudad DESDE `viaje-muestra` DONDE ciudad = $CIUDAD;`

var parámetros = { parámetros: { CIUDAD: nombre de la ciudad}}

await grupo.consulta(querystr, parámetros, función(err, resultado){

res.json(resultado)

})

}));

aplicación.escuche(3000, () => consola.registro(Escuchando en el puerto 3000));

función runAsync (devolución de llamada) {

devolver función (consulte, res, siguiente) {

devolución de llamada(consulte, res, siguiente)

.captura(siguiente)

}

var grupo = nuevo couchbase.Grupo("couchbase://localhost", {

nombre de usuario: "Administrador",

contraseña: "Administrador"

});

var cubo = grupo.cubo("viaje-muestra");

var colección = cubo.defaultCollection();

var getDoc = async (clave) => {

var resultado = await colección.consiga(clave);

consola.registro(resultado)

devolver resultado

}

principal();

Conclusión

Hay un montón de nuevas direcciones que puede tomar este proyecto. Para empezar, es posible que desee incluir la captura de errores adecuada, información de registro de salida a la consola, o el uso de la resultados.filas para crear resultados tabulares.

Le animo a profundizar en la documentación de Couchbase sobre el uso de consultas del SDK de Node.js.

Póngase al día con el resto de la serie Node.js + Couchbase how-to:

¿Listo para arremangarse y hacerlo usted mismo?
Pruebe Couchbase hoy mismo

Tyler Mitchell - Director de Marketing de Producto

Comparte este artículo

Platform

Self-Managed

Services

Capabilities

Why Couchbase?

Migrate to Capella

By Use Case

By Industry

By Application Need

Popular Docs

By Developer Role

Quickstart

Resource Center

About

Partnerships

Our Services

Partners: Register a Deal

Ready to register a deal with Couchbase?

Marriott

Cómo consultar datos JSON con SQL++ para Node.js y Couchbase

Configuración de la base de datos Couchbase

Entender las consultas N1QL

Ejemplo de consulta

Creación de una función de consulta

REST-ificar su consulta

Ejemplo de código completo

Conclusión

Recibe actualizaciones del blog de Couchbase en tu bandeja de entrada

Autor

Publicado por Tyler Mitchell - Director de Marketing de Producto

Deja un comentario Cancelar respuesta

¿Listo para empezar con Couchbase Capella?

Empezar a construir

Utilizar Capella gratis

Póngase en contacto