15.00 - LPAD - Teradata Database

Teradata Database SQL Functions, Operators, Expressions, and Predicates

Product
Teradata Database
Release Number
15.00
Content Type
Programming Reference
Publication ID
B035-1145-015K
Language
English (United States)
Last Update
2018-09-24

LPAD

Purpose  

Returns the source_string padded to the left with the characters in fill_string so that the resulting string is length characters.

Syntax  

where:

 

Syntax element…

Specifies…

TD_SYSFNLIB

the name of the database where the function is located.

source_string

a character string or string expression.

If the length of source_string is greater than length, source_string is truncated to length characters.

length

the number of characters in the resulting string.

fill_string

an optional string of characters used to pad the source_string.

If fill_string is not specified, source_string will be padded to the left with space characters.

The sequence of characters in fill_string is replicated as necessary.

ANSI Compliance

This is a Teradata extension to the ANSI SQL:2011 standard.

Invocation

LPAD is an embedded services system function. For information on activating and invoking embedded services functions, see “Embedded Services System Functions” on page 24.

Argument Types and Rules

Expressions passed to this function must have one of the following data types:

  • source_string = VARCHAR or CLOB
  • length = INTEGER, BIGINT, or NUMBER
  • fill_string = CHAR, VARCHAR, or CLOB
  • If any of the input arguments are NULL, the function returns NULL.

    You can also pass arguments with data types that can be converted to the above types using the implicit data type conversion rules that apply to UDFs.

    Note: The UDF implicit type conversion rules are more restrictive than the implicit type conversion rules normally used by Teradata Database. If an argument cannot be converted to the required data type following the UDF implicit conversion rules, it must be explicitly cast.

    For details, see “Compatible Types” in SQL External Routine Programming.

    Result Type

    The result data type and character set are the same as those of the source_string argument. For example, if the source_string argument has a data type of VARCHAR CHARACTER SET UNICODE, the result data type is VARCHAR CHARACTER SET UNICODE.

    Example  

    The following query returns the result 'yzybuilding'.

       SELECT LPAD('building', 11, 'yz');

    Example  

    The following query returns the result 'build'.

       SELECT LPAD('building', 5, 'yz');

    Example  

    The following query returns the result '   building'. The space character is used by default to pad the source string.

       SELECT LPAD('building', 11);