Referência de função MDX (MDX)
O Analysis Services fornece o uso de funções na sintaxe MDX (Multidimensional Expressions). As funções podem ser usadas em qualquer instrução MDX válida e são frequentemente usadas em consultas, definições de acúmulos personalizados e outros cálculos. Esta seção fornece informações sobre as funções MDX.
Você pode usar as tabelas a seguir para localizar funções pela categoria dos valores retornados ou pode selecionar uma função por nome na lista alfabética, no índice.
Funções de Matriz
| Função | Descrição |
|---|---|
| SetToArray (MDX) | Converte um ou mais conjuntos para uma matriz para uso em uma função definida pelo usuário. |
Funções de hierarquia
| Função | Descrição |
|---|---|
| Função Hierarchy (MDX) | Retorna a hierarquia que contém um membro ou nível especificado. |
| Função Dimension (MDX) | Retorna a dimensão que contém um membro, um nível ou uma hierarquia especificada. |
| Dimensions (MDX) | Retorna uma hierarquia especificada por uma expressão numérica ou de cadeia de caracteres. |
Funções de nível
| Função | Descrição |
|---|---|
| Level (MDX) | Retorna o nível de um membro. |
| Função Levels (MDX) | Retorna o nível cuja posição em uma dimensão ou hierarquia é especificada por uma expressão numérica ou cujo nome é especificado por uma expressão de cadeia de caracteres. |
Funções lógicas
| Função | Descrição |
|---|---|
| IsAncestor (MDX) | Retorna se um membro especificado é um ancestral de outro membro especificado. |
| IsEmpty (MDX) | Retorna se a expressão avaliada for o valor de célula vazio. |
| IsGeneration (MDX) | Retorna se um membro especificado estiver em uma geração especificada. |
| IsLeaf (MDX) | Retorna se um membro especificado for um membro folha. |
| IsSibling (MDX) | Retorna se um membro especificado for um irmão de outro membro especificado. |
Funções de membro
| Função | Descrição |
|---|---|
| Ancestor (MDX) | Retorna o ancestral de um membro em um nível ou uma distância especificada. |
| ClosingPeriod (MDX) | Retorna o último irmão entre os descendentes de um membro em um nível especificado. |
| Função Cousin (MDX) | Retorna o membro filho com a mesma posição relativa sob um membro pai como o membro filho especificado. |
| Função CurrentMember (MDX) | Retorna o membro atual junto junto de uma dimensão ou hierarquia especificada durante a iteração. |
| DataMember (MDX) | Retorna o membro de dados gerado pelo sistema associado a um membro não folha de uma dimensão. |
| DefaultMember (MDX) | Retorna o membro padrão de uma dimensão ou hierarquia. |
| FirstChild (MDX) | Retorna o primeiro filho de um membro. |
| FirstSibling (MDX) | Retorna o primeiro filho do pai de um membro. |
| Item (Membro) (MDX) | Retorna um membro de uma tupla especificada. |
| Latência (MDX) | Retorna o membro que é um número especificado de posições antes de um membro especificado junto à dimensão do membro. |
| LastChild (MDX) | Retorna o último filho de um membro especificado. |
| LastSibling (MDX) | Retorna o último filho do pai de um membro especificado. |
| Lead (MDX) | Retorna o membro que é um número especificado de posições que seguem um membro especificado junto à dimensão do membro. |
| LinkMember (MDX) | Retorna o membro equivalente a um membro especificado em uma hierarquia especificada. |
| Membros (cadeia de caracteres) (MDX) | Retorna um membro especificado por uma expressão de cadeia de caracteres. |
| NextMember (MDX) | Retorna o próximo membro no nível que contém um membro especificado. |
| OpeningPeriod (MDX) | Retorna o primeiro irmão entre os descendentes de um nível especificado, opcionalmente em um membro especificado. |
| Função ParallelPeriod (MDX) | Retorna um membro de um período anterior na mesma posição relativa como um membro especificado. |
| Função Parent (MDX) | Retorna o pai de um membro. |
| PrevMember (MDX) | Retorna o membro anterior no nível que contém um membro especificado. |
| StrToMember (MDX) | Retorna o membro especificado por uma cadeia de caracteres formatada em MDX. |
| UnknownMember (MDX) | Retorna o membro desconhecido associado a um nível ou membro. |
| ValidMeasure (MDX) | Retorna uma medida válida em um cubo virtual forçando dimensões inaplicáveis ao nível superior. |
Funções numéricas
| Função | Descrição |
|---|---|
| Função Aggregate (MDX) | Retorna um valor escalar calculado agregando-se medidas ou uma expressão numérica opcionalmente especificada sobre as tuplas de um conjunto especificado. |
| Avg (MDX) | Retorna o valor médio de medidas ou o valor médio de uma expressão numérica opcional, avaliado sobre um conjunto especificado. |
| CalculationCurrentPass (MDX) | Retorna a análise de cálculo atual de um cubo para o contexto de consulta especificado. |
| CalculationPassValue (MDX) | Retorna o valor de uma expressão MDX avaliada sobre a passagem de cálculo especificada de um cubo. |
| CoalesceEmpty (MDX) | Transforma um valor de célula vazio em um número ou uma cadeia de caracteres e retorna o valor transformado. |
| Função Correlation (MDX) | Retorna o coeficiente de correlação de duas séries avaliadas sobre um conjunto. |
| Count (Dimensão) (MDX) | Retorna o número de dimensões em um cubo. |
| Count (Níveis de hierarquia) (MDX) | Retorna o número de níveis em uma dimensão ou hierarquia. |
| Count (Conjunto) (MDX) | Retorna o número de células em um conjunto. |
| Count (Tupla) (MDX) | Retorna o número de dimensões em uma tupla. |
| Função Covariance (MDX) | Retorna a covariação de população de duas séries avaliadas sobre um conjunto, usando a fórmula de população polarizada. |
| CovarianceN (MDX) | Retorna a covariação de exemplo de duas séries avaliadas sobre um conjunto, usando a fórmula de população não polarizada. |
| DistinctCount (MDX) | Retorna o número de tuplas distintas, não vazias em um conjunto. |
| IIF (MDX) | Retorna um de dois valores determinados por um teste lógico. |
| Função LinRegIntercept (MDX) | Calcula a regressão linear de um conjunto e retorna o valor da interceptação na linha de regressão, y = ax + b. |
| LinRegPoint (MDX) | Calcula a regressão linear de um conjunto e retorna o valor de y na linha de regressão, y = ax + b. |
| LinRegR2 (MDX) | Calcula a regressão linear de um conjunto e retorna o coeficiente de determinação, R2. |
| LinRegSlope (MDX) | Calcula a regressão linear de um conjunto e retorna o valor da inclinação na linha de regressão, y = ax + b. |
| LinRegVariance (MDX) | Calcula a regressão linear de um conjunto e retorna a variação associada à linha de regressão, y = ax + b. |
| LookupCube (MDX) | Retorna o valor de uma expressão MDX avaliada sobre outro cubo especificado no mesmo banco de dados. |
| Max (MDX) | Retorna o valor máximo de uma expressão numérica que é avaliada sobre um conjunto. |
| Median (MDX) | Retorna o valor mediano de uma expressão numérica que é avaliada sobre um conjunto. |
| Min (MDX) | Retorna o valor mínimo de uma expressão numérica que é avaliada sobre um conjunto. |
| Ordinal (MDX) | Retorna o valor ordinal com base em zero associado a um nível. |
| Predict (MDX) | Retorna um valor de uma expressão numérica avaliada em função sobre um modelo de mineração de dados. |
| Rank (MDX) | Retorna a classificação de base um de uma tupla especificada em um conjunto especificado. |
| Função RollupChildren (MDX) | Retorna um valor gerado pelo acúmulo dos valores dos filhos de um membro especificado usando o operador unário especificado. |
| Stddev (MDX) | Alias para Stdev (MDX). |
| Função StddevP (MDX) | Alias para StdevP (MDX). |
| Stdev (MDX) | Retorna o desvio padrão de exemplo de uma expressão numérica, avaliado em relação a um conjunto, usando a fórmula de população não polarizada. |
| StdevP (MDX) | Retorna o desvio padrão de população de uma expressão numérica avaliada sobre um conjunto, usando a fórmula de população polarizada. |
| StrToValue (MDX) | Retorna o valor especificado por uma cadeia de caracteres formatada em MDX. |
| Função Sum (MDX) | Retorna a soma de uma expressão numérica avaliada em um conjunto. |
| Value (MDX) | Retorna o valor de uma medida. |
| Var (MDX) | Retorna a variância de exemplo de uma expressão numérica, avaliado em relação a um conjunto, usando a fórmula de população não polarizada. |
| Variance (MDX) | Alias para Var (MDX). |
| Função VarianceP (MDX) | Alias para VarP (MDX). |
| VarP (MDX) | Retorna a variância de população de uma expressão numérica avaliada sobre um conjunto, usando a fórmula de população polarizada. |
Funções do conjunto
| Função | Descrição |
|---|---|
| AddCalculatedMembers (MDX) | Retorna um conjunto gerado, adicionando membros calculados a um conjunto especificado. |
| AllMembers (MDX) | Retorna um conjunto que contém todos os membros, inclusive membros calculados, da dimensão, da hierarquia ou do nível especificado. |
| Ancestors (MDX) | Retorna um conjunto de todos os ancestrais de um membro a um nível especificado ou distância. |
| Ascendants (MDX) | Retorna o conjunto dos ascendentes de um membro especificado, inclusive o próprio membro. |
| Axis (MDX) | Retorna um conjunto definido em um eixo. |
| BottomCount (MDX) | Classifica um conjunto na ordem crescente e retorna o número especificado de tuplas com os valores mais baixos. |
| BottomPercent (MDX) | Classifica um conjunto em ordem crescente e retorna um conjunto de tuplas com os valores mais baixos, cujo total cumulativo é igual ou menor do que um percentual especificado. |
| BottomSum (MDX) | Classifica um conjunto em ordem crescente e retorna um conjunto de tuplas com os valores mais baixos, cujo total é igual a ou menor que um valor especificado. |
| Children (MDX) | Retorna os filhos de um membro especificado. |
| Crossjoin (MDX) | Retorna o produto cruzado de um ou mais conjuntos. |
| CurrentOrdinal (MDX) | Retorna o número de iteração atual dentro de um conjunto durante a iteração. |
| Descendants (MDX) | Retorna o conjunto de descendentes de um membro em uma distância ou nível especificado, incluindo ou excluindo, opcionalmente, descendentes em outros níveis. |
| Distinct (MDX) | Retorna um conjunto, removendo tuplas duplicadas de um conjunto especificado. |
| DrilldownLevel (MDX) | Faz uma busca detalhada dos membros de um conjunto em um nível abaixo do nível mais baixo representado no conjunto ou para um nível abaixo de um nível opcionalmente especificado de um membro representado no conjunto. |
| DrilldownLevelBottom (MDX) | Faz uma busca detalhada dos membros mais inferiores de um conjunto, em um nível especificado, para um nível abaixo. |
| DrilldownLevelTop (MDX) | Faz uma busca detalhada dos principais membros de um conjunto, em um nível especificado, para um nível abaixo. |
| DrilldownMember (MDX) | Faz uma busca detalhada dos membros de um determinado conjunto que estejam presentes em um segundo conjunto especificado. Opcionalmente, a função faz uma busca em um conjunto de tuplas. |
| DrilldownMemberBottom (MDX) | Faz uma busca detalhada dos membros de um determinado conjunto que estejam presentes em um segundo conjunto especificado, limitando o conjunto de resultado a um número especificado de membros. Opcionalmente, essa função também faz uma busca detalhada em um conjunto de tuplas. |
| DrilldownMemberTop (MDX) | Faz uma busca detalhada dos membros de um determinado conjunto que estejam presentes em um segundo conjunto especificado, limitando o conjunto de resultado a um número especificado de membros. Opcionalmente, essa função faz uma busca detalhada em um conjunto de tuplas. |
| DrillupLevel (MDX) | Faz drill up dos membros de um conjunto que estão abaixo de um nível especificado. |
| DrillupMember (MDX) | Faz drill up de membros em um conjunto detalhado presente em um segundo conjunto especificado. |
| Except (MDX) | Encontra a diferença entre dois conjuntos, enquanto retendo duplicatas opcionalmente. |
| Exists (MDX) | Retorna o conjunto de membros de um conjunto que existem com uma ou mais tuplas de um ou mais conjuntos. |
| Extract (MDX) | Retorna um conjunto de tuplas dos elementos de dimensão extraídos. |
| Filter (MDX) | Retorna o conjunto resultante da filtragem de um conjunto especificado com base em um critério de pesquisa. |
| Generate (MDX) | Aplica um conjunto a cada membro de outro conjunto e une os conjuntos resultantes por união. Opcionalmente, essa função retorna uma cadeia de caracteres concatenada criada avaliando-se uma expressão de cadeia de caracteres sobre um conjunto. |
| Head (MDX) | Retorna o primeiro número especificado de elementos em um conjunto, mantendo as duplicatas. |
| Hierarquize (MDX) | Ordena os membros de um conjunto em uma hierarquia. |
| Função Intersect (MDX) | Retorna a interseção de dois conjuntos de entrada, mantendo as duplicatas. |
| LastPeriods (MDX) | Retorna um conjunto de membros até e inclusive um membro especificado. |
| Members (Conjunto) (MDX) | Retorna o conjunto de membros em uma dimensão, nível ou hierarquia. |
| Mtd (MDX) | Retorna um conjunto de membros irmão do mesmo nível como um determinado membro, começando com o primeiro irmão e terminando com um determinado membro, restringido pelo nível Ano na dimensão Tempo. |
| NameToSet (MDX) | Retorna um conjunto que contém o membro especificado por uma cadeia de caracteres formatada em MDX. |
| Função NonEmptyCrossjoin (MDX) | Retorna um conjunto cruzado de um ou mais conjuntos, com exceção de tuplas vazias e tuplas sem dados da tabela de fatos associados. |
| Order (MDX) | Organiza membros de um conjunto especificado, preservando opcionalmente ou quebrando a hierarquia. |
| PeriodsToDate (MDX) | Retorna um conjunto de membros irmão do mesmo nível como um determinado membro, começando com o primeiro irmão e terminando com um determinado membro, restringido por um nível especificado na dimensão Tempo. |
| Qtd (MDX) | Retorna um conjunto de membros irmãos do mesmo nível de um determinado membro, começando com o primeiro irmão e terminando com o membro fornecido, conforme restrito pelo nível Trimestre na dimensão Tempo. |
| Siblings (MDX) | Retorna os irmãos de um membro especificado, inclusive o próprio membro. |
| StripCalculatedMembers (MDX) | Retorna um conjunto gerado, removendo membros calculados de um conjunto especificado. |
| StrToSet (MDX) | Retorna o conjunto especificado por uma cadeia de caracteres formatada em MDX. |
| Subset (MDX) | Retorna um subconjunto de tuplas de um conjunto especificado. |
| Tail (MDX) | Retorna um subconjunto desde o final de um conjunto. |
| ToggleDrillState (MDX) | Alterna o estado de busca de membros. |
| TopCount (MDX) | Classifica um conjunto em ordem decrescente e retorna o número especificado de elementos com os valores mais altos. |
| TopPercent (MDX) | Classifica um conjunto em ordem decrescente e retorna um conjunto de tuplas com os valores mais altos, cujo total cumulativo é igual ou menor que um percentual especificado. |
| TopSum (MDX) | Classifica um conjunto e retorna os elementos de nível mais alto cujo total cumulativo é pelo menos um valor especificado. |
| Union (MDX) | Retorna a união de dois conjuntos, retendo duplicatas opcionalmente. |
| Unorder (MDX) | Remove qualquer classificação forçada de um conjunto especificado. |
| Função VisualTotals (MDX) | Retorna um conjunto gerado com a totalização dinâmica de membros filho em um conjunto especificado, utilizando, opcionalmente, um padrão para o nome do membro pai no conjunto de células resultante. |
| Wtd (MDX) | Retorna um conjunto de membros irmãos do mesmo nível como um determinado membro, começando com o primeiro irmão e terminando com um determinado membro, restringido pelo nível Semana na dimensão Tempo. |
| Ytd (MDX) | Retorna um conjunto de membros irmãos do mesmo nível que um determinado membro, começando com o primeiro irmão e terminando com o membro fornecido, conforme restrito pelo nível Ano na dimensão Tempo. |
Funções de Cadeia de Caracteres
| Função | Descrição |
|---|---|
| CalculationPassValue (MDX) | Retorna o valor de uma expressão MDX avaliado sobre a passagem de cálculo especificada de um cubo. |
| CoalesceEmpty (MDX) | Transforma um valor de célula vazio em um número ou uma cadeia de caracteres e retorna o valor transformado. |
| Generate (MDX) | Aplica um conjunto a cada membro de outro conjunto e une os conjuntos resultantes por união. Opcionalmente, essa função retorna uma cadeia de caracteres concatenada criada avaliando-se uma expressão de cadeia de caracteres sobre um conjunto. |
| IIF (MDX) | Retorna um de dois valores determinados por um teste lógico. |
| LookupCube (MDX) | Retorna o valor de uma expressão MDX avaliada sobre outro cubo especificado no mesmo banco de dados. |
| MemberToStr (MDX) | Retorna uma cadeia de caracteres formatada em MDX que corresponde a um membro especificado. |
| Name (MDX) | Retorna o nome de uma dimensão, hierarquia, nível ou membro. |
| Properties (MDX) | Retorna uma cadeia de caracteres ou um valor com rigidez de tipos que contém um valor de propriedade do membro. |
| SetToStr (MDX) | Retorna uma cadeia de caracteres formatada para MDX que corresponde a um conjunto especificado. |
| TupleToStr (MDX) | Retorna uma cadeia de caracteres formatada em MDX que corresponde à tupla especificada. |
| UniqueName (MDX) | Retorna o nome exclusivo de uma dimensão, hierarquia, nível ou membro especificado. |
| UserName (MDX) | Retorna o nome de domínio e nome de usuário da conexão atual. |
Funções de subcubo
| Função | Descrição |
|---|---|
| This (MDX) | Retorna o subcubo atual. |
| Leaves (MDX) | Retorna o conjunto de membros folha no membro, na dimensão ou na tupla especificada. |
funções de tupla
| Função | Descrição |
|---|---|
| Função Current (MDX) | Retorna a tupla atual de um conjunto durante a iteração. |
| Item (Tupla) (MDX) | Retorna uma tupla de um conjunto. |
| Root (MDX) | Retorna uma tupla que consiste em Todos os membros de cada hierarquia de atributo em um cubo, dimensão ou tupla. |
| StrToTuple (MDX) | Retorna a tupla especificada por uma cadeia de caracteres formatada em MDX. |
Outras funções
| Função | Descrição |
|---|---|
| Função Error (MDX) | Identifica um erro, fornecendo uma mensagem de erro específica (opcional). |