RETENTION (Lakehouse v1)

Função de agregação

A função RETENTION() recebe como argumentos um conjunto de 1 a 32 condições do tipo UInt8 que indicam se uma determinada condição foi atendida para o evento.

Qualquer condição pode ser especificada como argumento (como em WHERE).

As condições, exceto a primeira, são aplicadas em pares: o resultado da segunda será verdadeiro se a primeira e a segunda forem verdadeiras, o da terceira se a primeira e a terceira forem verdadeiras, e assim por diante.

Sintaxe do Analyze

func.retention(<cond1> , <cond2> , ..., <cond32>)

Exemplos do Analyze

table.user_id, func.retention(table.event_type=='signup', table.event_type='login', table.event_type='purchase').alias('sales_amounts')

| user_id | retention |
|---------|-----------|
|   1     | [1, 1, 0] |
|   2     | [1, 0, 1] |
|   3     | [1, 1, 0] |

Sintaxe SQL

RETENTION( <cond1> , <cond2> , ..., <cond32> );

Argumentos

Argumentos	Descrição
<cond>	Uma expressão que retorna um resultado booleano

Tipo de retorno

O array de 1 ou 0.

Exemplos de SQL

Criar uma tabela e inserir dados de exemplo

CREATE TABLE user_events (
  id INT,
  user_id INT,
  event_date DATE,
  event_type VARCHAR
);

INSERT INTO user_events (id, user_id, event_date, event_type)
VALUES (1, 1, '2022-01-01', 'signup'),
       (2, 1, '2022-01-02', 'login'),
       (3, 2, '2022-01-01', 'signup'),
       (4, 2, '2022-01-03', 'purchase'),
       (5, 3, '2022-01-01', 'signup'),
       (6, 3, '2022-01-02', 'login');

Demonstração de consulta: calcular a retenção de usuários com base nos eventos de inscrição, login e compra

SELECT
  user_id,
  RETENTION(event_type = 'signup', event_type = 'login', event_type = 'purchase') AS retention
FROM user_events
GROUP BY user_id;

Resultado

| user_id | retention |
|---------|-----------|
|   1     | [1, 1, 0] |
|   2     | [1, 0, 1] |
|   3     | [1, 1, 0] |