Skip to main content

Funções: referência rápida

Os seguintes tipos de funções estão disponíveis para transformar seus dados. O tipo de dados determina quais funções você pode usar. Acesse Tipos de dados para obter mais informações.

Use este guia para consultar rapidamente as funções que podem ser usadas no Editor de expressões no Designer. Se precisar de mais informações e exemplos, acesse as páginas específicas das categorias vinculadas a cada seção.

Funções de fórmulas personalizadas

Se você usar funções de fórmulas personalizadas e sua função personalizada tiver o mesmo nome de uma função do Alteryx existente (ou uma inserida recentemente), poderá encontrar conflitos e resultados inesperados.Build Custom Formula Functions

Para resolver isso, renomeie sua função personalizada (ou adicione um prefixo/sufixo) para diferenciá-la das funções do Designer instaladas por padrão.

Condicional

As funções condicionais permitem que você execute uma ação ou cálculo usando uma instrução IF. Para obter parâmetros e exemplos, acesse o artigo Funções condicionais.

IF c THEN t ELSE f ENDIF

IF c THEN t ELSE f ENDIF: retorna t se a condição c for verdadeira; senão, retorna f.

IF c THEN t ELSEIF c2 THEN t2 ELSE f ENDIF

IF c THEN t ELSEIF c2 THEN t2 ELSE f ENDIF: retorna t se a primeira condição c for verdadeira; senão, retorna t2 se a segunda condição c2 for verdadeira; senão, retorna f.

IIF

IIF(bool, x, y): retorna x se bool for verdadeiro; senão, retorna y.

Switch

Switch(Value,Default,Case1,Result1,...,CaseN,ResultN): compara um valor em relação a uma lista de casos e retorna o resultado correspondente.

Conversão

As funções de conversão convertem números em cadeias de caracteres ou vice-versa. Para obter parâmetros e exemplos, acesse o artigo Funções de conversão.

BinToInt

BinToInt(s): converte a cadeia de caracteres binária s em um número inteiro (limitado a 53 bits).

CharFromInt

CharFromInt(x): retorna o caractere Unicode® que corresponde ao número fornecido em x.

CharToInt

CharToInt(s): retorna o número que corresponde ao caractere Unicode® fornecido em s.

ConvertFromCodePage

ConvertFromCodePage(s, codePage): traduz o texto de uma página de código para Unicode. Para saber mais sobre páginas de código, acesse a documentação sobre Páginas de código.

ConvertToCodePage

ConvertToCodePage(s, codePage): traduz um texto de codificação Unicode® para uma página de código específica. Para saber mais sobre páginas de código, acesse a documentação sobre Páginas de código.

HexToNumber

HexToNumber(x): converte uma cadeia de caracteres hexadecimal em um número (limitado a 53 bits).

IntToBin

IntToBin(x): converte x em uma cadeia de caracteres binária.

IntToHex

IntToHex(x): converte x em uma cadeia de caracteres hexadecimal.

ToDegrees

ToDegrees(x): converte um valor numérico (x) radiano para graus por meio do cálculo (x)rad × 180/π. Observe que x deve ser um valor numérico e não pode incluir o símbolo de radiano (rad).

ToNumber

ToNumber(x, [bIgnoreErrors], [keepNulls], [decimalSeparator]): converte uma cadeia de caracteres (x) em um número.

ToRadians

ToRadians(x): converte um valor numérico de grau (x) em radianos por meio do cálculo (x)° × π/180. Observe que x deve ser um valor numérico e não pode incluir o símbolo de grau (°).

ToString

ToString(x, numDec, [addThousandsSeparator], [decimalSeparator]): converte um parâmetro numérico (x) em uma cadeia de caracteres usando as casas decimais especificadas em numDec. A seleção padrão usa um ponto como o separador decimal.

Data e Hora

As funções de data e hora permitem que você execute uma ação ou cálculo em um valor de data/hora. Para obter parâmetros e exemplos, acesse o artigo Funções de data e hora.

DateTimeAdd

DateTimeAdd(dt,i,u): adiciona um intervalo específico a um valor de data/hora.

DateTimeDay

DateTimeDay(dt): retorna o valor numérico para o dia do mês em um valor de data/hora.

DateTimeDiff

DateTimeDiff(dt1,dt2,u): subtrai o segundo argumento do primeiro e retorna a diferença entre eles como um número inteiro na unidade especificada. A duração é retornada como um número inteiro, não como uma cadeia de caracteres, nas unidades de tempo especificadas.

DateTimeFirstOfMonth

DateTimeFirstOfMonth(): retorna o primeiro dia do mês, à meia-noite.

DateTimeFormat

DateTimeFormat(dt,f,l): converte dados de data/hora do formato ISO para outro formato especificado (f) em um idioma especificado (l) para uso em outro aplicativo. A saída gerada são dados do tipo cadeia de caracteres. Se o formato especificado tiver menos precisão, o resultado será truncado.

DateTimeHour

DateTimeHour(dt): retorna a parte das horas de um valor de data/hora.

DateTimeLastOfMonth

DateTimeLastOfMonth(): retorna o último dia do mês atual, com o relógio definido para um segundo antes do final do dia (23:59:59).

DateTimeMinutes

DateTimeMinutes(dt): retorna a parte dos minutos de um valor de data/hora.

DateTimeMonth

DateTimeMonth(dt): retorna o valor numérico para o mês em um valor de data/hora.

DateTimeNow

DateTimeNow(): retorna a data e a hora atuais do sistema com a precisão de segundos.

DateTimeNowPrecise

DateTimeNowPrecise(): retorna a data e a hora atuais do sistema com a precisão de frações de segundo (até 18 dígitos de precisão). Observe que se você solicitar uma precisão além do que o sistema operacional fornece, a função preencherá o restante com zeros.

DateTimeParse

DateTimeParse(dt,f,l): converte uma cadeia de caracteres de data com o formato especificado (f) no idioma especificado (l) para o formato padrão ISO (yyyy-mm-dd HH:MM:SS, com precisão de data/hora opcional, se aplicável). Se o formato especificado tiver menos precisão, o resultado será truncado.

DateTimeSeconds

DateTimeSeconds(dt): retorna a parte dos segundos de um valor data/hora, incluindo qualquer nível de precisão de subsegundos, se aplicável.

DateTimeStart

DateTimeStart(): retorna a data e a hora em que a execução do fluxo de trabalho atual começou.

DateTimeToday

DateTimeToday(): retorna a data de hoje.

DateTimeToLocal

DateTimeToLocal(dt): converte uma data/hora UTC para o fuso horário local do sistema. A função DateTimeToLocal atualmente não oferece suporte para a precisão de data/hora no campo dt.

DateTimeToUTC

DateTimeToUTC(dt): converte uma data/hora (no fuso horário local do sistema) para UTC. A função DateTimeToUTC atualmente não oferece suporte para a precisão de data/hora no campo dt.

DateTimeTrim

DateTimeTrim(dt,t): remove partes indesejadas de uma data/hora e retorna a data/hora modificada.

DateTimeYear

DateTimeYear(dt): retorna o valor numérico para o ano em um valor de data/hora.

ToDate

ToDate(x): converte uma cadeia de caracteres, número ou data/hora em uma data.

ToDateTime

ToDateTime(x): converte uma cadeia de caracteres, um número ou uma data em uma data/hora. A função ToDateTime não oferece suporte para a precisão de data/hora. O valor do Excel deve ser limitado à representação de segundos (5 dígitos, até 99999).

Arquivo

Uma função de arquivo cria caminhos de arquivo, verifica se um arquivo existe ou extrai parte de um caminho de arquivo. Para obter parâmetros e exemplos, acesse o artigo Funções de arquivo.

FileAddPaths

FileAddPaths(Path1, Path2): adiciona duas partes de caminho de arquivo, garantindo que haja exatamente uma \ (barra invertida) entre elas.

FileExists

FileExists(Path): retorna True (verdadeiro) se o arquivo existir e False (falso) se não existir.

FileGetDir

FileGetDir(Path): retorna o diretório referente ao caminho em "Path".

FileGetExt

FileGetExt(Path): retorna a extensão referente ao caminho em "Path", incluindo o "." (ponto).

FileGetFileName

FileGetFileName(Path): retorna o nome do arquivo referente ao caminho em "Path", sem a extensão.

Finanças

Uma função de finanças aplica algoritmos financeiros ou cálculos matemáticos. Saiba mais no artigo Funções de finanças.

FinanceCAGR

FinanceCAGR(BeginningValue, EndingValue, NumYears): calcula a taxa de crescimento anual composta: a média geométrica da taxa de crescimento em uma base anualizada.

FinanceEffectiveRate

FinanceEffectiveRate(NominalRate, PaymentsPerYear): calcula a taxa de juros anual efetiva: a taxa de juros sobre um empréstimo ou produto financeiro fixada a partir da taxa de juros nominal como uma taxa com juros anuais compostos postecipados.

FinanceFV

FinanceFV(Rate, NumPayments, PaymentAmount, PresentValue, PayAtPeriodBegin): calcula o valor futuro de um investimento: o valor de um ativo em um tempo especificado no futuro, assumindo uma determinada taxa de juros ou taxa de retorno.

FinanceFVSchedule

FinanceFVSchedule(Principle, Year1Rate, Year2Rate): calcula a programação do valor futuro: o valor futuro de um principal inicial após a aplicação de uma série de taxas de juros a um investimento.

FinanceIRR

FinanceIRR(Value1, Value2): calcula a taxa interna de retorno: a taxa de juros em que os custos do investimento são iguais aos benefícios. Isso significa que todos os ganhos do investimento são inerentes ao valor temporal do dinheiro (TVM, time value of money) e que o investimento tem um valor presente líquido de zero com essa taxa de juros.

FinanceMIRR

FinanceMIRR(FinanceRate, ReinvestRate, Value1, Value2): calcula a taxa interna de retorno modificada: uma modificação da taxa interna de retorno que visa resolver alguns problemas da IRR. A MIRR é uma medida financeira da atratividade de um investimento.

FinanceMXIRR

FinanceMXIRR(FinanceRate, ReinvestRate, Value1, Date1, Value2, Date2): calcula a taxa interna de retorno modificada de um investimento com datas.

FinanceNominalRate

FinanceNominalRate(EffectiveRate, PaymentsPerYear): calcula a taxa de juros nominal anual: uma taxa de juros é chamada de nominal se a frequência de capitalização (como um mês) não for idêntica à unidade de tempo básica (normalmente um ano).

FinanceNPER

FinanceNPER(Rate, PaymentAmount, PresentValue, FutureValue, PayAtPeriodBegin): calcula o número de períodos para um investimento ou empréstimo.

FinanceNPV

FinanceNPV(Rate, Value1, Value2): calcula o valor presente líquido de um investimento: mede o excesso ou o déficit de fluxos de caixa, em termos de valor atual, uma vez que os encargos financeiros são cumpridos.

FinancePMT

FinancePMT(Rate, NumPayments, PresentValue, FutureValue, PayAtPeriodBegin): calcula os pagamentos de um empréstimo.

FinancePV

FinancePV(Rate, NumPayments, PaymentAmount, FutureValue, PayAtPeriodBegin): calcula o valor presente de um investimento: o valor em uma determinada data de um pagamento futuro, ou uma série de pagamentos futuros, descontados para refletir o valor temporal do dinheiro e outros fatores como o risco de investimento.

FinanceRate

FinanceRate(NumPayments, PaymentAmount, PresentValue, FutureValue, PayAtPeriodBegin): calcula a taxa de juros (por período).

FinanceXIRR

FinanceXIRR(Value1, Date1, Value2, Date2): calcula a taxa interna de retorno de um investimento com datas.

FinanceXNPV

FinanceXNPV(Rate, Value1, Date1, Value2, Date2): calcula o valor presente líquido de um investimento com datas.

Matemática

Uma função matemática realiza cálculos matemáticos. Para obter parâmetros e exemplos, acesse o artigo Funções matemáticas.

ABS

ABS(x): retorna o valor absoluto de (x). É a distância entre 0 e um número. O valor é sempre positivo.

ACOS

ACOS(x): retorna o arco cosseno, ou o cosseno inverso, de (x).

ASIN

ASIN(x): retorna o arco seno, ou seno inverso, de (x).

ATAN

ATAN(x): retorna a arco tangente, ou tangente inversa, de (x).

ATAN2

ATAN2(y, x): retorna o arco tangente de y e x (Arco – Tangente de (y/x)).

Average

Average(n1, ...): retorna a média de uma lista de números.

AverageNonNull

AverageNonNull(n1, ...): retorna a média de uma lista de números. Valores nulos são excluídos do cálculo. O cálculo funciona apenas com tipos de dados numéricos.

CEIL

CEIL(x, [mult]): retorna um valor numérico (x) aumentado para o múltiplo mais baixo de (mult) que seja maior que ou igual a x. O parâmetro (mult) deve ser um número maior que 0. Se (mult) não estiver especificado, a função retorna o menor número inteiro maior ou igual a (x).

COS

COS(x): retorna o cosseno de (x).

COSH

COSH(x): retorna o cosseno hiperbólico de (x).

DISTANCE

DISTANCE(from_Lat,from_Lon, to_Lat, to_Lon): retorna a distância de (lat1,lon1) até (lat2,lon2).

EXP

EXP(x): retorna e elevado à potência x (e^x).

FACTORIAL

FACTORIAL(x): retorna o fatorial de um valor numérico (x) por meio do cálculo (n! = n x (n-1) x … x 1). Por exemplo, o fatorial de 4 é calculado como: 4! = 4 x 3 x 2 x 1 = 24.

FLOOR

FLOOR(x, [mult]): retorna um valor numérico (x) reduzido para o múltiplo mais alto de (mult) que seja menor que ou igual a x. O parâmetro (mult) deve ser um número maior que 0. Se (mult) não estiver especificado, a função retorna o maior número inteiro menor ou igual a (x), conforme mostrado no primeiro exemplo abaixo.

LOG

LOG(x): retorna o logaritmo natural de (x).

LOG10

LOG10(x): retorna o logaritmo na base 10 de (x).

Median

Median(...): calcula a mediana de um ou mais valores (possivelmente não ordenados).

Mod

Mod(n,d): módulo de (n) dividido por (d) (operação com número inteiro).

PI

PI(): retorna o valor da constante PI com 15 dígitos de acurácia.

POW

POW(x, e): retorna (x) elevado à potência (e).

RAND

RAND(): retorna um número aleatório maior ou igual a 0 e menor que 1.

RandInt

RandInt(n): retorna um número inteiro aleatório entre 0 e o parâmetro especificado.

Round

Round(x, mult): retorna (x) arredondado para o múltiplo mais próximo de (mult).

SIN

SIN(x): retorna o seno de (x).

SINH

SINH(x): retorna o seno hiperbólico de (x).

SmartRound

SmartRound(x): retorna (x) arredondado para o múltiplo mais próximo de um valor determinado dinamicamente com base no tamanho de (x).

SQRT

SQRT(x): retorna a raiz quadrada de (x).

TAN

TAN(x): retorna a tangente de (x).

TANH

TANH(x): retorna a tangente hiperbólica de (x).

Matemática: bit a bit

Uma função bit a bit opera em um ou mais padrões de bit ou numerais binários no nível de seus bits individuais. Use uma função bit a bit para manipular valores para comparações e cálculos. Para obter parâmetros e exemplos, acesse o artigo Funções matemáticas: bit a bit.

BinaryAnd

BinaryAnd(n,m): retorna um binário AND de (n) e (m). O resultado é 1 se ambos n e m forem 1; senão, o resultado é 0. Se 0 for equiparado a "falso" e 1 a "verdadeiro", a operação BinaryAnd funciona como um AND lógico.

BinaryNot

BinaryNot(n): retorna um binário NOT de (n).

BinaryOr

BinaryOr(n,m): retorna um binário OR de (n) e (m).

BinaryXOR

BinaryXOr(n,m): retorna um binário XOR de (n) e (m).

ShiftLeft

ShiftLeft(n,b): desloca (n) à esquerda (como número inteiro) por (b) bits.

ShiftRight

ShiftRight(n,b): desloca (n) à direita (como número inteiro) por (b) bits.

Mín/Máx

Uma função de mínimo ou máximo encontra o menor ou o maior valor de um conjunto de valores. Para obter parâmetros e exemplos, acesse o artigo Funções de mín/máx.

Between

BETWEEN(x, min, max): testa se um valor (x) está entre dois outros valores (min e max), incluindo esses valores de mínimo e máximo. Retorna VERDADEIRO se x estiver entre min e max. Retorna FALSO se x não estiver entre min e max.

Bound

Bound(x, min, max): Se (x < min) retorna o mínimo; se (x > max) retorna o máximo; senão, retorna x.

Max

Max(v0, v1, ..., vn): retorna o valor máximo da lista.

MaxIDX

MaxIDX(v0, v1,..., vn): retorna o índice de base 0 do valor máximo da lista.

Min

Min(v0, v1,..., vn): retorna o valor mínimo da lista.

MinIDX

MinIDX(v0, v1,..., vn): retorna o índice de base 0 do valor mínimo da lista.

Operadores

Um operador é um caractere que representa uma ação. Use um operador aritmético para executar cálculos matemáticos ou um operador booleano para trabalhar com valores verdadeiro/falso. Saiba mais no artigo Operadores.

Comentário de bloco

/*Comment*/: use um operador de comentário de bloco para adicionar um bloco de comentários a um editor de expressões (dentro da linha da expressão) sem interferir na expressão.

Comentário de linha única

// Comment: use o comentário de linha única para adicionar um comentário de linha única a um editor de expressões sem interferir na expressão.

Boolean AND &&

Boolean AND &&: (AND booleano): use esse operador para combinar dois valores booleanos. O resultado também é um valor booleano. O resultado é verdadeiro se ambos os valores combinados forem verdadeiros e falso se um dos valores combinados for falso.

AND - palavra-chave (booleano: e)

Boolean AND - palavra-chave (AND booleano): use esse operador para combinar dois valores booleanos. O resultado também é um valor booleano. O resultado é verdadeiro se ambos os valores combinados forem verdadeiros e falso se um dos valores combinados for falso.

NOT ! (booleano: não)

Boolean NOT ! (NOT booleano): aceita uma entrada. Se essa entrada for verdadeira, retorna falso. Se essa entrada for falsa, retorna verdadeiro.

NOT - palavra-chave (booleano: não)

Boolean NOT - palavra-chave (NOT booleano): aceita uma entrada. Se essa entrada for verdadeira, retorna falso. Se essa entrada for falsa, retorna verdadeiro.

OR - palavra-chave (booleano: ou)

Boolean OR - palavra-chave (OR booleano): se um (ou ambos) dos dois valores for verdadeiro, retorna verdadeiro.

OR || (booleano: ou)

Boolean OR || (OR booleano): se um (ou ambos) dos dois valores for verdadeiro, retorna verdadeiro.

Fechar parêntese

) (fechar parênteses): feche um parêntese.

Divisão

/ (divisão): use o operador de divisão para dividir um valor numérico por outro valor numérico.

Igual a

= (igual a): igual a.

Maior que

> (maior que): maior que.

Maior ou igual a

>= (maior ou igual a): maior ou igual a.

Menor que

< (menor que): menor que.

Menor ou igual a

<= (menor ou igual a): menor ou igual a.

Multiplicação

* (multiplicação): use o operador de multiplicação para multiplicar valores numéricos.

Não igual a

!= (não igual a): não igual a.

Abrir parêntese

( (abrir parênteses): abra um parêntese.

Subtração

- (subtração): use o operador de subtração para subtrair um valor numérico de outro.

IN (...) - palavra-chave (valor é encontrado em)

IN (...) - palavra-chave (testar se um valor está na lista): define se um determinado valor corresponde a qualquer valor em uma subconsulta ou lista.

NOT IN (...) - palavra-chave (valor não é encontrado em)

NOT IN (...) - palavra-chave (testar se um valor não está na lista): define se um determinado valor corresponde a qualquer valor que não esteja em uma subconsulta ou lista.

Geografia

Uma função de geografia constrói objetos geográficos, analisa dados espaciais e retorna métricas de campos espaciais. Para obter parâmetros e exemplos, acesse o artigo Funções de geografia.

ST_Area

ST_Area(object, units): retorna a área do objeto geográfico nas unidades especificadas (dados numéricos).

ST_Boundary

ST_Boundary(object): retorna os limites do objeto geográfico (objeto geográfico de polilinha indicando o limite do polígono de entrada).

ST_BoundingRectangle

ST_BoundingRectangle(object, ...): retorna o retângulo delimitador do objeto geográfico (objeto geográfico de polígono).

ST_Centroid

ST_Centroid(object): retorna o centroide do objeto geográfico (objeto geográfico de ponto).

ST_CentroidX

ST_CentroidX(object): retorna a longitude do centroide do objeto geográfico (dados numéricos).

ST_CentroidY

ST_CentroidY(object): retorna a latitude do centroide do objeto geográfico (dados numéricos).

ST_Combine

ST_Combine(object1, object2,...): combina os objetos geográficos (objeto geográfico).

ST_Contains

ST_Contains(object1,object2): retorna verdadeiro se o objeto1 contiver o objeto2 (valor booleano).

ST_ConvexHull

ST_ConvexHull(object1,...): retorna a envoltória convexa dos objetos geográficos (objeto geográfico).

ST_CreateLine

ST_CreateLine(point1, point2...): cria uma linha ao conectar os pontos e linhas especificados em uma sequência (objeto geográfico).

ST_CreatePoint

ST_CreatePoint(x,y): retorna um objeto geográfico contendo as coordenadas especificadas de longitude e latitude (objeto geográfico).

ST_CreatePolygon

ST_CreatePolygon(obj1, obj2...): cria um polígono ao conectar os pontos e linhas especificados em uma sequência (objeto geográfico).

ST_Cut

ST_Cut(object1,object2): retorna o resultado de recortar o objeto1 do objeto2 (objeto geográfico).

ST_Dimension

ST_Dimension(object): retorna a dimensão do objeto geográfico. A dimensão espacial é o número mínimo de coordenadas que são necessárias para especificar cada ponto que compõe o objeto geográfico (dados numéricos).

  • Objetos de ponto retornam um valor de 0.

  • Objetos de linha retornam um valor de 1.

  • Objetos de polígono retornam um valor de 2.

ST_Distance

ST_Distance(object1, object2, units): retorna a distância do objeto1 ao objeto2 nas unidades especificadas. As unidades compatíveis são milhas ("miles"), quilômetros ("kilometers"), metros ("meters") e pés ("feet") (dados numéricos).

ST_EndPoint

ST_EndPoint(object): retorna o último ponto do objeto geográfico (objeto geográfico de ponto).

ST_Intersection

ST_Intersection(object1, object2, ...): retorna a interseção dos objetos geográficos especificados (objeto geográfico).

ST_Intersects

ST_Intersects(object1, object2...): retorna verdadeiro se houver interseção entre os objetos geográficos (valor booleano).

ST_InverseIntersection

ST_InverseIntersection(object1, object2...): retorna a interseção inversa dos objetos geográficos especificados (objeto geográfico).

ST_Length

ST_Length(object, units): retorna o comprimento linear do objeto geográfico nas unidades especificadas (dados numéricos).

ST_MD5

ST_MD5(object): calcula o hash MD5 do objeto geográfico.

ST_MaxX

ST_MaxX(object): retorna a longitude máxima do objeto geográfico (dados numéricos).

ST_MaxY

ST_MaxY(object): retorna a latitude máxima do objeto geográfico (dados numéricos).

ST_MinX

ST_MinX(object): retorna a longitude mínima do objeto geográfico (dados numéricos).

ST_MinY

ST_MinY(object): retorna a latitude mínima do objeto geográfico (dados numéricos).

ST_NumParts

ST_NumParts(object): retorna o número de partes no objeto geográfico (dados numéricos).

ST_NumPoints

ST_NumPoints(object): retorna o número de pontos no objeto geográfico (dados numéricos).

ST_ObjectType

ST_ObjectType(object): retorna o tipo do objeto geográfico como um valor de cadeia de caracteres (dados de cadeia de caracteres).

ST_PointN

ST_PointN(object, n): retorna o enésimo (n) ponto do objeto geográfico (objeto geográfico de ponto).

ST_RandomPoint

ST_RandomPoint(object): retorna um ponto aleatório do objeto geográfico (objeto geográfico de ponto).

ST_Relate

ST_Relate(object1,object2,relation): retorna verdadeiro se os objetos satisfizerem a relação DE-9IM fornecida (valor booleano).

ST_StartPoint

ST_StartPoint(object): retorna o primeiro ponto do objeto geográfico (objeto geográfico).

ST_Touches

ST_Touches(object1, object2): retorna verdadeiro se o objeto1 tocar o objeto2 (valor booleano).

ST_TouchesOrIntersects

ST_TouchesOrIntersects(object1, object2): retorna verdadeiro se o objeto1 tocar ou intersectar o objeto2 (valor booleano).

ST_Within

ST_Within(object1, object2): retorna verdadeiro se o objeto1 estiver contido no objeto2 (valor booleano).

Especializado

Estas funções executam uma variedade de ações especializadas e podem ser usadas com todos os tipos de dados. Para obter parâmetros e exemplos, acesse o artigo Funções especializadas.

EscapeXMLMetacharacters

EscapeXMLMetacharacters(String): substitui metacaracteres XML por suas versões de escape. Há 5 caracteres de escape.

Caractere

Versão de escape

"

&quot;

'

&apos;

<

&lt;

>

&gt;

&

&

GetVal

GetVal(index, v0,...vn): retorna o valor (v0, ..., vn) especificado pelo índice de base 0 (index).

GetEnvironmentVariable

GetEnvironmentVariable(Name): retorna a variável de ambiente especificada em "Name". Para obter uma lista de variáveis de ambiente, em sua máquina, acesse Painel de controle > Sistema e segurança > Sistema > Configurações avançadas do sistema > Variáveis de ambiente. É exibida uma lista de variáveis do sistema. Você pode usar qualquer valor desta lista.

Suporte no Server

O Alteryx não oferece suporte a GetEnvironmentVariable em aplicativos salvos no Server.

Message

Message(messageType, message, returnValue): use com uma instrução condicional para enviar uma mensagem ao log de mensagens e atualizar os dados da coluna com um valor especificado quando uma condição for atendida.

NULL

NULL(): retorna um valor nulo.

RangeMedian

RangeMedian(...): calcula a mediana de uma série de intervalos agregados. Visite Mediana de intervalos para obter mais informações.

ReadRegistry

ReadRegistryString(Key, ValueName, DefaultValue="): retorna um valor do registro.

Soundex

Soundex(String): retorna o Soundex da cadeia de caracteres. O Soundex cria um código com base no primeiro caractere da cadeia mais três caracteres com base nestes itens:

Caractere

Soundex

Caracteres não alfabéticos (números e pontuação)

-1

a, e, i, o, u, y, h, w

Ignorado, a menos que seja o primeiro caractere da cadeia.

b, f, p, v

1

c, g, j, k, q, s, x, z

2

d, t

3

l

4

m, n

5

r

6

Soundex_Digits

Soundex_Digits(String): retorna os primeiros quatro dígitos, se existirem, ou o Soundex.

  • Se houver dígitos (números) na cadeia de caracteres, os primeiros 4 dígitos são retornados.

  • Se não houver dígitos, o código Soundex é retornado.

TOPNIDX

TOPNIDX(N, v0, v1, ..., vn): retorna o índice de base 0 da enésima posição do valor máximo da lista. Com N==0, é o mesmo que MaxIdx(...).

UrlEncode

UrlEncode(String): codifica a cadeia de caracteres UTF-16 como um URL válido da Web tanto para o mecanismo original quanto para o AMP.

Cadeia de caracteres

Uma função de cadeia de caracteres executa operações em dados de texto. Utilize uma função de cadeia de caracteres para limpar dados, converter dados a um formato diferente, modificar o uso de maiúsculas, calcular métricas sobre os dados ou executar outras manipulações. Para obter parâmetros e exemplos, acesse o artigo Funções de cadeia de caracteres.

Contains

Contains(String, Target, CaseInsensitive=1): procura pela ocorrência de uma cadeia específica (Target) dentro de uma cadeia de caracteres (String). Retorna verdadeiro se a cadeia de caracteres (String) contém a sequência-alvo (Target); senão, retorna falso.

CountWords

CountWords(string): retorna a contagem das palavras na cadeia de caracteres especificada. Palavras são definidas por caracteres separados por um espaço.

DecomposeUnicodeForMatch

DecomposeUnicodeForMatch(String): remove acentos e expande caracteres compostos ao convertê-los para estreitos. Essa função pega uma cadeia de caracteres Unicode e a converte em uma cadeia de caracteres estreita e com letras minúsculas. Todos os acentos e similares são removidos.

EndsWith

EndsWith(String, Target, CaseInsensitive=1): verifica se uma cadeia de caracteres termina com a sequência-alvo especificada. Retorna verdadeiro se a cadeia de caracteres termina com a sequência-alvo; senão, retorna falso. Por padrão, não diferencia maiúsculas de minúsculas.

FindString

FindString(String,Target): procura pela ocorrência de uma sequência-alvo em uma cadeia de caracteres e retorna a posição numérica dessa ocorrência. Retorna o índice de base 0 da primeira ocorrência da sequência-alvo (Target) na cadeia de caracteres (String). Retorna -1 se não houver ocorrência.

GetWord

GetWord(string, n): retorna a enésima palavra (base 0) da cadeia de caracteres. Palavras são definidas como um grupo de caracteres separados por um espaço. O índice de base 0 significa que a primeira palavra está na posição 0.

Left

Left(String, len): retorna os primeiros caracteres (número determinado em len) da cadeia (String). Se len for menor que 0 ou maior que o comprimento da cadeia de caracteres, esta permanecerá inalterada.

Length

Length(String): retorna o comprimento da cadeia de caracteres (String).

LowerCase

LowerCase(String): converte a cadeia de caracteres para letras minúsculas.

MD5_ASCII

MD5_ASCII(String): calcula o hash MD5 da cadeia de caracteres. A cadeia de caracteres deve ter apenas caracteres estreitos. Caracteres largos são convertidos em “?” antes de calcular o hash. Use para o tipo String, não recomendado para o tipo WString. Evite usar essa função em cadeias de caracteres que podem conter caracteres largos.

MD5_UNICODE

MD5_UNICODE(String): tanto para o motor original quanto para o AMP, calcula o hash MD5 da cadeia armazenada como UTF-16.

MD5_UTF8

MD5_UTF8(String): calcula o hash MD5 da cadeia de caracteres armazenada como UTF-8.

PadLeft

PadLeft (String, len, char): preenche o lado esquerdo da cadeia de caracteres (String) com o caractere especificado (char) até o comprimento especificado (len). Se o preenchimento definido em char for maior do que um caractere, somente o primeiro caractere será usado.

PadRight

PadRight (String, len, char): preenche o lado direito da cadeia de caracteres (String) com o caractere especificado (char) até o comprimento especificado (len). Se o preenchimento definido em char for maior do que um caractere, somente o primeiro caractere será usado.

REGEX_CountMatches

REGEX_CountMatches(String,pattern,icase): retorna quantas vezes a cadeia de caracteres (String) corresponde ao padrão especificado (pattern).

REGEX_Match

REGEX_Match(String,pattern,icase): procura, em uma cadeia de caracteres (String), a ocorrência de um padrão de expressão regular (pattern). Informa se a cadeia de caracteres coincide com o padrão do primeiro ao último caractere.

REGEX_Replace

REGEX_Replace(String, pattern, replace, icase): permite substituir texto usando expressões regulares e retorna a cadeia de caracteres resultante das funções RegEx de encontrar padrão (pattern) e substituir cadeia de caracteres (replace). Todas as ocorrências são substituídas, não apenas a primeira.

Replace

Replace(String, Target, Replacement): retorna a cadeia de caracteres (String) após substituir todas as ocorrências da sequência-alvo (Target) com a sequência de substituição (Replacement).

ReplaceChar

ReplaceChar(String, y, z): retorna a cadeia de caracteres (String) após substituir todas as ocorrências de qualquer caractere em y pelo caractere em z. Se z for uma cadeia com mais de um caractere, apenas o primeiro será usado. Se z estiver vazio, todos os caracteres da cadeia que corresponderem a quaisquer caracteres em y serão simplesmente removidos.

ReplaceFirst

ReplaceFirst(String, Target, Replacement): retorna a cadeia de caracteres (String) após substituir a primeira ocorrência da sequência-alvo (Target) pela sequência de substituição (Replacement).

ReverseString

ReverseString(String): inverte todos os caracteres da cadeia de caracteres (String).

Right

Right(String, len): retorna os últimos caracteres (número determinado em len) da cadeia. Se len for menor que 0 ou maior que o comprimento da cadeia de caracteres, esta permanecerá inalterada.

StartsWith

StartsWith(String, Target, CaseInsensitive=1): verifica se uma cadeia de caracteres (String) começa com a sequência-alvo especificada (Target). Retorna verdadeiro se a cadeia de caracteres (String) inicia com a sequência-alvo (Target); senão, retorna falso.

STRCSPN

STRCSPN(String, y): retorna o comprimento da porção inicial da cadeia de caracteres (String) consistindo em caracteres que não estão em y.

StripQuotes

StripQuotes(String): remove um par de aspas ou apóstrofos das extremidades da cadeia de caracteres (String).

STRSPN

STRSPN(String, y): retorna o comprimento da porção inicial da cadeia de caracteres (String) consistindo em caracteres que estão em (y).

Substring

Substring(String, start, length): retorna a subcadeia da cadeia de caracteres (String), começando em "start" e parando após o comprimento informado em "lenght", se informado.

TitleCase

TitleCase(String) : converte a primeira letra de cada palavra da cadeia de caracteres (String) para maiúscula.

Trim

Trim(String, y): remove os caracteres em (y) das extremidades da cadeia de caracteres (String). O parâmetro y é opcional: por padrão, essa função remove espaços em branco. Observe, nos exemplos da função TRIM, que os caracteres especificados são removidos. Não importa a ordem em que os caracteres estão.

TrimLeft

TrimLeft(String, y): remove os caracteres em y do início da cadeia de caracteres (String). O parâmetro y é opcional: por padrão, essa função remove espaços em branco.

TrimRight

TrimRight(String, y): remove os caracteres em y do final da cadeia de caracteres (String). O parâmetro y é opcional: por padrão, essa função remove espaços em branco.

Uppercase

Uppercase(String): converte a cadeia de caracteres (String) para letras maiúsculas.

Uuid

UuidCreate(): cria um identificador exclusivo.

Teste

Uma função de teste realiza comparações de dados. Use uma função de teste para identificar o tipo de dados de um valor ou determinar se um valor existe. Para obter parâmetros e exemplos, acesse o artigo Funções de teste.

CompareDictionary

CompareDictionary(a,b): compara 2 cadeias de caracteres, sem diferenciar maiúsculas de minúsculas, e compara, em ordem numérica, texto que parece conter números. A função retorna -1 se a < b, 0 se a==b e 1 se a > b.

CompareDigits

CompareDigits(a, b, nNumDigits): compara 2 números e determina se eles são iguais em relação ao número de dígitos fornecido (nNumDigits). A comparação encontra a diferença entre os números e informa que A e B são iguais quando o primeiro dígito da diferença está a nNumDigits ou mais casas decimais à direita do primeiro dígito do maior entre A e B.

CompareEpsilon

CompareEpsilon(a, b, epsilon): compara 2 números de ponto flutuante e retorna verdadeiro se a diferença for menor que epsilon.

IsEmpty

IsEmpty(v): testa se v é nulo (NULL) ou igual a "".

IsInteger

IsInteger(v) : testa se v contém um valor que pode ser convertido em um número inteiro. Caso afirmativo, retorna verdadeiro.

IsNull

IsNull(v) : testa se v é nulo. Retorna verdadeiro se v for nulo; caso contrário, retorna falso.

IsNumber

IsNumber(v) : testa se o tipo de campo para v é numérico ou não.

IsSpatialObj

IsSpatialObj(v): testa se o tipo de campo para v é de objeto geográfico ou não.

IsString

IsString(v): testa se o tipo de campo para v é de cadeia de caracteres ou não.