String expressions

All string operations are valid for both scalars and columns.

StringValue

StringValue(arg)

Methods

Name Description
as_date Parse a string and return a date.
as_time Parse a string and return a time.
as_timestamp Parse a string and return a timestamp.
ascii_str Return the numeric ASCII code of the first character of a string.
authority Parse a URL and extract authority.
capitalize Uppercase the first letter, lowercase the rest.
concat Concatenate strings.
contains Return whether the expression contains substr.
convert_base Convert a string representing an integer from one base to another.
endswith Determine if self ends with end.
file Parse a URL and extract file.
find Return the position of the first occurrence of substring.
find_in_set Find the first occurrence of str_list within a list of strings.
fragment Parse a URL and extract fragment identifier.
hashbytes Compute the binary hash value of the input.
hexdigest Return the hash digest of the input as a hex encoded string.
host Parse a URL and extract host.
ilike Match patterns against self, case-insensitive.
join Join a list of strings using self as the separator.
left Return the nchars left-most characters.
length Compute the length of a string.
levenshtein Return the Levenshtein distance between two strings.
like Match patterns against self, case-sensitive.
lower Convert string to all lowercase.
lpad Pad arg by truncating on the right or padding on the left.
lstrip Remove whitespace from the left side of string.
path Parse a URL and extract path.
protocol Parse a URL and extract protocol.
query Parse a URL and returns query string or query string parameter.
re_extract Return the specified match at index from a regex pattern.
re_replace Replace all matches found by regex pattern with replacement.
re_search Return whether self contains the regex pattern.
re_split Split a string by a regular expression pattern.
repeat Repeat a string n times.
replace Replace each exact match of pattern with replacement.
reverse Reverse the characters of a string.
right Return up to nchars from the end of each string.
rpad Pad self by truncating or padding on the right.
rstrip Remove whitespace from the right side of string.
split Split as string on delimiter.
startswith Determine whether self starts with start.
strip Remove whitespace from left and right sides of a string.
substr Extract a substring.
translate Replace from_str characters in self characters in to_str.
upper Convert string to all uppercase.
userinfo Parse a URL and extract user info.

as_date

as_date(format_str, /)

Parse a string and return a date.

Parameters

Name Type Description Default
format_str str Format string in strptime format required

Returns

Name Type Description
DateValue Parsed date value

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"ts": ["20170206"]})
t.ts.as_date("%Y%m%d")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringToDate(ts, '%Y%m%d') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ date                       โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 2017-02-06                 โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

as_time

as_time(format_str, /)

Parse a string and return a time.

Parameters

Name Type Description Default
format_str str Format string in strptime format required

Returns

Name Type Description
TimeValue Parsed time value

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"ts": ["20:01:02"]})
t.ts.as_time("%H:%M:%S")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringToTime(ts, '%H:%M:%S') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ time                         โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 20:01:02                     โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

as_timestamp

as_timestamp(format_str, /)

Parse a string and return a timestamp.

Parameters

Name Type Description Default
format_str str Format string in strptime format required

Returns

Name Type Description
TimestampValue Parsed timestamp value

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"ts": ["20170206"]})
t.ts.as_timestamp("%Y%m%d")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringToTimestamp(ts, '%Y%m%d') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ timestamp('UTC')                โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 2017-02-06 00:00:00+00:00       โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

ascii_str

ascii_str()

Return the numeric ASCII code of the first character of a string.

Returns

Name Type Description
IntegerValue ASCII code of the first character of the input

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", "def", "ghi"]})
t.s.ascii_str()
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringAscii(s) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ int32          โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚             97 โ”‚
โ”‚            100 โ”‚
โ”‚            103 โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

authority

authority()

Parse a URL and extract authority.

Examples

import ibis
url = ibis.literal("https://user:pass@example.com:80/docs/books")
result = url.authority()  # user:pass@example.com:80

Returns

Name Type Description
StringValue Extracted string value

capitalize

capitalize()

Uppercase the first letter, lowercase the rest.

This API matches the semantics of the Python str.capitalize method.

Returns

Name Type Description
StringValue Capitalized string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["aBC", " abc", "ab cd", None]})
t.s.capitalize()
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ Capitalize(s) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string        โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ Abc           โ”‚
โ”‚  abc          โ”‚
โ”‚ Ab cd         โ”‚
โ”‚ NULL          โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

concat

concat(other, /, *args)

Concatenate strings.

NULLs are propagated. This methods is equivalent to using the + operator.

Parameters

Name Type Description Default
other str | StringValue | Deferred String to concatenate required
args str | StringValue | Deferred Additional strings to concatenate ()

Returns

Name Type Description
StringValue All strings concatenated

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", None]})
t.s.concat("xyz", "123")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringConcat((s, 'xyz', '123')) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string                          โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ abcxyz123                       โ”‚
โ”‚ NULL                            โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

t.s + "xyz"
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringConcat((s, 'xyz')) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string                   โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ abcxyz                   โ”‚
โ”‚ NULL                     โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

contains

contains(substr, /)

Return whether the expression contains substr.

Parameters

Name Type Description Default
substr str | StringValue | Deferred Substring for which to check required

Returns

Name Type Description
BooleanValue Boolean indicating the presence of substr in the expression

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["bab", "ddd", "eaf"]})
t.s.contains("a")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringContains(s, 'a') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ boolean                โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ True                   โ”‚
โ”‚ False                  โ”‚
โ”‚ True                   โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

convert_base

convert_base(from_base, to_base)

Convert a string representing an integer from one base to another.

Parameters

Name Type Description Default
from_base int | ir.IntegerValue Numeric base of the expression required
to_base int | ir.IntegerValue New base required

Returns

Name Type Description
IntegerValue Converted expression

endswith

endswith(end, /)

Determine if self ends with end.

Parameters

Name Type Description Default
end str | StringValue | Deferred Suffix to check for required

Returns

Name Type Description
BooleanValue Boolean indicating whether self ends with end

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["Ibis project", "GitHub"]})
t.s.endswith("project")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ EndsWith(s, 'project') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ boolean                โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ True                   โ”‚
โ”‚ False                  โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

file

file()

Parse a URL and extract file.

Examples

import ibis
url = ibis.literal(
    "https://example.com:80/docs/books/tutorial/index.html?name=networking"
)
result = url.file()  # docs/books/tutorial/index.html?name=networking

Returns

Name Type Description
StringValue Extracted string value

find

find(sub, start=None, end=None, /)

Return the position of the first occurrence of substring.

Parameters

Name Type Description Default
sub str | StringValue | Deferred Substring to search for required
start int | ir.IntegerValue | Deferred | None Zero based index of where to start the search None
end int | ir.IntegerValue | Deferred | None Zero based index of where to stop the search. Currently not implemented. None

Returns

Name Type Description
IntegerValue Position of substr in arg starting from start

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", "bac", "bca"]})
t.s.find("a")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringFind(s, 'a') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ int64              โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚                  0 โ”‚
โ”‚                  1 โ”‚
โ”‚                  2 โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

t.s.find("z")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringFind(s, 'z') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ int64              โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚                 -1 โ”‚
โ”‚                 -1 โ”‚
โ”‚                 -1 โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

find_in_set

find_in_set(str_list, /)

Find the first occurrence of str_list within a list of strings.

No string in str_list can have a comma.

Parameters

Name Type Description Default
str_list Sequence[str] Sequence of strings required

Returns

Name Type Description
IntegerValue Position of str_list in self. Returns -1 if self isnโ€™t found or if self contains ','.

Examples

import ibis
table = ibis.table(dict(string_col="string"))
result = table.string_col.find_in_set(["a", "b"])

fragment

fragment()

Parse a URL and extract fragment identifier.

Examples

import ibis
url = ibis.literal("https://example.com:80/docs/#DOWNLOADING")
result = url.fragment()  # DOWNLOADING

Returns

Name Type Description
StringValue Extracted string value

hashbytes

hashbytes(how='sha256', /)

Compute the binary hash value of the input.

Parameters

Name Type Description Default
how Literal['md5', 'sha1', 'sha256', 'sha512'] Hash algorithm to use 'sha256'

Returns

Name Type Description
BinaryValue Binary expression

Examples

import ibis
str_lit = ibis.literal("hello")
result = str_lit.hashbytes("md5")  # b']A@*\xbcK*v\xb9q\x9d\x91\x10\x17\xc5\x92'

hexdigest

hexdigest(how='sha256', /)

Return the hash digest of the input as a hex encoded string.

Parameters

Name Type Description Default
how Literal['md5', 'sha1', 'sha256', 'sha512'] Hash algorithm to use 'sha256'

Returns

Name Type Description
StringValue Hexadecimal representation of the hash as a string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"species": ["Adelie", "Chinstrap", "Gentoo"]})
t.species.hexdigest()
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ HexDigest(species)                                               โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string                                                           โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ a4d7d46b27480037bc1e513e0e157cbf258baae6ee69e3110d0f9ff418b57a3c โ”‚
โ”‚ cb97d113ca69899ae4f1fb581f4a90d86989db77b4a33873d604b0ee412b4cc9 โ”‚
โ”‚ b5e90cdff65949fe6bc226823245f7698110e563a12363fc57b3eed3e4a0a612 โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

host

host()

Parse a URL and extract host.

Examples

import ibis
url = ibis.literal("https://user:pass@example.com:80/docs/books")
result = url.host()  # example.com

Returns

Name Type Description
StringValue Extracted string value

ilike

ilike(patterns, /)

Match patterns against self, case-insensitive.

This function is modeled after SQLโ€™s ILIKE directive. Use % as a multiple-character wildcard or _ as a single-character wildcard.

Use re_search or rlike for regular expression-based matching.

Parameters

Name Type Description Default
patterns str | StringValue | Deferred | Iterable[str | StringValue | Deferred] If pattern is a list, then if any pattern matches the input then the corresponding row in the output is True. required

Returns

Name Type Description
BooleanValue Column indicating matches

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["Ibis project", "GitHub"]})
t.s.ilike("%PROJect")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringSQLILike(s, '%PROJect') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ boolean                       โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ True                          โ”‚
โ”‚ False                         โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

join

join(strings, /)

Join a list of strings using self as the separator.

Parameters

Name Type Description Default
strings Sequence[str | StringValue | Deferred] | ir.ArrayValue | Deferred Strings to join with arg required

Returns

Name Type Description
StringValue Joined string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"arr": [["a", "b", "c"], None, [], ["b", None]]})
t
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ arr                โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ array<string>      โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ ['a', 'b', ... +1] โ”‚
โ”‚ NULL               โ”‚
โ”‚ []                 โ”‚
โ”‚ ['b', None]        โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

ibis.literal("|").join(t.arr)
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ ArrayStringJoin(arr, '|') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string                    โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ a|b|c                     โ”‚
โ”‚ NULL                      โ”‚
โ”‚ NULL                      โ”‚
โ”‚ b                         โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

See Also

ArrayValue.join

left

left(nchars, /)

Return the nchars left-most characters.

Parameters

Name Type Description Default
nchars int | ir.IntegerValue | Deferred Maximum number of characters to return required

Returns

Name Type Description
StringValue Characters from the start

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", "defg", "hijlk"]})
t.s.left(2)
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ Substring(s, 0, 2) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string             โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ ab                 โ”‚
โ”‚ de                 โ”‚
โ”‚ hi                 โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

length

length()

Compute the length of a string.

Returns

Name Type Description
IntegerValue The length of each string in the expression

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["aaa", "a", "aa"]})
t.s.length()
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringLength(s) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ int32           โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚               3 โ”‚
โ”‚               1 โ”‚
โ”‚               2 โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

levenshtein

levenshtein(other, /)

Return the Levenshtein distance between two strings.

Parameters

Name Type Description Default
other str | StringValue | Deferred String to compare to required

Returns

Name Type Description
IntegerValue The edit distance between the two strings

Examples

import ibis
ibis.options.interactive = True
s = ibis.literal("kitten")
s.levenshtein("sitting")
โ”Œโ”€โ”€โ”€โ”
โ”‚ 3 โ”‚
โ””โ”€โ”€โ”€โ”˜

like

like(patterns, /)

Match patterns against self, case-sensitive.

This function is modeled after the SQL LIKE directive. Use % as a multiple-character wildcard or _ as a single-character wildcard.

Use re_search or rlike for regular expression-based matching.

Parameters

Name Type Description Default
patterns str | StringValue | Deferred | Iterable[str | StringValue | Deferred] If pattern is a list, then if any pattern matches the input then the corresponding row in the output is True. required

Returns

Name Type Description
BooleanValue Column indicating matches

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["Ibis project", "GitHub"]})
t.s.like("%project")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringSQLLike(s, '%project') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ boolean                      โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ True                         โ”‚
โ”‚ False                        โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

lower

lower()

Convert string to all lowercase.

Returns

Name Type Description
StringValue Lowercase string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["AAA", "a", "AA"]})
t
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ s      โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ AAA    โ”‚
โ”‚ a      โ”‚
โ”‚ AA     โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

t.s.lower()
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ Lowercase(s) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string       โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ aaa          โ”‚
โ”‚ a            โ”‚
โ”‚ aa           โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

lpad

lpad(width, fillchar=' ', /)

Pad arg by truncating on the right or padding on the left.

Parameters

Name Type Description Default
width int | ir.IntegerValue | Deferred Length of output string required
fillchar str | StringValue Pad character ' '

Returns

Name Type Description
StringValue Left-padded string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", "def", "ghij"]})
t.s.lpad(5, "-")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ LPad(s, 5, '-') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string          โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ --abc           โ”‚
โ”‚ --def           โ”‚
โ”‚ -ghij           โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

lstrip

lstrip()

Remove whitespace from the left side of string.

Returns

Name Type Description
StringValue Left-stripped string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["\ta\t", "\nb\n", "\vc\t"]})
t
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ s      โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ \ta\t  โ”‚
โ”‚ \nb\n  โ”‚
โ”‚ \vc\t  โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

t.s.lstrip()
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ LStrip(s) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string    โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ a\t       โ”‚
โ”‚ b\n       โ”‚
โ”‚ c\t       โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

path

path()

Parse a URL and extract path.

Examples

import ibis
url = ibis.literal(
    "https://example.com:80/docs/books/tutorial/index.html?name=networking"
)
result = url.path()  # docs/books/tutorial/index.html

Returns

Name Type Description
StringValue Extracted string value

protocol

protocol()

Parse a URL and extract protocol.

Examples

import ibis
url = ibis.literal("https://user:pass@example.com:80/docs/books")
result = url.protocol()  # https

Returns

Name Type Description
StringValue Extracted string value

query

query(key=None, /)

Parse a URL and returns query string or query string parameter.

If key is passed, return the value of the query string parameter named. If key is absent, return the query string.

Parameters

Name Type Description Default
key str | StringValue | Deferred | None Query component to extract None

Examples

import ibis
url = ibis.literal(
    "https://example.com:80/docs/books/tutorial/index.html?name=networking"
)
result = url.query()  # name=networking
query_name = url.query("name")  # networking

Returns

Name Type Description
StringValue Extracted string value

re_extract

re_extract(pattern, index)

Return the specified match at index from a regex pattern.

Parameters

Name Type Description Default
pattern str | StringValue | Deferred Regular expression pattern string required
index int | ir.IntegerValue The index of the match group to return. The behavior of this function follows the behavior of Pythonโ€™s match objects: when index is zero and thereโ€™s a match, return the entire match, otherwise return the content of the index-th match group. required

Returns

Name Type Description
StringValue Extracted match or whole string if index is zero

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", "bac", "bca"]})

Extract a specific group

t.s.re_extract(r"^(a)bc", 1)
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ RegexExtract(s, '^(a)bc', 1) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string                       โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ a                            โ”‚
โ”‚ ~                            โ”‚
โ”‚ ~                            โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

Extract the entire match

t.s.re_extract(r"^(a)bc", 0)
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ RegexExtract(s, '^(a)bc', 0) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string                       โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ abc                          โ”‚
โ”‚ ~                            โ”‚
โ”‚ ~                            โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

re_replace

re_replace(pattern, replacement)

Replace all matches found by regex pattern with replacement.

Parameters

Name Type Description Default
pattern str | StringValue | Deferred Regular expression string required
replacement str | StringValue | Deferred Replacement string or regular expression required

Returns

Name Type Description
StringValue Modified string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", "bac", "bca", "this has  multi \t whitespace"]})
s = t.s

Replace all โ€œaโ€s that are at the beginning of the string with โ€œbโ€:

s.re_replace("^a", "b")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ RegexReplace(s, '^a', 'b')    โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string                        โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ bbc                           โ”‚
โ”‚ bac                           โ”‚
โ”‚ bca                           โ”‚
โ”‚ this has  multi \t whitespace โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

Double up any โ€œaโ€s or โ€œbโ€s, using capture groups and backreferences:

s.re_replace("([ab])", r"\0\0")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ RegexReplace(s, '()', '\\0\\0')     โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string                              โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ aabbc                               โ”‚
โ”‚ bbaac                               โ”‚
โ”‚ bbcaa                               โ”‚
โ”‚ this haas  multi \t whitespaace     โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

Normalize all whitespace to a single space:

s.re_replace(r"\s+", " ")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ RegexReplace(s, '\\s+', ' ') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string                       โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ abc                          โ”‚
โ”‚ bac                          โ”‚
โ”‚ bca                          โ”‚
โ”‚ this has multi whitespace    โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

re_split

re_split(pattern, /)

Split a string by a regular expression pattern.

Parameters

Name Type Description Default
pattern str | StringValue | Deferred Regular expression string to split by required

Returns

Name Type Description
ArrayValue Array of strings from splitting by pattern

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable(dict(s=["a.b", "b.....c", "c.........a", "def"]))
t.s
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ s           โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string      โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ a.b         โ”‚
โ”‚ b.....c     โ”‚
โ”‚ c.........a โ”‚
โ”‚ def         โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

t.s.re_split(r"\.+").name("splits")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ splits        โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ array<string> โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ ['a', 'b']    โ”‚
โ”‚ ['b', 'c']    โ”‚
โ”‚ ['c', 'a']    โ”‚
โ”‚ ['def']       โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

repeat

repeat(n, /)

Repeat a string n times.

Parameters

Name Type Description Default
n int | ir.IntegerValue | Deferred Number of repetitions required

Returns

Name Type Description
StringValue Repeated string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["a", "bb", "c"]})
t.s.repeat(5)
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ Repeat(s, 5) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string       โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ aaaaa        โ”‚
โ”‚ bbbbbbbbbb   โ”‚
โ”‚ ccccc        โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

replace

replace(pattern, replacement)

Replace each exact match of pattern with replacement.

This method transforms strings to strings. For replacing arbitrary types, see Value.substitute.

Parameters

Name Type Description Default
pattern str | StringValue | Deferred String pattern required
replacement str | StringValue | Deferred String replacement required

Returns

Name Type Description
StringValue Replaced string

See Also

Value.substitute

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", "bac", "bca"]})
t.s.replace("b", "z")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringReplace(s, 'b', 'z') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string                     โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ azc                        โ”‚
โ”‚ zac                        โ”‚
โ”‚ zca                        โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

reverse

reverse()

Reverse the characters of a string.

Returns

Name Type Description
StringValue Reversed string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", "def", "ghi"]})
t
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ s      โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ abc    โ”‚
โ”‚ def    โ”‚
โ”‚ ghi    โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

t.s.reverse()
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ Reverse(s) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string     โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ cba        โ”‚
โ”‚ fed        โ”‚
โ”‚ ihg        โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

right

right(nchars, /)

Return up to nchars from the end of each string.

Parameters

Name Type Description Default
nchars int | ir.IntegerValue | Deferred Maximum number of characters to return required

Returns

Name Type Description
StringValue Characters from the end

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", "defg", "hijlk"]})
t.s.right(2)
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StrRight(s, 2) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string         โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ bc             โ”‚
โ”‚ fg             โ”‚
โ”‚ lk             โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

rpad

rpad(width, fillchar=' ', /)

Pad self by truncating or padding on the right.

Parameters

Name Type Description Default
self String to pad required
width int | ir.IntegerValue | Deferred Length of output string required
fillchar str | StringValue Pad character ' '

Returns

Name Type Description
StringValue Right-padded string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", "def", "ghij"]})
t.s.rpad(5, "-")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ RPad(s, 5, '-') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string          โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ abc--           โ”‚
โ”‚ def--           โ”‚
โ”‚ ghij-           โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

rstrip

rstrip()

Remove whitespace from the right side of string.

Returns

Name Type Description
StringValue Right-stripped string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["\ta\t", "\nb\n", "\vc\t"]})
t
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ s      โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ \ta\t  โ”‚
โ”‚ \nb\n  โ”‚
โ”‚ \vc\t  โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

t.s.rstrip()
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ RStrip(s) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string    โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ \ta       โ”‚
โ”‚ \nb       โ”‚
โ”‚ \vc       โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

split

split(delimiter, /)

Split as string on delimiter.

NoteThis API only works on backends with array support.

Parameters

Name Type Description Default
delimiter str | StringValue | Deferred Value to split by required

Returns

Name Type Description
ArrayValue The string split by delimiter

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"col": ["a,b,c", "d,e", "f"]})
t
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ col    โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ a,b,c  โ”‚
โ”‚ d,e    โ”‚
โ”‚ f      โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

t.col.split(",")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StringSplit(col, ',') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ array<string>         โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ ['a', 'b', ... +1]    โ”‚
โ”‚ ['d', 'e']            โ”‚
โ”‚ ['f']                 โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

startswith

startswith(start, /)

Determine whether self starts with start.

Parameters

Name Type Description Default
start str | StringValue | Deferred prefix to check for required

Returns

Name Type Description
BooleanValue Boolean indicating whether self starts with start

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["Ibis project", "GitHub"]})
t.s.startswith("Ibis")
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ StartsWith(s, 'Ibis') โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ boolean               โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ True                  โ”‚
โ”‚ False                 โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

strip

strip()

Remove whitespace from left and right sides of a string.

Returns

Name Type Description
StringValue Stripped string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["\ta\t", "\nb\n", "\vc\t"]})
t
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ s      โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ \ta\t  โ”‚
โ”‚ \nb\n  โ”‚
โ”‚ \vc\t  โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

t.s.strip()
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ Strip(s) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string   โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ a        โ”‚
โ”‚ b        โ”‚
โ”‚ c        โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

substr

substr(start, length=None)

Extract a substring.

Parameters

Name Type Description Default
start int | ir.IntegerValue | Deferred First character to start splitting, indices start at 0 required
length int | ir.IntegerValue | Deferred | None Maximum length of each substring. If not supplied, searches the entire string None

Returns

Name Type Description
StringValue Found substring

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["abc", "defg", "hijlk"]})
t.s.substr(2)
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ Substring(s, 2) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string          โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ c               โ”‚
โ”‚ fg              โ”‚
โ”‚ jlk             โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

translate

translate(from_str, to_str)

Replace from_str characters in self characters in to_str.

To avoid unexpected behavior, from_str should be shorter than to_str.

Parameters

Name Type Description Default
from_str StringValue Characters in arg to replace required
to_str StringValue Characters to use for replacement required

Returns

Name Type Description
StringValue Translated string

Examples

import ibis
table = ibis.table(dict(string_col="string"))
result = table.string_col.translate("a", "b")

upper

upper()

Convert string to all uppercase.

Returns

Name Type Description
StringValue Uppercase string

Examples

import ibis
ibis.options.interactive = True
t = ibis.memtable({"s": ["aaa", "A", "aa"]})
t
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ s      โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ aaa    โ”‚
โ”‚ A      โ”‚
โ”‚ aa     โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

t.s.upper()
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ Uppercase(s) โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ string       โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ AAA          โ”‚
โ”‚ A            โ”‚
โ”‚ AA           โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

userinfo

userinfo()

Parse a URL and extract user info.

Examples

import ibis
url = ibis.literal("https://user:pass@example.com:80/docs/books")
result = url.userinfo()  # user:pass

Returns

Name Type Description
StringValue Extracted string value
Back to top