Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Le langage de requête inclut une série de fonctions système intégrées au langage de requête et conçues pour gérer une grande variété de tâches courantes.
Functions
Voici la liste des fonctions prises en charge par le langage de requête :
Fonctions mathématiques
| Descriptif | |
|---|---|
ABS |
La ABS fonction calcule la valeur absolue (positive) de l’expression numérique spécifiée. |
ACOS |
La ACOS fonction calcule l’arccosine trigonométrique de la valeur numérique spécifiée. L’arccosine est l’angle, en radians, dont le cosinus est l’expression numérique spécifiée. |
ASIN |
La ASIN fonction calcule l’arcsin trigonométrique de la valeur numérique spécifiée. L’arcsin est l’angle, en radians, dont le sinus est l’expression numérique spécifiée. |
ATAN |
La ATAN fonction calcule l’arctangente trigonométrique de la valeur numérique spécifiée. L’arctangente est l’angle, en radians, dont la tangente est l’expression numérique spécifiée. |
ATN2 |
La ATN2 fonction calcule la valeur principale de l’arctangente , y/xexprimée en radians. |
CEILING |
La CEILING fonction calcule la plus petite valeur entière supérieure ou égale à l’expression numérique spécifiée. |
COS |
La COS fonction calcule le cosinus trigonométrique de l’angle spécifié en radians. |
COT |
La COT fonction calcule la cotangente trigonométrique de l’angle spécifié en radians. |
DEGREES |
La DEGREES fonction calcule l’angle correspondant en degrés pour un angle spécifié en radians. |
EXP |
La EXP fonction calcule la valeur exponentielle de l’expression numérique spécifiée. |
FLOOR |
La FLOOR fonction calcule le plus grand entier inférieur ou égal à l’expression numérique spécifiée. |
INTADD |
La INTADD fonction retourne la somme de deux valeurs entières. |
INTBITAND |
La INTBITAND fonction retourne une comparaison des bits de chaque opérande à l’aide d’un opérateur AND inclusif. |
INTBITLEFTSHIFT |
La INTBITLEFTSHIFT fonction retourne le résultat d’une opération de décalage gauche au niveau du bit sur une valeur entière. |
INTBITNOT |
La INTBITNOT fonction retourne le résultat d’une opération NOT au niveau du bit sur une valeur entière. |
INTBITOR |
La INTBITOR fonction retourne le résultat d’une opération OR inclusive au niveau du bit sur deux valeurs entières. |
INTBITRIGHTSHIFT |
La INTBITRIGHTSHIFT fonction retourne le résultat d’une opération de décalage droit au niveau du bit sur une valeur entière. |
INTBITXOR |
La INTBITXOR fonction retourne le résultat d’une opération OR exclusive au niveau du bit sur deux valeurs entières. |
INTDIV |
La INTDIV fonction retourne le résultat de la division de la première valeur entière par la seconde. |
INTMOD |
La INTMOD fonction retourne le reste de la division de la première valeur entière par la seconde. |
INTMUL |
La INTMUL fonction retourne le produit de deux valeurs entières. |
INTSUB |
La INTSUB fonction retourne le résultat de la soustraction de la deuxième valeur entière du premier. |
LOG |
La LOG fonction retourne le logarithme naturel de l’expression numérique spécifiée. |
LOG10 |
La LOG10 fonction retourne le logarithme de base 10 de l’expression numérique spécifiée. |
NUMBERBIN |
La NUMBERBIN fonction calcule la valeur d’entrée arrondie à un multiple de la taille spécifiée. |
PI |
La PI fonction retourne la valeur constante de Pi. |
POWER |
La POWER fonction retourne la valeur de l’expression spécifiée multiple par elle-même le nombre donné de fois. |
RADIANS |
La RADIANS fonction retourne l’angle correspondant en radians pour un angle spécifié en degrés. |
RAND |
La RAND fonction retourne une valeur numérique générée aléatoirement de zéro à une. |
ROUND |
La ROUND fonction retourne une valeur numérique arrondie à la valeur entière la plus proche. |
SIGN |
La SIGN fonction retourne le signe positif (+1), zéro (0) ou négatif (-1) de l’expression numérique spécifiée. |
SIN |
La SIN fonction retourne le sinus trigonométrique de l’angle spécifié en radians. |
SQRT |
La SQRT fonction retourne la racine carrée de la valeur numérique spécifiée. |
SQUARE |
La SQUARE fonction retourne le carré de la valeur numérique spécifiée. |
TAN |
La TAN fonction retourne la tangente trigonométrique de l’angle spécifié en radians. |
TRUNC |
La TRUNC fonction retourne une valeur numérique tronquée à la valeur entière la plus proche. |
Fonctions de tableau
| Descriptif | |
|---|---|
ARRAY_CONCAT |
La ARRAY_CONCAT fonction retourne un tableau qui est le résultat de la concaténation de deux valeurs de tableau ou plus. |
ARRAY_CONTAINS_ALL |
La ARRAY_CONTAINS_ALL fonction retourne une valeur booléenne indiquant si le tableau contient toutes les valeurs spécifiées. |
ARRAY_CONTAINS_ANY |
La ARRAY_CONTAINS_ANY fonction retourne une valeur booléenne indiquant si le tableau contient l’une des valeurs spécifiées. |
ARRAY_CONTAINS |
La ARRAY_CONTAINS fonction retourne une valeur booléenne indiquant si le tableau contient la valeur spécifiée. Vous pouvez rechercher une correspondance partielle ou complète d’un objet à l’aide d’une expression booléenne dans la fonction. |
ARRAY_LENGTH |
La ARRAY_LENGTH fonction retourne le nombre d’éléments dans l’expression de tableau spécifiée. |
ARRAY_SLICE |
La ARRAY_SLICE fonction retourne un sous-ensemble d’une expression de tableau à l’aide de l’index et de la longueur spécifiés. |
CHOOSE |
La CHOOSE fonction retourne l’expression à l’index spécifié d’une liste, ou Undefined si l’index dépasse les limites de la liste. |
OBJECTTOARRAY |
La OBJECTTOARRAY fonction convertit les paires champ/valeur dans un objet JSON en tableau JSON. |
SETINTERSECT |
La SETINTERSECT fonction retourne l’ensemble d’expressions contenues dans les deux tableaux d’entrée sans doublons. |
SETUNION |
La SETUNION fonction retourne un ensemble d’expressions contenant toutes les expressions de deux ensembles collectés sans doublons. |
Fonctions d’agrégation
| Descriptif | |
|---|---|
AVG |
La AVG fonction calcule la moyenne des valeurs dans l’expression. |
COUNT |
La COUNT fonction retourne le nombre de valeurs dans l’expression. |
MAX |
La MAX fonction retourne la valeur maximale de l’expression spécifiée. |
MIN |
La MIN fonction retourne la valeur minimale de l’expression spécifiée. |
SUM |
La SUM fonction calcule la somme des valeurs dans l’expression. |
Fonctions de chaîne
| Descriptif | |
|---|---|
CONCAT |
La CONCAT fonction retourne une chaîne qui est le résultat de la concaténation de plusieurs champs à partir d’un document. |
CONTAINS |
La CONTAINS fonction retourne une valeur booléenne indiquant si la première expression de chaîne contient la deuxième expression de chaîne. |
ENDSWITH |
La ENDSWITH fonction retourne une valeur booléenne indiquant si une chaîne se termine par le suffixe spécifié. Si vous le souhaitez, la comparaison peut ne pas respecter la casse. |
INDEX-OF |
La INDEX_OF fonction retourne l’index de la première occurrence d’une chaîne. |
LEFT |
La LEFT fonction retourne la partie gauche d’une chaîne jusqu’au nombre de caractères spécifié. |
LENGTH |
La LENGTH fonction retourne le nombre de caractères dans l’expression de chaîne spécifiée. |
LOWER |
La LOWER fonction retourne une expression de chaîne après avoir converti les données de caractères majuscules en minuscules. |
LTRIM |
La LTRIM fonction retourne une expression de chaîne après avoir supprimé les espaces blancs de début ou les caractères spécifiés. |
REGEXMATCH |
La REGEXMATCH fonction retourne une valeur booléenne indiquant si la chaîne fournie correspond à l’expression régulière spécifiée. Les expressions régulières sont une notation concise et flexible pour rechercher des modèles de texte. |
REPLACE |
La REPLACE fonction retourne une chaîne avec toutes les occurrences d’une chaîne spécifiée remplacée. |
REPLICATE |
La REPLICATE fonction retourne une valeur de chaîne répétée un nombre spécifique de fois. |
REVERSE |
La REVERSE fonction retourne l’ordre inverse d’une valeur de chaîne. |
RIGHT |
La RIGHT fonction retourne la partie droite d’une chaîne jusqu’au nombre spécifié de caractères. |
RTRIM |
La RTRIM fonction retourne une expression de chaîne après avoir supprimé les espaces blancs de fin ou les caractères spécifiés. |
STARTSWITH |
La STARTSWITH fonction retourne une valeur booléenne indiquant si la première expression de chaîne commence par la seconde. |
STRINGEQUALS |
La STRINGEQUALS fonction retourne une valeur booléenne indiquant si la première expression de chaîne correspond à la seconde. |
STRINGJOIN |
La STRINGJOIN fonction retourne une chaîne, qui concatène les éléments d’un tableau spécifié, à l’aide du séparateur spécifié entre chaque élément. |
STRINGSPLIT |
La STRINGSPLIT fonction retourne un tableau de sous-chaînes obtenues à partir de la séparation de la chaîne source par le délimiteur spécifié. |
STRINGTOARRAY |
La STRINGTOARRAY fonction convertit une expression de chaîne en tableau. |
STRINGTOBOOLEAN |
La STRINGTOBOOLEAN fonction convertit une expression de chaîne en valeur booléenne. |
SUBSTRING |
La SUBSTRING fonction retourne une partie d’une expression de chaîne commençant à la position spécifiée et de la longueur spécifiée, ou à la fin de la chaîne. |
TOSTRING |
La TOSTRING fonction retourne une représentation sous forme de chaîne d’une valeur. |
TRIM |
La TRIM fonction retourne une expression de chaîne après avoir supprimé les espaces blancs de début et de fin ou les caractères personnalisés. |
UPPER |
La UPPER fonction retourne une expression de chaîne après avoir converti les données de caractères minuscules en majuscules. |
Fonctions de date et d’heure
| Descriptif | |
|---|---|
DATETIMEADD |
La DATETIMEADD fonction retourne une valeur de chaîne de date et d’heure qui est le résultat de l’ajout d’une valeur numérique spécifiée à la chaîne de date et d’heure fournie. |
DATETIMEBIN |
La DATETIMEBIN fonction retourne une valeur de chaîne de date et d’heure qui est le résultat de l’arrondi (ou de l’arrondi) une partie de la chaîne de date et d’heure fournie. |
DATETIMEDIFF |
La DATETIMEDIFF fonction retourne la différence, sous la forme d’un entier signé, de la partie de date et d’heure spécifiée entre deux valeurs de date et d’heure. |
DATETIMEFROMPARTS |
La DATETIMEFROMPARTS fonction retourne une valeur de chaîne de date et d’heure construite à partir de valeurs numériques d’entrée pour différentes parties de date et d’heure. |
DATETIMEPART |
La DATETIMEPART fonction retourne la valeur de la partie date et heure spécifiées pour la date et l’heure fournies. |
DATETIMETOTICKS |
La DATETIMETOTICKS fonction convertit le DateTime spécifié en graduations. Une seule graduation représente 100 nanosecondes ou 0,0000001 d’une seconde. |
DATETIMETOTIMESTAMP |
La DATETIMETOTIMESTAMP fonction convertit la date et l’heure spécifiées en horodatage numérique. L’horodatage est un entier numérique signé qui mesure les millisecondes depuis l’époque Unix. |
GETCURRENTDATETIME |
La GETCURRENTDATETIME fonction retourne la date et l’heure UTC actuelles (temps universel coordonné) sous forme de chaîne ISO 8601 . |
GETCURRENTDATETIMESTATIC |
La GETCURRENTDATETIMESTATIC fonction retourne la même valeur de date et d’heure UTC pour tous les éléments de la requête, sous forme de chaîne ISO 8601. Cela est utile pour les horodatages cohérents entre les résultats de la requête. |
GETCURRENTTICKS |
La GETCURRENTTICKS fonction retourne l’heure UTC actuelle comme nombre d’intervalles de 100 nanosecondes (graduations) qui se sont écoulés depuis 0001-01-01T00:00:00.000000Z. |
GETCURRENTTICKSSTATIC |
La GETCURRENTTICKSSTATIC fonction retourne une valeur de graduations nanosecondes statiques (intervalles de 100 nanosecondes depuis l’époque Unix) pour tous les éléments de la même partition. |
GETCURRENTTIMESTAMP |
La GETCURRENTTIMESTAMP fonction retourne l’horodatage actuel en millisecondes depuis l’époque Unix. |
GETCURRENTTIMESTAMPSTATIC |
La GETCURRENTTIMESTAMPSTATIC fonction retourne une valeur d’horodatage statique (millisecondes depuis l’époque Unix) pour tous les éléments de la même partition. |
TICKSTODATETIME |
La TICKSTODATETIME fonction convertit le nombre spécifié de graduations en valeur de date et d’heure. |
TIMESTAMPTODATETIME |
La TIMESTAMPTODATETIME fonction convertit l’horodatage spécifié en valeur de date et d’heure. |
Fonctions des éléments
| Descriptif | |
|---|---|
DOCUMENTID |
La DOCUMENTID fonction retourne l’ID de document unique d’un élément donné dans le conteneur. |
Fonctions de recherche en texte intégral
| Descriptif | |
|---|---|
FULLTEXTCONTAINS |
La FULLTEXTCONTAINS fonction retourne une valeur booléenne indiquant si l’expression de chaîne de mot clé est contenue dans un chemin de propriété spécifié. |
FULLTEXTCONTAINSALL |
La FULLTEXTCONTAINSALL fonction retourne une valeur booléenne indiquant si toutes les expressions de chaîne fournies sont contenues dans un chemin de propriété spécifié. |
FULLTEXTCONTAINSANY |
La FULLTEXTCONTAINSANY fonction retourne une valeur booléenne indiquant si l’une des expressions de chaîne fournies est contenue dans un chemin de propriété spécifié. |
FULLTEXTSCORE |
La FULLTEXTSCORE fonction retourne une valeur de score BM25 qui ne peut être utilisée que dans une ORDER BY RANK clause pour trier les résultats de la plus haute pertinence à la plus faible pertinence des termes spécifiés. |
RRF |
La RRF fonction retourne un score fusionné en combinant deux scores ou plus fournis par d’autres fonctions. |
Fonctions conditionnelles
| Descriptif | |
|---|---|
IIF |
La IIF fonction retourne l’une des deux valeurs, selon que l’expression booléenne prend la valeur true ou false. |
Fonctions de vérification du type
| Descriptif | |
|---|---|
IS_ARRAY |
La IS_ARRAY fonction retourne une valeur booléenne indiquant si le type de l’expression spécifiée est un tableau. |
IS_BOOL |
La IS_BOOL fonction retourne une valeur booléenne indiquant si le type de l’expression spécifiée est une valeur booléenne. |
IS_DEFINED |
La IS_DEFINED fonction retourne une valeur booléenne indiquant si la propriété a été affectée à une valeur. |
IS_FINITE_NUMBER |
La IS_FINITE_NUMBER fonction retourne une valeur booléenne indiquant si un nombre est un nombre fini (pas infini). |
IS_INTEGER |
La IS_INTEGER fonction retourne une valeur booléenne indiquant si un nombre est un entier signé 64 bits. Les entiers signés 64 bits vont de -9,223,372,036,854,775,808 à 9,223,372,036,854,775,807. Pour plus d’informations, consultez __int64. |
IS_NULL |
La IS_NULL fonction retourne une valeur booléenne indiquant si le type de l’expression spécifiée est null. |
IS_NUMBER |
La IS_NUMBER fonction retourne une valeur booléenne indiquant si le type de l’expression spécifiée est un nombre. |
IS_OBJECT |
La IS_OBJECT fonction retourne une valeur booléenne indiquant si le type de l’expression spécifiée est un objet JSON. |
IS_PRIMITIVE |
La IS_PRIMITIVE fonction retourne une valeur booléenne indiquant si le type de l’expression spécifiée est une primitive (chaîne, booléen, numérique ou null). |
IS_STRING |
La IS_STRING fonction retourne une valeur booléenne indiquant si le type de l’expression spécifiée est une chaîne. |
STRINGTONULL |
La STRINGTONULL fonction convertit une expression de chaîne en null. |
STRINGTONUMBER |
La STRINGTONUMBER fonction convertit une expression de chaîne en nombre. |
STRINGTOOBJECT |
La STRINGTOOBJECT fonction convertit une expression de chaîne en objet. |
Fonctions spatiales
| Descriptif | |
|---|---|
ST_AREA |
La ST_AREA fonction retourne la zone totale d’une expression Polygone GeoJSON ou MultiPolygon. |
ST_DISTANCE |
La ST_DISTANCE fonction retourne la distance entre deux expressions GeoJSON Point, Polygon, MultiPolygon ou LineString. |
ST_INTERSECTS |
La ST_INTERSECTS fonction retourne une valeur booléenne indiquant si l’objet GeoJSON spécifié dans le premier argument croise l’objet GeoJSON dans le deuxième argument. |
ST_ISVALID |
La ST_ISVALID fonction retourne une valeur booléenne indiquant si l’expression GeoJSON Point, Polygon, MultiPolygon ou LineString spécifiée est valide. |
ST_ISVALIDDETAILED |
La ST_ISVALIDDETAILED fonction retourne une valeur JSON contenant une valeur booléenne si l’expression GeoJSON Point, Polygon ou LineString spécifiée est valide et, si elle n’est pas valide, la raison. |
ST_WITHIN |
La ST_WITHIN fonction retourne une expression booléenne indiquant si l’objet GeoJSON spécifié dans le premier argument se trouve dans l’objet GeoJSON dans le deuxième argument. |
VECTORDISTANCE |
La VECTORDISTANCE fonction retourne le score de similarité entre deux vecteurs spécifiés. |