Cómo usar el IDE
El entorno de desarrollo integrado (IDE) de Looker tiene varias funciones que lo ayudarán a escribir LookML.
Sugerencia automática
A medida que escribes, el IDE sugiere posibles parámetros y valores que son sensibles al contexto de lo que estás escribiendo. Por ejemplo, las sugerencias del 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 verlo en cualquier momento, presiona Ctrl+Espacio (Windows) o Control-espacio (Mac).
Verificación de errores ad hoc
El IDE detecta errores de sintaxis a medida que escribes. Una X roja en el margen indica un error de sintaxis, que está subrayado en rojo. Cuando te desplaces sobre la X roja, aparecerá una descripción breve del problema. Por ejemplo, si escribes avrage por error en lugar del valor average del parámetro type para una medida, el IDE mostrará el error Invalid value for "type":avrage.
Aún se necesita el validador de LookML para realizar una validación completa del modelo. Algunos errores, como la referencia de un campo no válido debido a una unión faltante, requieren una mirada 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 Ayuda rápida para abrir el panel Ayuda rápida, que proporciona explicaciones y opciones de la ubicación actual del código. Selecciona un nombre de parámetro en la barra lateral a fin de abrir la página de documentación de Looker para ese parámetro.
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 sangría automáticamente a su 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.
Plegable
Aparece una pequeña flecha en el margen junto al inicio de cada parámetro LookML de nivel superior en el archivo. Si selecciona esta flecha, se pliega o despliega esa sección de LookML para que pueda enfocarse solo en secciones específicas.
El menú See file actions del archivo LookML también ofrece las opciones Fold LookML y Unfold LookML para expandir o contraer todas las secciones de LookML al parámetro de nivel superior dentro del archivo actual.
También puede usar las combinaciones de teclas para plegar y desplegar LookML.
Marca las adiciones, los cambios y las 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 la parte izquierda de la ventana para indicar que el archivo es nuevo, que se cambió o que se le cambió el nombre.
- Cuando abres un archivo nuevo o modificado, los números de las líneas 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 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:
- 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 comentas líneas que están completamente dentro de un bloque de código de SQL, agrega manualmente la notación de comentarios de SQL.
Cuando uses el bloque de comentarios de SQL, las secciones comentadas seguirán siendo interpretadas como código LookML. Por lo tanto, verá sus 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 objetos de LookML y archivos de proyectos con la función Ir a un objeto o un archivo. 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 Comando-J (Mac) o Ctrl+J (Windows):
Consulta la página de documentación Accede a los archivos del proyecto de LookML para obtener más información.
Busca y reemplaza texto en tu proyecto
El IDE de Looker tiene una función de encontrar y reemplazar 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.
Para usar la función de búsqueda de IDE de Looker, haz lo siguiente:
- Navega hasta el panel de búsqueda en el IDE.
- Ingresa un término en el campo Buscar.
- De forma opcional, puede seleccionar Distinción entre mayúsculas y minúsculas para buscar solo las instancias que coincidan con el caso que ingresó en el campo Buscar, o bien seleccione Registro para realizar una búsqueda de expresiones regulares.
- Selecciona Buscar.
- De forma opcional, puedes seleccionar el nombre de un archivo para abrirlo en el IDE.
Si estás en el modo de desarrollo, también verás el campo Reemplazar por. Para reemplazar texto en tu proyecto, haz lo siguiente:
Ingresa el texto de reemplazo en el campo Reemplazar por. De manera opcional, puedes dejar el campo Reemplazar por en blanco si deseas borrar el texto en el campo Buscar en lugar de reemplazarlo.
Selecciona Select & Replace 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 reemplazarlas. Puedes usar las siguientes opciones para personalizar las instancias que se reemplazan:
- Usa la casilla de verificación que se encuentra junto al resumen de resultados para seleccionar o anular la selección de todas las instancias de todo tu proyecto.
- Usa la casilla de verificación junto a una sola instancia para seleccionar o anular la selección de esa instancia.
Selecciona el botón Reemplazar los elementos seleccionados para aplicar el reemplazo a las instancias que seleccionaste. El IDE mostrará los cambios que se realizaron.
Creación y prueba de campos nuevos
Como ejemplo de la 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 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.
La apariencia 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 de esta nueva medida se ve así:
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) en el archivo.
Cómo probar los campos en Explorar
Para probar su nueva dimensión y realizar mediciones, puede consultarlas. Después de guardar los cambios, estos campos aparecerán en el selector de campos de la pestaña Explorar. Utilice el menú desplegable Ver acciones del archivo junto al nombre del archivo de vista para acceder fácilmente a Explorar en la vista actual. En el menú desplegable Ver acciones del archivo, se muestran todas las exploraciones basadas en la vista, incluidas las exploraciones a las que se unió la vista. Por ejemplo, para acceder a Explorar de una vista llamada users, puedes seleccionar la opción Explorar usuarios del menú desplegable Ver acciones del archivo.
En 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 son:
Cómo validar su LookML
Cuando estés conforme con las actualizaciones, puedes guardar los cambios. El IDE te alertará sobre cualquier error de sintaxis sin resolver dentro de un solo archivo.
A continuación, usa el validador de LookML para realizar una validación completa del modelo. Algunos errores, como la referencia de un campo no válido debido a una unión faltante, requieren una mirada integral del modelo y, por lo tanto, solo se muestran cuando se ejecuta el validador de LookML. Asegúrese 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 de permisos de bases de datos, sí evitará la mayoría de los errores.
El validador de LookML solo analiza archivos que se hayan actualizado desde la última validación de LookML o archivos afectados por actualizaciones:
- Si una configuración a nivel de modelo cambia, todo vuelve a validarse.
- Si cambia una vista, solo se vuelven a validar las exploraciones en las que se usa.
- Si una exploración cambia, solo se volverá 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 de Project Health y, luego, el botón Validate LookML.
Después de ejecutar el validador de LookML, es posible que vea una lista de errores y otras advertencias que debe solucionar. Puedes seleccionar cualquier flecha para expandir las listas de errores o advertencias.
El botón de validación en el panel de Estado del proyecto volverá a estar disponible si haces y guardas otro cambio.
Mensajes de validación
Looker muestra mensajes de validación después de ejecutar la validación en su LookML.
No se encontraron errores de LookML
Cuando no hay problemas encontrados con el validador, Looker muestra 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 evitar 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 cual no se aprobó la validación. A menudo, si haces clic en el error, se te dirigirá directamente a la fila de código del problema. Verá una "X" roja junto a la fila. Si colocas el cursor sobre ella, se mostrará información de errores más detallada en algunos casos:
Sugerencia para el equipo de Chat: El error de validación con el que más nos preguntamos es "Campo desconocido o inaccesible". Visite la página de prácticas recomendadas Error: Campo desconocido o inaccesible para conocer las causas y lo que debe 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 no deseada 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, puedes expandir las advertencias y pasar al código de problema seleccionando la advertencia en el panel de Estado del proyecto y colocando el cursor sobre el ícono rojo de la X para ver más información:
Implementa cambios
Una vez que hayas validado que los cambios funcionarán correctamente, puedes usar la integración de Git de Looker para confirmar e implementar los cambios en producción.