Cómo usar el IDE
El entorno de desarrollo integrado (IDE) de Looker tiene varias funciones para ayudarte a escribir LookML.
Sugerencia automática
A medida que escribes, el IDE sugiere parámetros y valores posibles que son sensibles al contexto de lo que estás escribiendo. Por ejemplo, las sugerencias para el parámetro type de una dimensión solo incluirán opciones válidas para ese parámetro. Además, los campos en los parámetros sql deben marcarse con ${...}, por lo que el IDE agrega esa sintaxis cuando sugiere campos.
La sugerencia automática aparece automáticamente donde se puede mostrar. Para cerrarla, presiona la tecla Esc en el teclado. Para verla en cualquier momento, presiona Ctrl+Espacio (Windows) o la tecla Control-espacio (Mac).
Comprobación de errores ad hoc
El IDE detecta errores de sintaxis mientras escribes. Una X roja en el margen indica un error de sintaxis, subrayado en rojo. Cuando te desplazas sobre la X roja, aparece una breve descripción del problema.
Aún se necesita el validador de LookML para realizar la validación de un modelo completo. Algunos errores, como una referencia de campo no válida debido a una unión faltante, requieren una visión integral del modelo y, por lo tanto, solo se muestran cuando se ejecuta el validador de LookML.
Panel de ayuda rápida
Haz clic en el ícono de información para abrir el panel Ayuda rápida, que proporciona explicaciones y opciones para la ubicación actual en el código. Haz clic en el nombre de un parámetro en la barra lateral a fin de abrir la página de documentación de Looker para ese parámetro.
También puedes usar el panel de metadatos para ver información contextual relevante sobre los objetos del panel de metadatos del IDE de Looker. Consulta la página de documentación Metadatos para objetos LookML a fin de obtener más información.
Formato automático
Cuando está en el modo de desarrollo, puede usar la combinación de teclas para archivos de formato a fin de aplicar automáticamente sangría al archivo LookML. La sangría indica la jerarquía de parámetros y subparámetros, lo que facilita la lectura y comprensión de su LookML.
Plegables
Aparece una flecha pequeña en el margen junto al inicio de cada parámetro LookML de nivel superior en el archivo. Si hace clic en esta flecha, se pliega o se despliega esa sección de LookML para que pueda enfocarse solo en secciones específicas.
El menú de archivos también ofrece las opciones Fold LookML y Unfold LookML para expandir o contraer todas las secciones de LookML hasta el parámetro de nivel superior dentro del archivo actual:
También puede usar combinaciones de teclas para acceso directo para plegar y desplegar LookML.
Marcar adiciones, cambios y eliminaciones
En el IDE de LookML, siempre se muestran varios indicadores cuando estás en el modo de desarrollo y tienes cambios sin confirmar.
- El nombre del archivo se muestra con un punto azul en el lado izquierdo de la ventana para indicar que el archivo es nuevo, cambió o se le cambió el nombre.
- Cuando abres un archivo nuevo o modificado, los números de línea dentro del archivo se destacan en verde para mostrar líneas nuevas o modificadas, y una línea roja horizontal indica las líneas quitadas.
Cómo agregar comentarios
Puede agregar comentarios a su LookML para hacerlo más legible. Para agregar un solo comentario, usa el carácter #:
dimension: name {
sql: ${TABLE}.name ;; # This is the customer's full name
}
Puedes comentar un bloque de código completo con las combinaciones de teclas:
- Selecciona las líneas que quieras comentar.
- Presiona ⌘ + / en una Mac o ctrl + / en una computadora con Windows.
El IDE agregará el carácter # a cada una de las líneas seleccionadas.
Comentarios sobre bloques de SQL
Si comenta líneas que están enteras dentro de un bloque de código SQL, agregue manualmente la notación de comentarios de SQL.
Cuando usas el bloque de comentarios de SQL, las secciones con comentarios se interpretarán como código LookML. Por lo tanto, verás tus comentarios en SQL generado por LookML, pero estos no afectarán los resultados de la consulta.
Ir al objeto o archivo
En el IDE de Looker, puedes realizar una búsqueda rápida para navegar directamente a los objetos de LookML y los archivos de proyectos con la función Jump to object or file. Haz clic en el ícono Jump to object or file desde el navegador de archivos o el navegador de objetos, o bien usa la combinación de teclas Command-J (Mac) o Ctrl+J (Windows):
Consulta la página de documentación Accede a la información del proyecto y edítala para obtener más información.
Busca y reemplaza texto en tu proyecto
El IDE de Looker tiene una función de búsqueda y reemplazo para que puedas buscar texto en todos los archivos de tu proyecto y reemplazar todas las instancias o instancias seleccionadas en una operación masiva.
El IDE de Looker busca y reemplaza es una herramienta excelente para ubicar elementos de LookML en proyectos de LookML grandes y para reemplazar texto en descripciones y etiquetas. Si quieres buscar y reemplazar en tu proyecto los nombres de los modelos, las exploraciones y los campos, usa la función de búsqueda y reemplazo de Content Validator. Cambiar los nombres de los modelos, las exploraciones y los campos puede romper las referencias dentro de tu modelo, y el validador de contenido puede validar tus referencias de LookML y corregir errores en el LookML después de realizar este tipo de cambios.
Para usar la función de búsqueda de IDE de Looker, haz lo siguiente:
- Navega al panel de búsqueda en el IDE.
- Ingresa un término en el campo Buscar.
- De manera opcional, puedes seleccionar Distinción entre mayúsculas y minúsculas para buscar solo las instancias que coincidan con el caso que ingresaste en el campo Buscar, o selecciona RegEX para realizar una búsqueda de expresiones regulares.
- Haz clic en Buscar.
- También puedes hacer clic en el nombre de un archivo para abrirlo en el IDE.
Si se encuentra en modo de desarrollo, también verá el campo Reemplazar con. Para reemplazar texto en tu proyecto:
Ingrese el texto de reemplazo en el campo Reemplazar con. De manera opcional, puedes dejar el campo Reemplazar con en blanco si deseas borrar el texto en el campo Buscar en lugar de reemplazarlo.
Haz clic en Seleccionar &Reemplazar para obtener una vista previa de cómo se reemplazará el texto en tu proyecto.
Los resultados muestran todas las instancias de tu proyecto destacadas para reemplazar. Puedes usar las siguientes opciones para personalizar las instancias que se reemplazan:
- Usa la casilla de verificación junto al resumen de resultados para seleccionar o anular la selección de todas las instancias de todo el proyecto.
- Usa la casilla de verificación junto a una sola instancia para seleccionar o anular la selección de esa instancia.
Haz clic en el botón Reemplazar seleccionados para aplicar el reemplazo a las instancias que seleccionaste. El IDE mostrará los cambios realizados:
Crea y prueba campos nuevos
Como ejemplo de edición de LookML, agregaremos varios campos y, luego, los probaremos.
Cómo crear una dimensión
Primero, agregaremos una nueva dimensión a nuestra vista de users, que determina si un usuario es de California o de Nueva York. La dimensión será type: yesno, lo que significa que mostrará Sí si el usuario es de California o Nueva York, y No si no lo es.
El LookML de nuestra nueva dimensión se ve de la siguiente manera:
dimension: from_ca_or_ny {
type: yesno
sql: ${TABLE}.state = "California" OR ${TABLE}.state = "New York" ;;
}
Agregue esta dimensión al archivo de vista user y, luego, haga clic en el botón Guardar cambios.
Consulta los operadores de sustitución para obtener más información sobre ${TABLE}.state.
Cómo crear una medida
A continuación, agregaremos una nueva medida a nuestra vista de user que promedia la edad de nuestros usuarios. Esta medida será type: average y se agregará en la columna age.
El LookML para esta nueva medida se ve de la siguiente manera:
measure: average_age {
type: average
sql: ${TABLE}.age ;;
}
Agrega esta medida al archivo de vista user y haz clic en el botón Guardar cambios.
Prueba los campos en Explorar
Puede probar su nueva dimensión y medirla. Después de guardar los cambios, estos campos aparecerán en el selector de campos de Explorar. Una forma fácil de acceder a Explorar para la vista actual es usar el menú desplegable que aparece junto al nombre del archivo de vista:
En la sección Usuarios, puede seleccionar los campos nuevos para agregarlos a una consulta. Por ejemplo, puede crear una consulta con los dos campos nuevos que muestran la edad promedio de los usuarios que son de California o Nueva York y la edad promedio de los usuarios que no:
Debes estar en modo de desarrollo para acceder a estos campos nuevos hasta que hayas confirmado y enviado los cambios a producción.
Valida tu LookML
Cuando estés conforme con las actualizaciones, puedes guardar los cambios. El IDE te alertará sobre cualquier error de sintaxis sin resolver en un solo archivo.
A continuación, usa el validador de LookML para realizar la validación de un modelo completo. Algunos errores, como una referencia de campo no válida debido a una unión faltante, requieren una visión integral del modelo y, por lo tanto, solo se muestran cuando se ejecuta el validador de LookML. Asegúrate de validar los cambios de LookML antes de publicarlos en el entorno de producción. Si bien la validación no detectará todos los problemas, como los permisos de bases de datos, sí evitará la mayoría de los errores.
El Validador de LookML no debe confundirse con el Validador de contenido, que comprueba si los cambios que hiciste dañarán los aspectos guardados.
El validador de LookML analiza solo los archivos de LookML que se actualizaron desde la última validación de LookML o los archivos afectados por actualizaciones:
- Si una configuración a nivel del modelo cambia, todo vuelve a validarse.
- Si cambia una vista, solo se vuelven a validar las exploraciones en las que se usa.
- Si se cambia Explorar, solo se volverá a validar.
Sugerencia para el equipo del chat: Si notas que la validación de LookML tarda mucho tiempo en completarse, lo primero que debes verificar es el parámetro
includeen el archivo del modelo. Si incluyes todos los archivos de vista (include: "*.view"), el validador de LookML tendrá que revisarlos todos, lo que puede afectar el rendimiento. Si este es el caso, actualiza el parámetroincludedel archivo de modelo para que solo se incluyan los archivos de vista necesarios.
Ejecutando validación
Para ejecutar el validador de LookML, selecciona el botón Validar LookML en la parte superior derecha del IDE de Looker o selecciona el ícono de estado del proyecto en la parte superior del IDE para abrir el panel Estado del proyecto y, luego, el botón Validar LookML:
Después de ejecutar el validador de LookML, es posible que vea una lista de errores y otras advertencias que debería solucionar. Puedes seleccionar cualquier flecha para expandir las listas de errores o advertencias:
El botón de validación del panel Estado del proyecto volverá a estar disponible si realiza y guarda otro cambio.
Mensajes de validación
Looker muestra mensajes de validación después de ejecutar la validación en su LookML.
Los paneles de LookML muestran mensajes informativos, en lugar de advertencias, en la barra lateral cuando la localización permisiva está habilitada.
No se encontraron errores de LookML
Cuando el validador no detecta problemas, Looker muestra una marca de verificación verde junto con el texto No se encontraron errores de LookML.
Errores de LookML
Los errores de LookML son problemas que podrían impedir que se ejecuten las consultas. El número entre paréntesis es la cantidad de errores encontrados (nueve en el siguiente ejemplo):
En la lista expandida de problemas, verás el motivo por el que no se aprobó la validación. A menudo, si haces clic en el error, accederás directamente a la fila de problemas del código. Verás una "X" roja junto a la fila. Si te desplazas sobre ella, verás información del error más detallada en algunos casos:
Sugerencia para equipos de chat: El error de validación que más se nos pregunta es el campo "Desconocido o inaccesible". Consulta este artículo del Centro de ayuda para conocer las causas y lo que debes hacer al respecto.
Advertencias de LookML
Es posible que las advertencias de LookML no impidan que se ejecute una consulta, pero pueden ocasionar una funcionalidad dañada o no deseada para los usuarios. Al igual que con los errores, el número entre paréntesis es el número de advertencias encontradas (tres advertencias en el siguiente ejemplo):
Al igual que con los errores de LookML, puede expandir las advertencias y saltar al código de problema. Para ello, seleccione la advertencia en el panel Estado del proyecto y, luego, coloque el cursor sobre el ícono X rojo para ver más información:
Implementa cambios
Una vez que hayas validado que los cambios funcionarán de forma correcta, puedes usar la integración de Git de Looker para confirmar y luego implementar los cambios en producción.
Si cambias los nombres de los campos que funcionan como filtros en la sección Apariencia o panel, asegúrate de revisar la sección Filtros de los paneles y estilos programados, y de actualizarlos según sea necesario para reflejar los cambios. Si una publicación de contenido programada incluye filtros que ya no funcionan (por ejemplo, si cambió el campo al que se hace referencia), la publicación programada podría exponer datos sin filtrar.