incluir

Uso

incluir: "/views/airports.view"

Jerarquía Archivo del modelo include - o - Ver archivo include - o - explore include

Valor predeterminado Ninguna Acepta Una string que contiene un nombre de archivo o patrón

Definición

El parámetro include especifica los archivos de LookML que estarán disponibles para un modelo, una vista o una exploración. Si deseas usar un archivo LookML o hacer referencia a él dentro de otro archivo, debes agregarlo con el parámetro include.

Puedes usar el parámetro include en los archivos de modelo, ver archivos y explorar archivos. El parámetro include puede hacer referencia a diferentes tipos de archivos LookML, según el contexto.

En un archivo de modelo, puedes usar include para hacer referencia a lo siguiente:

• Cómo ver archivos
• Archivos del panel
• Cómo explorar archivos
• Archivos de prueba de datos

En un archivo de vista, puedes usar include para hacer referencia a lo siguiente:

• Cómo ver archivos
• Cómo explorar archivos
• Archivos de prueba de datos

En un archivo de Explorar, puedes usar include para hacer referencia a lo siguiente:

• Cómo ver archivos
• Cómo explorar archivos

También puedes usar include para incorporar archivos de otros proyectos. Consulta la página de documentación Importa archivos de otros proyectos para obtener información sobre cómo incluir archivos de otro proyecto. Para importar archivos de proyectos de LookML locales, debes habilitar la función Importación de proyectos locales de Labs.

Ten en cuenta lo siguiente cuando uses include:

• No necesitas usar include para tipos de archivos que no sean de LookML, como los archivos de documentación o los archivos de datos.
• Incluir archivos es todo o nada, por lo que toda la información del archivo incluido se agrega al archivo incluido.
• Puedes usar varios parámetros include en un archivo.
• Puedes usar el carácter comodín * para indicar archivos con convenciones de nomenclatura estratégica o con la misma extensión. Por ejemplo, puedes usar "*base.dashboard" para que coincidan y se incluyan "database.dashboard" y "crunchbase.dashboard". Puedes usar "*.dashboard" para indicar todos los archivos con la extensión .dashboard.
• Puedes usar el carácter comodín * para incluir todos los archivos en un directorio. Por ejemplo, puedes incluir todos los archivos de vista en el directorio views/users/ si especificas include: "/views/users/*.view". Consulta la página de documentación sobre las carpetas IDE para obtener más información sobre el uso de comodines con carpetas IDE.

Sugerencia útil: Cuando usas comodines, puedes desplazarte sobre el ícono de información por el número de línea del archivo o hacer clic en la sentencia include y consultar la ayuda rápida para verificar qué archivos se incluyen:

Sugerencia práctica: Para copiar la ruta de un archivo, seleccione Copiar ruta de archivo en el menú de tres puntos del archivo del IDE de Looker:

Usa include en un archivo de modelo

Puedes usar el parámetro include en un archivo de modelo para incluir vistas y paneles o exploraciones.

Incluye vistas y paneles en un modelo

Usa el parámetro include en un archivo de modelo a fin de especificar el panel y ver los archivos que estarán disponibles para ese modelo. Si deseas usar un archivo LookML o hacer referencia a él dentro de un modelo, debes agregarlo con el parámetro include.

En el parámetro include, usa la extensión .view para los archivos de vista y la extensión .dashboard para los paneles. Puedes omitir las secciones .lkml y .lookml de estas extensiones.

Puedes usar el carácter comodín * para indicar archivos con convenciones de nomenclatura estratégica o con la misma extensión. También puedes usar el comodín * junto con las rutas de acceso a directorios para especificar varios archivos, como se describe en la sección Ejemplos de comodines de la página de documentación de las carpetas del IDE.

Por ejemplo, puedes usar estos parámetros de include en un archivo de modelo:

include: "/**/*.dashboard"
include: "/*/*base.view.lkml"
include: "//e_commerce/views/*.view.lkml"

Estos parámetros incluirían los siguientes archivos:

• Todos los archivos del panel en cualquier directorio de tu proyecto
• Los archivos de vista que terminan en base.view.lkml en cualquier directorio secundario inmediato del proyecto, como /views/database.view.lkml o /public/crunchbase.view.lkml
• Todos los archivos de vista del directorio /views/ del proyecto importado se denominan e_commerce

Si tu proyecto tiene una gran cantidad de archivos de vista o si usa tablas derivadas persistentes (PDT), debes evitar incluir todos los archivos de vista en tu modelo. En su lugar, incluye archivos de vista individuales como este. A continuación, se muestra un ejemplo de cómo incluir archivos de vista individuales y todos los paneles de un proyecto:

include: "/views/order.view"
include: "/views/user.view"
include: "/**/*.dashboard"

Incluir modelos en un modelo

No puedes incluir un archivo de modelo de otro proyecto. En su lugar, para reutilizar, definir mejor o extender las exploraciones en todos los proyectos, en el proyecto importado, puede crear un archivo de Explorar independiente y, luego, incluirlo en otros proyectos. Consulta Cómo incluir exploraciones en un modelo para obtener más información.

Cómo incluir Explorar en un modelo

Los archivos de Explorar detectarán la conexión del modelo en el que se incluyen. Tenga en cuenta este hecho cuando incluya archivos de Explorar en modelos configurados con una conexión diferente del modelo superior del archivo de Explorar. Si el esquema de la conexión del modelo incluido difiere del esquema de la conexión del modelo superior, puede causar errores de consulta.

Por lo general, las exploraciones se definen dentro de un archivo de modelo. Sin embargo, a veces necesita un archivo de Explorar independiente para una tabla derivada o para extender o definir mejor una Explorar en todos los modelos.

Si tienes un archivo Explorar independiente, debes usar el parámetro include en el archivo de modelo para incluirlo. En el parámetro include, usa la extensión .explore.lkml para los archivos de Explorar.

Por ejemplo, a continuación, se muestra un archivo de modelo con dos exploraciones:

• La exploración de aircraft_new, que se define en su propio archivo llamado aircraft_new.explore.lkml en la carpeta explores Dado que Explorar se define en su propio archivo, debes especificar la ruta del archivo en un parámetro include.
• La exploración de accidents, que se define dentro del archivo del modelo Debido a que se define en el archivo de modelo, no necesitas usar un parámetro include para él en el modelo. Sin embargo, necesitas un include para la vista en la que se basa la exploración de accidents.

connection: "faa"

include: "/explores/aircraft_new.explore.lkml"
include: "/views/accidents.view"

explore: accidents {
  view_name: accidents
  from: accidents
}

Incluir pruebas de datos en un modelo

Las pruebas de datos se pueden definir directamente en un archivo de modelo o un archivo de vista. Sin embargo, también puedes crear un archivo de prueba de datos por separado si deseas reutilizar tus pruebas en varios lugares de tu proyecto.

Si tienes un archivo de prueba de datos independiente, debes usar el parámetro include en el archivo de modelo o de visualización para poder ejecutar las pruebas de datos. En el parámetro include, usa la extensión .lkml para los archivos de prueba de datos.

Por ejemplo, a continuación se muestra un extracto de un archivo de modelo que incluye un archivo de prueba de datos:

connection: "faa"

include: "/explores/aircraft_new.explore.lkml"
include: "/views/accidents.view"
include: "/tests/data_tests.lkml"

. . .

Una vez que incluyes el archivo de prueba de datos en un archivo de modelo, puedes ejecutar la prueba de datos para verificar que tu prueba de datos funcione correctamente y ver si la lógica de tu modelo pasa la prueba.

También puede incluir el archivo de prueba de datos en un archivo de vista, como se describe en la sección Cómo incluir pruebas de datos en una vista de esta página.

Usa include en un archivo de vista

En la mayoría de los casos, no es necesario usar include en un archivo de vista. Sin embargo, hay algunos casos en los que sí quieres incluir archivos en tu archivo de vista:

• Si amplías o perfeccionas una vista
• Si tienes un archivo Explore para una tabla derivada

Incluir vistas en una vista (para extenderla o definirla mejor)

También puedes incluir un archivo de vista en otro archivo de vistas para extender o definir mejor la vista incluida.

Por ejemplo, este es el archivo de vista marketing_order_fields que incluye el archivo de vista basic_order_fields y, luego, lo extiende:

include: "/views/basic_order_fields.view"
view: marketing_order_fields {
  extends: [basic_order_fields]  # The file that contains the basic_order_fields
}                                # view should be included

Cómo incluir Explorar en una vista

Los archivos de Explorar detectarán la conexión del modelo en el que se incluyan. Tenga en cuenta este hecho cuando incluya archivos de Explorar en modelos configurados con una conexión diferente del modelo superior del archivo de Explorar. Si el esquema de la conexión del modelo incluido difiere del esquema de la conexión del modelo superior, puede causar errores de consulta.

En la mayoría de los casos, no es necesario incluir una pestaña Explorar en una vista. Sin embargo, las tablas derivadas nativas son un caso especial, ya que se definen en su propio archivo de vista que tiene un parámetro explore_source. Usa el parámetro explore_source a fin de especificar una exploración y definir las columnas deseadas y otras características deseadas para la tabla derivada nativa. Por lo general, las exploraciones se definen dentro de un archivo de modelo, pero en el caso de las tablas derivadas nativas, puede ser más limpio crear un archivo separado para Explorar con la extensión de archivo .explore.lkml. Si crea un archivo de Explorar independiente, debe incluir el archivo de Explorar en el archivo nativo de vista de tabla derivada.

A continuación, se muestra un ejemplo del uso de include en un archivo de vista de tabla derivada nativa para apuntar a un archivo de Explorar:

include: "/explores/order_items.explore.lkml"

view: user_order_facts {
  derived_table: {
    explore_source: order_items {
      column: user_id {field: order_items.user_id}
      column: lifetime_number_of_orders {field: order_items.order_count}
      column: lifetime_customer_value {field: order_items.total_revenue}
      derived_column: average_customer_order {
        sql:  lifetime_customer_value / lifetime_number_of_orders ;;
      }
    }
  }
  dimension: user_id {hidden: yes}
  dimension: lifetime_number_of_orders {type: number}
  dimension: lifetime_customer_value {type: number}
  dimension: average_customer_order {type: number}
}

Consulta nuestra documentación sobre el uso de las instrucciones include para habilitar los campos de referencia a fin de obtener más información sobre los archivos de Explorar para tablas derivadas nativas.

Incluye pruebas de datos en una vista

Las pruebas de datos se pueden definir directamente en un archivo de modelo o un archivo de vista. Sin embargo, también puedes crear un archivo de prueba de datos por separado si deseas reutilizar tus pruebas en varios lugares de tu proyecto.

Si tienes un archivo de prueba de datos independiente, debes usar el parámetro include en el archivo de modelo o de visualización para poder ejecutar las pruebas de datos. En el parámetro include, usa la extensión .lkml para los archivos de prueba de datos.

Por ejemplo, a continuación se muestra un extracto de un archivo de vista que incluye un archivo de prueba de datos:

include: "/tests/data_tests.lkml"

view: orders {
  sql_table_name: looker.orders ;;

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

. . .

Una vez que incluyas el archivo de prueba de datos en un archivo de vista, puedes ejecutar la prueba de datos para verificar que la prueba de datos funcione correctamente y ver si la lógica de tu vista pasa la prueba.

También puedes incluir el archivo de prueba de datos en un archivo de modelo, como se describe en la sección Incluye pruebas de datos en un modelo en esta página.

Cómo usar include en un archivo de Explorar

Por lo general, las exploraciones se definen dentro de un archivo de modelo. Sin embargo, a veces necesita un archivo de Explorar independiente para una tabla derivada o para extender o definir mejor una Explorar en todos los modelos.

Si tienes un archivo Explorar independiente, puedes usar el parámetro include para incluir vistas o bien otras exploraciones.

Cómo incluir vistas en Explorar

Si tienes un archivo Explorar aparte, debes incluir las vistas que se usan. Usa la extensión de archivo .view para ver archivos. Puedes omitir la parte .lkml de la extensión de archivo. A continuación, se muestra un ejemplo del archivo Explorar que incluye las dos vistas que utiliza:

include: "/views/aircraft.view"
include: "/views/aircraft_types.view"

explore: aircraft {
  join: aircraft_types {
    type: left_outer
    sql_on: ${aircraft.aircraft_type_id} = ${aircraft_types.aircraft_type_id} ;;
    relationship: many_to_one
  }
}

Cómo incluir Explorar en Explorar

Los archivos de Explorar detectarán la conexión del modelo en el que se incluyan. Tenga en cuenta este hecho cuando incluya archivos de Explorar en modelos configurados con una conexión diferente del modelo superior del archivo de Explorar. Si el esquema de la conexión del modelo incluido difiere del esquema de la conexión del modelo superior, puede causar errores de consulta.

Puedes incluir un archivo de Explorar en otro, como cuando extiendes o defines mejor un archivo de Explorar. Usa el parámetro include y agrega la extensión de archivo .explore.lkml.

Este es un archivo de ejemplo que incluye otro archivo Explorar y después lo extiende:

include: "/explores/base.explore.lkml"

explore: aircraft_information {
  extends: [aircraft]

Ejemplos

Consulta las secciones anteriores para ver ejemplos de uso de include en los archivos del modelo, ver los archivos y explorar los archivos.

Aspectos para tener en cuenta

Uso de comodines

Para los proyectos en los que solo se deben administrar unos pocos archivos, puedes enumerar cada archivo con su propio parámetro include, de la siguiente manera:

include: "/dashboards/user_info.dashboard"
include: "/views/users.view"

En proyectos que incluyen muchos archivos, puedes reducir la cantidad de parámetros include que debes escribir mediante comodines para incluir varios archivos a la vez:

• Usa comodines con carpetas de IDE para incluir archivos en un directorio específico de tu proyecto.
• Usa comodines con extensiones de archivo para incluir archivos de un tipo específico.
• Usa comodines con nombres de archivos estratégicos para incluir archivos con prefijos o sufijos específicos en sus nombres de archivo.

El uso de comodines puede ser especialmente útil durante el desarrollo cuando necesites crear una corrección temporal para las advertencias de validación de LookML, en especial cuando organizas un proyecto existente en carpetas de IDE. Sin embargo, ten en cuenta lo siguiente cuando uses comodines en tus declaraciones include:

• Looker no recomienda el uso de comodines para incluir todos los archivos de vista en un proyecto, ya que incluir todos los archivos de vista puede afectar el rendimiento de la validación de LookML y puede ordenar el esquema de la base de datos.
• Looker no admite el uso de comodines para incluir todos los archivos de un proyecto si este tiene varios archivos de modelo, ya que los archivos de modelo no se pueden incluir en otros archivos de modelo.

Cómo usar comodines con carpetas de IDE

Puedes usar comodines en combinación con las carpetas IDE para incluir archivos en un directorio específico de tu proyecto de LookML.

Por ejemplo, esta declaración include hace referencia a todos los archivos del directorio /explores/ de un proyecto de LookML:

include: "/explores/*"

Usa comodines para tipos de archivos específicos

Puedes usar comodines para hacer referencia a todos los archivos de un tipo específico. Por ejemplo, esta declaración include hace referencia a todos los archivos de Explorar de un proyecto de LookML:

include: "/**/*.explore.lkml"

Consulta la sección Tipos de archivos de proyectos de la página de documentación Archivos de proyectos de LookML para obtener una lista de los tipos de archivos LookML y sus extensiones.

Looker no recomienda el uso de comodines para incluir todos los archivos de vista en un proyecto, ya que incluir todos los archivos de vista puede afectar el rendimiento de la validación de LookML y puede ordenar el esquema de la base de datos.

Usa comodines con patrones estratégicos de nombres

También puedes usar comodines con nombres estratégicos de archivos para optimizar aún más tus declaraciones include. Por ejemplo, en lugar de nombrar archivos como este:

/views/apple.view
/views/banana.view
/views/cherry.view
/views/orange.view
/views/celery.view

Puedes agregar un prefijo o sufijo estratégico a tus nombres de archivo, como se muestra a continuación:

/views/apple.fruit.view
/views/banana.fruit.view
/views/cherry.fruit.view
/views/orange.fruit.view
/views/celery.vegetable.view

Luego, usa comodines para hacer referencia solo al sufijo .fruit con este include:

include: "/views/*.fruit.view"

Incluir todos los archivos de vista puede afectar el rendimiento de la validación de LookML

Si tu proyecto tiene una gran cantidad de archivos de vista e incluyes todos en tu archivo de modelo, esto puede afectar el rendimiento del Validador LookML. Dado que el validador de LookML verifica todos los archivos de vista incluidos en el modelo, debes incluir solo los archivos de vista necesarios en el parámetro include del archivo de modelo.

Considera usar convenciones de nombres estratégicas para los archivos de vista a fin de permitir la inclusión fácil de grupos de vistas dentro de un modelo (consulta el ejemplo Usa comodines con patrones de nomenclatura estratégica en esta página). También puedes usar IDE Folders para organizar tus vistas en carpetas. Luego, puedes usar el comodín * para incluir todas las vistas en una sola carpeta, en lugar de incluir todas las vistas en tu proyecto. Consulta nuestra documentación sobre el uso de include con carpetas IDE para obtener más información.

Incluir todos los archivos de vista puede desordenar el esquema de tu base de datos

Para los proyectos que usan tablas derivadas persistentes (PDT), puedes incluir el archivo de vista de PDT en el archivo de modelo. Sin embargo, cada archivo del modelo que incluya el archivo de vista del PDT creará una copia del PDT en el esquema desde cero de su base de datos. Si tienes varios archivos de modelo y, además, incluyes todos los archivos de vista en tus archivos de modelo, puedes agregar un desorden innecesario al esquema temporal de tu base de datos. Por este motivo, asegúrese de incluir un archivo de vista de PDT solo en los archivos de modelo en los que se necesite.