Functions: lenguaje de consulta en Cosmos DB (en Azure y Fabric)

El lenguaje de consulta incluye una serie de funciones del sistema integradas en el lenguaje de consulta y diseñadas para controlar una amplia variedad de tareas comunes.

Functions

Esta es una lista de funciones que admite actualmente el lenguaje de consulta:

Funciones matemáticas

	Description
ABS	La ABS función calcula el valor absoluto (positivo) de la expresión numérica especificada.
ACOS	La ACOS función calcula el arcocoseno trigonométrico del valor numérico especificado. El arcocoseno es el ángulo, en radianes, cuyo coseno es la expresión numérica especificada.
ASIN	La ASIN función calcula el arcoseno trigonométrico del valor numérico especificado. El arcoseno es el ángulo, en radianes, cuyo seno es la expresión numérica especificada.
ATAN	La ATAN función calcula la arctangent trigonométrica del valor numérico especificado. La arcotangente es el ángulo, en radianes, cuya tangente es la expresión numérica especificada.
ATN2	La ATN2 función calcula el valor principal de la arcotangente de y/x, expresado en radianes.
CEILING	La CEILING función calcula el valor entero más pequeño mayor o igual que la expresión numérica especificada.
COS	La COS función calcula el coseno trigonométrico del ángulo especificado en radianes.
COT	La COT función calcula la cotangente trigonométrica del ángulo especificado en radianes.
DEGREES	La DEGREES función calcula el ángulo correspondiente en grados para un ángulo especificado en radianes.
EXP	La EXP función calcula el valor exponencial de la expresión numérica especificada.
FLOOR	La FLOOR función calcula el entero más grande menor o igual que la expresión numérica especificada.
INTADD	La INTADD función devuelve la suma de dos valores enteros.
INTBITAND	La INTBITAND función devuelve una comparación de los bits de cada operando mediante un operador AND inclusivo.
INTBITLEFTSHIFT	La INTBITLEFTSHIFT función devuelve el resultado de una operación de desplazamiento a la izquierda bit a bit en un valor entero.
INTBITNOT	La INTBITNOT función devuelve el resultado de una operación NOT bit a bit en un valor entero.
INTBITOR	La INTBITOR función devuelve el resultado de una operación OR inclusiva bit a bit en dos valores enteros.
INTBITRIGHTSHIFT	La INTBITRIGHTSHIFT función devuelve el resultado de una operación de desplazamiento a la derecha bit a bit en un valor entero.
INTBITXOR	La INTBITXOR función devuelve el resultado de una operación OR exclusiva bit a bit en dos valores enteros.
INTDIV	La INTDIV función devuelve el resultado de dividir el primer valor entero por el segundo.
INTMOD	La INTMOD función devuelve el resto de dividir el primer valor entero por el segundo.
INTMUL	La INTMUL función devuelve el producto de dos valores enteros.
INTSUB	La INTSUB función devuelve el resultado de restar el segundo valor entero del primero.
LOG	La LOG función devuelve el logaritmo natural de la expresión numérica especificada.
LOG10	La LOG10 función devuelve el logaritmo base-10 de la expresión numérica especificada.
NUMBERBIN	La NUMBERBIN función calcula el valor de entrada redondeado a un múltiplo del tamaño especificado.
PI	La PI función devuelve el valor constante de Pi.
POWER	La POWER función devuelve el valor de la expresión especificada múltiplo por sí mismo el número de veces especificado.
RADIANS	La RADIANS función devuelve el ángulo correspondiente en radianes para un ángulo especificado en grados.
RAND	La RAND función devuelve un valor numérico generado aleatoriamente de cero a uno.
ROUND	La ROUND función devuelve un valor numérico redondeado al valor entero más cercano.
SIGN	La SIGN función devuelve el signo positivo (+1), cero (0) o negativo (-1) de la expresión numérica especificada.
SIN	La SIN función devuelve el seno trigonométrico del ángulo especificado en radianes.
SQRT	La SQRT función devuelve la raíz cuadrada del valor numérico especificado.
SQUARE	La SQUARE función devuelve el cuadrado del valor numérico especificado.
TAN	La TAN función devuelve la tangente trigonométrica del ángulo especificado en radianes.
TRUNC	La TRUNC función devuelve un valor numérico truncado al valor entero más cercano.

Funciones de matriz

	Description
ARRAY_CONCAT	La ARRAY_CONCAT función devuelve una matriz que es el resultado de concatenar dos o más valores de matriz.
ARRAY_CONTAINS_ALL	La ARRAY_CONTAINS_ALL función devuelve un valor booleano que indica si la matriz contiene todos los valores especificados.
ARRAY_CONTAINS_ANY	La ARRAY_CONTAINS_ANY función devuelve un valor booleano que indica si la matriz contiene cualquiera de los valores especificados.
ARRAY_CONTAINS	La ARRAY_CONTAINS función devuelve un valor booleano que indica si la matriz contiene el valor especificado. Puede comprobar si hay una coincidencia parcial o completa de un objeto mediante una expresión booleana dentro de la función .
ARRAY_LENGTH	La ARRAY_LENGTH función devuelve el número de elementos de la expresión de matriz especificada.
ARRAY_SLICE	La ARRAY_SLICE función devuelve un subconjunto de una expresión de matriz mediante el índice y la longitud especificados.
CHOOSE	La CHOOSE función devuelve la expresión en el índice especificado de una lista o Undefined si el índice supera los límites de la lista.
OBJECTTOARRAY	La OBJECTTOARRAY función convierte pares de campo/valor en un objeto JSON en una matriz JSON.
SETINTERSECT	La SETINTERSECT función devuelve el conjunto de expresiones contenidas en ambas matrices de entrada sin duplicados.
SETUNION	La SETUNION función devuelve un conjunto de expresiones que contienen todas las expresiones de dos conjuntos recopilados sin duplicados.

Funciones de agregación

	Description
AVG	La AVG función calcula el promedio de los valores de la expresión.
COUNT	La COUNT función devuelve el recuento de los valores de la expresión.
MAX	La MAX función devuelve el valor máximo de la expresión especificada.
MIN	La MIN función devuelve el valor mínimo de la expresión especificada.
SUM	La SUM función calcula la suma de los valores de la expresión.

Funciones de cadena

	Description
CONCAT	La CONCAT función devuelve una cadena que es el resultado de concatenar varios campos de un documento.
CONTAINS	La CONTAINS función devuelve un valor booleano que indica si la primera expresión de cadena contiene la segunda expresión de cadena.
ENDSWITH	La ENDSWITH función devuelve un valor booleano que indica si una cadena termina con el sufijo especificado. Opcionalmente, la comparación puede no distinguir mayúsculas de minúsculas.
INDEX-OF	La INDEX_OF función devuelve el índice de la primera aparición de una cadena.
LEFT	La LEFT función devuelve la parte izquierda de una cadena hasta el número de caracteres especificado.
LENGTH	La LENGTH función devuelve el número de caracteres de la expresión de cadena especificada.
LOWER	La LOWER función devuelve una expresión de cadena después de convertir los datos de caracteres en mayúsculas en minúsculas.
LTRIM	La LTRIM función devuelve una expresión de cadena después de quitar los espacios en blanco iniciales o los caracteres especificados.
REGEXMATCH	La REGEXMATCH función devuelve un valor booleano que indica si la cadena proporcionada coincide con la expresión regular especificada. Las expresiones regulares son una notación concisa y flexible para buscar patrones de texto.
REPLACE	La REPLACE función devuelve una cadena con todas las apariciones de una cadena especificada reemplazada.
REPLICATE	La REPLICATE función devuelve un valor de cadena repetido un número específico de veces.
REVERSE	La REVERSE función devuelve el orden inverso de un valor de cadena.
RIGHT	La RIGHT función devuelve la parte derecha de una cadena hasta el número de caracteres especificado.
RTRIM	La RTRIM función devuelve una expresión de cadena después de quitar los espacios en blanco finales o los caracteres especificados.
STARTSWITH	La STARTSWITH función devuelve un valor booleano que indica si la primera expresión de cadena comienza por la segunda.
STRINGEQUALS	La STRINGEQUALS función devuelve un valor booleano que indica si la primera expresión de cadena coincide con la segunda.
STRINGJOIN	La STRINGJOIN función devuelve una cadena, que concatena los elementos de una matriz especificada, utilizando el separador especificado entre cada elemento.
STRINGSPLIT	La STRINGSPLIT función devuelve una matriz de subcadenas obtenidas de separar la cadena de origen por el delimitador especificado.
STRINGTOARRAY	La STRINGTOARRAY función convierte una expresión de cadena en una matriz.
STRINGTOBOOLEAN	La STRINGTOBOOLEAN función convierte una expresión de cadena en un valor booleano.
SUBSTRING	La SUBSTRING función devuelve parte de una expresión de cadena a partir de la posición especificada y de la longitud especificada, o al final de la cadena.
TOSTRING	La TOSTRING función devuelve una representación de cadena de un valor.
TRIM	La TRIM función devuelve una expresión de cadena después de quitar espacios en blanco iniciales y finales o caracteres personalizados.
UPPER	La UPPER función devuelve una expresión de cadena después de convertir los datos de caracteres en minúsculas en mayúsculas.

Funciones de fecha y hora

	Description
DATETIMEADD	La DATETIMEADD función devuelve un valor de cadena de fecha y hora que es el resultado de agregar un valor de número especificado a la cadena de fecha y hora proporcionada.
DATETIMEBIN	La DATETIMEBIN función devuelve un valor de cadena de fecha y hora que es el resultado de la binning (o redondeo) una parte de la cadena de fecha y hora proporcionada.
DATETIMEDIFF	La DATETIMEDIFF función devuelve la diferencia, como un entero con signo, de la parte de fecha y hora especificadas entre dos valores de fecha y hora.
DATETIMEFROMPARTS	La DATETIMEFROMPARTS función devuelve un valor de cadena de fecha y hora construido a partir de valores numéricos de entrada para varias partes de fecha y hora.
DATETIMEPART	La DATETIMEPART función devuelve el valor de la parte de fecha y hora especificadas para la fecha y hora proporcionadas.
DATETIMETOTICKS	La DATETIMETOTICKS función convierte la fecha y hora especificada en tics. Un solo tic representa 100 nanosegundos o 0,0000001 de un segundo.
DATETIMETOTIMESTAMP	La DATETIMETOTIMESTAMP función convierte la fecha y hora especificadas en una marca de tiempo numérica. La marca de tiempo es un entero numérico con signo que mide los milisegundos desde la época de Unix.
GETCURRENTDATETIME	La GETCURRENTDATETIME función devuelve la fecha y hora UTC (hora universal coordinada) actual como una cadena ISO 8601 .
GETCURRENTDATETIMESTATIC	La GETCURRENTDATETIMESTATIC función devuelve el mismo valor de fecha y hora UTC para todos los elementos de la consulta, como una cadena ISO 8601. Esto resulta útil para marcas de tiempo coherentes entre los resultados de la consulta.
GETCURRENTTICKS	La GETCURRENTTICKS función devuelve la hora UTC actual como el número de intervalos de 100 nanosegundos (tics) transcurridos desde 0001-01-01T00:00:00.0000000Z.
GETCURRENTTICKSSTATIC	La GETCURRENTTICKSSTATIC función devuelve un valor estático de tics nanosegundos (intervalos de 100 nanosegundos desde la época de Unix) para todos los elementos de la misma partición.
GETCURRENTTIMESTAMP	La GETCURRENTTIMESTAMP función devuelve la marca de tiempo actual en milisegundos desde la época de Unix.
GETCURRENTTIMESTAMPSTATIC	La GETCURRENTTIMESTAMPSTATIC función devuelve un valor de marca de tiempo estático (milisegundos desde la época de Unix) para todos los elementos de la misma partición.
TICKSTODATETIME	La TICKSTODATETIME función convierte el número especificado de tics en un valor de fecha y hora.
TIMESTAMPTODATETIME	La TIMESTAMPTODATETIME función convierte la marca de tiempo especificada en un valor de fecha y hora.

Funciones de elemento

	Description
DOCUMENTID	La DOCUMENTID función devuelve el identificador de documento único de un elemento determinado en el contenedor.

Funciones de búsqueda de texto completo

	Description
FULLTEXTCONTAINS	La FULLTEXTCONTAINS función devuelve un valor booleano que indica si la expresión de cadena de palabra clave está contenida en una ruta de acceso de propiedad especificada.
FULLTEXTCONTAINSALL	La FULLTEXTCONTAINSALL función devuelve un valor booleano que indica si todas las expresiones de cadena proporcionadas están contenidas en una ruta de acceso de propiedad especificada.
FULLTEXTCONTAINSANY	La FULLTEXTCONTAINSANY función devuelve un valor booleano que indica si alguna de las expresiones de cadena proporcionadas está contenida en una ruta de acceso de propiedad especificada.
FULLTEXTSCORE	La FULLTEXTSCORE función devuelve un valor de puntuación BM25 que solo se puede usar en una ORDER BY RANK cláusula para ordenar los resultados de mayor relevancia a menor relevancia de los términos especificados.
RRF	La RRF función devuelve una puntuación fusionada combinando dos o más puntuaciones proporcionadas por otras funciones.

Funciones condicionales

	Description
IIF	La IIF función devuelve uno de dos valores, dependiendo de si la expresión booleana se evalúa como true o false.

Funciones de comprobación de tipos

	Description
IS_ARRAY	La IS_ARRAY función devuelve un valor booleano que indica si el tipo de la expresión especificada es una matriz.
IS_BOOL	La IS_BOOL función devuelve un valor booleano que indica si el tipo de la expresión especificada es un valor booleano.
IS_DEFINED	La IS_DEFINED función devuelve un valor booleano que indica si a la propiedad se le ha asignado un valor.
IS_FINITE_NUMBER	La IS_FINITE_NUMBER función devuelve un valor booleano que indica si un número es un número finito (no infinito).
IS_INTEGER	La IS_INTEGER función devuelve un valor booleano que indica si un número es un entero de 64 bits con signo. Los enteros con signo de 64 bits van de -9,223,372,036,854,775,808 a 9,223,372,036,854,775,807. Para obtener más información, consulte __int64.
IS_NULL	La IS_NULL función devuelve un valor booleano que indica si el tipo de la expresión especificada es null.
IS_NUMBER	La IS_NUMBER función devuelve un valor booleano que indica si el tipo de la expresión especificada es un número.
IS_OBJECT	La IS_OBJECT función devuelve un valor booleano que indica si el tipo de la expresión especificada es un objeto JSON.
IS_PRIMITIVE	La IS_PRIMITIVE función devuelve un valor booleano que indica si el tipo de la expresión especificada es primitivo (cadena, booleano, numérico o null).
IS_STRING	La IS_STRING función devuelve un valor booleano que indica si el tipo de la expresión especificada es una cadena.
STRINGTONULL	La STRINGTONULL función convierte una expresión de cadena en null.
STRINGTONUMBER	La STRINGTONUMBER función convierte una expresión de cadena en un número.
STRINGTOOBJECT	La STRINGTOOBJECT función convierte una expresión de cadena en un objeto .

Funciones espaciales

	Description
ST_AREA	La ST_AREA función devuelve el área total de una expresión GeoJSON Polygon o MultiPolygon.
ST_DISTANCE	La ST_DISTANCE función devuelve la distancia entre dos expresiones GeoJSON Point, Polygon, MultiPolygon o LineString.
ST_INTERSECTS	La ST_INTERSECTS función devuelve un valor booleano que indica si el objeto GeoJSON especificado en el primer argumento interseca el objeto GeoJSON en el segundo argumento.
ST_ISVALID	La ST_ISVALID función devuelve un valor booleano que indica si la expresión GeoJSON Point, Polygon, MultiPolygon o LineString especificada es válida.
ST_ISVALIDDETAILED	La ST_ISVALIDDETAILED función devuelve un valor JSON que contiene un valor booleano si la expresión GeoJSON Point, Polygon o LineString especificada es válida y, si no es válida, el motivo.
ST_WITHIN	La ST_WITHIN función devuelve una expresión booleana que indica si el objeto GeoJSON especificado en el primer argumento está dentro del objeto GeoJSON en el segundo argumento.
VECTORDISTANCE	La VECTORDISTANCE función devuelve la puntuación de similitud entre dos vectores especificados.