Funkcje — język zapytań w usłudze Cosmos DB (na platformie Azure i w sieci szkieletowej)

Język zapytań zawiera szereg funkcji systemowych wbudowanych w język zapytań i przeznaczonych do obsługi wielu typowych zadań.

Functions

Oto lista funkcji, które obecnie obsługuje język zapytań:

Funkcje matematyczne

	Description
ABS	Funkcja ABS oblicza wartość bezwzględną (dodatnią) określonego wyrażenia liczbowego.
ACOS	Funkcja ACOS oblicza arcus cosinus trygonometryczny określonej wartości liczbowej. Arcus cosinus jest kątem w radianach, którego cosinus jest określonym wyrażeniem liczbowym.
ASIN	Funkcja ASIN oblicza arcusus trygonometryczny określonej wartości liczbowej. Arcynia jest kątem w radianach, którego sinus jest określonym wyrażeniem liczbowym.
ATAN	Funkcja ATAN oblicza arcus tangens trygonometryczny określonej wartości liczbowej. Arcus tangens jest kątem w radianach, którego tangens jest określonym wyrażeniem liczbowym.
ATN2	Funkcja ATN2 oblicza wartość główną arcus tangensu , wyrażonego y/xw radianach.
CEILING	Funkcja CEILING oblicza najmniejszą wartość całkowitą większą lub równą określonemu wyrażeniu liczbowemu.
COS	Funkcja COS oblicza cosinus trygonometryczny określonego kąta w radianach.
COT	Funkcja COT oblicza cotangent trygonometryczny określonego kąta w radianach.
DEGREES	Funkcja DEGREES oblicza odpowiedni kąt w stopniach dla kąta określonego w radianach.
EXP	Funkcja EXP oblicza wartość wykładniczą określonego wyrażenia liczbowego.
FLOOR	Funkcja FLOOR oblicza największą liczbę całkowitą mniejszą lub równą określonemu wyrażeniu liczbowemu.
INTADD	Funkcja INTADD zwraca sumę dwóch wartości całkowitych.
INTBITAND	Funkcja INTBITAND zwraca porównanie bitów każdego operandu przy użyciu operatora AND inkluzywnego.
INTBITLEFTSHIFT	Funkcja INTBITLEFTSHIFT zwraca wynik operacji przesunięcia bitowego w lewo na wartości całkowitej.
INTBITNOT	Funkcja INTBITNOT zwraca wynik bitowej operacji NOT na wartości całkowitej.
INTBITOR	Funkcja INTBITOR zwraca wynik bitowej operacji OR dla dwóch wartości całkowitych.
INTBITRIGHTSHIFT	Funkcja INTBITRIGHTSHIFT zwraca wynik operacji przesunięcia bitowego w prawo na wartości całkowitej.
INTBITXOR	Funkcja INTBITXOR zwraca wynik bitowej operacji wykluczania OR na dwóch wartościach całkowitych.
INTDIV	Funkcja INTDIV zwraca wynik dzielenia pierwszej wartości całkowitej przez drugą.
INTMOD	Funkcja INTMOD zwraca resztę dzielenia pierwszej wartości całkowitej przez drugą.
INTMUL	Funkcja INTMUL zwraca iloczyn dwóch wartości całkowitych.
INTSUB	Funkcja INTSUB zwraca wynik odejmowania drugiej wartości całkowitej z pierwszej.
LOG	Funkcja LOG zwraca logarytm naturalny określonego wyrażenia liczbowego.
LOG10	Funkcja LOG10 zwraca logarytm base-10 określonego wyrażenia liczbowego.
NUMBERBIN	Funkcja NUMBERBIN oblicza wartość wejściową zaokrągloną do wielokrotności określonego rozmiaru.
PI	Funkcja PI zwraca stałą wartość pi.
POWER	Funkcja POWER zwraca wartość określonego wyrażenia wiele razy.
RADIANS	Funkcja RADIANS zwraca odpowiedni kąt w radianach dla kąta określonego w stopniach.
RAND	Funkcja RAND zwraca losowo wygenerowaną wartość liczbową z zera do jednego.
ROUND	Funkcja ROUND zwraca wartość liczbową zaokrąglaną do najbliższej wartości całkowitej.
SIGN	Funkcja SIGN zwraca dodatni (+1), zero (0) lub ujemny (-1) znak określonego wyrażenia liczbowego.
SIN	Funkcja SIN zwraca sinus trygonometryczny określonego kąta w radianach.
SQRT	Funkcja SQRT zwraca pierwiastek kwadratowy określonej wartości liczbowej.
SQUARE	Funkcja SQUARE zwraca kwadrat określonej wartości liczbowej.
TAN	Funkcja TAN zwraca tangens trygonometryczny określonego kąta w radianach.
TRUNC	Funkcja TRUNC zwraca wartość liczbową obciętą do najbliższej wartości całkowitej.

Funkcje tablicy

	Description
ARRAY_CONCAT	Funkcja ARRAY_CONCAT zwraca tablicę, która jest wynikiem łączenia co najmniej dwóch wartości tablicy.
ARRAY_CONTAINS_ALL	Funkcja ARRAY_CONTAINS_ALL zwraca wartość logiczną wskazującą, czy tablica zawiera wszystkie określone wartości.
ARRAY_CONTAINS_ANY	Funkcja ARRAY_CONTAINS_ANY zwraca wartość logiczną wskazującą, czy tablica zawiera dowolną z określonych wartości.
ARRAY_CONTAINS	Funkcja ARRAY_CONTAINS zwraca wartość logiczną wskazującą, czy tablica zawiera określoną wartość. Możesz sprawdzić częściowe lub pełne dopasowanie obiektu przy użyciu wyrażenia logicznego w funkcji.
ARRAY_LENGTH	Funkcja ARRAY_LENGTH zwraca liczbę elementów w określonym wyrażeniu tablicy.
ARRAY_SLICE	Funkcja ARRAY_SLICE zwraca podzbiór wyrażenia tablicy przy użyciu określonego indeksu i długości.
CHOOSE	Funkcja CHOOSE zwraca wyrażenie w określonym indeksie listy lub niezdefiniowane, jeśli indeks przekracza granice listy.
OBJECTTOARRAY	Funkcja OBJECTTOARRAY konwertuje pary pól/wartości w obiekcie JSON na tablicę JSON.
SETINTERSECT	Funkcja SETINTERSECT zwraca zestaw wyrażeń zawartych w obu tablicach wejściowych bez duplikatów.
SETUNION	Funkcja SETUNION zwraca zestaw wyrażeń zawierających wszystkie wyrażenia z dwóch zebranych zestawów bez duplikatów.

Funkcje agregacji

	Description
AVG	Funkcja AVG oblicza średnią wartości w wyrażeniu.
COUNT	Funkcja COUNT zwraca liczbę wartości w wyrażeniu.
MAX	Funkcja MAX zwraca maksymalną wartość określonego wyrażenia.
MIN	Funkcja MIN zwraca minimalną wartość określonego wyrażenia.
SUM	Funkcja SUM oblicza sumę wartości w wyrażeniu.

Funkcje łańcuchów znakowych

	Description
CONCAT	Funkcja CONCAT zwraca ciąg, który jest wynikiem łączenia wielu pól z dokumentu.
CONTAINS	Funkcja CONTAINS zwraca wartość logiczną wskazującą, czy pierwsze wyrażenie ciągu zawiera drugie wyrażenie ciągu.
ENDSWITH	Funkcja ENDSWITH zwraca wartość logiczną wskazującą, czy ciąg kończy się określonym sufiksem. Opcjonalnie porównanie może być bez uwzględniania wielkości liter.
INDEX-OF	Funkcja INDEX_OF zwraca indeks pierwszego wystąpienia ciągu.
LEFT	Funkcja LEFT zwraca lewą część ciągu do określonej liczby znaków.
LENGTH	Funkcja LENGTH zwraca liczbę znaków w określonym wyrażeniu ciągu.
LOWER	Funkcja LOWER zwraca wyrażenie ciągu po przekonwertowaniu danych wielkich liter na małe litery.
LTRIM	Funkcja LTRIM zwraca wyrażenie ciągu po usunięciu wiodącego odstępu lub określonych znaków.
REGEXMATCH	Funkcja REGEXMATCH zwraca wartość logiczną wskazującą, czy podany ciąg jest zgodny z określonym wyrażeniem regularnym. Wyrażenia regularne to zwięzła i elastyczna notacja służąca do znajdowania wzorców tekstu.
REPLACE	Funkcja REPLACE zwraca ciąg ze wszystkimi wystąpieniami określonego ciągu zamienione.
REPLICATE	Funkcja REPLICATE zwraca wartość ciągu powtarzaną określoną liczbę razy.
REVERSE	Funkcja REVERSE zwraca odwrotną kolejność wartości ciągu.
RIGHT	Funkcja RIGHT zwraca prawą część ciągu do określonej liczby znaków.
RTRIM	Funkcja RTRIM zwraca wyrażenie ciągu po usunięciu końcowego odstępu lub określonych znaków.
STARTSWITH	Funkcja STARTSWITH zwraca wartość logiczną wskazującą, czy pierwsze wyrażenie ciągu rozpoczyna się od drugiego.
STRINGEQUALS	Funkcja STRINGEQUALS zwraca wartość logiczną wskazującą, czy pierwsze wyrażenie ciągu jest zgodne z drugim.
STRINGJOIN	Funkcja STRINGJOIN zwraca ciąg, który łączy elementy określonej tablicy przy użyciu określonego separatora między poszczególnymi elementami.
STRINGSPLIT	Funkcja STRINGSPLIT zwraca tablicę podciągów uzyskanych z oddzielania ciągu źródłowego przez określony ogranicznik.
STRINGTOARRAY	Funkcja STRINGTOARRAY konwertuje wyrażenie ciągu na tablicę.
STRINGTOBOOLEAN	Funkcja STRINGTOBOOLEAN konwertuje wyrażenie ciągu na wartość logiczną.
SUBSTRING	Funkcja SUBSTRING zwraca część wyrażenia ciągu rozpoczynającą się od określonej pozycji i określonej długości lub na końcu ciągu.
TOSTRING	Funkcja TOSTRING zwraca reprezentację ciągu wartości.
TRIM	Funkcja TRIM zwraca wyrażenie ciągu po usunięciu wiodącego i końcowego odstępu lub znaków niestandardowych.
UPPER	Funkcja UPPER zwraca wyrażenie ciągu po przekonwertowaniu małych liter na wielkie litery.

Funkcje daty i godziny

	Description
DATETIMEADD	Funkcja DATETIMEADD zwraca wartość ciągu daty i godziny, która jest wynikiem dodania określonej wartości liczbowej do podanego ciągu daty i godziny.
DATETIMEBIN	Funkcja DATETIMEBIN zwraca wartość ciągu daty i godziny, która jest wynikiem kwantowania (lub zaokrąglania) części podanego ciągu daty i godziny.
DATETIMEDIFF	Funkcja DATETIMEDIFF zwraca różnicę jako podpisaną liczbę całkowitą określonej części daty i godziny między dwiema wartościami daty i godziny.
DATETIMEFROMPARTS	Funkcja DATETIMEFROMPARTS zwraca wartość ciągu daty i godziny skonstruowaną na podstawie wejściowych wartości liczbowych dla różnych części daty i godziny.
DATETIMEPART	Funkcja DATETIMEPART zwraca wartość określonej części daty i godziny dla podanej daty i godziny.
DATETIMETOTICKS	Funkcja DATETIMETOTICKS konwertuje określoną wartość DateTime na znaczniki. Pojedynczy znacznik reprezentuje 100 nanosekund lub 0,0000001 sekundy.
DATETIMETOTIMESTAMP	Funkcja DATETIMETOTIMESTAMP konwertuje określoną datę i godzinę na liczbowy znacznik czasu. Sygnatura czasowa jest cyfrową liczbą całkowitą, która mierzy milisekundy od epoki Unix.
GETCURRENTDATETIME	Funkcja GETCURRENTDATETIME zwraca bieżącą datę i godzinę UTC (uniwersalny czas koordynowany) jako ciąg ISO 8601 .
GETCURRENTDATETIMESTATIC	Funkcja GETCURRENTDATETIMESTATIC zwraca tę samą wartość daty i godziny UTC dla wszystkich elementów w zapytaniu jako ciąg ISO 8601. Jest to przydatne w przypadku spójnych sygnatur czasowych w wynikach zapytania.
GETCURRENTTICKS	Funkcja GETCURRENTTICKS zwraca bieżącą godzinę UTC jako liczbę interwałów 100-nanosekundowych (kleszczy), które upłynęły od 0001-01-01T00:00:00.000000Z.
GETCURRENTTICKSSTATIC	Funkcja GETCURRENTTICKSSTATIC zwraca statyczną wartość znaczników nanosekundowych (100-nanosekundowych od epoki unix) dla wszystkich elementów w tej samej partycji.
GETCURRENTTIMESTAMP	Funkcja GETCURRENTTIMESTAMP zwraca bieżący znacznik czasu w milisekundach od epoki unix.
GETCURRENTTIMESTAMPSTATIC	Funkcja GETCURRENTTIMESTAMPSTATIC zwraca statyczną wartość znacznika czasu (milisekund od epoki systemu Unix) dla wszystkich elementów w tej samej partycji.
TICKSTODATETIME	Funkcja TICKSTODATETIME konwertuje określoną liczbę znaczników na wartość daty i godziny.
TIMESTAMPTODATETIME	Funkcja TIMESTAMPTODATETIME konwertuje określony znacznik czasu na wartość daty i godziny.

Funkcje elementów

	Description
DOCUMENTID	Funkcja DOCUMENTID zwraca unikatowy identyfikator dokumentu dla danego elementu w kontenerze.

Funkcje wyszukiwania pełnotekstowego

	Description
FULLTEXTCONTAINS	Funkcja FULLTEXTCONTAINS zwraca wartość logiczną wskazującą, czy wyrażenie ciągu kluczowego znajduje się w określonej ścieżce właściwości.
FULLTEXTCONTAINSALL	Funkcja FULLTEXTCONTAINSALL zwraca wartość logiczną wskazującą, czy wszystkie podane wyrażenia ciągu znajdują się w określonej ścieżce właściwości.
FULLTEXTCONTAINSANY	Funkcja FULLTEXTCONTAINSANY zwraca wartość logiczną wskazującą, czy którekolwiek z podanych wyrażeń ciągu znajdują się w określonej ścieżce właściwości.
FULLTEXTSCORE	Funkcja FULLTEXTSCORE zwraca wartość wyniku BM25, która może być używana tylko w ORDER BY RANK klauzuli w celu sortowania wyników z najwyższej trafności do najniższego trafności określonych terminów.
RRF	Funkcja RRF zwraca wynik połączony przez połączenie co najmniej dwóch wyników udostępnianych przez inne funkcje.

Funkcje warunkowe

	Description
IIF	Funkcja IIF zwraca jedną z dwóch wartości, w zależności od tego, czy wyrażenie logiczne zwraca wartość true, czy false.

Funkcje sprawdzania typów

	Description
IS_ARRAY	Funkcja IS_ARRAY zwraca wartość logiczną wskazującą, czy typ określonego wyrażenia jest tablicą.
IS_BOOL	Funkcja IS_BOOL zwraca wartość logiczną wskazującą, czy typ określonego wyrażenia jest wartością logiczną.
IS_DEFINED	Funkcja IS_DEFINED zwraca wartość logiczną wskazującą, czy właściwość została przypisana wartość.
IS_FINITE_NUMBER	Funkcja IS_FINITE_NUMBER zwraca wartość logiczną wskazującą, czy liczba jest liczbą skończona (nie nieskończoną).
IS_INTEGER	Funkcja IS_INTEGER zwraca wartość logiczną wskazującą, czy liczba jest 64-bitową liczbą całkowitą ze znakiem. 64-bitowe liczby całkowite ze znakiem od -9,223,372,036,854,775,808 do 9,223,372,036,854,775,807. Aby uzyskać więcej informacji, zobacz __int64.
IS_NULL	Funkcja IS_NULL zwraca wartość logiczną wskazującą, czy typ określonego wyrażenia to null.
IS_NUMBER	Funkcja IS_NUMBER zwraca wartość logiczną wskazującą, czy typ określonego wyrażenia jest liczbą.
IS_OBJECT	Funkcja IS_OBJECT zwraca wartość logiczną wskazującą, czy typ określonego wyrażenia jest obiektem JSON.
IS_PRIMITIVE	Funkcja IS_PRIMITIVE zwraca wartość logiczną wskazującą, czy typ określonego wyrażenia jest pierwotny (ciąg, wartość logiczna, numeryczna lub null).
IS_STRING	Funkcja IS_STRING zwraca wartość logiczną wskazującą, czy typ określonego wyrażenia jest ciągiem.
STRINGTONULL	Funkcja STRINGTONULL konwertuje wyrażenie ciągu na null.
STRINGTONUMBER	Funkcja STRINGTONUMBER konwertuje wyrażenie ciągu na liczbę.
STRINGTOOBJECT	Funkcja STRINGTOOBJECT konwertuje wyrażenie ciągu na obiekt.

Funkcje przestrzenne

	Description
ST_AREA	Funkcja ST_AREA zwraca całkowity obszar wyrażenia Wielokątnego lub Wielopolygonu GeoJSON.
ST_DISTANCE	Funkcja ST_DISTANCE zwraca odległość między dwoma wyrażeniami GeoJSON Point, Polygon, MultiPolygon lub LineString.
ST_INTERSECTS	Funkcja ST_INTERSECTS zwraca wartość logiczną wskazującą, czy obiekt GeoJSON określony w pierwszym argumencie przecina obiekt GeoJSON w drugim argumencie.
ST_ISVALID	Funkcja ST_ISVALID zwraca wartość logiczną wskazującą, czy określone wyrażenie GeoJSON Point, Polygon, MultiPolygon lub LineString jest prawidłowe.
ST_ISVALIDDETAILED	Funkcja ST_ISVALIDDETAILED zwraca wartość JSON zawierającą wartość logiczną, jeśli określone wyrażenie GeoJSON Point, Polygon lub LineString jest prawidłowe, a jeśli jest nieprawidłowe, przyczyna.
ST_WITHIN	Funkcja ST_WITHIN zwraca wyrażenie logiczne wskazujące, czy obiekt GeoJSON określony w pierwszym argumencie znajduje się w obiekcie GeoJSON w drugim argumencie.
VECTORDISTANCE	Funkcja VECTORDISTANCE zwraca wynik podobieństwa między dwoma określonymi wektorami.