snowflake.snowpark.DataFrame.drop¶
- DataFrame.drop(*cols: Union[Column, str, Iterable[Union[Column, str]]]) DataFrame [source] (https://github.com/snowflakedb/snowpark-python/blob/v1.16.0/src/snowflake/snowpark/dataframe.py#L1139-L1206)¶
Returns a new DataFrame that excludes the columns with the specified names from the output.
This is functionally equivalent to calling
select()
and passing in all columns except the ones to exclude. This is a no-op if schema does not contain the given column name(s).Example:
>>> df = session.create_dataframe([[1, 2, 3]], schema=["a", "b", "c"]) >>> df.drop("a", "b").show() ------- |"C" | ------- |3 | -------
- Parameters:
*cols – the columns to exclude, as
str
,Column
or a list of those.- Raises:
SnowparkClientException – if the resulting
DataFrame
contains no output columns.