lit

functionView source ↗

def lit(
    value: Any,
    dtype: PolarsDataType | None = None,
    allow_object: bool = False,
) -> TdExpr

Categories: generation

Expression for the given literal value.

Parameters

parameter

value

The literal value.

parameter

dtype

The data type of the literal value.

parameter

allow_object

Whether to allow object data type.

Examples

>>> import tabsdata as td
>>>
>>> tf: td.TableFrame ...
>>>
>>> tf.select(td.lit("Hi").alias("lit"), td.col("age").alias("Age"))
>>>
┌──────┬──────┐
│ lit  ┆ Age  │
│ ---  ┆ ---  │
│ str  ┆ i64  │
╞══════╪══════╡
│ Hi   ┆ 1    │
│ Hi   ┆ 15   │
│ Hi   ┆ 18   │
│ Hi   ┆ null │
└──────┴──────┘