{"id":11798,"date":"2021-09-15T00:00:07","date_gmt":"2021-09-15T07:00:07","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=11798"},"modified":"2025-06-13T21:22:56","modified_gmt":"2025-06-14T04:22:56","slug":"how-to-query-json-data-n1ql-node-js-couchbase","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/es\/how-to-query-json-data-n1ql-node-js-couchbase\/","title":{"rendered":"C\u00f3mo consultar datos JSON con SQL++ para Node.js y Couchbase"},"content":{"rendered":"

Hoy es el d\u00eda<\/strong> tu aplicaci\u00f3n Node.js aprende \"go fetch\".<\/p>\n

Siguiendo este tutorial b\u00e1sico, aprender\u00e1s a construir una API REST para tu aplicaci\u00f3n Node.js que env\u00ede consultas SQL++ (tambi\u00e9n conocidas como N1QL) para recuperar datos de Couchbase.<\/p>\n

Este post contin\u00faa mi serie introductoria sobre usando Node.js con Couchbase<\/a>incluyendo funciones as\u00edncronas<\/a> y Creaci\u00f3n de una API REST con Node.js y Express<\/a>.<\/p>\n

El post de hoy contin\u00faa donde lo dejaron los anteriores tras construir una API REST para la recuperaci\u00f3n directa de documentos.<\/p>\n

Configuraci\u00f3n de la base de datos Couchbase<\/h2>\n

This post assumes you have installed the `travel-sample` Bucket that comes with all Couchbase<\/a> instalaciones. Es importante que tenga instalado este conjunto de datos porque utilizaremos \u00edndices que se crean autom\u00e1ticamente y se utilizar\u00e1n criterios espec\u00edficos de documentos que son totalmente repetibles.<\/p>\n

La conectividad b\u00e1sica y los cimientos de la API REST ya est\u00e1n establecidos en el gui\u00f3n que creamos juntos la semana pasada<\/a>. Lo incluir\u00e9 en el ejemplo de c\u00f3digo de hoy, pero tendr\u00e1s que leer todas las entradas anteriores (enlazadas m\u00e1s arriba) para obtener una explicaci\u00f3n completa.<\/p>\n

Adem\u00e1s, 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\u00e9n asumir\u00e9 que tienes una familiaridad b\u00e1sica con JavaScript, Node.js y bases de datos de documentos NoSQL.<\/p>\n

Entender las consultas N1QL<\/h2>\n

En Lenguaje de consulta N1QL<\/a> para Couchbase es casi exactamente como SQL, con unas pocas excepciones.<\/p>\n

When a N1QL query requests a specific column from a Bucket, it returns a list of all matching JSON documents in the Bucket. If there is no data in the document for the column then you get a `NULL` value, unless it is filtered out with a `WHERE` clause.<\/p>\n

Como m\u00ednimo, debe existir un \u00edndice primario en los documentos para que \u00e9stos puedan consultarse. Sin embargo, el rendimiento de las consultas mejora cuando existe un \u00edndice secundario definido para una columna determinada.<\/p>\n

Ambos \u00edndices pueden crearse con una consulta propiamente dicha y pueden hacerse mediante un script o a trav\u00e9s de la funci\u00f3n Consola web de Couchbase<\/a>. De hecho, puedes conocer estos \u00edndices y ver la consulta utilizada para crearlos explor\u00e1ndolos en la consola web.<\/p>\n

<\/div>\n

\"Couchbase<\/a><\/p>\n

<\/div>\n

En el ejemplo anterior, se ha creado un \u00edndice en la columna denominada ciudad<\/code> dentro de cualquier documento que se encuentre en el viaje-muestra<\/code> Cubo.<\/p>\n

Ejemplo de consulta<\/h2>\n

Antes de sumergirte en el c\u00f3digo, puedes ejecutar consultas directamente en la consola web para asegurarte de que devuelven lo que esperas. Cambie a la funci\u00f3n Consulta<\/code> e introduzca la siguiente consulta, despu\u00e9s pulse Ejecute<\/code>.<\/p>\n

SELECT * FROM `travel-sample` WHERE city = 'Los Angeles';\r\n<\/pre>\n
<\/div>\n
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\u00e1fico tipo<\/code> columna. (Ahora, estoy diciendo \"columnas\" pero por supuesto estos son en realidad objetos\/elementos JSON que podr\u00edan estar incrustados dentro de otros objetos).<\/p>\n
Modifique su consulta para que s\u00f3lo devuelva unas pocas columnas, como en el ejemplo siguiente.<\/p>\n
SELECT type, name, city FROM `travel-sample` WHERE city = 'Los Angeles';\r\n<\/pre>\n
<\/div>\n
\"Couchbase<\/a><\/p>\n
<\/div>\n
Creaci\u00f3n de una funci\u00f3n de consulta<\/h2>\n
Antes de sumergirnos en el resto del c\u00f3digo, empezaremos por ver lo b\u00e1sico de pasar consultas utilizando el SDK de Node.js<\/a>.<\/p>\n
En lugar de pasar una cadena de consulta completamente formada, querr\u00e1s utilizar los marcadores de posici\u00f3n incorporados para que sea c\u00f3digo reutilizable. En este caso, utiliza par\u00e1metros con nombre: Su consulta tendr\u00e1 una variable de marcador de posici\u00f3n, y usted pasar\u00e1 una variable con los valores a utilizar.<\/p>\n
En primer lugar, cree la variable de consulta:<\/p>\n
const querystr = `SELECT type, name, city FROM \\`travel-sample\\` WHERE city = $CITY;`\r\n<\/pre>\n
<\/div>\n
A continuaci\u00f3n, cree la variable de par\u00e1metros de entrada:<\/p>\n
const params = { parameters: { CITY: 'Los Angeles' }}\r\n<\/pre>\n
<\/div>\n
A continuaci\u00f3n, pasa ambos datos a la funci\u00f3n de consulta del cl\u00faster para que inicie y devuelva los resultados:<\/p>\n
  let result = await cluster.query(querystr, params)\r\n<\/pre>\n
<\/div>\n
La funci\u00f3n completa que crea ahora es posible:<\/p>\n
  async function getQuery(){\r\n    const querystr = `SELECT type, name, city FROM \\`travel-sample\\` WHERE city = $CITY;`\r\n    const params = { parameters: { CITY: 'Los Angeles' }}\r\n\r\n    try {\r\n      let result = await cluster.query(querystr, params)\r\n      console.log(\"Result:\", result)\r\n      return result\r\n    } catch (error) {\r\n      console.error(\"Query failed: \", error)\r\n    }\r\n  };\r\n<\/pre>\n
<\/div>\n
REST-ificar su consulta<\/h2>\n
El siguiente paso es a\u00f1adir esta funci\u00f3n de consulta a nuestro anterior ejemplo de c\u00f3digo de la API REST para poder introducir el nombre de una ciudad y devolver los resultados HTTP al navegador.<\/p>\n
En primer lugar, haga que la funci\u00f3n pase una variable para el nombre de la ciudad, como se indica a continuaci\u00f3n:<\/p>\n
  async function getQuery(cityname){...\r\n<\/pre>\n
<\/div>\n
Then, create a query endpoint (instead of the `get` route we used in an earlier post) and move the logic for the REST response into that function.<\/p>\n
  app.get('\/query\/:cityname',\r\n    runAsync(async (req, res) => {\r\n      var cityname = req.params.cityname;\r\n\r\n      var querystr = `SELECT type, name, city FROM \\`travel-sample\\` WHERE city = $CITY;`\r\n      var params = { parameters: { CITY: cityname}}\r\n\r\n      await cluster.query(querystr, params, function(err, result){\r\n        res.json(result)\r\n      })\r\n  }));\r\n<\/pre>\n
<\/div>\n
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.<\/p>\n
<\/div>\n
\"couchbase<\/a><\/p>\n
<\/div>\n
Ejemplo de c\u00f3digo completo<\/h2>\n
Aqu\u00ed est\u00e1 el resultado completo del c\u00f3digo de ejemplo. Tenga en cuenta que algunos c\u00f3digos anteriores de otros art\u00edculos se mantienen para su referencia.<\/p>\n
var app = require('express')();\r\nvar couchbase = require(\"couchbase\");\r\n\r\nasync function main(){\r\n  app.get('\/get\/:docid',\r\n    runAsync(async (req, res) => {\r\n      var docid = req.params.docid;\r\n      var docjson = await getDoc(docid, function(err, result){\r\n        res.json(result.content)\r\n      });\r\n  }));\r\n\r\n  app.get('\/query\/:cityname',\r\n    runAsync(async (req, res) => {\r\n      var cityname = req.params.cityname;\r\n      var querystr = `SELECT type, name, city FROM \\`travel-sample\\` WHERE city = $CITY;`\r\n      var params = { parameters: { CITY: cityname}}\r\n      await cluster.query(querystr, params, function(err, result){\r\n        res.json(result)\r\n      })\r\n  }));\r\n\r\n  app.listen(3000, () => console.log('Listening on port 3000'));\r\n\r\n  function runAsync (callback) {\r\n    return function (req, res, next) {\r\n      callback(req, res, next)\r\n      .catch(next)\r\n    }\r\n  }\r\n\r\n  var cluster = new couchbase.Cluster(\"couchbase:\/\/localhost\", {\r\n    username: \"Administrator\",\r\n    password: \"Administrator\"\r\n  });\r\n\r\n  var bucket = cluster.bucket(\"travel-sample\");\r\n  var collection = bucket.defaultCollection();\r\n\r\n  var getDoc = async (key) => {\r\n      var result = await collection.get(key);\r\n      console.log(result)\r\n      return result\r\n  }\r\n}\r\n\r\nmain();\r\n<\/pre>\n
<\/div>\n
Conclusi\u00f3n<\/h2>\n
Hay un mont\u00f3n de nuevas direcciones que puede tomar este proyecto. Para empezar, es posible que desee incluir la captura de errores adecuada, informaci\u00f3n de registro de salida a la consola, o el uso de la resultados.filas<\/code> para crear resultados tabulares.<\/p>\n
Le animo a profundizar en la documentaci\u00f3n de Couchbase sobre el uso de consultas del SDK de Node.js<\/a>.<\/p>\n
P\u00f3ngase al d\u00eda con el resto de la serie Node.js + Couchbase how-to:<\/em><\/p>\n