pyspark.sql.DataFrame.metadataColumn#

DataFrame.metadataColumn(colName)[source]#

Selects a metadata column based on its logical column name and returns it as a Column.

A metadata column can be accessed this way even if the underlying data source defines a data column with a conflicting name.

New in version 4.0.0.

Parameters
colNamestr

string, metadata column name

Returns
Column