Help Center/ Data Lake Insight/ Spark SQL Syntax Reference/ Built-In Functions/ String Functions/ substring_index
Updated on 2023-10-25 GMT+08:00
View PDF
Share

substring_index

This function is used to truncate the string before the count separator of str. If the value of count is positive, the string is truncated from the left. If the value of count is negative, the string is truncated from the right.

Syntax

substring_index(string <str>, string <separator>, int <count>)

Parameters

Table 1 Parameters

Parameter

Mandatory

Type

Description

str

Yes

STRING

String to be truncated

separator

Yes

STRING

Separator of the STRING type

count

No

INT

Position of the delimiter

Return Values

The return value is of the STRING type.

If the value of any input parameter is NULL, NULL is returned.

Example Code

The value hello.world is returned.

SELECT substring_index('hello.world.people', '.', 2);

The value world.people is returned.

select substring_index('hello.world.people', '.', -2);
Parent topic: String Functions