lpad#

swordfish.function.lpad()#

Pad the left-side of a string with a specific set of characters.

If str is a table, the function is applied only to columns of STRING type. Other column types are ignored.

Parameters:
  • str (Constant) – A STRING scalar/vector, or table. It is the string to pad characters to (the left-hand side).

  • length (Constant) – A positive integer indicating the number of characters to return. If length is smaller than the length of str, the lpad function is equivalent to left(str, length).

  • pattern (Constant) – A string scalar. It is the string that will be padded to the left-hand side of str. If it is unspecified, the lpad function will pad spaces to the left-side of str.