Scalar functions

abs()

Learn how to use the abs() function to calculate the absolute value of an input.

acos()

Learn how to use the acos() function to calculate the angle of the cosine input.

ago()

Learn how to use the ago() function to subtract a given timespan from the current UTC clock time.

around() function

Learn how to use the around() function to indicate if the first argument is within a range around the center value.

array_concat()

Learn how to use the array_concat() function to concatenate many dynamic arrays to a single array.

array_iff()

Learn how to use the array_iff() function to scan and evaluate elements in an array.

array_index_of()

Learn how to use the array_index_of() function to search an array for a specified item, and return its position.

array_length()

Learn how to use the array_length() function to calculate the number of elements in a dynamic array.

array_reverse()

Learn how to use the array_reverse() function to reverse the order of the elements in a dynamic array.

array_rotate_left()

Learn how to use the array_rotate_left() function to rotate values inside a dynamic array to the left.

array_rotate_right()

Learn how to use the array_rotate_right() function to rotate values inside a dynamic array to the right.

array_shift_left()

Learn how to use the array_shift_left() function to shift the values inside a dynamic array to the left.

array_shift_right()

Learn how to use the array_shift_right() function to shift values inside a dynamic array to the right.

array_slice()

Learn how to use the array_slice() function to extract a slice of a dynamic array.

array_sort_asc()

Learn how to use the array_sort_asc() function to sort arrays in ascending order.

array_sort_desc()

Learn how to use the array_sort_desc() function to sort arrays in descending order.

array_split()

Learn how to use the array_split() function to split an array into multiple arrays.

array_sum()

Learn how to use the array_sum() function to calculate the sum of elements in a dynamic array.

asin()

Learn how to use the asin() function to calculate the angle from a sine input.

assert()

Learn how to use the assert() function to check for a condition and output an error message when false.

atan()

Learn how to use the atan() function to return the inverse operation of tan().

atan2()

Learn how to use the atan2() function to calculate an angle in radians between axes.

bag_has_key()

Learn how to use the bag_has_key() function to check if a dynamic property bag object contains a given key.

bag_keys()

Learn how to use the bag_keys() function to enumerate the root keys in a dynamic property bag object.

bag_merge()

Learn how to use the bag_merge() function to merge property bags.

bag_pack_columns()

Learn how to use the bag_pack_columns() function to create a dynamic JSON object from a list of columns.

bag_pack()

Learn how to use the bag_pack() function to create a dynamic JSON object from a list of keys and values.

bag_remove_keys()

Learn how to use the bag_remove_keys() function to remove keys and associated values from property bags.

bag_set_key()

Learn how to use the bag_set_key() function to set a given key to a given value in a dynamic property-bag.

bag_zip()

Learn how to use bag_zip() to merge two dynamic arrays into a single property-bag of keys and values.

base64_decode_toarray()

Learn how to use the base64_decode_toarray() function to decode a base64 string into an array of long values.

base64_decode_toguid()

Learn how to use base64_decode_toguid() function to return a GUID from a base64 string.

base64_decode_tostring()

Learn how to use a base64_decode_tostring() function to decode a base64 string into a UTF-8 string.

base64_encode_fromarray()

Learn how to use the base64_encode_fromarray() function to encode a base64 string from a bytes array.

base64_encode_fromguid()

Learn how to use the base64_encode_fromguid() function to return a base64 string from a GUID.

base64_encode_tostring()

This article describes base64_encode_tostring().

beta_cdf()

Learn how to use the beta_cdf() function to return a standard beta cumulative distribution function.

beta_inv()

Learn how to use the beta_inv() function to return the inverse of the beta cumulative probability density function.

beta_pdf()

Learn how to use the beta_pdf() function to return the beta probability density function.

bin_at()

Learn how to use the bin_at() function to round values down to a fixed-size bin.

bin_auto()

Learn how to use the bin_auto() function to round values down to a fixed-size bin.

bin()

Learn how to use the bin() function to round values down to an integer multiple of a given bin size.

binary_and()

Learn how to use the binary_and() function to compare bits in corresponding operands.

binary_not()

Learn how to use the binary_not() function to return a bitwise negation of the input value.

binary_or()

Learn how to use the bianry_or() function to perform a bitwise OR operation of the two values.

binary_shift_left()

Learn how to use the binary_shift_left() function to perform a binary shift left operation on a pair of numbers.

binary_shift_right()

Learn how to use the binary_shift_right() function to perform a binary shift right operation on a pair of numbers.

binary_xor()

Learn how to use the binary_xor() function to perform the bitwise xor operation on a pair of values.

bitset_count_ones()

Learn how to use the bitset_count_ones() function to return the number of set bits in the binary representation of a number.

case()

Learn how to use the case() function to evaluate a list of predicates and return the first expression for which the predicate evaluates to true.

ceiling()

Learn how to use the ceiling() function to calculate the smallest integer greater than, or equal to, the specified numeric expression.

coalesce()

Learn how to use the coalesce() function to evaluate a list of expressions to return the first non-null expression.

column_ifexists()

Learn how to use the column_ifexists() function to return a reference to the column if it exists.

convert_angle()

Learn how to use the convert_angle() function to convert an angle input value from one unit to another.

convert_energy()

Learn how to use the convert_energy() function to convert an energy input value from one unit to another.

convert_force()

Learn how to use the convert_force() function to convert a force input value from one unit to another.

convert_length()

Learn how to use the convert_length() function to convert a length input value from one unit to another.

convert_mass()

Learn how to use the convert_mass() function to convert a mass input value from one unit to another.

convert_speed()

Learn how to use the convert_speed() function to convert a speed input value from one unit to another.

convert_temperature()

Learn how to use the convert_temperature() function to convert a temperature input value from one unit to another.

convert_volume()

Learn how to use the convert_volume() function to convert a volume input value from one unit to another.

cos()

Learn how to use the cos() function to return the cosine of the input value.

cot()

Learn how to use the cot() function to calculate the trigonometric cotangent of the specified angle in radians.

countof()

Learn how to use the countof() function to count the occurrences of a substring in a string.

current_cluster_endpoint()

Learn how to use the current_cluster_endpoint() function to return the network endpoint of the cluster being queried as a string type value.

current_database()

Learn how to use the current_database() function to return the name of the database in scope as a string type value.

current_principal_details()

Learn how to use the current_principal_details() function to return the details of the principal running the query.

current_principal_is_member_of()

Learn how to use the current_principal_is_member_of() function to check the identity of the principal running the query.

current_principal()

Learn how to use the current_principal() function to return the name of the principal running the query.

cursor_after()

Learn how to use the cursor_after() function to compare the ingestion time of the records of a table against the database cursor time.

cursor_before_or_at()

Learn how to use the cursor_before_or_at() function to compare the ingestion time of the records of a table against the database cursor time.

cursor_current()

Learn how to use the cursor_current() function to return a string type value.

datetime_add()

Learn how to use the datetime_add() function to calculate a new datetime.

datetime_diff()

Learn how to use the datetime_diff() function to calculate the period between two datetime values.

datetime_list_timezones()

Get a list of all supported timezones.

datetime_local_to_utc()

Learn how to use the datetime_local_to_utc() function to convert local datetime to UTC datetime.

datetime_part()

This article describes datetime_part().

datetime_utc_to_local()

This article describes the datetime_utc_to_local function.

dayofmonth()

Learn how to use the dayofmonth() function to return an integer representing the day of the month.

dayofweek()

Learn how to use the dayofweek() function to return the timespan since the preceding Sunday.

dayofyear()

Learn how to use the dayofyear() function to return the day number of the given year.

dcount_hll()

Learn how to use the dcount_hll() function to calculate the distinct count from hyper log log (hll) intermediate calculation results.

degrees()

Learn how to use the degrees() function to convert angle values from radians to values in degrees.

dynamic_to_json()

Learn how to use the dynamic_to_json() function to convert a scalar value of type dynamic to a canonical string representation.

endofday()

Learn how to use the endofday() function to return a datetime representing the end of the day for the given date value.

endofmonth()

Learn how to use the endofmonth() function to return a datetime representing the end of the month for the given date value.

endofweek()

Learn how to use the endofweek() function to return a datetime representing the end of the week for the given date value.

endofyear()

Learn how to use the endofyear() function to return a datetime representing the end of the year for the given date value.

erf()

This article describes erf() function.

erfc()

This article describes erfc() function.

estimate_data_size()

Learn how to use the estimate_data_size() function to return an estimated data size in bytes of the selected columns of the tabular expression.

exp()

Learn how to use the exp() function to return the base-e exponential value of x.

exp10()

Learn how to use the exp10() function to return the base-10 exponential value of x.

exp2()

Learn how to use the exp2() function to return the base-2 exponential value of x.

extent_id()

Learn how to use the extent_id() function to return an identifier of the current record’s data shard

extent_tags()

Learn how to use the extent_tags() function to return a dynamic array of the data shard that the current record is in.

extract_all()

Lean how to use the extract_all() to extract all matches for a regular expression from a source string.

extract_json()

Learn how to use the extract_json() function to get a specified element out of a JSON text using a path expression.

extract()

Learn how to use the extract() function to get a match for a regular expression from a source string.

format_bytes()

Learn how to use the format_bytes() function to format a number as a string representing the data size in bytes.

format_datetime()

Learn how to use the format_datetime() function to format a datetime according to the provided format.

format_ipv4_mask()

Learn how to use the format_ipv4_mask() function to parse the input with a netmask and return a string representing the IPv4 address in CIDR notation.

format_ipv4()

Learn how to use the format_ipv4() function to parse the input with a netmask and return a string representing the IPv4 address.

format_timespan()

Learn how to use the format_timespan() function to format a timespan according to the provided format.

gamma()

Learn how to use the gamma() function to compute the gamma of the input parameter.

geo_info_from_ip_address()

Learn how to use the geo_info_from_ip_address() function to retrieve geolocation information about IPv4 or IPv6 addresses.

gettype()

Learn how to use the gettype() function to return a string representing the runtime type of its single argument.

getyear()

Learn how tow use the getyear() function to return the year of the datetime input.

gzip_compress_to_base64_string

Learn how to use the gzip_compress_to_base64_string() function to gzip-compress an input and encode it into a base64 string.

gzip_decompress_from_base64_string()

Learn how to use the gzip_decompress_from_base64_string() function to decode an input string from base64 and perform a gzip-decompression.

has_any_ipv4_prefix()

Learn how to use the has_any_ipv4_prefix() function to check if any IPv4 address prefixes appear in the text.

has_any_ipv4()

Learn how to use the has_any_ipv4() function to check if any IPv4 addresses appear in the text.

has_ipv4_prefix()

Learn how to use the has_ipv4_prefix() function to check if a specified IPv4 address prefix appears in the text.

has_ipv4()

Learn how to use the has_ipv4() function to check if a specified IPv4 address appears in the text.

hash_combine()

learn how to use the hash_combine() function to combine hash values of two or more hashes.

hash_many()

Learn how to use the hash_many() function to return a combined hash value of multiple values.

hash_md5()

Learn how to use the hash_md5() function to return the MD5 hash value of the input.

hash_sha1()

Learn how to use the hash_sha1() function to return a sha1 hash value of the source input.

hash_sha256()

Learn how to use the hash_sha256() function to return a sha256 hash value of the source input.

hash_xxhash64()

Learn how to use the hash_xxhash64() function to return the xxhash64 value of the input.

hash()

Learn how to use the hash() function to return the hash value of the input.

hll_merge()

Learn how to use the hll_merge() function toe merge HLL results.

hourofday()

Learn how to use the hourofday() function to return an integer representing the hour of the given date.

iff()

This article describes iff().

indexof_regex()

Learn how to use the indexof_regex() function to return the zero-based index position of a regex input.

indexof()

Learn how to use the indexof() function to report the zero-based index position of the input string.

ingestion_time()

Learn how to use the ingestion_time() function to return the approximate time of the data’s ingestion.

ipv4_compare()

Learn how to use the ipv4_compare() function to compare two IPv4 strings.

ipv4_is_in_any_range()

Learn how to use the ipv4_is_in_any_range() function to check if the IPv4 string address is in any of the IPv4 address ranges.

ipv4_is_in_range()

Learn how to use the ipv4_is_in_range() function to check if the IPv4 string address is in the IPv4-prefix notation range.

ipv4_is_match()

Learn how to use the ipv4_is_match() function to match two IPv4 strings.

ipv4_is_private()

Learn how to use the ipv4_is_private() function to check if the IPv4 string address belongs to a set of private network IPs.

ipv4_netmask_suffix()

Learn how to use the ipv4_netmask_suffix() function to return the value of the IPv4 netmask suffix from an IPv4 string address.

ipv4_range_to_cidr_list()

Learn how to use the ipv4_range_to_cidr_list() function to convert IPv4 address range to a list of CIDR ranges.

ipv6_compare()

Learn how to use the ipv6_compare() function to compare two IPv6 or IPv4 network address strings.

ipv6_is_in_any_range()

Learn how to use the ipv6_is_in_any_range function to check if an IPv6 string address is in any of the IPv6 address ranges.

ipv6_is_in_range()

Learn how to use the ipv6_is_in_range() function to check if an IPv6 string address is in the Ipv6-prefix notation range.

ipv6_is_match()

Learn how to use the ipv6_is_match() function to match two IPv6 or IPv4 network address strings.

isascii()

Learn how to use the isascii() to check if the argument is a valid ascii string.

isempty()

Learn how to use the isempty() function to check if the argument is an empty string.

isfinite()

Learn how to use the isfinite() function to check if the input is a finite value.

isinf()

Learn how to use the isinf() function to check if the input is an infinite value.

isnan()

Learn how to use the isnan() function to check if the input is a not-a-number (NaN) value.

isnotempty()

Learn how to use the isnotempty() function to check if the argument isn’t an empty string.

isnotnull()

Learn how to use the isnotnull() function to check if the argument isn’t null.

isnull()

Learn how to use the isnull() function to check if the argument value is null.

isutf8()

Learn how to use the isutf8() function to check if the argument is a valid utf8 string.

jaccard_index()

Learn how to use the jaccard_index() function to calculate the Jaccard index of two input sets.

log()

Learn how to use the log() function to return the natural logarithm of the input.

log10()

Learn how to use the log10() function to return the common (base-10) logarithm of the input.

log2()

Learn how to use the log2() function to return the base-2 logarithm of the input.

loggamma()

Learn how to use the loggamma() function to compute the log of the absolute value of the gamma function.

make_datetime()

Learn how to use the make_datetime() function to create a datetime scalar value from the specified date and time.

make_timespan()

Learn how to use the make_timespan() function to create a timespan scalar value from the specified time period.

max_of()

Learn how to use the max_of() function to return the maximum value of all argument expressions.

merge_tdigest()

Learn how to use the merge_tdigest() function to merge columns.

min_of()

Learn how to use the min_of() function to return the minimum value of all argument expressions.

monthofyear()

Learn how to use the monthofyear() function to get the integer representation of the month.

new_guid()

Learn how to use the new_guid() function to return a random GUID (Globally Unique Identifier).

not()

Learn how to use the not() function to reverse the value of its boolean argument.

now()

Learn how to use the now() function to return the current UTC time.

pack_all()

Learn how to use the pack_all() function to create a dynamic object from all the columns of the tabular expression.

pack_array()

Learn how to use the pack_array() function to pack all input values into a dynamic array.

parse_command_line()

Learn how to use the parse_command_line() function to parse a unicode command-line string.

parse_csv()

Learn how to use the parse_csv() function to split a given string representing a single record of comma-separated values.

parse_ipv4_mask()

Learn how to use the parse_ipv4_mask() function to convert an IPv4 input string and netmask to a 64-bit wide long number in big-endian order.

parse_ipv4()

Learn how to use the parse_ipv4() function to convert an IPv4 string to a long number in big-endian order.

parse_ipv6_mask()

Learn how to use the parse_ipv6_mask() function to convert IPv6 or IPv4 strings and netmask to a canonical IPv6 string representation.

parse_ipv6()

Learn how to use the parse_ipv6() function to convert IPv6 or IPv4 strings to a canonical IPv6 string representation.

parse_json() function

Learn how to use the parse_json() function to return an object of type dynamic.

parse_path()

Learn how to use the parse_path() function to parse a file path.

parse_url()

Learn how to use the parse_url() function to parse a URL string.

parse_urlquery()

Learn how to use the parse_urlquery() function to return a dynamic object that contains the query parameters.

parse_user_agent()

Learn how to use the parse_user_agent() to return a dynamic object that contains information about the user-agent.

parse_version()

Learn how to use the parse_version() function to convert the input string representation of the version to a comparable decimal number,

parse_xml()

Learn how to use the parse_xml() function to return a dynamic object that is determined by the value of XML.

percentile_array_tdigest()

Learn how to use the percentile_array_tdigest() to calculate the percentile value of an expression.

percentile_tdigest()

Learn how to use the percentile_tdigest() function to calculate the percentile value of an expression.

percentrank_tdigest()

Learn how to use the percentrank_tdigest() function to calculate the approximate rank of the value in a set.

pi()

Learn how to use the pi() function to return the constant value of Pi.

pow()

Learn how to use the pow() function to calculate the base raised to the power of the exponent.

punycode_domain_from_string

This article describes the punycode_domain_from_string() command.

punycode_domain_to_string

This article describes the punycode_domain_to_string() command.

punycode_from_string

This article describes the punycode_from_string() command.

punycode_to_string

This article describes the punycode_to_string() command.

radians()

Learn how to use the radians() function to convert angle values from degrees to radians.

rand()

Learn how to use the rand() function to return a random number.

range()

Learn how to use the range() function to generate a dynamic array holding a series of equally spaced values.

rank_tdigest()

Learn how to use the rank_tdigest() function to calculate the approximate rank of the value in a set.

regex_quote()

Learn how to use the regex_quote() function to return a string that escapes all regular expression characters.

repeat()

Learn how to use the repeat() function to generate a dynamic array containing a series comprised of repeated numbers.

replace_regex()

Learn how to use the replace_regex() function to replace all regex matches with another string.

replace_string()

Learn how to use the replace_string() function to replace all string matches with another string.

replace_strings()

Learn how to use the replace_strings() function to replace multiple strings matches with multiple replacement strings.

reverse()

Learn how to use the reverse() function to reverse the order of the input string.

round()

Learn how to use the round() function to round the number to the specified precision.

Scalar Functions

Learn how to use scalar functions to perform calculations that return a single value.

set_difference()

Learn how to use the set_difference() function to create a difference set of all distinct values in the first array that aren’t in the other array inputs.

set_has_element()

Learn how to use the set_has_element() function to determine if the input set contains the specified value.

set_intersect()

Learn how to use the set_intersect() function to create a set of the distinct values that are in all the array inputs.

set_union()

Learn how to use the set_union() function to create a union set of all the distinct values in all of the array inputs.

sign()

Learn how to use the sign() function to return the sign of the numeric expression.

sin()

Learn how to use the sin() function to return the sine value of the input.

split()

Learn how to use the split() function to split the source string according to a given delimiter.

sqrt()

Learn how to use the sqrt() function to return the square root of the input,

startofday()

Learn how to use the startofday() function to return the start of the day for the given date.

startofmonth()

Learn how to use the startofmonth() function to return the start of the month for the given date.

startofweek()

Learn how to use the startofweek() function to return the start of the week for the given date.

startofyear()

Learn how to use the startofyear() function to return the start of the year for the given date.

strcat_array()

Learn how to use the strcat_array() function to create a concatenated string of array values using a specified delimiter.

strcat_delim()

Learn how to use the strcat_delim() function to concatenate between 2 and 64 arguments using a specified delimiter as the first argument.

strcat()

Learn how to use the strcat() function to concatenate between 1 and 64 arguments.

strcmp()

Learn how to use the strcmp() function to compare two strings.

string_size()

Learn how to use the string_size() function to measure the size of the input string.

strlen()

Learn how to use the strlen() function to measure the length of the input string.

strrep()

Learn how to use the strrep() function to repeat the input value.

substring()

Learn how to use the substring() function to extract a substring from the source string.

tan()

Learn how to use the tan() function to return the tangent value of the specified number.

The has_any_index operator

Learn how to use the has_any_index operator to search the input string for items specified in the array.

tobool()

Learn how to use the tobool() function to convert an input to a boolean representation.

todatetime()

Learn how to use the todatetime() function to convert the input expression to a datetime value.

todecimal()

Learn how to use the todecimal() function to convert the input expression to a decimal number representation.

toguid()

Learn how to use the toguid() function to convert the input string to a guid scalar.

tohex()

Learn how to use the tohex() function to convert the input value to a hexadecimal string.

toint()

Learn how to use the toint() function to convert the input value to an integer number representation.

tolong()

Learn how to use the tolong() function to convert the input value to a long number representation.

tolower()

Learn how to use the tolower() function to convert the input string to lower case.

toreal()

Learn how to use the toreal() function to convert the input expression to a value of type real.

tostring()

Learn how to use the tostring() function to convert the input value to a string representation.

totimespan()

Learn how to use the totimespan() function to convert the input to a timespan scalar value.

toupper()

Learn how to use the toupper() function to convert a string to upper case.

translate()

Learn how to use the translate() function to replace a set of characters with another set of characters in a given string.

treepath()

This article describes treepath().

trim_end()

Learn how to use the trim_end() function to remove the trailing match of the specified regular expression.

trim_start()

Learn how to use the trim_start() function to remove the leading match of the specified regular expression.

trim()

Learn how to use the trim() function to remove the leading and trailing match of the specified regular expression.

unicode_codepoints_from_string()

Learn how to use the unicode_codepoints_from_string() function to return a dynamic array of the Unicode codepoints of the input string.

unicode_codepoints_to_string()

Learn how to use the unicode_codepoints_to_string() function to return the string represented by the Unicode codepoints.

unixtime_microseconds_todatetime()

Learn how to use the unixtime_microseconds_todatetime() function to convert unix-epoch microseconds to UTC datetime.

unixtime_milliseconds_todatetime()

Learn how to use the unixtime_milliseconds_todatetime() function to convert unix-epoch milliseconds to UTC datetime.

unixtime_nanoseconds_todatetime()

Learn how to use the unixtime_nanoseconds_todatetime() function to convert unix-epoch nanoseconds to UTC datetime.

unixtime_seconds_todatetime()

Learn how to use the unixtime_seconds_todatetime() function to convert unix-epoch seconds to UTC datetime.

url_decode()

Learn how to use the url_decode() function to convert an encoded URL into a regular URL representation.

url_encode_component()

Learn how to use the url_encode_component() function to convert characters of the input URL into a transmittable format.

url_encode()

Learn how to use the url_encode() function to convert characters of the input URL into a transmittable format.

week_of_year()

Learn how to use the week_of_year() function to get the integer representation of the week.

welch_test()

Learn how to use the welch_test() function to compute the p_value of the Welch-test.

zip()

This article describes zip().

zlib_compress_to_base64_string

This article describes the zlib_compress_to_base64_string() command.

zlib_decompress_from_base64_string()

This article describes the zlib_decompress_from_base64_string() command.