snowflake.snowpark.DataFrameReader.with_metadata¶

DataFrameReader.with_metadata(*metadata_cols: Iterable[Column | str]) → DataFrameReader[source] (https://github.com/snowflakedb/snowpark-python/blob/release-v1.5.0/src/snowflake/snowpark/dataframe_reader.py#L291-L306)¶

Define the metadata columns that need to be selected from stage files.

Returns:

a DataFrameReader instance with metadata columns to read.

See also

https://docs.snowflake.cn/en/user-guide/querying-metadata