..  Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

..    http://www.apache.org/licenses/LICENSE-2.0

..  Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.


=========
Functions
=========
.. currentmodule:: pyspark.sql.functions

A collections of builtin functions available for DataFrame operations.

.. note::
   From Apache Spark 3.5.0, all functions support Spark Connect.

Normal Functions
----------------
.. autosummary::
    :toctree: api/

    broadcast
    call_function
    col
    column
    lit
    expr


Conditional Functions
---------------------
.. autosummary::
    :toctree: api/

    coalesce
    ifnull
    nanvl
    nullif
    nullifzero
    nvl
    nvl2
    when
    zeroifnull


Predicate Functions
-------------------
.. autosummary::
    :toctree: api/

    equal_null
    ilike
    isnan
    isnotnull
    isnull
    like
    regexp
    regexp_like
    rlike


Sort Functions
--------------
.. autosummary::
    :toctree: api/

    asc
    asc_nulls_first
    asc_nulls_last
    desc
    desc_nulls_first
    desc_nulls_last


Mathematical Functions
----------------------
.. autosummary::
    :toctree: api/

    abs
    acos
    acosh
    asin
    asinh
    atan
    atan2
    atanh
    bin
    bround
    cbrt
    ceil
    ceiling
    conv
    cos
    cosh
    cot
    csc
    degrees
    e
    exp
    expm1
    factorial
    floor
    greatest
    hex
    hypot
    least
    ln
    log
    log10
    log1p
    log2
    negate
    negative
    pi
    pmod
    positive
    pow
    power
    radians
    rand
    randn
    random
    rint
    round
    sec
    sign
    signum
    sin
    sinh
    sqrt
    tan
    tanh
    try_add
    try_divide
    try_mod
    try_multiply
    try_subtract
    unhex
    uniform
    width_bucket


String Functions
----------------
.. autosummary::
    :toctree: api/

    ascii
    base64
    bit_length
    btrim
    char
    char_length
    character_length
    chr
    collate
    collation
    concat_ws
    contains
    decode
    elt
    encode
    endswith
    find_in_set
    format_number
    format_string
    initcap
    instr
    is_valid_utf8
    lcase
    left
    length
    levenshtein
    locate
    lower
    lpad
    ltrim
    make_valid_utf8
    mask
    octet_length
    overlay
    position
    printf
    quote
    randstr
    regexp_count
    regexp_extract
    regexp_extract_all
    regexp_instr
    regexp_replace
    regexp_substr
    repeat
    replace
    right
    rpad
    rtrim
    sentences
    soundex
    split
    split_part
    startswith
    substr
    substring
    substring_index
    to_binary
    to_char
    to_number
    to_varchar
    translate
    trim
    try_to_binary
    try_to_number
    try_validate_utf8
    ucase
    unbase64
    upper
    validate_utf8


Bitwise Functions
-----------------
.. autosummary::
    :toctree: api/

    bit_count
    bit_get
    bitwise_not
    getbit
    shiftleft
    shiftright
    shiftrightunsigned


Date and Timestamp Functions
----------------------------
.. autosummary::
    :toctree: api/

    add_months
    convert_timezone
    curdate
    current_date
    current_time
    current_timestamp
    current_timezone
    date_add
    date_diff
    date_format
    date_from_unix_date
    date_part
    date_sub
    date_trunc
    dateadd
    datediff
    datepart
    day
    dayname
    dayofmonth
    dayofweek
    dayofyear
    extract
    from_unixtime
    from_utc_timestamp
    hour
    last_day
    localtimestamp
    make_date
    make_dt_interval
    make_interval
    make_time
    make_timestamp
    make_timestamp_ltz
    make_timestamp_ntz
    make_ym_interval
    minute
    month
    monthname
    months_between
    next_day
    now
    quarter
    second
    session_window
    timestamp_add
    timestamp_diff
    timestamp_micros
    timestamp_millis
    timestamp_seconds
    time_bucket
    time_diff
    time_from_micros
    time_from_millis
    time_from_seconds
    time_to_micros
    time_to_millis
    time_to_seconds
    time_trunc
    to_date
    to_time
    to_timestamp
    to_timestamp_ltz
    to_timestamp_ntz
    to_unix_timestamp
    to_utc_timestamp
    trunc
    try_make_interval
    try_make_timestamp
    try_make_timestamp_ltz
    try_make_timestamp_ntz
    try_to_time
    try_to_timestamp
    try_to_date
    unix_date
    unix_micros
    unix_millis
    unix_seconds
    unix_timestamp
    weekday
    weekofyear
    window
    window_time
    year


Hash Functions
--------------
.. autosummary::
    :toctree: api/

    crc32
    hash
    md5
    sha
    sha1
    sha2
    xxhash64


Collection Functions
--------------------
.. autosummary::
    :toctree: api/

    aggregate
    array_sort
    cardinality
    concat
    element_at
    exists
    filter
    forall
    map_filter
    map_zip_with
    reduce
    reverse
    size
    transform
    transform_keys
    transform_values
    try_element_at
    zip_with


Array Functions
---------------
.. autosummary::
    :toctree: api/

    array
    array_append
    array_compact
    array_contains
    array_distinct
    array_except
    array_insert
    array_intersect
    array_join
    array_max
    array_min
    array_position
    array_prepend
    array_remove
    array_repeat
    array_size
    array_union
    arrays_overlap
    arrays_zip
    flatten
    get
    sequence
    shuffle
    slice
    sort_array


Struct Functions
----------------
.. autosummary::
    :toctree: api/

    named_struct
    struct


Map Functions
-------------
.. autosummary::
    :toctree: api/

    create_map
    map_concat
    map_contains_key
    map_entries
    map_from_arrays
    map_from_entries
    map_keys
    map_values
    str_to_map


Aggregate Functions
-------------------
.. autosummary::
    :toctree: api/

    any_value
    approx_count_distinct
    approx_percentile
    array_agg
    avg
    bit_and
    bit_or
    bit_xor
    bitmap_construct_agg
    bitmap_or_agg
    bool_and
    bool_or
    collect_list
    collect_set
    corr
    count
    count_distinct
    count_if
    count_min_sketch
    covar_pop
    covar_samp
    every
    first
    first_value
    grouping
    grouping_id
    histogram_numeric
    hll_sketch_agg
    hll_union_agg
    kll_sketch_agg_bigint
    kll_sketch_agg_double
    kll_sketch_agg_float
    kll_merge_agg_bigint
    kll_merge_agg_float
    kll_merge_agg_double
    kurtosis
    last
    last_value
    listagg
    listagg_distinct
    max
    max_by
    mean
    median
    min
    min_by
    mode
    percentile
    percentile_approx
    product
    regr_avgx
    regr_avgy
    regr_count
    regr_intercept
    regr_r2
    regr_slope
    regr_sxx
    regr_sxy
    regr_syy
    skewness
    some
    std
    stddev
    stddev_pop
    stddev_samp
    string_agg
    string_agg_distinct
    sum
    sum_distinct
    theta_intersection_agg
    theta_sketch_agg
    theta_union_agg
    tuple_intersection_agg_double
    tuple_intersection_agg_integer
    tuple_sketch_agg_double
    tuple_sketch_agg_integer
    tuple_union_agg_double
    tuple_union_agg_integer
    try_avg
    try_sum
    var_pop
    var_samp
    variance


Window Functions
----------------
.. autosummary::
    :toctree: api/

    cume_dist
    dense_rank
    lag
    lead
    nth_value
    ntile
    percent_rank
    rank
    row_number


Generator Functions
-------------------
.. autosummary::
    :toctree: api/

    explode
    explode_outer
    inline
    inline_outer
    posexplode
    posexplode_outer
    stack


Partition Transformation Functions
----------------------------------
.. autosummary::
    :toctree: api/

    partitioning.years
    partitioning.months
    partitioning.days
    partitioning.hours
    partitioning.bucket


CSV Functions
-------------
.. autosummary::
    :toctree: api/

    from_csv
    schema_of_csv
    to_csv


JSON Functions
--------------
.. autosummary::
    :toctree: api/

    from_json
    get_json_object
    json_array_length
    json_object_keys
    json_tuple
    schema_of_json
    to_json


VARIANT Functions
-----------------
.. autosummary::
    :toctree: api/

    is_valid_variant
    is_variant_null
    parse_json
    schema_of_variant
    schema_of_variant_agg
    try_variant_get
    variant_get
    try_parse_json
    to_variant_object


XML Functions
--------------
.. autosummary::
    :toctree: api/

    from_xml
    schema_of_xml
    to_xml
    xpath
    xpath_boolean
    xpath_double
    xpath_float
    xpath_int
    xpath_long
    xpath_number
    xpath_short
    xpath_string


URL Functions
-------------
.. autosummary::
    :toctree: api/

    parse_url
    try_parse_url
    url_decode
    url_encode
    try_url_decode


Misc Functions
--------------
.. autosummary::
    :toctree: api/

    aes_decrypt
    aes_encrypt
    assert_true
    bitmap_bit_position
    bitmap_bucket_number
    bitmap_count
    current_catalog
    current_database
    current_path
    current_schema
    current_user
    input_file_block_length
    input_file_block_start
    input_file_name
    java_method
    monotonically_increasing_id
    raise_error
    reflect
    session_user
    spark_partition_id
    try_aes_decrypt
    try_reflect
    typeof
    user
    uuid
    version

Datasketch Functions
--------------------
.. autosummary::
    :toctree: api/

    hll_sketch_estimate
    hll_union
    kll_sketch_get_n_bigint
    kll_sketch_get_n_double
    kll_sketch_get_n_float
    kll_sketch_get_quantile_bigint
    kll_sketch_get_quantile_double
    kll_sketch_get_quantile_float
    kll_sketch_get_rank_bigint
    kll_sketch_get_rank_double
    kll_sketch_get_rank_float
    kll_sketch_merge_bigint
    kll_sketch_merge_double
    kll_sketch_merge_float
    kll_sketch_to_string_bigint
    kll_sketch_to_string_double
    kll_sketch_to_string_float
    theta_difference
    theta_intersection
    theta_sketch_estimate
    theta_union
    tuple_difference_double
    tuple_difference_integer
    tuple_difference_theta_double
    tuple_difference_theta_integer
    tuple_intersection_double
    tuple_intersection_integer
    tuple_intersection_theta_double
    tuple_intersection_theta_integer
    tuple_sketch_estimate_double
    tuple_sketch_estimate_integer
    tuple_sketch_summary_double
    tuple_sketch_summary_integer
    tuple_sketch_theta_double
    tuple_sketch_theta_integer
    tuple_union_double
    tuple_union_integer
    tuple_union_theta_double
    tuple_union_theta_integer


Geospatial ST Functions
-----------------------
.. autosummary::
    :toctree: api/

    st_asbinary
    st_geogfromwkb
    st_geomfromwkb
    st_setsrid
    st_srid


UDF, UDTF and UDT
-----------------
.. autosummary::
    :toctree: api/

    arrow_udf
    arrow_udtf
    call_udf
    pandas_udf
    udf
    udtf
    unwrap_udt


Table-Valued Functions
----------------------
.. currentmodule:: pyspark.sql.tvf

.. autosummary::
    :toctree: api/

    TableValuedFunction.collations
    TableValuedFunction.explode
    TableValuedFunction.explode_outer
    TableValuedFunction.inline
    TableValuedFunction.inline_outer
    TableValuedFunction.json_tuple
    TableValuedFunction.posexplode
    TableValuedFunction.posexplode_outer
    TableValuedFunction.python_worker_logs
    TableValuedFunction.range
    TableValuedFunction.sql_keywords
    TableValuedFunction.stack
    TableValuedFunction.variant_explode
    TableValuedFunction.variant_explode_outer
