search
Search
Login
Unlock 100+ guides
menu
menu
web
search toc
close
Comments
Log in or sign up
Cancel
Post
account_circle
Profile
exit_to_app
Sign out
What does this mean?
Why is this true?
Give me some examples!
search
keyboard_voice
close
Searching Tips
Search for a recipe:
"Creating a table in MySQL"
Search for an API documentation: "@append"
Search for code: "!dataframe"
Apply a tag filter: "#python"
Useful Shortcuts
/ to open search panel
Esc to close search panel
to navigate between search results
d to clear all current filters
Enter to expand content preview
icon_star
Doc Search
icon_star
Code Search Beta
SORRY NOTHING FOUND!
mic
Start speaking...
Voice search is only supported in Safari and Chrome.
Navigate to

PySpark Column | isin method

schedule Aug 12, 2023
Last updated
local_offer
PySpark
Tags
mode_heat
Master the mathematics behind data science with 100+ top-tier guides
Start your free 7-days trial now!

PySpark Column's isin(~) method returns a Column object of booleans where True corresponds to column values that are included in the specified list of values.

Parameters

1. *cols | any type

The values to compare against.

Return Value

A Column object of booleans.

Examples

Consider the following PySpark DataFrame:

df = spark.createDataFrame([["Alex", 20], ["Bob", 30]], ["name", "age"])
df.show()
+----+---+
|name|age|
+----+---+
|Alex| 20|
| Bob| 30|
+----+---+

Getting rows where values are contained in a list of values in PySpark DataFrame

To get rows where values for the name column is either "Cathy" or "Alex":

from pyspark.sql import functions as F
df.filter(F.col("name").isin("Cathy", "Alex")).show()
+----+---+
|name|age|
+----+---+
|Alex| 20|
+----+---+

Here, F.col("name").isin("Cathy","Alex") returns a Column object of booleans:

from pyspark.sql import functions as F
df.select(F.col("name").isin("Cathy", "Alex")).show()
+-----------------------+
|(name IN (Cathy, Alex))|
+-----------------------+
| true|
| false|
+-----------------------+

The filter(~) method fetches the rows that correspond to True.

Note that if you have a list of values instead, use the * operator to convert the list into positional arguments:

from pyspark.sql import functions as F
my_list = ["Cathy", "Alex"]
df.filter(F.col("name").isin(*my_list)).show()
+----+---+
|name|age|
+----+---+
|Alex| 20|
+----+---+
robocat
Published by Isshin Inada
Edited by 0 others
Did you find this page useful?
thumb_up
thumb_down
Comment
Citation
Ask a question or leave a feedback...
thumb_up
1
thumb_down
0
chat_bubble_outline
0
settings
Enjoy our search
Hit / to insta-search docs and recipes!