Teradata Package for Python Function Reference - 17.00 - initcap - Teradata Package for Python

Teradata® Package for Python Function Reference

Product
Teradata Package for Python
Release Number
17.00
Release Date
November 2021
Content Type
Programming Reference
Publication ID
B700-4008-070K
Language
English (United States)
 
 
initcap

 
Functions
       
initcap(column_expression)
DESCRIPTION:
    Function modifies a string argument and returns the string with the first character
    in each word in uppercase and all other characters in lowercase. Words are delimited
    by white space or characters that are not alphanumeric.
 
PARAMETERS:
    column_expression:
        Required Argument.
        Specifies a ColumnExpression of a string column or a string literal.
        If the argument is null, then result is null.
        Format of a ColumnExpression of a string column: '<dataframe>.<dataframe_column>.expression'.
        Supported column types: CHAR, VARCHAR, or CLOB
 
NOTE:
    Function accepts positional arguments only.
 
EXAMPLES:
    # Load the data to run the example.
    >>> load_example_data("dataframe", "admissions_train")
    >>>
 
    # Create a DataFrame on 'admissions_train' table.
    >>> admissions_train = DataFrame("admissions_train")
    >>> admissions_train
       masters   gpa     stats programming  admitted
    id
    22     yes  3.46    Novice    Beginner         0
    36      no  3.00  Advanced      Novice         0
    15     yes  4.00  Advanced    Advanced         1
    38     yes  2.65  Advanced    Beginner         1
    5       no  3.44    Novice      Novice         0
    17      no  3.83  Advanced    Advanced         1
    34     yes  3.85  Advanced    Beginner         0
    13      no  4.00  Advanced      Novice         1
    26     yes  3.57  Advanced    Advanced         1
    19     yes  1.98  Advanced    Advanced         0
    >>>
 
    # Example: Convert the first character to uppercase for strings in "masters" column.
    # Import func from sqlalchemy to execute initcap function.
    >>> from sqlalchemy import func
 
    # Create a sqlalchemy Function object.
    >>> initcap_func_ = func.initcap(admissions_train.masters.expression)
    >>>
 
    # Pass the Function object as input to DataFrame.assign().
    >>> df = admissions_train.assign(initcap_masters_=initcap_func_)
    >>> print(df)
       masters   gpa     stats programming  admitted initcap_masters_
    id
    15     yes  4.00  Advanced    Advanced         1              Yes
    7      yes  2.33    Novice      Novice         1              Yes
    22     yes  3.46    Novice    Beginner         0              Yes
    17      no  3.83  Advanced    Advanced         1               No
    13      no  4.00  Advanced      Novice         1               No
    38     yes  2.65  Advanced    Beginner         1              Yes
    26     yes  3.57  Advanced    Advanced         1              Yes
    5       no  3.44    Novice      Novice         0               No
    34     yes  3.85  Advanced    Beginner         0              Yes
    40     yes  3.95    Novice    Beginner         0              Yes
    >>>