Teradata Package for Python Function Reference | 20.00 - setbit - 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 - 20.00

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Teradata Package for Python
Release Number
20.00
Published
March 2024
Language
English (United States)
Last Update
2024-04-10
dita:id
TeradataPython_FxRef_Enterprise_2000
Product Category
Teradata Vantage
teradataml.dataframe.sql.DataFrameColumn.setbit = setbit(target_bit, target_value)
DESCRIPTION:
    Function sets the value of the bit specified by "target_bit" to the value
    of "target_value" in the integer or byte value of column.
 
PARAMETERS:
    target_bit:
        Required Argument.
        Specifies a ColumnExpression of an integer column or an integer literal.
        Notes:
            1. The range of input values can vary from 0 (bit 0 is the least significant
               bit) to the (sizeof(byte value of column) - 1).
            2. If "target_bit" is negative or out-of-range (meaning that it exceeds the size
               of byte value of column), an error is returned.
            3. If the argument is NULL, the function returns NULL.
        Format of a ColumnExpression of a column: '<dataframe>.<dataframe_column>'.
        Types: ColumnExpression, int
 
    target_value:
        Optional Argument.
        Specifies a ColumnExpression of an integer column or an integer literal representing
        a binary bit value, 0 or 1, to be set within the byte value of column.
        Note:
            1. If the argument is NULL, the function returns NULL.
        Default Value: 1
        Format of a ColumnExpression of a column: '<dataframe>.<dataframe_column>'.
        Types: ColumnExpression, int
 
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: Set the fourth bit from the values in "varbyte_col" column with "1" and
    #           pass it as input to DataFrame.assign().
    >>> res_df = df.assign(col= df.varbyte_col.setbit(3))
    >>> print(res_df)
           byte_col      varbyte_col             blob_col              col
    id_col
    0         b'63'      b'627A7863'  b'3330363136323633'      b'627A786B'
    2         b'61'  b'616263643132'  b'6162636431323233'  b'61626364313A'
    1         b'62'      b'62717765'  b'3331363136323633'      b'6271776D'