ColumnInfo Class

Column metadata from a Dataverse table definition.

Constructor

ColumnInfo(schema_name: str = '', logical_name: str = '', type: str = '', is_primary: bool = False, is_required: bool = False, max_length: int | None = None, display_name: str | None = None, description: str | None = None)

Parameters

Name	Description
schema_name Required	str Column schema name (e.g. `"new_Price"`).
logical_name Required	str Column logical name (lowercase).
type Required	str Column type string (e.g. `"String"`, `"Integer"`).
is_primary	bool Whether this is the primary name column. Default value: False
is_required	bool Whether the column is required. Default value: False
max_length	int Maximum length for string columns. Default value: None
display_name	str Human-readable display name. Default value: None
description	str Column description. Default value: None

Methods

from_api_response

Create from a raw Dataverse AttributeMetadata API response.

from_api_response

Create from a raw Dataverse AttributeMetadata API response.

from_api_response(response_data: Dict[str, Any]) -> ColumnInfo

Parameters

Name	Description
response_data Required	dict Raw attribute metadata dict (PascalCase keys).

Returns

Type	Description
ColumnInfo

Attributes

description

description: str | None = None

display_name

display_name: str | None = None

is_primary

is_primary: bool = False

is_required

is_required: bool = False

logical_name

logical_name: str = ''

max_length

max_length: int | None = None

schema_name

schema_name: str = ''

type

type: str = ''