Funções - Linguagem de consulta no Cosmos DB (no Azure e no Fabric)

A linguagem de consulta inclui uma série de funções do sistema que são incorporadas à linguagem de consulta e projetadas para lidar com uma ampla variedade de tarefas comuns.

Funções

Aqui está uma lista de funções que a linguagem de consulta suporta atualmente:

Funções matemáticas

	Description
ABS	A ABS função calcula o valor absoluto (positivo) da expressão numérica especificada.
ACOS	A ACOS função calcula o arco trigonométrico do valor numérico especificado. O arco cosseno é o ângulo, em radianos, cujo cosseno é a expressão numérica especificada.
ASIN	A ASIN função calcula o arco trigonométrico do valor numérico especificado. O arco seno é o ângulo, em radianos, cujo seno é a expressão numérica especificada.
ATAN	A ATAN função calcula o arco trigonométrico tangente do valor numérico especificado. O arco tangente é o ângulo, em radianos, cuja tangente é a expressão numérica especificada.
ATN2	A ATN2 função calcula o valor principal do arco tangente de y/x, expresso em radianos.
CEILING	A CEILING função calcula o menor valor inteiro maior ou igual à expressão numérica especificada.
COS	A COS função calcula o cosseno trigonométrico do ângulo especificado em radianos.
COT	A COT função calcula a cotangente trigonométrica do ângulo especificado em radianos.
DEGREES	A DEGREES função calcula o ângulo correspondente em graus para um ângulo especificado em radianos.
EXP	A EXP função calcula o valor exponencial da expressão numérica especificada.
FLOOR	A FLOOR função calcula o maior inteiro menor ou igual à expressão numérica especificada.
INTADD	A INTADD função retorna a soma de dois valores inteiros.
INTBITAND	A INTBITAND função retorna uma comparação dos bits de cada operando usando um operador AND inclusivo.
INTBITLEFTSHIFT	A INTBITLEFTSHIFT função retorna o resultado de uma operação de deslocamento para a esquerda bit a bit em um valor inteiro.
INTBITNOT	A INTBITNOT função retorna o resultado de uma operação bit a bit NOT em um valor inteiro.
INTBITOR	A INTBITOR função retorna o resultado de uma operação OR inclusiva bit a bit em dois valores inteiros.
INTBITRIGHTSHIFT	A INTBITRIGHTSHIFT função retorna o resultado de uma operação de deslocamento para a direita bit a bit em um valor inteiro.
INTBITXOR	A INTBITXOR função retorna o resultado de uma operação OR exclusiva bit a bit em dois valores inteiros.
INTDIV	A INTDIV função retorna o resultado da divisão do primeiro valor inteiro pelo segundo.
INTMOD	A INTMOD função retorna o restante da divisão do primeiro valor inteiro pelo segundo.
INTMUL	A INTMUL função retorna o produto de dois valores inteiros.
INTSUB	A INTSUB função retorna o resultado da subtração do segundo valor inteiro do primeiro.
LOG	A LOG função retorna o logaritmo natural da expressão numérica especificada.
LOG10	A LOG10 função retorna o logaritmo de base 10 da expressão numérica especificada.
NUMBERBIN	A NUMBERBIN função calcula o valor de entrada arredondado para um múltiplo do tamanho especificado.
PI	A PI função retorna o valor constante de Pi.
POWER	A POWER função retorna o valor da expressão especificada multiplicada por si mesma o número dado de vezes.
RADIANS	A RADIANS função retorna o ângulo correspondente em radianos para um ângulo especificado em graus.
RAND	A RAND função retorna um valor numérico gerado aleatoriamente de zero a um.
ROUND	A ROUND função retorna um valor numérico arredondado para o valor inteiro mais próximo.
SIGN	A SIGN função retorna o sinal positivo (+1), zero (0) ou negativo (-1) da expressão numérica especificada.
SIN	A SIN função retorna o seno trigonométrico do ângulo especificado em radianos.
SQRT	A SQRT função retorna a raiz quadrada do valor numérico especificado.
SQUARE	A SQUARE função retorna o quadrado do valor numérico especificado.
TAN	A TAN função retorna a tangente trigonométrica do ângulo especificado em radianos.
TRUNC	A TRUNC função retorna um valor numérico truncado para o valor inteiro mais próximo.

Funções de Array

	Description
ARRAY_CONCAT	A ARRAY_CONCAT função retorna uma matriz que é o resultado da concatenação de dois ou mais valores de matriz.
ARRAY_CONTAINS_ALL	A ARRAY_CONTAINS_ALL função retorna um booleano indicando se a matriz contém todos os valores especificados.
ARRAY_CONTAINS_ANY	A ARRAY_CONTAINS_ANY função retorna um booleano indicando se a matriz contém algum dos valores especificados.
ARRAY_CONTAINS	A ARRAY_CONTAINS função retorna um booleano indicando se a matriz contém o valor especificado. Você pode verificar uma correspondência parcial ou total de um objeto usando uma expressão booleana dentro da função.
ARRAY_LENGTH	A ARRAY_LENGTH função retorna o número de elementos na expressão de matriz especificada.
ARRAY_SLICE	A ARRAY_SLICE função retorna um subconjunto de uma expressão de matriz usando o índice e o comprimento especificados.
CHOOSE	A CHOOSE função retorna a expressão no índice especificado de uma lista, ou Undefined se o índice exceder os limites da lista.
OBJECTTOARRAY	A OBJECTTOARRAY função converte pares campo/valor em um objeto JSON em uma matriz JSON.
SETINTERSECT	A SETINTERSECT função retorna o conjunto de expressões que está contido em ambas as matrizes de entrada sem duplicatas.
SETUNION	A SETUNION função retorna um conjunto de expressões contendo todas as expressões de dois conjuntos reunidos sem duplicatas.

Funções de agregação

	Description
AVG	A AVG função calcula a média dos valores na expressão.
COUNT	A COUNT função retorna a contagem dos valores na expressão.
MAX	A MAX função retorna o valor máximo da expressão especificada.
MIN	A MIN função retorna o valor mínimo da expressão especificada.
SUM	A SUM função calcula a soma dos valores na expressão.

Funções de cadeia de caracteres

	Description
CONCAT	A CONCAT função retorna uma cadeia de caracteres que é o resultado da concatenação de vários campos de um documento.
CONTAINS	A CONTAINS função retorna um booleano indicando se a primeira expressão de cadeia de caracteres contém a segunda expressão de cadeia de caracteres.
ENDSWITH	A ENDSWITH função retorna um booleano indicando se uma cadeia de caracteres termina com o sufixo especificado. Opcionalmente, a comparação pode não diferenciar maiúsculas de minúsculas.
INDEX-OF	A INDEX_OF função retorna o índice da primeira ocorrência de uma cadeia de caracteres.
LEFT	A LEFT função retorna a parte esquerda de uma cadeia de caracteres até o número especificado de caracteres.
LENGTH	A LENGTH função retorna o número de caracteres na expressão de cadeia de caracteres especificada.
LOWER	A LOWER função retorna uma expressão de cadeia de caracteres depois de converter dados de caracteres maiúsculos em minúsculas.
LTRIM	A LTRIM função retorna uma expressão de cadeia de caracteres depois de remover o espaço em branco à esquerda ou caracteres especificados.
REGEXMATCH	A REGEXMATCH função retorna um booleano indicando se a cadeia de caracteres fornecida corresponde à expressão regular especificada. As expressões regulares são uma notação concisa e flexível para encontrar padrões de texto.
REPLACE	A REPLACE função retorna uma cadeia de caracteres com todas as ocorrências de uma cadeia de caracteres especificada substituída.
REPLICATE	A REPLICATE função retorna um valor de cadeia de caracteres repetido um número específico de vezes.
REVERSE	A REVERSE função retorna a ordem inversa de um valor de cadeia de caracteres.
RIGHT	A RIGHT função retorna a parte direita de uma cadeia de caracteres até o número especificado de caracteres.
RTRIM	A RTRIM função retorna uma expressão de cadeia de caracteres depois de remover espaços em branco à direita ou caracteres especificados.
STARTSWITH	A STARTSWITH função retorna um valor booleano indicando se a primeira expressão de cadeia de caracteres começa com a segunda.
STRINGEQUALS	A STRINGEQUALS função retorna um booleano indicando se a primeira expressão de cadeia de caracteres corresponde à segunda.
STRINGJOIN	A STRINGJOIN função retorna uma cadeia de caracteres, que concatena os elementos de uma matriz especificada, usando o separador especificado entre cada elemento.
STRINGSPLIT	A STRINGSPLIT função retorna uma matriz de substrings obtidas da separação da string de origem pelo delimitador especificado.
STRINGTOARRAY	A STRINGTOARRAY função converte uma expressão de cadeia de caracteres em uma matriz.
STRINGTOBOOLEAN	A STRINGTOBOOLEAN função converte uma expressão de cadeia de caracteres em um booleano.
SUBSTRING	A SUBSTRING função retorna parte de uma expressão de cadeia de caracteres começando na posição especificada e do comprimento especificado, ou até o final da cadeia de caracteres.
TOSTRING	A TOSTRING função retorna uma representação de cadeia de caracteres de um valor.
TRIM	A TRIM função retorna uma expressão de cadeia de caracteres depois de remover espaços em branco à esquerda e à direita ou caracteres personalizados.
UPPER	A UPPER função retorna uma expressão de cadeia de caracteres depois de converter dados de caracteres minúsculos em maiúsculas.

Funções de data e hora

	Description
DATETIMEADD	A DATETIMEADD função retorna um valor de cadeia de caracteres de data e hora que é o resultado da adição de um valor de número especificado à cadeia de caracteres de data e hora fornecida.
DATETIMEBIN	A DATETIMEBIN função retorna um valor de cadeia de caracteres de data e hora que é o resultado da vinculação (ou arredondamento) de uma parte da cadeia de caracteres de data e hora fornecida.
DATETIMEDIFF	A DATETIMEDIFF função retorna a diferença, como um inteiro assinado, da parte de data e hora especificada entre dois valores de data e hora.
DATETIMEFROMPARTS	A DATETIMEFROMPARTS função retorna um valor de cadeia de caracteres de data e hora construído a partir de valores numéricos de entrada para várias partes de data e hora.
DATETIMEPART	A DATETIMEPART função retorna o valor da parte de data e hora especificada para a data e hora fornecidas.
DATETIMETOTICKS	A DATETIMETOTICKS função converte o DateTime especificado em ticks. Um único tick representa 100 nanossegundos ou 0,0000001 de segundo.
DATETIMETOTIMESTAMP	A DATETIMETOTIMESTAMP função converte a data e hora especificadas em um carimbo de data/hora numérico. O carimbo de data/hora é um inteiro numérico assinado que mede os milissegundos desde a época Unix.
GETCURRENTDATETIME	A GETCURRENTDATETIME função retorna a data e a hora UTC (Tempo Universal Coordenado) atuais como uma cadeia de caracteres ISO 8601 .
GETCURRENTDATETIMESTATIC	A GETCURRENTDATETIMESTATIC função retorna o mesmo valor de data e hora UTC para todos os itens na consulta, como uma cadeia de caracteres ISO 8601. Isso é útil para carimbos de data/hora consistentes nos resultados da consulta.
GETCURRENTTICKS	A GETCURRENTTICKS função retorna a hora UTC atual como o número de intervalos de 100 nanossegundos (ticks) decorridos desde 0001-01-01T00:00:00.0000000Z.
GETCURRENTTICKSSTATIC	A GETCURRENTTICKSSTATIC função retorna um valor estático de ticks de nanossegundos (intervalos de 100 nanossegundos desde a época Unix) para todos os itens na mesma partição.
GETCURRENTTIMESTAMP	A GETCURRENTTIMESTAMP função retorna o carimbo de data/hora atual em milissegundos desde a época do Unix.
GETCURRENTTIMESTAMPSTATIC	A GETCURRENTTIMESTAMPSTATIC função retorna um valor estático de carimbo de data/hora (milissegundos desde a época Unix) para todos os itens na mesma partição.
TICKSTODATETIME	A TICKSTODATETIME função converte o número especificado de ticks em um valor de data e hora.
TIMESTAMPTODATETIME	A TIMESTAMPTODATETIME função converte o carimbo de data/hora especificado em um valor de data e hora.

Funções do item

	Description
DOCUMENTID	A DOCUMENTID função retorna o ID de documento exclusivo para um determinado item no contêiner.

Funções de pesquisa de texto completo

	Description
FULLTEXTCONTAINS	A FULLTEXTCONTAINS função retorna um booleano indicando se a expressão de cadeia de caracteres de palavra-chave está contida em um caminho de propriedade especificado.
FULLTEXTCONTAINSALL	A FULLTEXTCONTAINSALL função retorna um booleano indicando se todas as expressões de cadeia de caracteres fornecidas estão contidas em um caminho de propriedade especificado.
FULLTEXTCONTAINSANY	A FULLTEXTCONTAINSANY função retorna um booleano indicando se alguma das expressões de cadeia de caracteres fornecidas está contida em um caminho de propriedade especificado.
FULLTEXTSCORE	A FULLTEXTSCORE função retorna um valor de pontuação BM25 que só pode ser usado em uma ORDER BY RANK cláusula para classificar os resultados da maior relevância para a menor relevância dos termos especificados.
RRF	A RRF função retorna uma pontuação fundida combinando duas ou mais pontuações fornecidas por outras funções.

Funções condicionais

	Description
IIF	A IIF função retorna um dos dois valores, dependendo se a expressão booleana é avaliada como true ou false.

Funções de verificação de tipo

	Description
IS_ARRAY	A IS_ARRAY função retorna um valor booleano indicando se o tipo da expressão especificada é uma matriz.
IS_BOOL	A IS_BOOL função retorna um valor booleano indicando se o tipo da expressão especificada é booleano.
IS_DEFINED	A IS_DEFINED função retorna um booleano indicando se a propriedade recebeu um valor.
IS_FINITE_NUMBER	A IS_FINITE_NUMBER função retorna um booleano indicando se um número é um número finito (não infinito).
IS_INTEGER	A IS_INTEGER função retorna um booleano indicando se um número é um inteiro assinado de 64 bits. Os inteiros assinados de 64 bits variam de -9,223,372,036,854,775,808 até 9,223,372,036,854,775,807. Para obter mais informações, consulte __int64.
IS_NULL	A IS_NULL função retorna um valor booleano indicando se o tipo da expressão especificada é null.
IS_NUMBER	A IS_NUMBER função retorna um valor booleano indicando se o tipo da expressão especificada é um número.
IS_OBJECT	A IS_OBJECT função retorna um valor booleano indicando se o tipo da expressão especificada é um objeto JSON.
IS_PRIMITIVE	A IS_PRIMITIVE função retorna um valor booleano indicando se o tipo da expressão especificada é uma primitiva (string, booleana, numérica ou nula).
IS_STRING	A IS_STRING função retorna um valor booleano indicando se o tipo da expressão especificada é uma cadeia de caracteres.
STRINGTONULL	A STRINGTONULL função converte uma expressão de cadeia de caracteres em null.
STRINGTONUMBER	A STRINGTONUMBER função converte uma expressão de cadeia de caracteres em um número.
STRINGTOOBJECT	A STRINGTOOBJECT função converte uma expressão de cadeia de caracteres em um objeto.

Funções espaciais

	Description
ST_AREA	A ST_AREA função retorna a área total de uma expressão GeoJSON Polygon ou MultiPolygon.
ST_DISTANCE	A ST_DISTANCE função retorna a distância entre duas expressões GeoJSON Point, Polygon, MultiPolygon ou LineString.
ST_INTERSECTS	A ST_INTERSECTS função retorna um booleano indicando se o objeto GeoJSON especificado no primeiro argumento intersecta o objeto GeoJSON no segundo argumento.
ST_ISVALID	A ST_ISVALID função retorna um valor booleano que indica se a expressão GeoJSON Point, Polygon, MultiPolygon ou LineString especificada é válida.
ST_ISVALIDDETAILED	A ST_ISVALIDDETAILED função retorna um valor JSON contendo um valor booleano se a expressão GeoJSON Point, Polygon ou LineString especificada for válida e, se inválida, o motivo.
ST_WITHIN	A ST_WITHIN função retorna uma expressão booleana indicando se o objeto GeoJSON especificado no primeiro argumento está dentro do objeto GeoJSON no segundo argumento.
VECTORDISTANCE	A VECTORDISTANCE função retorna a pontuação de similaridade entre dois vetores especificados.