Cómo usar el IDE
En esta página, se describen algunas de las funciones del IDE de Looker que pueden ayudarte a escribir LookML.
Puedes acceder al IDE de Looker (entorno de desarrollo integrado) a través del menú Desarrollo de Looker. Consulta Accede a archivos del proyecto para obtener detalles y otras opciones.
Sugerencia automática
A medida que escribes, el IDE sugiere posibles parámetros y valores que son sensibles al contexto de lo que escribes. 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 estar marcados con ${...}, de modo que el IDE agregue esa sintaxis cuando sugiera campos.
Las sugerencias automáticas aparecen automáticamente dondequiera que se pueda mostrar. Para cerrarlo, presiona la tecla Esc en el teclado. Para verla en cualquier momento, presiona Ctrl+Espacio (Windows) o Control+Espacio (Mac).
Verificación de errores ad hoc
El IDE detecta errores de sintaxis mientras escribes. Una X roja en el margen indica un error de sintaxis subrayada en rojo. Cuando colocas el cursor sobre la X roja, aparece una descripción breve del problema. Por ejemplo, si escribes por error avrage en lugar de average como el valor del parámetro type para una medición, el IDE mostrará el error Invalid value for "type":avrage.
Aún se requiere el validador de LookML para realizar una validación completa del modelo. Algunos errores, como una referencia de campo no válida debido a una unión faltante, requieren una vista integral del modelo y, por lo tanto, solo se muestran cuando se ejecuta el validador de LookML.
Panel de Ayuda rápida
Selecciona el ícono de Quick Help para abrir el panel de Quick Help, que proporciona explicaciones y opciones de la ubicación actual en el código. Selecciona un nombre de parámetro en la barra lateral para abrir la página de documentación de Looker de ese parámetro.
Formato automático
Cuando estás en Modo de desarrollo, puedes usar la combinación de teclas para acceso directo de archivo de formato para aplicar sangría automáticamente a tu archivo de LookML. La sangría indica la jerarquía de parámetros y subparámetros, lo que hace que LookML sea más fácil de leer y comprender.
Plegables
Aparecerá una pequeña flecha en el margen junto al inicio de cada parámetro de LookML de nivel superior en el archivo. Si seleccionas esta flecha, se pliega o despliega esa sección de LookML para que puedas enfocarte solo en secciones particulares.
El menú Ver acciones de archivo del archivo de LookML también proporciona las opciones Fold LookML y Desplegar LookML para expandir o contraer todas las secciones de LookML hasta el parámetro de nivel superior del archivo actual.
También puedes usar combinaciones de teclas para plegar y desplegar LookML.
Cómo marcar adiciones, cambios y eliminaciones
En el IDE de LookML, siempre se muestran varios indicadores cuando estás en 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, se modificó 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 las líneas nuevas o modificadas, y una línea roja horizontal indica las líneas que se quitaron.
Agregar comentarios
Puedes agregar comentarios a LookML para que sea 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 siguiendo estos pasos:
- Selecciona las líneas que quieres comentar.
- Presiona Command + / (Mac) o Ctrl + / (Windows).
El IDE agregará el carácter # a cada una de las líneas seleccionadas.
Comentar bloques de SQL
Si estás comentando líneas que están completamente dentro de un bloque de código SQL, agrega manualmente una notación de comentario SQL.
Cuando usas el bloque de comentarios de SQL, las secciones comentadas aún se interpretarán como código de LookML. Por lo tanto, verás tus comentarios en el SQL generado con LookML, pero los comentarios no afectarán los resultados de la consulta.
Ir al objeto o archivo
En el IDE de Looker, puedes hacer una búsqueda rápida para navegar directamente a los objetos y archivos de proyectos de LookML con la función Saltar a un objeto o archivo. Haz clic en el ícono Ir a un objeto o archivo en el navegador de archivos o en el navegador de objetos, o bien usa la combinación de teclas Comando + J (Mac) o Ctrl + J (Windows).
Consulta la página de documentación Cómo acceder a archivos de proyecto de LookML para obtener más información.
Buscar y reemplazar texto en tu proyecto
El IDE de Looker tiene una función de búsqueda y reemplazo que puedes usar para buscar texto en todos los archivos de tu proyecto y, luego, reemplazar todas las instancias o instancias seleccionadas de forma masiva.
Para usar la función de búsqueda del IDE de Looker, sigue estos pasos:
- 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 las que ingresaste en el campo Buscar, o bien seleccionar RegEX para realizar una búsqueda de expresiones regulares.
- Selecciona Buscar.
- De manera opcional, puedes seleccionar el nombre de un archivo para abrirlo en el IDE.
Si estás en Modo de desarrollo, también verás el campo Reemplazar por. Para reemplazar texto en tu proyecto, sigue estos pasos:
Ingrese el texto de reemplazo en el campo Reemplazar por. De manera opcional, puedes dejar en blanco el campo Reemplazar por si deseas eliminar el texto del campo Buscar en lugar de reemplazarlo.
Selecciona Seleccionar y reemplazar para obtener una vista previa de cómo se reemplazaría el texto en tu proyecto.
En los resultados, se muestran todas las instancias de tu proyecto destacadas para reemplazarlas. Puedes usar las siguientes opciones para personalizar qué instancias se reemplazan:
- Usa la casilla de verificación junto al resumen de los 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 seleccionarla o anular la selección.
Selecciona el botón Replace Selected para aplicar el reemplazo a las instancias que seleccionaste. El IDE mostrará los cambios que se realizaron.
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 users que determina si un usuario es de California o 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.
LookML para 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" ;;
}
Agrega esta dimensión al archivo de vista user y, luego, haz clic en el botón Save Changes (Guardar cambios).
Consulta los operadores de sustitución para obtener más información sobre ${TABLE}.state.
Crea una medición
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á a la columna age.
LookML para esta medición nueva se ve de la siguiente manera:
measure: average_age {
type: average
sql: ${TABLE}.age ;;
}
Agrega esta medida al archivo de vista user y, luego, haz clic en el botón Save Changes (Guardar cambios) del archivo.
Cómo probar los campos en Explorar
Puedes probar tu dimensión nueva y medirla mediante consultas. Después de guardar los cambios, estos campos aparecerán en el selector de campos de la exploración. Usa el menú desplegable Ver acciones del archivo junto al nombre del archivo de vista para acceder fácilmente a la función Explorar de la vista actual. En el menú desplegable Ver acciones de archivo, se muestran todas las exploraciones que se basan en la vista, incluidas las exploraciones con las que está vinculada la vista. Por ejemplo, para acceder a Explorar de una vista llamada users, puedes seleccionar la opción Explorar usuarios en el menú desplegable Ver acciones de archivos.
En la exploración de usuarios, puedes seleccionar los campos nuevos para agregarlos a una consulta. Por ejemplo, puedes crear una consulta con ambos campos nuevos que muestren la edad promedio de los usuarios que son de California o Nueva York y la edad promedio de los usuarios que no son:
Valida tu LookML
Cuando estés conforme con los cambios, puedes guardar los cambios. El IDE te alertará acerca de cualquier error de sintaxis no resuelto dentro de un único archivo.
A continuación, usa el validador de LookML para realizar una validación completa del modelo. Algunos errores, como una referencia de campo no válida debido a una unión faltante, requieren una vista integral del modelo y, por lo tanto, solo se muestran cuando se ejecuta el validador de LookML. Asegúrate de validar tus cambios de LookML antes de publicarlos en el entorno de producción. Si bien la validación no detectará todos los problemas, como los problemas de permisos de la base de datos, evitará la mayoría de los errores.
El validador de LookML solo analiza los archivos de LookML que se actualizaron desde la última validación de LookML o los archivos afectados por actualizaciones:
- Si cambia la configuración a nivel de modelo, todo se vuelve a validar.
- Si una vista cambia, solo se validan de nuevo las exploraciones en las que se usa.
- Si una exploración cambia, solo esa exploración se vuelve a validar.
Ejecutando validación
Para ejecutar el validador de LookML, selecciona el botón Validate LookML en la parte superior derecha del IDE de Looker o selecciona el ícono de Project Health en la parte superior del IDE para abrir el panel Project Health y, luego, haz clic en el ícono Validate LookML.
Después de ejecutar el validador de LookML, es posible que veas una lista de errores y otras advertencias que debes abordar. Puedes seleccionar cualquier flecha para expandir las listas de errores o advertencias.
El botón de validador del panel Estado del proyecto volverá a estar disponible si realizas y guardas otro cambio.
Mensajes de validación
Looker muestra mensajes de validación después de ejecutar la validación en LookML.
No se encontraron errores de LookML
Cuando el validador no encuentre problemas, Looker mostrará una marca de verificación verde junto con el texto No LookML errors found.
Errores de LookML
Los errores de LookML son problemas que podrían impedir que se ejecuten consultas. La cifra entre paréntesis es el número 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, te llevará directamente a la fila del código con problemas. Verás una "X" roja junto a la fila. Si colocas el cursor sobre ella, se mostrará información de error más detallada en algunos casos:
Sugerencia para el equipo del Chat: El error de validación sobre el que más nos preguntamos es “Campo desconocido o inaccesible”. Visita la página de prácticas recomendadas Error: campo desconocido o inaccesible 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 aun así generen una funcionalidad dañada o no deseada para tus usuarios. Al igual que con los errores, el número entre paréntesis es el número de advertencias encontradas (en el siguiente ejemplo, hay tres advertencias):
Al igual que con los errores de LookML, puedes expandir las advertencias y pasar al código del problema seleccionando la advertencia en el panel Project Health y, luego, colocando el cursor sobre el ícono X rojo para ver más información:
Implementa cambios
Una vez que hayas validado que tus cambios funcionarán correctamente, puedes usar la integración de Git de Looker para confirmar e implementar los cambios en producción.