Teradata Package for Python Function Reference on VantageCloud Lake | 17.20 - to_byte - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the Teradata Package for Python.

Teradata® Package for Python Function Reference on VantageCloud Lake

Deployment
VantageCloud
Edition
Lake
Product
Teradata Package for Python
Release Number
17.20
Published
November 2022
ft:locale
en-US
ft:lastEdition
2024-02-21
dita:id
TeradataPython_FxRef_Lake_1720
Product Category
Teradata Vantage
teradataml.dataframe.sql.DataFrameColumn.to_byte = to_byte()
DESCRIPTION:
    Function converts a numeric data type to the Vantage byte representation
    (byte value) of the input value.
    Note:
        The size of the byte string returned varies according to the data type of the
        value in column as shown below:
         =======================================================
        | IF value in column type is | THEN the result type is  |
         =======================================================
        | BYTEINT                   | BYTE(1)                   |
        | SMALLINT                  | BYTE(2)                   |
        | INTEGER                   | BYTE(4)                   |
        | BIGINT                    | BYTE(8)                   |
        ========================================================
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    DataFrameColumn
 
EXAMPLES:
    # Load the data to run the example.
    >>> load_example_data("dataframe", "bytes_table")
 
    # Create a DataFrame on 'bytes_table' table.
    >>> df = DataFrame("bytes_table")
    >>> print(df)
           byte_col      varbyte_col             blob_col
    id_col
    2         b'61'  b'616263643132'  b'6162636431323233'
    1         b'62'      b'62717765'  b'3331363136323633'
    0         b'63'      b'627A7863'  b'3330363136323633'
 
    # Example1: Converts values in "id_col" to bytes and pass it as input to
    #           DataFrame.assign().
    >>> res_df = df.assign(col = df.id_col.to_byte())
    >>> print(res_df)
           byte_col      varbyte_col             blob_col   col
    id_col
    2         b'61'  b'616263643132'  b'6162636431323233'  b'2'
    1         b'62'      b'62717765'  b'3331363136323633'  b'1'
    0         b'63'      b'627A7863'  b'3330363136323633'  b'0'