Tipos de archivos en un proyecto de LookML

Un proyecto de LookML es una colección de archivos LookML que le indican a Looker cómo conectarse a tu base de datos, cómo consultar tus datos y cómo controlar el comportamiento de la interfaz de usuario. Puedes acceder a los archivos del proyecto de LookML desde la sección Desarrollar de Looker o desde la IU, como se describe en la página de documentación Accede a los archivos del proyecto de LookML.

Los desarrolladores de Looker organizan los archivos de proyectos mediante carpetas del IDE.

Un proyecto de LookML consta de al menos un archivo de modelo y al menos un archivo de vista, y posiblemente algunos de los otros tipos de archivos que se describen en esta página. Todos los archivos de proyecto tienen extensiones, aunque estas se ocultan en la lista del IDE si tu proyecto no está habilitado para las carpetas en el IDE.

Selecciona los siguientes vínculos para obtener más información sobre cada uno de los tipos de archivos que se pueden usar en un proyecto de LookML:

Una vez que crees un proyecto de LookML, podrás acceder a los archivos del proyecto y agregar archivos y carpetas nuevos al proyecto con el IDE de Looker.

Archivos de modelos

Un archivo de modelo especifica una conexión de base de datos y el conjunto de Exploras que usan esa conexión. Un archivo de modelo también define las exploraciones en sí y sus relaciones con otras vistas. Una exploración es un punto de partida para consultar tus datos. En términos de SQL, una exploración es la cláusula FROM de una consulta. Los usuarios pueden ver las exploraciones que defines en el modelo cuando consultan el menú Explorar de Looker.

En otras palabras, en el archivo de modelo es donde defines qué tablas de datos se deben usar (como vistas incluidas) y cómo se deben unir, si es necesario.

Consulta la página de documentación Administra archivos y carpetas de LookML para obtener instrucciones sobre cómo crear archivos de proyectos de LookML, incluidos los archivos de modelos.

Estructura y sintaxis general

Dentro de los corchetes de una exploración, { }, defines los parámetros para la exploración. Puedes usar parámetros join para unir otras vistas con una exploración en un archivo de modelo.

En el siguiente ejemplo, el código LookML de un archivo de modelo de muestra define una exploración llamada inventory_items, junto con sus vistas unidas:

connection: "thelook_events"

explore: inventory_items {
  join: products {
    type: left_outer
    sql_on: ${inventory_items.product_id} = ${products.id} ;;
    relationship: many_to_one
  }

  join: distribution_centers {
    type: left_outer
    sql_on: ${products.distribution_center_id} = ${distribution_center.id} ;;
    relationship: many_to_one
  }
}

Esta definición de LookML hace que Inventory Items aparezca en la sección Explorar de la navegación de Looker y una los datos de las vistas products y distribution_centers a la vista inventory_items.

Se puede acceder a las vistas Distribution Centers, Inventory Items y Products desde el selector de campos de la Inventory Items Explore.

Para obtener información más específica sobre las estructuras de LookML en un archivo de modelo, consulta la página de documentación de Términos y conceptos de LookML.

Lee las páginas de documentación Parámetros del modelo, Parámetros de exploración y Parámetros de unión para obtener más información sobre los parámetros de LookML en el archivo del modelo.

Ver archivos

Por lo general, un archivo de vista define una sola “vista” en Looker. Una vista corresponde a una sola tabla en tu base de datos o a una sola tabla derivada. El archivo de vista especifica una tabla para consultar y los campos (dimensiones y medidas) que se incluirán de esa tabla para que los usuarios puedan crear consultas con esos campos en la IU de Looker.

Consulta la página de documentación Administra archivos y carpetas de LookML para obtener instrucciones sobre cómo crear archivos de proyectos de LookML, incluidos los archivos de vistas.

Estructura y sintaxis general

Dentro de los corchetes de cada vista, { }, se encuentran las definiciones de campos, que suelen corresponder a una columna en la tabla subyacente o a un cálculo en Looker. Looker clasifica la mayoría de ellos como dimensiones o medidas.

En el siguiente ejemplo de un archivo de vista, el archivo orders.view incluye definiciones para las dimensiones id, status y user_id, el grupo de dimensiones created y la medida count:

view: orders {
  sql_table_name: demo_db.orders ;;
  drill_fields: [id]

  dimension: id {
    primary_key: yes
    type: number
    sql: ${TABLE}.id ;;
  }

  dimension: status {
    type: string
    sql: ${TABLE}.status ;;
  }

  dimension: user_id {
    type: number
    # hidden: yes
    sql: ${TABLE}.user_id ;;
  }

    dimension_group: created {
    type: time
    timeframes: [
      raw,
      time,
      date,
      week,
      month,
      quarter,
      year
    ]
    sql: ${TABLE}.created_at ;;
  }


  measure: count {
    type: count
    drill_fields: [id, users.id, users.first_name, users.last_name, order_items.count]
  }
}

La definición de estos campos en la vista orders expone los campos Created Date, ID, Status, User ID y Count en el selector de campos de la exploración Orders.

Los usuarios con acceso a la exploración de Pedidos pueden seleccionar y filtrar estos campos para consultar la exploración de Pedidos.

Además de las dimensiones y las mediciones, también puedes crear varias dimensiones basadas en el tiempo a la vez con los grupos de dimensiones o especificar un filtro para tus usuarios con los campos de filtro. Visita la página de documentación de Ver parámetros para obtener más información sobre los parámetros de LookML en archivos de vista y visita la página de documentación de Parámetros de campos para obtener información sobre los parámetros de LookML que se usan para definir las dimensiones, las medidas, los grupos de dimensiones y los campos de filtro en LookML.

Archivos del panel

Looker admite dos tipos de paneles:

  • Paneles definidos por el usuario, que pueden crear los usuarios que no son desarrolladores sin usar LookML. Para obtener más detalles, consulta la página de documentación Crea paneles definidos por el usuario.
  • Paneles de LookML, que se almacenan como archivos con control de versión asociados con el proyecto.

Si tu proyecto contiene paneles de LookML, se definirán en archivos de paneles dedicados en el IDE, con la extensión .dashboard.lookml.

Para obtener más información sobre los paneles de LookML, consulta la página de documentación Crea paneles de LookML.

Archivos de documento

Los archivos de documentos de Looker te permiten escribir documentación o notas sobre tu modelo de datos de Looker con Markdown con formato de GitHub. Esto puede ser útil para que los usuarios conozcan cómo tu organización usa Looker.

Consulta la página de documentación Administra archivos y carpetas de LookML para obtener instrucciones sobre cómo crear archivos de proyectos de LookML, incluidos los archivos de documentos.

Cómo ver el documento fuera del IDE

Para ver un documento fuera del IDE, lo que deberás hacer para aprovechar las funciones de navegación que se describen en esta página, elige la opción Ver documento en el menú Ver acciones del archivo del archivo del documento:

Puedes distribuir la URL de la página resultante a otros usuarios, de modo que no deban navegar por la sección para desarrolladores de Looker para llegar a ella.

Cómo agregar una estructura de navegación a tu documento

Puedes agregar una barra lateral a tus archivos de documento para que los usuarios puedan ver con facilidad la estructura de la información y navegar entre documentos.

Para agregar navegación en la barra lateral de un documento, crea una sección de navegación que comience en la primera línea del documento. Marca el inicio y el final de la sección de navegación con tres guiones (---).

Puedes usar los siguientes parámetros en la sección de navegación:

Puedes usar navigation: true en un archivo de documento para agregar la barra lateral de navegación a ese documento. Por ejemplo, puedes agregar el siguiente código en la parte superior de un archivo de Markdown:

---
navigation: true
---

Este código agrega al documento una barra lateral de navegación con vínculos a todos los documentos del proyecto. Si solo incluyes navigation: true en un documento, la barra lateral de ese documento mostrará todos los documentos del proyecto en orden alfabético por nombre de archivo.

Además, es posible que la organización por nombre de archivo alfabético no sea ideal, o que tengas algunos documentos que no deseas que aparezcan en la navegación:

La barra lateral enumera el Documento cuatro, el Documento Uno, el Documento tres y el Documento dos en orden alfabético, junto con un documento titulado No mostrar.

En este ejemplo, es posible que quieras enumerar los documentos Documento uno, Documento dos, Documento tres y Documento cuatro en orden numérico en lugar de alfabético, y ocultar la opción No mostrar del documento en la barra lateral de navegación.

Para cambiar el orden de los documentos en la barra lateral de navegación o mostrar solo un subconjunto de tus documentos en la barra lateral, puedes usar este formato:

---
navigation:
  - document_one
  - document_two
  - document_three
  - document_four
---

Ahora, la navegación mostrará solo los archivos de documentos que quieras mostrar y aparecerán en un orden más lógico:

La barra lateral muestra los documentos en orden numérico, y el documento "No mostrar" ya no aparece.

title

De forma predeterminada, la barra lateral muestra el encabezado del documento (si el documento comienza con un encabezado) o el nombre del archivo si no hay un encabezado en el archivo. Puedes agregar un parámetro title en la parte superior de un documento para cambiar la forma en que se muestra en las barras laterales de navegación:

---
title: New Title for Users
---

Este título se usará como texto del vínculo en las barras laterales de navegación de todos los documentos, a menos que especifiques un label diferente en la sección de navegación de un documento.

label

Si deseas cambiar la forma en que se muestra un documento en la barra lateral de navegación, puedes usar los parámetros document y label de la siguiente manera:

---
navigation:
  - document_one
  - document: document_two
    label: Customized Label for Document Two
  - document_three
  - document_four
---

El valor label define cómo se muestra un documento en la navegación de la barra lateral, incluso si el documento al que hace referencia tiene su propio parámetro title.

El ejemplo anterior se ve de la siguiente manera en la barra lateral del documento:

La página document_two aparece como Etiqueta personalizada para el documento dos en la barra lateral.

section

Si quieres dividir la barra lateral de navegación en secciones, puedes usar el parámetro section de la siguiente manera:

---
navigation:
  - document_one
  - document_two
  - section: My Section Name
  - document_three
  - document_four
---

En este ejemplo, el parámetro section agrega un corte de sección y el encabezado de texto My Section Name a la barra lateral.

El encabezado del texto no es un vínculo en sí mismo. no hace referencia a ninguno de los archivos de tus documentos.

Archivos de datos

Los archivos de datos son archivos JSON con la extensión de archivo .json, .topojson o .geojson.

El parámetro map_layer te permite usar un archivo JSON como un mapa personalizado que luego se puede usar para trazar tus datos en Looker.

Luego, se utiliza el parámetro map_layer_name con una dimensión para asociar un valor de datos (como "París") con una región geográfica en tu mapa personalizado.

Puedes editar un archivo JSON en el IDE de LookML y, luego, seleccionar Guardar.

Para depurar, puedes elegir Ver sin procesar seleccionando el menú Ver acciones del archivo junto al nombre del archivo para verlo en formato sin procesar. Si tienes la extensión adecuada para ver JSON en el navegador, también podrás ver el archivo en formato Analizado.

Consulta la página de documentación Administra archivos y carpetas de LookML para obtener instrucciones sobre cómo subir un archivo JSON a un proyecto de LookML.

Archivos de manifiesto del proyecto

Tu proyecto puede contener un archivo de manifiesto de proyecto, que se usa para las siguientes tareas:

Cada proyecto solo puede tener un archivo de manifiesto. Debe llamarse manifest.lkml y ubicarse en el nivel raíz de la estructura del directorio del proyecto y en tu repositorio de Git.

Consulta la página de documentación Cómo administrar archivos y carpetas de LookML para obtener instrucciones sobre cómo crear archivos de proyectos de LookML, incluidos los archivos de manifiesto del proyecto.

Archivos de bloqueo del manifiesto

Los archivos de bloqueo de manifiesto se crean automáticamente cuando se agrega una dependencia remota al archivo de manifiesto del proyecto. Looker usa el archivo de bloqueo de manifiesto para hacer un seguimiento de la versión de los proyectos remotos que se especifican en el archivo de manifiesto. El archivo de bloqueo del manifiesto aparece en el panel del navegador de archivos del IDE de Looker y tiene el nombre de archivo manifest_lock.lkml.

Los desarrolladores de Looker no necesitan crear ni editar un archivo de bloqueo de manifiesto, ya que Looker administra automáticamente los archivos de bloqueo.

Para obtener más información, consulta la página de documentación Cómo importar archivos de otros proyectos.

Archivos de cadenas de configuración regional

Si estás localizando tu modelo de datos, deberás crear archivos de cadenas de configuración regional para cada configuración regional que quieras localizar, incluida la configuración regional predeterminada (por ejemplo, a menudo, inglés en EE.UU.).

Los archivos de cadenas de configuración regional enumeran pares clave-valor para cada etiqueta y descripción que localizas en tu modelo. El archivo de cadenas de cada configuración regional debe proporcionar la traducción de esa configuración regional para cada etiqueta o descripción. En la página de documentación Localiza tu modelo de LookML, encontrarás más información para crear archivos de cadenas de configuración regional.

Consulta la página de documentación Cómo administrar archivos y carpetas de LookML para obtener instrucciones sobre cómo crear archivos de proyecto de LookML, incluidos los archivos de cadenas de configuración regional.

Explorar archivos

Una exploración es una vista que los usuarios pueden consultar. Una exploración es el punto de partida de una consulta o, en términos de SQL, el FROM en una instrucción de SQL. Consulta la página de documentación Cómo ver y explorar exploraciones en Looker para obtener información sobre cómo los usuarios interactúan con las exploraciones para consultar tus datos.

Por lo general, las exploraciones se definen dentro de un archivo de modelo. Sin embargo, en ocasiones, necesitas un archivo de exploración independiente para una tabla derivada o para extend o definir mejor una exploración en diferentes modelos.

Consulta la página de documentación Administra archivos y carpetas de LookML para obtener instrucciones sobre cómo crear archivos de proyectos de LookML, incluidos los archivos de Explorar.

Archivos de prueba de datos

Es posible que tu proyecto tenga archivos de prueba de datos que se usan para verificar la lógica de tu modelo de LookML. Las pruebas de datos pueden estar contenidas en archivos de modelos o de vista, pero si tus desarrolladores quieren usar las mismas pruebas de datos en varios modelos diferentes, puede ser útil mantenerlas en su propio archivo dedicado.

Consulta la página de documentación Cómo administrar archivos y carpetas de LookML para obtener instrucciones para crear archivos de proyectos de LookML, incluidos los archivos de prueba de datos.

Archivos de mejoras

Es posible que tu proyecto tenga archivos que se usan para definir mejor LookML. Con las mejoras de LookML, puedes adaptar una vista o una Exploración existente sin editar el archivo de LookML que la contiene. Las mejoras de LookML se pueden incluir en archivos de modelo, vista o Explorar, o en su propio archivo exclusivo.

Consulta la página de documentación Administra archivos y carpetas de LookML para obtener instrucciones sobre cómo crear archivos de proyectos de LookML, incluidos los archivos de mejoras.

Otros archivos

Muchos elementos de LookML se pueden alojar en diferentes archivos de tu proyecto o en sus propios archivos dedicados. Por ejemplo, las pruebas de datos se pueden alojar en archivos de modelos, archivos de vistas o sus propios archivos .lkml dedicados.