Filtros basados en plantillas y parámetros Liquid

Este es un tema avanzado para el que se supone que tienes un buen conocimiento preexistente de SQL y LookML.

Looker ofrece automáticamente a los usuarios la capacidad de manipular sus consultas con la creación de filtros, que se basan en dimensiones y medidas. Si bien este método simple se adapta a muchos casos de uso, no puede habilitar todas las necesidades analíticas. Los filtros basados en plantillas y los parámetros Liquid amplían enormemente los posibles casos de uso que puedes admitir.

Desde la perspectiva de SQL, las dimensiones y medidas solo pueden alterar las cláusulas WHERE o HAVING más externas en tu consulta. Sin embargo, es posible que quieras permitir que los usuarios manipulen otras partes de SQL. Ajustar parte de una tabla derivada, ajustar qué tabla de base de datos se consulta o crear dimensiones y filtros multipropósito son solo algunas de las funciones que puedes habilitar con los filtros con plantillas y los parámetros Liquid.

Advertencia: La persistencia no es compatible con las tablas derivadas que usan filtros con plantillas o parámetros Liquid.

Los filtros con plantillas y los parámetros Liquid usan el lenguaje de plantillas Liquid para insertar entradas del usuario en las consultas en SQL. Primero, usas un parámetro de LookML para crear un campo con el que los usuarios puedan interactuar. A continuación, usarás una variable Liquid para inyectar la entrada del usuario en las consultas en SQL.

Ejemplos

Veamos algunos ejemplos para demostrar el valor de los filtros con plantilla y los parámetros Liquid.

Crea una tabla derivada dinámica con un filtro con plantilla

Considera el caso de una tabla derivada que calcule la inversión total del cliente, dentro de la región nordeste:

view: customer_facts {
  derived_table: {
    sql:
      SELECT
        customer_id,                        -- Can be made a dimension
        SUM(sale_price) AS lifetime_spend   -- Can be made a dimension
      FROM
        order
      WHERE
        region = 'northeast'                -- Can NOT be made a dimension
      GROUP BY 1
    ;;
  }
}

En esta consulta, puedes crear dimensiones a partir de customer_id y lifetime_spend. Sin embargo, supongamos que deseas que el usuario pueda especificar el region, en lugar de codificarlo en el "nordeste". El elemento region no se puede exponer como una dimensión, por lo que el usuario no puede filtrarlo como de costumbre.

Una opción sería utilizar un filtro basado en una plantilla, que se vería de la siguiente manera:

view: customer_facts {
  derived_table: {
    sql:
      SELECT
        customer_id,
        SUM(sale_price) AS lifetime_spend
      FROM
        order
      WHERE
        {% condition order_region %} order.region {% endcondition %}
      GROUP BY 1
    ;;
  }

  filter: order_region {
    type: string
  }
}

Lee más a continuación para obtener instrucciones paso a paso.

Si una tabla derivada utiliza un filtro con plantilla, no puedes hacer que la tabla sea persistente.

Cómo realizar una medición dinámica con un parámetro Liquid

Considera una medición filtrada que sume la cantidad de pantalones vendidos:

measure: pants_count {
  filters: [category: "pants"]
}

Esto es sencillo, pero si hubiera decenas de categorías, sería tedioso crear una medición para cada una. Además, puede desordenar la experiencia de Explorar para los usuarios.

Una alternativa sería crear una medición dinámica como la siguiente:

measure: category_count {
  type: sum
  sql:
    CASE
      WHEN ${category} = '{% parameter category_to_count %}'
      THEN 1
      ELSE 0
    END
  ;;
}

parameter: category_to_count {
  type: string
}

Lee más a continuación para obtener instrucciones paso a paso.

Uso básico

Paso uno: Crea algo con lo que el usuario interactúe

• Para los filtros basados en plantillas, agrega un filter.
• Para los parámetros Liquid, agrega un parameter.

En cualquier caso, estos campos se mostrarán al usuario en la sección Campos de solo filtro del selector de campos.

Los campos filter y parameter pueden aceptar una serie de parámetros secundarios, lo que te permite personalizar la forma en que funcionan. Consulta la página de documentación Parámetros de campo para obtener una lista completa. Existen dos opciones que tienen una mención especial para los campos parameter.

Primero, los campos parameter pueden tener un tipo especial llamado sin comillas:

parameter: table_name {
  type: unquoted
}

Este tipo permite insertar valores en SQL sin encerrarse entre comillas, como lo haría una cadena. Esto puede ser útil cuando necesites insertar valores SQL, como nombres de tablas.

En segundo lugar, los campos parameter tienen una opción llamada valores permitidos que te permiten asociar un nombre fácil de usar con el valor que deseas insertar. Por ejemplo:

  parameter: sale_price_metric_picker {
    description: "Use with the Sale Price Metric measure"
    type: unquoted
    allowed_value: {
      label: "Total Sale Price"
      value: "SUM"
    }
    allowed_value: {
      label: "Average Sale Price"
      value: "AVG"
    }
    allowed_value: {
      label: "Maximum Sale Price"
      value: "MAX"
    }
    allowed_value: {
      label: "Minimum Sale Price"
      value: "MIN"
    }
  }

Paso dos: Aplica la entrada del usuario

El segundo paso es usar Liquid para agregar el filtro con plantilla o el parámetro Liquid como desees.

Filtros basados en plantillas

La sintaxis de los filtros con plantillas se desglosa de la siguiente manera:

{% condition filter_name %} sql_or_lookml_reference {% endcondition %}

• Las palabras condition y endcondition no cambian nunca.
• Reemplaza filter_name por el nombre del filtro que creaste en el primer paso. Si no creaste un campo de solo filtro, también puedes utilizar una dimensión.
• Reemplaza sql_or_lookml_reference por SQL o LookML que debe establecerse como “igual” a la entrada del usuario (lee más detalles a continuación). Si usas LookML, usa la sintaxis de LookML ${view_name.field_name}.

En el ejemplo anterior, Cómo crear una tabla derivada dinámica con un filtro con plantilla, usamos lo siguiente:

{% condition order_region %} order.region {% endcondition %}

Es importante comprender la interacción entre las etiquetas Liquid y el SQL que escribes entre ellas. Las etiquetas de filtro con plantilla siempre se transforman en una expresión lógica. Por ejemplo, si el usuario ingresó “Nordeste” en el filtro order_region, Looker convertirá estas etiquetas en order.region = 'Northeast'. En otras palabras, Looker comprende la entrada del usuario y genera la expresión lógica adecuada.

Esto suele ser un punto de confusión entre los desarrolladores de Looker. Los filtros con plantilla siempre dan como resultado una expresión lógica de algún tipo y no el valor individual ingresado por un usuario.

Debido a que los filtros con plantillas muestran una expresión lógica, puedes usarlos con otros operadores lógicos y expresiones lógicas que sean válidas en la sentencia WHERE de SQL. Con el ejemplo anterior, si quieres mostrar todos los valores excepto la región que seleccionó el usuario, podrías usar lo siguiente en la sentencia WHERE:

NOT ({% condition order_region %} order.region {% endcondition %})

También es válido usar un campo de LookML como condición del filtro. Cualquier filtro aplicado directamente al campo de LookML determinará el valor de la declaración WHERE:

view: customer_facts {
  derived_table: {
    sql:
      SELECT
        customer_id,
        SUM(sale_price) AS lifetime_spend
      FROM
        order
      WHERE
        {% condition region %} order.region {% endcondition %}
      GROUP BY 1
    ;;
  }

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

Parámetros líquidos

La sintaxis de los parámetros Liquid se desglosa de la siguiente manera:

{% parameter parameter_name %}

• La palabra parameter nunca cambia.
• Reemplaza parameter_name por el nombre del parameter que creaste en el primer paso.

Por ejemplo, para aplicar la entrada del campo parameter en el paso uno, puedes crear una medición como la siguiente:

  measure: sale_price_metric {
    description: "Use with the Sale Price Metric Picker filter-only field"
    type: number
    label_from_parameter: sale_price_metric_picker
    sql: {% parameter sale_price_metric_picker %}(${sale_price}) ;;
    value_format_name: usd
  }

Elige entre filtros con plantillas y parámetros Liquid

Aunque los filtros con plantillas y los parámetros Liquid son similares, existe una diferencia importante entre ellos:

• Los parámetros líquidos insertan la entrada del usuario directamente (o mediante los valores que definas con los valores permitidos).
• Los filtros con plantillas insertan valores como sentencias lógicas, como se describe en la sección Filtros con plantillas.

En situaciones en las que desees ofrecer a los usuarios entradas más flexibles (como con varios tipos de períodos o búsquedas de cadenas), intenta utilizar filtros basados en plantillas cuando sea posible. Looker puede interpretar las entradas del usuario y escribir el SQL adecuado en segundo plano. Esto evita que tengas que tener en cuenta todos los tipos posibles de entradas del usuario.

En situaciones en las que no se puede insertar una instrucción lógica o cuando conoces un conjunto limitado de opciones que el usuario podría ingresar, usa los parámetros Liquid.