Docs
DocumentationQuery ReferenceAPI Reference
Open Console→→
DocumentationQuery ReferenceAPI Reference

Introduction

Query reference overview

APL

IntroductionSample queriesAll features
Functions
Scalar functions
Array functions
Overview
array_concat
array_extract
array_iff
array_index_of
array_length
array_reverse
array_rotate_left
array_rotate_right
array_select_dict
array_shift_left
array_shift_right
array_slice
array_sort_asc
array_sort_desc
array_split
array_sum
bag_has_key
bag_keys
bag_pack
bag_zip
isarray
len
pack_array
pack_dictionary
strcat_array
Conditional functions
Overview
case
iff
Conversion functions
Overview
dynamic_to_json
ensure_field
isbool
toarray
tobool
todatetime
todouble, toreal
todynamic
tohex
toint, tolong
tostring
totimespan
Datetime functions
Overview
ago
datetime_add
datetime_diff
datetime_part
dayofmonth
dayofweek
dayofyear
endofday
endofmonth
endofweek
endofyear
format_datetime
getmonth
getyear
hourofday
monthofyear
now
startofday
startofmonth
startofweek
startofyear
unixtime_microseconds_todatetime
unixtime_milliseconds_todatetime
unixtime_nanoseconds_todatetime
unixtime_seconds_todatetime
week_of_year
GenAI functions
Overview
genai_concat_contents
genai_conversation_turns
genai_cost
genai_estimate_tokens
genai_extract_assistant_response
genai_extract_function_results
genai_extract_system_prompt
genai_extract_tool_calls
genai_extract_user_prompt
genai_get_content_by_index
genai_get_content_by_role
genai_get_pricing
genai_get_role
genai_has_tool_calls
genai_input_cost
genai_is_truncated
genai_message_roles
genai_output_cost
Hash functions
Overview
hash
hash_md5
hash_sha1
hash_sha256
hash_sha512
IP functions
Overview
format_ipv4
format_ipv4_mask
geo_info_from_ip_address
has_any_ipv4
has_any_ipv4_prefix
has_ipv4
has_ipv4_prefix
ipv4_compare
ipv4_is_in_range
ipv4_is_in_any_range
ipv4_is_match
ipv4_is_private
ipv4_netmask_suffix
ipv6_compare
ipv6_is_in_any_range
ipv6_is_in_range
ipv6_is_match
parse_ipv4
parse_ipv4_mask
Mathematical functions
Overview
abs
acos
asin
atan
atan2
cos
cot
degrees
exp
exp2
exp10
gamma
isfinite
isinf
isint
isnan
log
log2
log10
loggamma
max_of
min_of
not
pi
pow
radians
rand
range
round
set_difference
set_has_element
set_intersect
set_union
sign
sin
sqrt
tan
Metadata functions
Overview
column_ifexists
cursor_current
ingestion_time
Pair functions
Overview
find_pair
pair
parse_pair
Rounding functions
Overview
bin
bin_auto
ceiling
floor
String functions
Overview
base64_decode_toarray
base64_decode_tostring
base64_encode_fromarray
base64_encode_tostring
coalesce
countof
countof_regex
extract
extract_all
format_bytes
format_url
gettype
indexof
indexof_regex
isascii
isempty
isnotempty
isnotnull
isnull
parse_bytes
parse_csv
parse_json
parse_path
parse_url
parse_urlquery
quote
regex_quote
replace
replace_regex
replace_string
reverse
split
strcat
strcat_delim
strcmp
string_size
strlen
strrep
strip_ansi_escapes
substring
tolower
totitle
toupper
translate
trim
trim_end
trim_end_regex
trim_regex
trim_space
trim_start
trim_start_regex
unicode_codepoints_from_string
unicode_codepoints_to_string
url_decode
url_encode
SQL functions
Overview
parse_sql
format_sql
Time series functions
Overview
series_abs
series_acos
series_add
series_asin
series_atan
series_ceiling
series_cos
series_cosine_similarity
series_divide
series_dot_product
series_equals
series_exp
series_fft
series_fill_backward
series_fill_const
series_fill_forward
series_fill_linear
series_fir
series_floor
series_greater
series_greater_equals
series_ifft
series_iir
series_less
series_less_equals
series_log
series_magnitude
series_max
series_min
series_multiply
series_not_equals
series_pearson_correlation
series_pow
series_sign
series_sin
series_stats
series_stats_dynamic
series_subtract
series_sum
series_tan
Type functions
Overview
isimei
ismap
isreal
iscc
isstring
isutf8
Aggregation functions
Overview
arg_min
arg_max
avg
avgif
avgw
count
countif
countw
dcount
dcountif
histogram
histogramif
histogramw
make_list
make_list_if
make_set
make_set_if
max
maxif
min
minif
percentile
percentileif
percentilew
percentiles_array
percentiles_arrayif
percentilesw_array
phrases
presence
rate
spotlight
stdev
stdevif
stdevw
sum
sumif
sumw
topk
topkif
topkw
variance
varianceif
variancew
Operators
Tabular operators
Overview
count
datatable
distinct
extend
extend-valid
externaldata
getschema
join
limit
lookup
make-series
mv-expand
order
parse
parse-kv
parse-where
print
project
project-away
project-keep
project-rename
project-reorder
redact
sample
search
sort
summarize
take
top
union
where
Scalar operators
Set membership operators
Overview
in
!in
in~
!in~
Logical
Numerical
String
Reference
Entity names
Map fields
Null values
Scalar data types
Declare query_parameters
Let statement
Set statement
Special field attributes
Migrate
Splunk SPL
SQL
Sumo Logic

MPL

Language featuresHistograms and summariesSample queriesMigrate
APL/Functions

format_datetime

This page explains how to use the format_datetime function in APL.

The format_datetime function formats a datetime value as a string according to a format pattern.

Usage

Syntax

APL
format_datetime(date, format)

Parameters

ParameterTypeDescription
datedatetimeThe datetime value to format.
formatstringA non-empty string literal specifying the output format. Dynamic expressions or empty strings return an error.

Supported format specifiers

Other characters in format are copied as-is. Month and day names are not supported.

SpecifierDescription
y, yy, yyyyYear (2-digit or 4-digit).
M, MMMonth number (1–12 or 01–12).
d, ddDay of month (1–31 or 01–31).
H, HH24-hour clock (0–23 or 00–23).
h, hh12-hour clock (1–12 or 01–12).
m, mmMinutes (0–59 or 00–59).
s, ssSeconds (0–59 or 00–59).
ttAM/PM designator.
f–fffffffFractional seconds (1 to 7 digits, including trailing zeros).
F–FFFFFFFFractional seconds (1 to 7 digits, trailing zeros omitted).

Returns

Returns a formatted string representation of date.

Examples

Query

APL
let dt = datetime(2017-01-29 09:00:05);
print
    fmt1 = format_datetime(dt, 'yy-MM-dd [hh:mm:ss tt]'),
    fmt2 = format_datetime(dt, 'yyyy-M-d H:mm:ss.fff'),
    fmt3 = format_datetime(dt, 'dd/MM/yyyy HH:mm:ss.FFF')

Output

fmt1fmt2fmt3
17-01-29 [09:00:05 AM]2017-1-29 9:00:05.00029/01/2017 09:00:05.

List of related functions

  • datetime_part: Extracts an integer component from a datetime value.
  • datetime_add: Adds a period to a datetime value.
  • datetime_diff: Calculates the difference between two datetime values.
Was this page helpful?
Suggest edits on GitHub
PreviousendofyearNextgetmonth
On this page
UsageSyntaxParametersSupported format specifiersReturnsExamplesList of related functions