Teradata Python Package Function Reference - 16.20 - from_query - Teradata Python Package

Teradata® Python Package Function Reference

prodname
Teradata Python Package
vrm_release
16.20
created_date
February 2020
category
Programming Reference
featnum
B700-4008-098K
teradataml.dataframe.dataframe.DataFrame.from_query = from_query(query, index=True, index_label=None, materialize=False) method of builtins.type instance
Class method for creating a DataFrame from a table or view.
 
PARAMETERS:
    query:
        Required Argument.
        The Teradata Vantage SQL query referenced by this DataFrame.
        Types: str
 
    index:
        Optional Argument.
        True if using index column for sorting otherwise False.
        Default Value: True
        Types: bool
 
    index_label:
        Optional Argument.
        Column/s used for sorting.
        Types: str
 
    materialize:
        Optional Argument.
        Whether to materialize DataFrame or not when created.
 
        One should use enable materialization, when the query  passed to from_query(),
        is expected to produce non-deterministic results, when it is executed multiple
        times. Using this option will help user to have deterministic results in the
        resulting teradataml DataFrame.
        Default Value: False (No materialization)
        Types: bool
 
EXAMPLES:
    from teradataml.dataframe.dataframe import DataFrame
    load_example_data("dataframe","sales")
    df = DataFrame.from_query("select accounts, Jan, Feb from sales")
    df = DataFrame.from_query("select accounts, Jan, Feb from sales", False)
    df = DataFrame.from_query("select * from sales", True, "accounts")
 
RETURNS:
    DataFrame
 
RAISES:
    TeradataMlException - TDMLDF_CREATE_FAIL