Teradata Package for Python Function Reference | 17.10 - ColumnSummary - Teradata Package for Python

Teradata® Package for Python Function Reference

Product
Teradata Package for Python
Release Number
17.10
Published
April 2022
Language
English (United States)
Last Update
2022-08-19
Product Category
Teradata Vantage
 
 
ColumnSummary

 
Functions
       
ColumnSummary(data=None, target_columns=None, **generic_arguments)
DESCRIPTION:
    The ColumnSummary() function can be used to take a quick look at the columns,
    their datatypes, and summary of NULLs/non-NULLs for a given table.
 
PARAMETERS:
    data:
        Required Argument.
        Specifies the input teradataml DataFrame.
        Types: teradataml DataFrame
 
    target_columns:
        Required Argument.
        Specifies the input teradataml DataFrame columns for which column
        summary needs to be determined.
        Types: str OR list of Strings (str)
 
    **generic_arguments:
        Specifies the generic keyword arguments SQLE functions accept.
        Below are the generic keyword arguments:
            persist:
                Optional Argument.
                Specifies whether to persist the results of the function in table or
                not. When set to True, results are persisted in table; otherwise,
                results are garbage collected at the end of the session.
                Default Value: False
                Types: boolean
 
            volatile:
                Optional Argument.
                Specifies whether to put the results of the function in volatile table
                or not. When set to True, results are stored in volatile table,
                otherwise not.
                Default Value: False
                Types: boolean
 
            Function allows the user to partition, hash, order or local order the input
            data. These generic arguments are available for each argument that accepts
            teradataml DataFrame as input and can be accessed as:
                * "<input_data_arg_name>_partition_column" accepts str or list of str (Strings)
                * "<input_data_arg_name>_hash_column" accepts str or list of str (Strings)
                * "<input_data_arg_name>_order_column" accepts str or list of str (Strings)
                * "local_order_<input_data_arg_name>" accepts boolean
            Note:
                These generic arguments are supported by teradataml if the underlying
                SQLE Engine function supports, else an exception is raised.
 
 
RETURNS:
    Instance of ColumnSummary.
    Output teradataml DataFrames can be accessed using attribute
    references, such as ColumnSummaryObj.<attribute_name>.
    Output teradataml DataFrame attribute name is:
        result
 
RAISES:
    TeradataMlException, TypeError, ValueError
 
 
EXAMPLES:
    # Notes:
    #    1. Get the connection to Vantage, before importing the function in user space.
    #    2. User can import the function, if it is available on the Vantage user is connected to.
    #    3. To check the list of analytic functions available on the Vantage user connected to,
    #       use "display_analytic_functions()"
 
    # Load the example data.
    load_example_data("teradataml", "titanic")
 
    # Create teradataml DataFrame object.
    titanic_data = DataFrame.from_table("titanic")
 
    # Check the list of available analytic functions.
    display_analytic_functions()
 
    # Import function ColumnSummary.
    from teradataml import ColumnSummary
 
    # Example: Find datatypes, NULL and non-NULL counts etc.
    obj = ColumnSummary(data=titanic_data,
                        target_columns=['age', 'pclass', 'embarked', 'cabin']
                       )
 
    # Print the result DataFrame.
    print(obj.result)