Initializing help system before first use

xpressinsight.Column

Purpose
Represent a single column within a DataFrame or PolarsDataFrame entity. Outside the Python model (e.g. VDL, Tableau), the column will be represented as a separate entity whose name combines the names of the DataFrame and the Column, concatenated by an underscore, i.e. MyDataFrame_MyColumnName
Synopsis
class xpressinsight.Column(Entity)
Example
Example of declaring two columns NumDays and NumMonths which will contain integer values within a DataFrame. 
>>> YearInfoFrame: xi.types.DataFrame(index='Years', columns=[
...     xi.types.Column("NumDays", dtype=xi.integer,
...                     alias="Number of days"),
...     xi.types.Column("NumMonths", dtype=xi.integer,
...                     alias="Number of years"),
... ])
When accessing the Insight data model from outside the Python app (for example, in VDL or Tableau views, or using the Insight REST API), this DataFrame is represented as two entities, YearInfoFrame_NumDays and YearInfoFrame_NumMonths. If values are inserted into these individual column entities outside the Python app, it's possible their indexes may not be consistent (e.g. YearInfoFrame_NumDays having values for 2003, 2004 and 2005 while YearInfoFrame_NumMonths has values for just 2003 and 2005). In this case, the empty cells in each column will be filled in with a default value when the DataFrame is loaded back into Python.
Related topics
Column.alias,
Column.default,
Column.dtype,
Column.entity_name,
Column.format,
Column.hidden,
Column.index,
Column.index_names,
Column.index_types,
Column.is_managed,
Column.manage,
Column.name,
Column.read_only,
Column.transform_labels_entity,
Column.type_hint,
Column.unique_index_names,
Column.update_after_execution,
Column.update_keep_result_data,
Column.update_progress,
Entity,
types.DataFrame,
types.PolarsDataFrame

Parent Topic Entity Definition Container Classes

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.