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

Teradata® Package for Python Function Reference

Product
Teradata Package for Python
Release Number
17.00
Release Date
April 2021
Content Type
Programming Reference
Publication ID
B700-4008-070K
Language
English (United States)
teradataml.dataframe.setop.td_intersect = td_intersect(df_list, allow_duplicates=True)
DESCRIPTION:
    This function intersects a list of teradataml DataFrames along the index axis and 
    returns a DataFrame with rows common to all input DataFrames. 
 
PARAMETERS:
    df_list:
        Required argument.
        Specifies the list of teradataml DataFrames on which the intersection is to be performed.
        Types: list of teradataml DataFrames
    
    allow_duplicates:
        Optional argument.
        Specifies if the result of intersection can have duplicate rows.
        Default value: True
        Types: bool
 
RETURNS:
    teradataml DataFrame
 
RAISES:
    TeradataMlException, TypeError
 
EXAMPLES:
    >>> from teradataml import load_example_data
    >>> load_example_data("dataframe", "setop_test1")
    >>> load_example_data("dataframe", "setop_test2")
    >>> from teradataml.dataframe.setop import td_intersect
    >>>
    >>> df1 = DataFrame('setop_test1')
    >>> df1
       masters   gpa     stats programming  admitted
    id                                              
    62      no  3.70  Advanced    Advanced         1
    53     yes  3.50  Beginner      Novice         1
    69      no  3.96  Advanced    Advanced         1
    61     yes  4.00  Advanced    Advanced         1
    58      no  3.13  Advanced    Advanced         1
    51     yes  3.76  Beginner    Beginner         0
    68      no  1.87  Advanced      Novice         1
    66      no  3.87    Novice    Beginner         1
    60      no  4.00  Advanced      Novice         1
    59      no  3.65    Novice      Novice         1
    >>> df2 = DataFrame('setop_test2')
    >>> df2
       masters   gpa     stats programming  admitted
    id                                              
    12      no  3.65    Novice      Novice         1
    15     yes  4.00  Advanced    Advanced         1
    14     yes  3.45  Advanced    Advanced         0
    20     yes  3.90  Advanced    Advanced         1
    18     yes  3.81  Advanced    Advanced         1
    17      no  3.83  Advanced    Advanced         1
    13      no  4.00  Advanced      Novice         1
    11      no  3.13  Advanced    Advanced         1
    60      no  4.00  Advanced      Novice         1
    19     yes  1.98  Advanced    Advanced         0
    >>> idf = td_intersect([df1, df2])
    >>> idf
       masters   gpa     stats programming  admitted
    id                                              
    64     yes  3.81  Advanced    Advanced         1
    60      no  4.00  Advanced      Novice         1
    58      no  3.13  Advanced    Advanced         1
    68      no  1.87  Advanced      Novice         1
    66      no  3.87    Novice    Beginner         1
    60      no  4.00  Advanced      Novice         1
    62      no  3.70  Advanced    Advanced         1
    >>>
    >>> idf = td_intersect([df1, df2], allow_duplicates=False)
    >>> idf
       masters   gpa     stats programming  admitted
    id                                              
    64     yes  3.81  Advanced    Advanced         1
    60      no  4.00  Advanced      Novice         1
    58      no  3.13  Advanced    Advanced         1
    68      no  1.87  Advanced      Novice         1
    66      no  3.87    Novice    Beginner         1
    62      no  3.70  Advanced    Advanced         1
    >>> # intersecting more than two DataFrames
    >>> df3 = df1[df1.gpa <= 3.5]
    >>> df3
       masters   gpa     stats programming  admitted
    id                                              
    58      no  3.13  Advanced    Advanced         1
    67     yes  3.46    Novice    Beginner         0
    54     yes  3.50  Beginner    Advanced         1
    68      no  1.87  Advanced      Novice         1
    53     yes  3.50  Beginner      Novice         1
    >>> idf = td_intersect([df1, df2, df3])
    >>> idf
       masters   gpa     stats programming  admitted
    id                                              
    58      no  3.13  Advanced    Advanced         1
    68      no  1.87  Advanced      Novice         1