String functions in Spark in Apache Spark

Introduction

String functions help you change and analyze text data easily in Spark. They make working with words and sentences simple.

You want to clean messy text data like removing spaces or changing case.

You need to find or replace parts of text in a big dataset.

You want to split a sentence into words or join words together.

You want to check if a text contains a certain word or pattern.

You want to count characters or get parts of a string.

Syntax

Apache Spark

from pyspark.sql.functions import lower, upper, trim, length, substring, concat, instr, regexp_replace

# Example usage in select:
df.select(lower(df.column_name), upper(df.column_name), trim(df.column_name))

Use these functions inside Spark DataFrame transformations like select or withColumn.

They work on columns, not plain Python strings.

Examples

This changes all letters in the 'name' column to lowercase.

Apache Spark

from pyspark.sql.functions import lower

df.select(lower(df.name))

This removes spaces at the start and end of the 'address' text.

Apache Spark

from pyspark.sql.functions import trim

df.select(trim(df.address))

This gets the first 3 characters from the 'name' column.

Apache Spark

from pyspark.sql.functions import substring

df.select(substring(df.name, 1, 3))

This replaces the word 'bad' with 'good' in the 'comment' column.

Apache Spark

from pyspark.sql.functions import regexp_replace

df.select(regexp_replace(df.comment, 'bad', 'good'))

Sample Program

This program creates a small table with names and comments. It then uses many string functions to clean names, change case, measure comment length, get parts of comments, replace spaces with underscores, find the word 'Spark', and create a user ID by joining text.

Apache Spark

from pyspark.sql import SparkSession
from pyspark.sql.functions import lower, upper, trim, length, substring, concat, instr, regexp_replace

spark = SparkSession.builder.appName('StringFunctionsExample').getOrCreate()

data = [
    (1, ' Alice ', 'Hello World!'),
    (2, 'Bob', 'Spark is fun'),
    (3, 'Charlie', '  Data Science  ')
]

columns = ['id', 'name', 'comment']
df = spark.createDataFrame(data, columns)

# Use string functions
result = df.select(
    trim(df.name).alias('trimmed_name'),
    lower(trim(df.name)).alias('lower_name'),
    upper(trim(df.name)).alias('upper_name'),
    length(df.comment).alias('comment_length'),
    substring(df.comment, 1, 5).alias('comment_start'),
    regexp_replace(df.comment, ' ', '_').alias('comment_no_spaces'),
    instr(df.comment, 'Spark').alias('spark_pos'),
    concat(trim(df.name), '_user').alias('user_id')
)

result.show()

Important Notes

String functions in Spark work on columns, so always use them inside DataFrame operations.

Remember to import functions from pyspark.sql.functions before using them.

Some functions like instr return 0 if the text is not found.

Summary

String functions help clean and analyze text data in Spark easily.

Use them inside DataFrame select or withColumn to transform text columns.

Common functions include lower, upper, trim, substring, regexp_replace, and instr.

Practice

1. Which Spark string function converts all characters in a column to lowercase?

easy

A. substring()

B. upper()

C. trim()

D. lower()

Solution

1. Step 1: Understand the function purpose

   The lower() function changes all letters in a string to lowercase.

2. Step 2: Compare with other functions

   upper() makes letters uppercase, trim() removes spaces, and substring() extracts part of the string.

3. Final Answer:

   lower() -> Option D

4. Quick Check:

   Lowercase conversion = lower() [OK]

Hint: Lowercase text? Use lower() function [OK]

Common Mistakes:

• Confusing lower() with upper()
• Using trim() to change case
• Thinking substring() changes case

2. Which of the following is the correct syntax to remove leading and trailing spaces from a Spark DataFrame column named name?

easy

A. df.select(trim(col('name')))

B. df.select(trim(name))

C. df.select(trim())

D. df.select(trim('df.name'))

Solution

1. Step 1: Understand Spark column referencing

   In Spark, to refer to a column by name in functions, use col('columnName').

2. Step 2: Apply trim function correctly

   The trim() function expects a Column object, so trim(col('name')) is correct syntax.

3. Final Answer:

   df.select(trim(col('name'))) -> Option A

4. Quick Check:

   Use col() inside trim() for column reference [OK]

Hint: Use col('colName') inside string functions [OK]

Common Mistakes:

• Passing string directly without col()
• Using variable name without quotes or col()
• Using trim() without any argument

3. What will be the output of this Spark code snippet?

from pyspark.sql.functions import substring
df = spark.createDataFrame([('SparkData',)], ['word'])
df.select(substring('word', 1, 5).alias('sub')).collect()

medium

A. [Row(sub='parkD')]

B. [Row(sub='SparkD')]

C. [Row(sub='Spark')]

D. [Row(sub='SparkData')]

Solution

1. Step 1: Understand substring parameters

   substring('word', 1, 5) extracts 5 characters starting at position 1 (1-based index).

2. Step 2: Extract substring from 'SparkData'

   Characters 1 to 5 are 'S', 'p', 'a', 'r', 'k' forming 'Spark'.

3. Final Answer:

   [Row(sub='Spark')] -> Option C

4. Quick Check:

   substring start=1, length=5 extracts 'Spark' [OK]

Hint: substring uses 1-based start index [OK]

Common Mistakes:

• Assuming 0-based index for substring
• Extracting wrong number of characters
• Confusing substring with slice

4. Identify the error in this Spark code that tries to replace all spaces with underscores in column text:

from pyspark.sql.functions import regexp_replace
df.select(regexp_replace(text, ' ', '_')).show()

medium

A. Incorrect number of arguments to regexp_replace

B. Missing column reference using col()

C. Wrong function name, should be replace()

D. Using show() instead of collect()

Solution

1. Step 1: Check argument types for regexp_replace

   The first argument must be a Column object, not a bare identifier.

2. Step 2: Correct usage with col()

   Use regexp_replace(col('text'), ' ', '_') to refer to the column properly.

3. Final Answer:

   Missing column reference using col() -> Option B

4. Quick Check:

   Use col() to reference columns in functions [OK]

Hint: Always wrap column names with col() in functions [OK]

Common Mistakes:

• Passing column name as string without col()
• Confusing regexp_replace with replace
• Ignoring function argument requirements

5. You want to create a new column clean_name in a Spark DataFrame by trimming spaces, converting to lowercase, and replacing all digits with empty strings from column name. Which code snippet correctly does this?

hard

A. df.withColumn('clean_name', regexp_replace(lower(trim(col('name'))), '\\d', ''))

B. df.withColumn('clean_name', lower(trim(regexp_replace(col(name), '\\d', ''))))

C. df.withColumn('clean_name', trim(lower(regexp_replace(col(name), '\\d', ''))))

D. df.withColumn('clean_name', trim(regexp_replace(lower(col(name)), '\\d', '')))

Solution

1. Step 1: Order of operations matters

   First trim spaces, then convert to lowercase, then remove digits.

2. Step 2: Check each option's function nesting

   df.withColumn('clean_name', regexp_replace(lower(trim(col('name'))), '\\d', '')) trims first, then lowers, then replaces digits last, matching the required order.

3. Final Answer:

   df.withColumn('clean_name', regexp_replace(lower(trim(col('name'))), '\\d', '')) -> Option A

4. Quick Check:

   Trim -> Lower -> Replace digits = df.withColumn('clean_name', regexp_replace(lower(trim(col('name'))), '\\d', '')) [OK]

Hint: Chain trim(), lower(), then regexp_replace() in that order [OK]

Common Mistakes:

• Wrong order of function calls
• Missing col() around column name
• Incorrect regex pattern for digits