Filtres basés sur un modèle et paramètres Liquid

Cette rubrique avancée s'adresse aux utilisateurs qui ont déjà une bonne connaissance des langages SQL et LookML.

Looker offre automatiquement aux utilisateurs la possibilité de manipuler leurs requêtes en créant des filtres, qui sont basés sur des dimensions et des mesures. Bien que cette méthode réponde à de nombreux cas d'utilisation, elle ne peut pas répondre à tous les besoins analytiques. Les filtres basés sur un modèle et les paramètres Liquid étendent considérablement les possibilités qui s'offrent à vous.

D'un point de vue SQL, les dimensions et les mesures ne peuvent modifier que les clauses WHERE ou HAVING les plus excentrées d'une requête. Vous pouvez néanmoins autoriser les utilisateurs à manipuler d'autres parties d'une requête SQL. Ajuster une partie d'une table dérivée, choisir la table de base de données à interroger ou créer des dimensions et des filtres polyvalents ne sont que quelques-unes des fonctionnalités que vous pouvez activer avec les filtres basés sur un modèle et les paramètres Liquid.

Avertissement : La persistance n'est pas prise en charge pour les tables dérivées qui utilisent des filtres basés sur un modèle ou des paramètres Liquid.

Les filtres basés sur un modèle et les paramètres Liquid font appel au langage de création de modèles Liquid pour insérer les valeurs saisies par l'utilisateur dans des requêtes SQL. Vous commencez par utiliser un paramètre LookML pour créer un champ avec lequel les utilisateurs peuvent interagir. Ensuite, vous utilisez une variable Liquid pour injecter les entrées utilisateur dans des requêtes SQL.

Examples

Examinons quelques exemples illustrant l'intérêt des filtres basés sur un modèle et des paramètres Liquid.

Création d'une table dérivée dynamique avec un filtre basé sur un modèle

Prenons l'exemple d'une table dérivée qui calcule les dépenses à vie (lifetime_spend) d'un client dans la région nord-ouest (northeast) :

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
    ;;
  }
}

Dans cette requête, vous pouvez créer des dimensions à partir de customer_id et lifetime_spend. Cependant, supposons que vous souhaitiez que l'utilisateur puisse spécifier region, au lieu de le coder en dur en "northeast". Impossible d'afficher l'élément region en tant que dimension. L'utilisateur ne peut donc pas l'utiliser comme d'habitude.

L'une des solutions serait d'utiliser un filtre basé sur un modèle, qui ressemblerait à ceci :

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
  }
}

Pour obtenir des instructions détaillées, consultez la section Utilisation de base.

Remarque :Si une table dérivée utilise un filtre basé sur un modèle, vous ne pouvez pas rendre la table persistante.

Création d'une mesure dynamique avec un paramètre Liquid

Prenons l'exemple d'une mesure filtrée calculant la somme des pantalons (« pants ») vendus :

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

Le principe est simple, mais en présence de dizaines de catégories, il serait fastidieux de créer une mesure pour chacune d'elles. En outre, l'utilisation des explorations n'en serait que plus confuse.

Une autre solution consisterait à créer une mesure dynamique comparable à celle-ci :

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

parameter: category_to_count {
  type: string
}

Pour obtenir des instructions détaillées, consultez la section Utilisation de base.

Utilisation de base

Étape 1 : Créez un élément avec lequel l'utilisateur peut interagir

• Pour les filtres avec modèle, ajoutez un filter.
• Pour les paramètres Liquid, ajoutez un parameter.

Dans les deux cas, ces champs seront présentés à l'utilisateur dans la section Champs de filtre uniquement du sélecteur de champs.

Les champs filter et parameter peuvent accepter une série de paramètres enfants, ce qui permet d'en personnaliser le fonctionnement. Consultez la page de documentation Paramètres de champ pour obtenir la liste complète. Les champs parameter présentent deux particularités :

Tout d'abord, les champs parameter peuvent avoir un type spécial appelé sans guillemets:

parameter: table_name {
  type: unquoted
}

Ce type de champ permet d'insérer des valeurs dans une requête SQL sans les mettre entre guillemets — comme c'est le cas des chaînes —, ce qui peut être utile pour insérer des valeurs SQL telles que des noms de tables.

Ensuite, les champs parameter disposent d'une option appelée valeurs autorisées qui vous permet d'associer un nom convivial à la valeur que vous souhaitez insérer. Exemple :

  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"
    }
  }

Étape 2 : Appliquer l'entrée utilisateur

La seconde étape consiste à utiliser Liquid pour ajouter le filtre basé sur un modèle ou le paramètre Liquid souhaité.

Filtres basés sur un modèle

La syntaxe des filtres basés sur un modèle se décompose de la manière suivante :

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

• Les mots condition et endcondition ne changent jamais.
• Remplacez filter_name par le nom du filtre que vous avez créé à la première étape. Si vous n'avez pas créé de champ réservé au filtrage, vous pouvez également utiliser une dimension.
• Remplacez sql_or_lookml_reference par le code SQL ou LookML qui doit être "égal" à l'entrée utilisateur (cela est expliqué plus en détail plus loin dans cette section). Si vous utilisez LookML, utilisez la syntaxe LookML ${view_name.field_name}.

Dans l'exemple précédent, Créer une table dérivée dynamique avec un filtre basé sur un modèle, nous avons utilisé :

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

Il est important de bien comprendre l'interaction entre le code SQL et les balises Liquid qui l'entourent. Ces balises de filtre modélisées sont toujours transformées en expression logique. Par exemple, si l'utilisateur saisit "Nord-Est" dans le filtre order_region, Looker convertit ces balises en :

order.region = 'Northeast'

Autrement dit, Looker interprète l'entrée utilisateur et génère l'expression logique appropriée.

Remarque : Ce point est souvent une source de confusion pour les développeurs Looker. Les filtres basés sur un modèle génèrent toujours une expression logique d'un type quelconque, et non la valeur individuelle saisie par un utilisateur.

Comme les filtres basés sur un modèle renvoient une expression logique, vous pouvez les utiliser avec d'autres opérateurs et expressions logiques qui sont valides dans l'instruction SQL WHERE. À l'aide de l'exemple précédent, si vous souhaitez renvoyer toutes les valeurs sauf la région sélectionnée par l'utilisateur, vous pouvez utiliser l'instruction WHERE suivante :

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

Il est également possible d'utiliser un champ LookML comme condition de filtre. Tous les filtres appliqués directement au champ LookML détermineront la valeur de l'instruction 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 ;;
}

Paramètres Liquid

La syntaxe des paramètres Liquid se décompose de la manière suivante :

{% parameter parameter_name %}

• Le mot parameter ne change jamais.
• Remplacez parameter_name par le nom parameter que vous avez créé à la première étape.

Par exemple, pour appliquer la valeur saisie dans le champ parameter à l'étape 1, vous pouvez créer une mesure comme suit :

  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
  }

Choix entre les filtres basés sur un modèle et les paramètres Liquid

Malgré leurs similitudes, les filtres basés sur un modèle et les paramètres Liquid présentent une différence de taille :

• Les paramètres Liquid insèrent directement les entrées utilisateur (ou en utilisant les valeurs que vous définissez avec les valeurs autorisées).
• Les filtres avec modèle insèrent des valeurs sous forme d'énoncés logiques, comme décrit dans la section Filtres avec modèle.

Lorsque vous voulez proposer aux utilisateurs un mode de saisie plus souple (différents types de plages de dates ou modes de recherche de chaînes, par exemple), privilégiez si possible les filtres basés sur un modèle. Looker peut interpréter l'entrée utilisateur et écrire le code SQL approprié en arrière-plan, ce qui vous évite de prévoir tous les types d'entrées utilisateur possibles.

Lorsqu'il est impossible d'insérer une instruction logique ou si vous connaissez un ensemble limité d'options que l'utilisateur peut saisir, utilisez les paramètres Liquid.