Functions – Frågespråk i Cosmos DB (i Azure och Fabric)

Frågespråket innehåller en serie systemfunktioner som är inbyggda i frågespråket och utformade för att hantera en mängd olika vanliga uppgifter.

Functions

Här är en lista över funktioner som frågespråket för närvarande stöder:

Matematiska funktioner

Description
ABS Funktionen ABS beräknar det absoluta (positiva) värdet för det angivna numeriska uttrycket.
ACOS Funktionen ACOS beräknar trigonometrisk arccosinus för det angivna numeriska värdet. Arccosinus är vinkeln, i radianer, vars cosinus är det angivna numeriska uttrycket.
ASIN Funktionen ASIN beräknar trigonometrisk arcsinus för det angivna numeriska värdet. Arcsinus är vinkeln, i radianer, vars sinus är det angivna numeriska uttrycket.
ATAN Funktionen ATAN beräknar trigonometrisk arctangens för det angivna numeriska värdet. Arctangensen är vinkeln, i radianer, vars tangent är det angivna numeriska uttrycket.
ATN2 Funktionen ATN2 beräknar huvudvärdet för arctangensen y/xför , uttryckt i radianer.
CEILING Funktionen CEILING beräknar det minsta heltalsvärdet som är större än eller lika med det angivna numeriska uttrycket.
COS Funktionen COS beräknar trigonometrisk cosiné för den angivna vinkeln i radianer.
COT Funktionen COT beräknar den trigonometriska cotangensen för den angivna vinkeln i radianer.
DEGREES Funktionen DEGREES beräknar motsvarande vinkel i grader för en vinkel som anges i radianer.
EXP Funktionen EXP beräknar exponentiellt värde för det angivna numeriska uttrycket.
FLOOR Funktionen FLOOR beräknar det största heltalet mindre än eller lika med det angivna numeriska uttrycket.
INTADD Funktionen INTADD returnerar summan av två heltalsvärden.
INTBITAND Funktionen INTBITAND returnerar en jämförelse av bitarna för varje operande med en inkluderande AND-operator.
INTBITLEFTSHIFT Funktionen INTBITLEFTSHIFT returnerar resultatet av en bitvis vänster skift-åtgärd på ett heltalsvärde.
INTBITNOT Funktionen INTBITNOT returnerar resultatet av en bitvis NOT-åtgärd på ett heltalsvärde.
INTBITOR Funktionen INTBITOR returnerar resultatet av en bitvis inkluderande OR-åtgärd på två heltalsvärden.
INTBITRIGHTSHIFT Funktionen INTBITRIGHTSHIFT returnerar resultatet av en bitvis höger skiftåtgärd på ett heltalsvärde.
INTBITXOR Funktionen INTBITXOR returnerar resultatet av en bitvis exklusiv OR-åtgärd på två heltalsvärden.
INTDIV Funktionen INTDIV returnerar resultatet av att dividera det första heltalsvärdet med det andra.
INTMOD Funktionen INTMOD returnerar resten av uppdelningen av det första heltalsvärdet med det andra.
INTMUL Funktionen INTMUL returnerar produkten av två heltalsvärden.
INTSUB Funktionen INTSUB returnerar resultatet av att subtrahera det andra heltalsvärdet från det första.
LOG Funktionen LOG returnerar den naturliga logaritmen för det angivna numeriska uttrycket.
LOG10 Funktionen LOG10 returnerar logaritmen base-10 för det angivna numeriska uttrycket.
NUMBERBIN Funktionen NUMBERBIN beräknar indatavärdet avrundat till en multipel av den angivna storleken.
PI Funktionen PI returnerar det konstanta värdet för Pi.
POWER Funktionen POWER returnerar värdet för det angivna uttrycket som multipelts av sig själv det angivna antalet gånger.
RADIANS Funktionen RADIANS returnerar motsvarande vinkel i radianer för en vinkel som anges i grader.
RAND Funktionen RAND returnerar ett slumpmässigt genererat numeriskt värde från noll till ett.
ROUND Funktionen ROUND returnerar ett numeriskt värde avrundat till närmaste heltalsvärde.
SIGN Funktionen SIGN returnerar det positiva (+1), noll (0) eller negativa (-1) tecknet för det angivna numeriska uttrycket.
SIN Funktionen SIN returnerar trigonometrisk sinus för den angivna vinkeln i radianer.
SQRT Funktionen SQRT returnerar kvadratroten för det angivna numeriska värdet.
SQUARE Funktionen SQUARE returnerar kvadraten för det angivna numeriska värdet.
TAN Funktionen TAN returnerar den trigonometriska tangensen för den angivna vinkeln i radianer.
TRUNC Funktionen TRUNC returnerar ett numeriskt värde trunkerat till närmaste heltalsvärde.

Array-funktioner

Description
ARRAY_CONCAT Funktionen ARRAY_CONCAT returnerar en matris som är resultatet av sammanlänkning av två eller flera matrisvärden.
ARRAY_CONTAINS_ALL Funktionen ARRAY_CONTAINS_ALL returnerar ett booleskt värde som anger om matrisen innehåller alla angivna värden.
ARRAY_CONTAINS_ANY Funktionen ARRAY_CONTAINS_ANY returnerar ett booleskt värde som anger om matrisen innehåller något av de angivna värdena.
ARRAY_CONTAINS Funktionen ARRAY_CONTAINS returnerar ett booleskt värde som anger om matrisen innehåller det angivna värdet. Du kan söka efter en partiell eller fullständig matchning av ett objekt med hjälp av ett booleskt uttryck i funktionen.
ARRAY_LENGTH Funktionen ARRAY_LENGTH returnerar antalet element i det angivna matrisuttrycket.
ARRAY_SLICE Funktionen ARRAY_SLICE returnerar en delmängd av ett matrisuttryck med hjälp av det angivna indexet och längden.
CHOOSE Funktionen CHOOSE returnerar uttrycket vid det angivna indexet för en lista eller Odefinierat om indexet överskrider listans gränser.
OBJECTTOARRAY Funktionen OBJECTTOARRAY konverterar fält/värde-par i ett JSON-objekt till en JSON-matris.
SETINTERSECT Funktionen SETINTERSECT returnerar den uppsättning uttryck som finns i båda indatamatriserna utan dubbletter.
SETUNION Funktionen SETUNION returnerar en uppsättning uttryck som innehåller alla uttryck från två insamlade uppsättningar utan dubbletter.

Sammansättningsfunktioner

Description
AVG Funktionen AVG beräknar medelvärdet av värdena i uttrycket.
COUNT Funktionen COUNT returnerar antalet värden i uttrycket.
MAX Funktionen MAX returnerar det maximala värdet för det angivna uttrycket.
MIN Funktionen MIN returnerar det minsta värdet för det angivna uttrycket.
SUM Funktionen SUM beräknar summan av värdena i uttrycket.

Strängfunktioner

Description
CONCAT Funktionen CONCAT returnerar en sträng som är resultatet av att sammanfoga flera fält från ett dokument.
CONTAINS Funktionen CONTAINS returnerar ett booleskt värde som anger om det första stränguttrycket innehåller det andra stränguttrycket.
ENDSWITH Funktionen ENDSWITH returnerar ett booleskt värde som anger om en sträng slutar med det angivna suffixet. Om du vill kan jämförelsen vara skiftlägeskänslig.
INDEX-OF Funktionen INDEX_OF returnerar indexet för den första förekomsten av en sträng.
LEFT Funktionen LEFT returnerar den vänstra delen av en sträng upp till det angivna antalet tecken.
LENGTH Funktionen LENGTH returnerar antalet tecken i det angivna stränguttrycket.
LOWER Funktionen LOWER returnerar ett stränguttryck efter konvertering av versaler till gemener.
LTRIM Funktionen LTRIM returnerar ett stränguttryck när det tar bort inledande blanksteg eller angivna tecken.
REGEXMATCH Funktionen REGEXMATCH returnerar ett booleskt värde som anger om den angivna strängen matchar det angivna reguljära uttrycket. Reguljära uttryck är en koncis och flexibel notation för att hitta textmönster.
REPLACE Funktionen REPLACE returnerar en sträng med alla förekomster av en angiven sträng ersatt.
REPLICATE Funktionen REPLICATE returnerar ett strängvärde som upprepas ett visst antal gånger.
REVERSE Funktionen REVERSE returnerar omvänd ordning för ett strängvärde.
RIGHT Funktionen RIGHT returnerar den högra delen av en sträng upp till det angivna antalet tecken.
RTRIM Funktionen RTRIM returnerar ett stränguttryck när det tar bort avslutande blanksteg eller angivna tecken.
STARTSWITH Funktionen STARTSWITH returnerar ett booleskt värde som anger om det första stränguttrycket börjar med det andra.
STRINGEQUALS Funktionen STRINGEQUALS returnerar ett booleskt värde som anger om det första stränguttrycket matchar det andra.
STRINGJOIN Funktionen STRINGJOIN returnerar en sträng som sammanfogar elementen i en angiven matris med hjälp av den angivna avgränsaren mellan varje element.
STRINGSPLIT Funktionen STRINGSPLIT returnerar en matris med delsträngar som hämtats från att avgränsa källsträngen med den angivna avgränsaren.
STRINGTOARRAY Funktionen STRINGTOARRAY konverterar ett stränguttryck till en matris.
STRINGTOBOOLEAN Funktionen STRINGTOBOOLEAN konverterar ett stränguttryck till ett booleskt värde.
SUBSTRING Funktionen SUBSTRING returnerar en del av ett stränguttryck som börjar vid den angivna positionen och den angivna längden, eller till slutet av strängen.
TOSTRING Funktionen TOSTRING returnerar en strängrepresentation av ett värde.
TRIM Funktionen TRIM returnerar ett stränguttryck när det tar bort inledande och avslutande blanksteg eller anpassade tecken.
UPPER Funktionen UPPER returnerar ett stränguttryck efter konvertering av gemener till versaler.

Datum- och tidsfunktioner

Description
DATETIMEADD Funktionen DATETIMEADD returnerar ett datum- och tidssträngsvärde som är resultatet av att lägga till ett angivet talvärde i den angivna datum- och tidssträngen.
DATETIMEBIN Funktionen DATETIMEBIN returnerar ett datum- och tidssträngsvärde som är resultatet av binning (eller avrundning) en del av den angivna datum- och tidssträngen.
DATETIMEDIFF Funktionen DATETIMEDIFF returnerar skillnaden, som ett signerat heltal, för den angivna datum- och tidsdelen mellan två datum- och tidsvärden.
DATETIMEFROMPARTS Funktionen DATETIMEFROMPARTS returnerar ett datum- och tidssträngsvärde som konstruerats från numeriska indatavärden för olika datum- och tidsdelar.
DATETIMEPART Funktionen DATETIMEPART returnerar värdet för den angivna datum- och tidsdelen för angivet datum och tid.
DATETIMETOTICKS Funktionen DATETIMETOTICKS konverterar den angivna DateTime till ticks. En enda tick representerar 100 nanosekunder eller 0,0000001 av en sekund.
DATETIMETOTIMESTAMP Funktionen DATETIMETOTIMESTAMP konverterar det angivna datumet och tiden till en numerisk tidsstämpel. Tidsstämpeln är ett signerat numeriskt heltal som mäter millisekunderna sedan Unix-epoken.
GETCURRENTDATETIME Funktionen GETCURRENTDATETIME returnerar aktuellt DATUM och tid för UTC (Coordinated Universal Time) som en ISO 8601-sträng .
GETCURRENTDATETIMESTATIC Funktionen GETCURRENTDATETIMESTATIC returnerar samma UTC-datum- och tidsvärde för alla objekt i frågan som en ISO 8601-sträng. Detta är användbart för konsekventa tidsstämplar mellan frågeresultat.
GETCURRENTTICKS Funktionen GETCURRENTTICKS returnerar den aktuella UTC-tiden som antalet intervall på 100 nanosekunder (tick) som har förflutit sedan 0001-01-01T00:00:00.0000000Z.
GETCURRENTTICKSSTATIC Funktionen GETCURRENTTICKSSTATIC returnerar ett statiskt nanosekunders tickvärde (intervall på 100 nanosekunder sedan Unix-epoken) för alla objekt i samma partition.
GETCURRENTTIMESTAMP Funktionen GETCURRENTTIMESTAMP returnerar den aktuella tidsstämpeln i millisekunder sedan Unix-epoken.
GETCURRENTTIMESTAMPSTATIC Funktionen GETCURRENTTIMESTAMPSTATIC returnerar ett statiskt tidsstämpelvärde (millisekunder sedan Unix-epoken) för alla objekt i samma partition.
TICKSTODATETIME Funktionen TICKSTODATETIME konverterar det angivna antalet tick till ett datum- och tidsvärde.
TIMESTAMPTODATETIME Funktionen TIMESTAMPTODATETIME konverterar den angivna tidsstämpeln till ett datum- och tidsvärde.

Funktioner för objekt

Description
DOCUMENTID Funktionen DOCUMENTID returnerar det unika dokument-ID:t för ett visst objekt i containern.

Fulltextsökningsfunktioner

Description
FULLTEXTCONTAINS Funktionen FULLTEXTCONTAINS returnerar ett booleskt värde som anger om nyckelordsstränguttrycket finns i en angiven egenskapssökväg.
FULLTEXTCONTAINSALL Funktionen FULLTEXTCONTAINSALL returnerar ett booleskt värde som anger om alla angivna stränguttryck finns i en angiven egenskapssökväg.
FULLTEXTCONTAINSANY Funktionen FULLTEXTCONTAINSANY returnerar ett booleskt värde som anger om något av de angivna stränguttrycken finns i en angiven egenskapssökväg.
FULLTEXTSCORE Funktionen FULLTEXTSCORE returnerar ett BM25-poängvärde som bara kan användas i en ORDER BY RANK sats för att sortera resultat från högsta relevans till lägsta relevans för de angivna termerna.
RRF Funktionen RRF returnerar en sammansvetsad poäng genom att kombinera två eller flera poäng som tillhandahålls av andra funktioner.

Villkorsstyrda funktioner

Description
IIF Funktionen IIF returnerar ett av två värden, beroende på om det booleska uttrycket utvärderas till sant eller falskt.

Funktioner för typkontroll

Description
IS_ARRAY Funktionen IS_ARRAY returnerar ett booleskt värde som anger om typen av det angivna uttrycket är en matris.
IS_BOOL Funktionen IS_BOOL returnerar ett booleskt värde som anger om typen av det angivna uttrycket är ett booleskt värde.
IS_DEFINED Funktionen IS_DEFINED returnerar ett booleskt värde som anger om egenskapen har tilldelats ett värde.
IS_FINITE_NUMBER Funktionen IS_FINITE_NUMBER returnerar ett booleskt värde som anger om ett tal är ett begränsat tal (inte oändligt).
IS_INTEGER Funktionen IS_INTEGER returnerar ett booleskt värde som anger om ett tal är ett 64-bitars signerat heltal. 64-bitars signerade heltal sträcker sig från -9,223,372,036,854,775,808 till 9,223,372,036,854,775,807. Mer information finns i __int64.
IS_NULL Funktionen IS_NULL returnerar ett booleskt värde som anger om typen av det angivna uttrycket är null.
IS_NUMBER Funktionen IS_NUMBER returnerar ett booleskt värde som anger om typen av det angivna uttrycket är ett tal.
IS_OBJECT Funktionen IS_OBJECT returnerar ett booleskt värde som anger om typen av det angivna uttrycket är ett JSON-objekt.
IS_PRIMITIVE Funktionen IS_PRIMITIVE returnerar ett booleskt värde som anger om typen av det angivna uttrycket är en primitiv (sträng, boolesk, numerisk eller null).
IS_STRING Funktionen IS_STRING returnerar ett booleskt värde som anger om typen av det angivna uttrycket är en sträng.
STRINGTONULL Funktionen STRINGTONULL konverterar ett stränguttryck till null.
STRINGTONUMBER Funktionen STRINGTONUMBER konverterar ett stränguttryck till ett tal.
STRINGTOOBJECT Funktionen STRINGTOOBJECT konverterar ett stränguttryck till ett objekt.

Spatiella funktioner

Description
ST_AREA Funktionen ST_AREA returnerar det totala området för ett GeoJSON Polygon- eller MultiPolygon-uttryck.
ST_DISTANCE Funktionen ST_DISTANCE returnerar avståndet mellan två GeoJSON Point-, Polygon-, MultiPolygon- eller LineString-uttryck.
ST_INTERSECTS Funktionen ST_INTERSECTS returnerar ett booleskt värde som anger om GeoJSON-objektet som anges i det första argumentet korsar GeoJSON-objektet i det andra argumentet.
ST_ISVALID Funktionen ST_ISVALID returnerar ett booleskt värde som anger om det angivna GeoJSON-, Polygon-, MultiPolygon- eller LineString-uttrycket är giltigt.
ST_ISVALIDDETAILED Funktionen ST_ISVALIDDETAILED returnerar ett JSON-värde som innehåller ett booleskt värde om det angivna GeoJSON-, Polygon- eller LineString-uttrycket är giltigt, och om det är ogiltigt, orsaken.
ST_WITHIN Funktionen ST_WITHIN returnerar ett booleskt uttryck som anger om GeoJSON-objektet som anges i det första argumentet finns i GeoJSON-objektet i det andra argumentet.
VECTORDISTANCE Funktionen VECTORDISTANCE returnerar likhetspoängen mellan två angivna vektorer.