{"id":13258,"date":"2022-05-26T12:05:50","date_gmt":"2022-05-26T19:05:50","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=13258"},"modified":"2025-06-13T23:34:35","modified_gmt":"2025-06-14T06:34:35","slug":"traverse-hierarchy-user-defined-functions-in-7-1","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/es\/traverse-hierarchy-user-defined-functions-in-7-1\/","title":{"rendered":"Recorrer la jerarqu\u00eda con funciones SQL++ definidas por el usuario (UDF)"},"content":{"rendered":"

Las funciones definidas por el usuario (UDF) son una caracter\u00edstica que existe en la mayor\u00eda de los RDBMS. Ya se trate de Oracle PL\/SQL (Procedural Language for SQL), SQL Server T-SQL (Transact-SQL), PL\/pgSQL (Procedural Language\/PostgreSQL) u otras variantes, todos estos lenguajes tienen las caracter\u00edsticas generales de proporcionar<\/span> una estructura de bloques, control de condiciones, bucle de iteraci\u00f3n y gesti\u00f3n de errores. Estos bloques permiten desarrollar tareas complejas, que pueden aislarse para mejorar el mantenimiento y la integridad de la aplicaci\u00f3n.<\/span><\/p>\n

En el caso de Couchbase, los criterios a la hora de elegir el idioma para SQL<\/a> Las Funciones Definidas por el Usuario son bastante claras - deben ser capaces de soportar todas las capacidades que existen en las implementaciones RDBMS actuales o al mismo nivel que el servicio Couchbase Query puede, y tambi\u00e9n reflejar la preferencia de los desarrolladores de hoy en d\u00eda. Seg\u00fan las encuestas a desarrolladores de Stack Overflow, el lenguaje de programaci\u00f3n m\u00e1s utilizado en el mundo en 2020 es <\/span>JavaScript<\/b>.<\/span><\/p>\n

SQL++ UDF\/JS<\/span><\/h2>\n

Couchbase es una base de datos de documentos que almacena sus datos de forma nativa en formato JSON (<\/span>J<\/b>ava<\/span>S<\/b>cript <\/span>O<\/b>bjeto <\/span>N<\/b>otaci\u00f3n). Su lenguaje de consulta, SQL++ , es SQL para JSON<\/em>. El lenguaje JavaScript es, por tanto, la forma m\u00e1s natural de acceder y manipular datos JSON.<\/span><\/p>\n

Consulte la documentaci\u00f3n de Couchbase para obtener m\u00e1s informaci\u00f3n sobre la funci\u00f3n implementaci\u00f3n completa de JavaScript en Couchbase<\/a>.<\/span><\/p>\n

La UDF de JavaScript para recorrer \u00e1rboles<\/span><\/h3>\n

JavaScript es potente, flexible y relativamente f\u00e1cil de empezar a utilizar. Para mostrar su versatilidad, he creado una UDF Javascript para este art\u00edculo que atraviesa una estructura de \u00e1rbol, como una estructura organizativa.<\/span><\/p>\n

UDF: traverseTree<\/em><\/p>\n

La UDF realiza una b\u00fasqueda recursiva en una colecci\u00f3n utilizando las dos conecte<\/em> (hacia y desde) para la recursi\u00f3n.<\/span><\/p>\n

Los par\u00e1metros se muestran en la siguiente tabla:<\/span><\/p>\n\n\n\n\n\n\n\n\n\n
#<\/strong><\/td>\nNombre<\/strong><\/td>\nDescripci\u00f3n<\/strong><\/td>\n<\/tr>\n
1<\/span><\/td>\nkSpace<\/span><\/i><\/td>\nEl espacio clave para la consulta. Puede ser una colecci\u00f3n o una consulta.<\/span><\/td>\n<\/tr>\n
2<\/span><\/td>\nstartWith<\/span><\/i><\/td>\nInicia la b\u00fasqueda con este valor para el connectToFld. Si est\u00e1 vac\u00edo, la b\u00fasqueda se realizar\u00e1 para todos los valores connectTo<\/span><\/td>\n<\/tr>\n
3<\/span><\/td>\nconnectTo<\/span><\/i><\/td>\nEl nombre del campo de la colecci\u00f3n donde se utilizar\u00e1 el campo connectTo<\/span><\/td>\n<\/tr>\n
4<\/span><\/td>\nconnectFrom<\/span><\/i><\/td>\nEl nombre del campo de la colecci\u00f3n donde se utilizar\u00e1 el campo connectFrom<\/span><\/td>\n<\/tr>\n
5<\/span><\/td>\ninformeHier<\/span><\/i><\/td>\nEl nombre del campo de la matriz jer\u00e1rquica<\/span><\/td>\n<\/tr>\n
6<\/span><\/td>\nlogKSpace<\/span><\/i><\/td>\nEl espacio clave donde se escribe el registro opcional para UDF. Tenga en cuenta que este par\u00e1metro s\u00f3lo se puede ejecutar cuando se ejecuta con EXECUTE FUNCTION.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Ejemplos de jerarqu\u00eda<\/span><\/h4>\n

Consideremos una estructura jer\u00e1rquica organizativa como la siguiente.<\/span><\/p>\n

\"traverse<\/p>\n

En <\/span>emp<\/span><\/em> La colecci\u00f3n cuenta con los siguientes documentos:<\/span><\/p>\n

[\r\n  { \"empid\": 1, \"name\": \"JeffC\" },\r\n  { \"empid\": 2, \"name\": \"SteveA\", \"reportsTo\": \"JeffC\" },\r\n  { \"empid\": 3, \"name\": \"AmitG\", \"reportsTo\": \"JeffC\" },\r\n  { \"empid\": 4, \"name\": \"BrendaM\", \"reportsTo\": \"SteveA\" },\r\n  { \"empid\": 5, \"name\": \"WillG\", \"reportsTo\": \"SteveA\" },\r\n  { \"empid\": 6, \"name\": \"PaulD\", \"reportsTo\": \"BrendaM\" }\r\n]<\/pre>\n
SELECT e.* FROM traverseTree('traversal.hierarchy.emp','','name','reportsTo','ReportHierarchy','') e;<\/pre>\n
La consulta produce los siguientes resultados:<\/p>\n
[\r\n  {\r\n    \"ReportHierarchy\": [],\r\n   \"nombre\": \"JeffC\"\r\n  },\r\n  {\r\n    \"ReportHierarchy\": [ { \"level\": 1, \"name\": \"JeffC\" } ],\r\n   \"name\": \"SteveA\",\r\n    \"reportsTo\": \"JeffC\"\r\n  },\r\n  {\r\n    \"ReportHierarchy\": [ { \"level\": 1, \"name\": \"JeffC\" } ],\r\n   \"name\": \"AmitG\",\r\n    \"reportsTo\": \"JeffC\"\r\n  },\r\n  {\r\n    \"ReportHierarchy\": [ {\"level\": 1, \"name\": \"SteveA\", \"reportsTo\": \"JeffC\" },\r\n                        { \"level\": 2 2, \"name\": \"JeffC\" }  ],\r\n    \"name\": \"BrendaM\",\r\n    \"reportsTo\": \"SteveA\"\r\n  },\r\n  {\r\n    \"ReportHierarchy\": [ {\"level\": 1, \"name\": \"SteveA\", \"reportsTo\": \"JeffC\" },\r\n                        { \"level\": 2 2, \"name\": \"JeffC\" }  ],\r\n    \"name\": \"WillG\",\r\n    \"reportsTo\": \"SteveA\"\r\n  },\r\n  {\r\n    \"ReportHierarchy\": [ {\"level\": 1, \"name\": \"BrendaM\", \"reportsTo\": \"SteveA\" },\r\n                        { \"level\": 2 2, \"name\": \"SteveA\", \"reportsTo\": \"JeffC\" },\r\n                        { \"level\": 3 3, \"name\": \"JeffC\" }  ],\r\n   \"name\": \"PaulD\",\r\n    \"reportsTo\": \"BrendaM\"\r\n  }\r\n]\r\n<\/pre>\n
Crear el <\/span>traverseTree<\/span><\/em> funci\u00f3n definida por el usuario<\/span><\/h3>\n
En Couchbase SQL++, una UDF puede definirse de varias maneras.\u00a0<\/span><\/p>\n
UDF como funci\u00f3n escalar<\/h5>\n
CREATE FUNCTION to_meters(...) { args[0] * 0.3048 };\r\n\r\nSELECT nombre_aeropuerto, ROUND(to_meters(geo.alt)) AS mamsl\r\nFROM `viajes-muestra`.inventario.aeropuerto\r\nLIMIT 5;<\/pre>\n
 <\/p>\n
Como funci\u00f3n en l\u00ednea con una subconsulta<\/h5>\n
CREAR FUNCI\u00d3N locations(vActivity) { (\r\n  SELECT id, nombre, direcci\u00f3n, ciudad\r\n  FROM `viaje-muestra`.inventario.localizacion\r\n  WHERE actividad = vActividad) };\r\n\r\nSELECT l.nombre, l.ciudad\r\nFROM locations(\"comer\") AS l\r\nWHERE l.city = \"Gillingham\";<\/pre>\n
 <\/p>\n
Definida como una funci\u00f3n externa<\/h5>\n
En traverseTree<\/em> UDF utiliza el mecanismo de funci\u00f3n externa. Pero en este caso, proporcionamos la biblioteca de c\u00f3digo externo para la funci\u00f3n. Consulta la documentaci\u00f3n de Couchbase para m\u00e1s detalles sobre Funci\u00f3n externa<\/a>.<\/span><\/p>\n
A continuaci\u00f3n se explica c\u00f3mo crear una biblioteca de funciones JavaScript:<\/span><\/p>\n
1- Crear la biblioteca de funciones<\/b> - En este ejemplo, utilizamos Query Workbench para crear la biblioteca JavaScript.\u00a0<\/span><\/p>\n
\"Managing<\/p>\n
2 - A\u00f1adir y editar el c\u00f3digo JavaScript<\/b><\/p>\n
\"Editing<\/p>\n
Consulte este [<\/span>enlace<\/span><\/a>] para ver el c\u00f3digo completo de la biblioteca JavaScript de traverseTree.<\/span><\/p>\n
3 - Crear la funci\u00f3n SQL++ definida por el usuario<\/b>\u00a0<\/span><\/p>\n
CREAR FUNCI\u00d3N traverseTree(kSpace,startWith, connectTo,\r\n                            connectFrom,reportHier, debugKSpace)\r\n  LANGUAGE JAVASCRIPT AS \"traverseTree\" AT \"tree\";<\/pre>\n
Tenga en cuenta que tambi\u00e9n puede crear la UDF utilizando el Query Workbench.<\/p>\n
\"Add<\/p>\n
Notas importantes<\/span><\/h3>\n
Couchbase 7.0 a\u00f1adi\u00f3 SQL++ UDFs para JavaScript. A Couchbase 7.1 a\u00f1adimos la capacidad de ejecutar SQL++ DMLs desde dentro del c\u00f3digo JavaScript. Tambi\u00e9n hay varias mejoras en el Query Workbench UI para el manejo de UDFs.<\/span><\/p>\n
Descargo de responsabilidad <\/b>- Tenga en cuenta que el c\u00f3digo JavaScript proporcionado en este art\u00edculo no es parte del producto Couchase. Se proporciona aqu\u00ed s\u00f3lo para ilustrar las capacidades de SQL++ UDF usando JavaScript. Se anima a los usuarios a verificar su correcci\u00f3n y a realizar modificaciones para adaptarlo a sus necesidades.<\/span><\/p>\n
Seguir aprendiendo<\/h3>\n