teradataml.dataframe.sql.DataFrameColumn.array_prepend = array_prepend(self, value)

DESCRIPTION:
    Append elements to the start of the array.
 
PARAMETERS:
    value:
        Required Argument.
        Specifies the value to be appended at the start of the array.
        Types: ColumnExpression OR Python literal
 
RETURNS:
    ColumnExpression
 
EXAMPLES:
    >>> from teradataml import *
    >>> load_example_data("array", "array_table")
 
    # Create a DataFrame on 'array_table'.
    >>> df = DataFrame("array_table")
    >>> df
                     arr1                   arr2                        arr3
    id                                                                      
    1    (10,20,30,40,50)     (23,200,215,40,21)  ('ab','bc','cd','ab','ef')
    4   (180,28,38,48,58)  (30,NULL,NULL,250,27)  ('mn','no',NULL,'op','pq')
    2   (150,25,35,45,55)       (28,50,95,90,26)  ('xy','yz','za','ab','xy')
    6   (16,261,36,46,56)     (29,170,160,46,25)  ('uv','xy','ab','xy','yz')
    3   (12,22,320,42,52)     (25,22,140,200,23)  ('pq','ab','ab','st','tu')
    5    (14,24,34,44,54)  (26,NULL,NULL,180,24)  ('ij','jk',NULL,'kl','lm')
 
    # Example 1: Prepend value 5 to array column 'arr1'.
    >>> res = df.assign(prepended_arr = df.arr1.array_prepend(5))
    >>> res
                     arr1                   arr2                        arr3        prepended_arr
    id                                                                                           
    1    (10,20,30,40,50)     (23,200,215,40,21)  ('ab','bc','cd','ab','ef')   (5,10,20,30,40,50)
    4   (180,28,38,48,58)  (30,NULL,NULL,250,27)  ('mn','no',NULL,'op','pq')  (5,180,28,38,48,58)
    2   (150,25,35,45,55)       (28,50,95,90,26)  ('xy','yz','za','ab','xy')  (5,150,25,35,45,55)
    6   (16,261,36,46,56)     (29,170,160,46,25)  ('uv','xy','ab','xy','yz')  (5,16,261,36,46,56)
    3   (12,22,320,42,52)     (25,22,140,200,23)  ('pq','ab','ab','st','tu')  (5,12,22,320,42,52)
    5    (14,24,34,44,54)  (26,NULL,NULL,180,24)  ('ij','jk',NULL,'kl','lm')   (5,14,24,34,44,54)
 
    # Example 2: Prepend the value in column 'id' to array column 'arr1'.
    >>> res = df.assign(prepended_arr = df.arr1.array_prepend(df.id))
    >>> res
                     arr1                   arr2                        arr3        prepended_arr
    id                                                                                           
    1    (10,20,30,40,50)     (23,200,215,40,21)  ('ab','bc','cd','ab','ef')   (1,10,20,30,40,50)
    4   (180,28,38,48,58)  (30,NULL,NULL,250,27)  ('mn','no',NULL,'op','pq')  (4,180,28,38,48,58)
    2   (150,25,35,45,55)       (28,50,95,90,26)  ('xy','yz','za','ab','xy')  (2,150,25,35,45,55)
    6   (16,261,36,46,56)     (29,170,160,46,25)  ('uv','xy','ab','xy','yz')  (6,16,261,36,46,56)
    3   (12,22,320,42,52)     (25,22,140,200,23)  ('pq','ab','ab','st','tu')  (3,12,22,320,42,52)
    5    (14,24,34,44,54)  (26,NULL,NULL,180,24)  ('ij','jk',NULL,'kl','lm')   (5,14,24,34,44,54)