alias (DataFrame)

Returns a new DataFrame with an alias set.

Syntax

alias(alias: str)

Parameters

Parameter	Type	Description
alias	str	an alias name to be set for the DataFrame.

Returns

DataFrame: Aliased DataFrame.

Examples

from pyspark.sql import functions as sf
df = spark.createDataFrame(
    [(14, "Tom"), (23, "Alice"), (16, "Bob")], ["age", "name"])
df_as1 = df.alias("df_as1")
df_as2 = df.alias("df_as2")
joined_df = df_as1.join(df_as2,
    sf.col("df_as1.name") == sf.col("df_as2.name"), 'inner')
joined_df.select(
    "df_as1.name", "df_as2.name", "df_as2.age"
).sort(sf.desc("df_as1.name")).show()
# +-----+-----+---+
# | name| name|age|
# +-----+-----+---+
# |  Tom|  Tom| 14|
# |  Bob|  Bob| 16|
# |Alice|Alice| 23|
# +-----+-----+---+