Referência de expressão de MAQL

O guia de referência da expressão MAQL fornece uma lista abrangente de funções, operadores e palavras-chave da MAQL que estão disponíveis nas abas Agregação, Numérico, Granularidade, Lógica e Filtros do Editor de Métricas Personalizadas.

Agregação

As funções de agregação são funções matemáticas simples que podem ser executadas em seus fatos para criar métricas. Uma métrica de exemplo retorna a quantidade total de ganho sobre vendas, somando os números de vendas individuais armazenados como um fato.

FunçãoDescrição
AVGRetorna o valor médio de todos os números no conjunto (por exemplo, Salário pago). Valores nulos são ignorados. ConsulteAVG.
RUNAVGMédia corrente de todos os valores de um fato ou métrica. ConsulteTotais correntes para funções principais.
CORRELRetorna o coeficiente de correlação que varia entre -1 e 1. Correlação indica o grau de associação entre dois conjuntos de valores. Consulte CORREL.
COUNTRetorna o número de valores únicos de um atributo no contexto disponível. Consulte COUNT.
COVAR/COVARPRetorna a covariância estatística – como dois conjuntos de valores se alteram com base em uma amostra da população (COVAR) ou com base em uma população polarizada (COVARP). Consulte Funções de covariância.
FORECASTRetorna estimativas de regressão linear de até 10 períodos futuros com base nos dados existentes. O segundo parâmetro é o número de períodos; o padrão é 3. ConsulteFORECAST - Adicionar uma linha de tendência a um relatório.
MAXRetorna o valor máximo de todos os números no conjunto (por exemplo, Salário pago).
RUNMAXMáximo corrente de todos os valores de um fato ou métrica. Consulte Totais correntes para funções principais.
MEDIANConta a mediana estatística, ou seja, uma estatística de ordem que fornece o valor "intermediário" de uma amostra. Se o "intermediário" estiver entre dois valores, a função retornará a média dos dois valores intermediários. Valores nulos são ignorados. Consulte Mediana.
MINRetorna o valor mínimo de todos os números no conjunto (por exemplo, Salário pago). Consulte MIN.
RUNMINMínimo corrente de todos os valores de um fato ou métrica. Consulte Totais correntes para funções principais.
PERCENTILERetorna o k-ésimo percentil de valores em um intervalo – k é especificado no segundo parâmetro por um número decimal ou uma percentagem. Consulte PERCENTILE.
RSQRetorna o quadrado do coeficiente de correlação. Consulte Funções de mínimos quadrados.
STDEVRetorna o desvio-padrão estatístico de todos os valores no conjunto com base em uma amostra da população (STDEV) ou com base em uma população polarizada (STDEVP). Consulte Funções de desvio padrão.
RUNSTDEVO desvio padrão corrente entre um conjunto de fatos ou valores métricos. Consulte Funções estatísticas de totais correntes.
SUMRetorna uma soma de todos os números no conjunto (por exemplo, Salário pago). Consulte SUM.
RUNSUMSoma corrente de todos os valores de um fato ou métrica. Consulte Totais correntes para funções principais.
VAR/VARPRetorna a variação estatística, ou seja, até que ponto um conjunto de valores é distribuído com base em uma amostra da população (VAR) ou com base em uma população polarizada (VARP). A variação não é negativa. Zero indica que todos os valores são idênticos. Consulte Funções de variância.
RUNVARVariância corrente entre dois conjuntos de valores. Consulte Funções estatísticas de totais correntes.

Numérico

Funções numéricas executam operações matemáticas em fatos ou métricas. Essas funções podem ser operadores aritméticos simples (consulte Operações aritméticas) ou cálculos mais sofisticados.

FunçãoDescrição
+, -, *, /Calcula expressões aritméticas simples. A divisão por zero retorna um valor NULL. Consulte Operações aritméticas.
ABSRetorna um valor absoluto de um número (por ex., Receita). Consulte ABS.
EXPRetorna e elevado à potência de um número (por ex., Taxa anual). Consulte EXP.
IFNULLRetorna um valor de substituição, especificado no segundo parâmetro da função IFNULL, no lugar do valor NULL. Quando usada em uma expressão, uma junção externa é aplicada no nível de dados. Consulte IFNULL.
LOG

LOG retorna o logaritmo de um número da base especificada, no segundo parâmetro da função LOG. Se o valor da base for omitido, a base 10 será usada. Consulte LOG.

LNLN retorna o logaritmo natural de um número. A função retornará NULL se o número for inferior ou igual a 0. Consulte LN.
POWERRetorna um número elevado à base especificada como segundo parâmetro da função POWER (por exemplo, Taxa de juros, Receita). Resultados complexos e indefinidos são substituídos por NULL. ConsultePOWER.
RANKRetorna uma classificação numérica dos valores de métrica em ordem crescente (o menor valor em primeiro lugar), padrão, ou decrescente (o maior valor em primeiro lugar). ConsulteClassificação.  Obs.: consulte também Cláusula WITHIN.

ROUND

Arredonda um valor de fato ou métrica para a casa decimal especificada no segundo parâmetro. ConsulteROUND.

FLOOR

Arredonda um valor de entrada para o inteiro mais próximo menor que ele. ConsulteFLOOR.

CEILING

Arredonda um valor de entrada para o inteiro mais próximo maior que ele. ConsulteCEILING.

TRUNC

Trunca um número com base na casa decimal especificada no segundo parâmetro. ConsulteTRUNC.
SIGNRetornará -1 se o número for negativo, 0 se o número for zero ou 1 se o número for positivo. ConsulteSIGN.
SQRTRetorna a raiz quadrada de um número (por exemplo, Receita); se negativo, retorna NULL. ConsulteSQRT.

* As funções ROUND e TRUNCATE aceitam um ou dois parâmetros, sendo o segundo o número de casas decimais (pode ser negativo); se omitido, o número é arredondado/truncado para o inteiro mais próximo. Um valor NULL em qualquer uma das funções de arredondamento retorna NULL.

Palavras-chave de granularidade

As palavras-chave de granularidade a seguir podem ser usadas para definir o nível de agregação da expressão MAQL. Se sua métrica contiver várias palavras-chave, elas deverão ser listadas em ordem alfabética.

Palavra-chaveDescrição
BYBloqueia o valor da métrica no nível de agregação especificado pelo atributo, após a instrução BY. Vários atributos separados por vírgulas de diferentes dimensões podem ser especificados. ConsulteBY.
Atributos BY ALLDigamos que gostaríamos de criar a exibição da porcentagem do tempo de resolução não apenas do trimestre ou do ano, mas total. Como o atributo de nível mais alto na dimensão de data é Year, precisamos de uma nova construção BY ALL Year. ConsulteBY ALL.
BY ALL IN ALL OTHER DIMENSIONSIsso bloqueia o valor da métrica no nível de agregação mais alto possível em todas as dimensões; portanto, retorna um total geral que é indivisível. BY ALL IN ALL OTHER DIMENSIONS.
BY Attribute ALL IN ALL OTHER DIMENSIONSEle complementa a instrução BY, especificando como a agregação das métricas deve ser calculada em todas as outras dimensões não especificadas anteriormente na instrução BY. Omitir ALL IN ALL OTHER DIMENSIONS permite que a métrica seja dividida e segmentada em outras dimensões. ConsulteAtributo BY ALL IN ALL OTHER DIMENSIONS.
FOR próximoPor padrão, a função refere-se a valores de período no futuro único. Isto pode ser personalizado, adicionando um segundo parâmetro para a função. ConsulteFOR próximo.
FOR anteriorPor padrão, a função refere-se a valores de um período de tempo anterior. Ele pode ser personalizado adicionando um segundo parâmetro à função. ConsulteFOR anterior.
FOR NextPeriodFunciona de maneira semelhante à função FOR Next, a menos que as funções adaptáveis se adaptem ao contexto do relatório manualmente. Embora a métrica seja definida como FOR NextPeriod(Quarter), por exemplo, a função retorna valores do próximo mês, já que o mês é o atributo de data mais granular nesse relatório. ConsulteFOR NextPeriod.
FOR PreviousPeriodFunciona de maneira semelhante às funções FOR Next e FOR Previous, a menos que as funções adaptáveis se adaptem ao contexto do relatório manualmente. Embora a métrica seja definida como FOR PreviousPeriod(Quarter), por exemplo, a função retorna valores do próximo anterior, já que o mês é o atributo de data mais granular nesse relatório. ConsulteFOR PreviousPeriod.
BY ALL IN ALL OTHER DIMENSIONS EXCEPT (FOR)Adicionar o "atributo EXCEPT FOR" à cláusula BY ALL especifica uma exceção na qual a métrica será dividida e segmentada pelo atributo especificado (e respectiva hierarquia) se o atributo estiver no relatório. ConsulteAtributo BY ALL IN ALL OTHER DIMENSIONS EXCEPT FOR.
WITHINCria os chamados subgrupos, respeitando ou ignorando a dimensionalidade do relatório especificada na parte HOW da página de criação do relatório. ConsulteCláusula WITHIN.
ROWS BETWEENIsso especifica uma janela de rolagem na qual são calculadas as funções de totais correntes (por ex., RUNAVG). Consulte Janela de rolamento.
OVER...TOA sintaxe OVER ...TO pode reduzir o número e a complexidade das permissões de dados em seu modelo de dados lógicos. Consulte Casos de uso de permissões de dados avançadas.

Operadores lógicos

Os operadores lógicos a seguir podem ser usados para combinar filtros e aplicar condições às suas expressões MAQL.

OperadorDescrição
ANDSe ambas as expressões forem verdadeiras (por exemplo, não FALSE nem NULL), o resultado será verdadeiro. Em todos os outros casos, o resultado é falso.  Se você combinar filtros usando AND, os dois filtros serão aplicados ao calcular a métrica. ConsulteAND.
CASECASE é uma declaração condicional que executa testes lógicos em uma série de condições e retorna valores quando a condição é atendida. ConsulteCASE.
IF/THEN/ELSEA instrução retorna um dos dois valores possíveis ou executa um dos dois cálculos possíveis, com base na condição atendida. Como a instrução é usada dentro de uma métrica, use apenas valores numéricos na parte THEN da instrução. ConsulteIF THEN ELSE.
NOTSe especificar um filtro e preceder com NOT, então tudo o que for especificado pelo filtro será excluído do cálculo. ConsulteNOT.
ORSe a expressão for verdadeira, então o resultado é verdadeiro. Se ambas as expressões forem falsas, o resultado será falso. Se você combinar filtros usando OR, o resultado será calculado individualmente para cada filtro e os resultados serão combinados. ConsulteOR.

Expressões de filtro

Filtros permitem restringir o conjunto de dados a partir do qual uma métrica é calculada através da segmentação dos valores de atributo que você deseja incluir ou excluir da consideração.

Por exemplo, uma métrica mostrando as vendas de uma determinada região.

OperadorDescrição
= (igual), <> (diferente de), > (maior que), < (menor que), >= (maior que ou igual), <= (menor que ou igual)ConsulteOperador Igual, Operador Diferente de, e Outros operadores relacionais.
BETWEENCalcula a métrica usando valores de atributos, métricas ou macros, de um intervalo especificado (incluindo/excluindo pontos de extremidade). ConsulteBETWEEN.
NOT BETWEENCalcula a métrica usando valores de atributos, métricas ou macros, fora de um intervalo especificado (incluindo/excluindo pontos de extremidade). ConsulteNOT BETWEEN.
INCalcula a métrica de vários valores de atributo. ConsulteIN.
NOT INCalcula a métrica pelo atributo especificado, excluindo os valores de atributo listado. ConsulteNOT IN.
TOP (%)Retorna os membros que se encaixam na condição especificada, definida como métrica. O número de membros que se encaixam no conjunto de saída pode ser especificado por um número ou uma porcentagem. Baseado em valores de métrica. A condição TOP(3) retorna todos os membros que se encaixam nela, que pode ter mais que três linhas. ConsulteClassificações TOP e BOTTOM estendidas.
BOTTOM (%)

Retorna os membros que se encaixam na condição especificada, definida como métrica. O número de membros que se encaixam no conjunto de saída pode ser especificado por um número ou uma porcentagem. Baseado em valores de métrica. A condição BOTTOM(3) retorna todos os membros que se encaixam nela, que pode ter mais que três linhas. ConsulteClassificações TOP e BOTTOM estendidas.

WITH PARENT FILTERCalcula a métrica, aplicando filtros aplicados em todos os níveis acima da métrica (métrica, relatório ou dashboard). Este é o comportamento padrão. ConsulteFiltros PRINCIPAIS.
WITH PARENT FILTER EXCEPTInclui todos os filtros principais, exceto os filtros especificados como uma lista de atributos separados por vírgulas. Filtros de atributo de exceção são aplicados para o atributo especificado e todos os atributos de granularidade maior na hierarquia. ConsulteFiltros PRINCIPAIS.
WITHOUT PARENT FILTERCalcula a métrica independentemente de qualquer filtro especificado nela. Obs.: Essa cláusula permite o cálculo de um valor (por exemplo, soma) para todos os anos, mesmo que alguns anos tenham ficado fora do filtro da métrica, do relatório ou do dashboard principal. ConsulteFiltros PRINCIPAIS.
WITHOUT PARENT FILTER EXCEPTRemove os filtros principais, exceto os filtros especificados como uma lista de atributos separados por vírgulas. Filtros de atributo de exceção são aplicados para o atributo especificado e todos os atributos de granularidade maior na hierarquia. ConsulteFiltros PRINCIPAIS.
THISA macro THIS referencia o valor atual do atributo especificado da dimensão de data. ConsulteMacro THIS.
PREVIOUSA macro PREVIOUS é usada para selecionar o valor do atributo da dimensão de data imediatamente anterior ao valor atual. ConsulteMacro PREVIOUS.
NEXTA macro NEXT é usada para selecionar o valor do atributo para a dimensão de data imediatamente posterior ao valor atual. ConsulteMacro NEXT.
LIKE, NOT LIKE, ILIKE, NOT ILIKEEssa condição filtra um valor de sequência de rótulo de atributo correspondente a um padrão especificado. O padrão pode conter um ou mais caracteres curinga. ILIKE é equivalente a LIKE, a diferença é que a correspondência não faz distinção entre maiúsculas e minúsculas. Um sublinhado (_) em um padrão corresponde a um único caractere; um sinal de porcentagem (%) corresponde a qualquer número de caracteres. O padrão deve ser colocado entre aspas duplas (""). Consulte Filtragem com a cláusula LIKE.