PolarsSchema

Namespace: Polars.FSharp

Polars Schema definition (Name -> DataType).

Properties & Indexers

Property	Type	Description
Count	int	-
DataTypes	DataType list	Get all column datatypes
.[name: string]	DataType	Indexer: schema["col_name"]
Names	string list	Get all column names

Constructors & Static Methods

new

Create an empty schema

Create schema from field definitions

new : unit -> PolarsSchema
new(fields: seq<Field>) : PolarsSchema
new(fields: seq<(string * DataType)>) : PolarsSchema

Parameters

Name	Type	Description
fields	seq<Field> / seq<(string * DataType)>	-

---

FromRecord

Create a Schema directly from a .NET type (e.g., a record or class).

static member FromRecord : unit -> PolarsSchema

Returns: A PolarsSchema mapped from the type's properties.

---

ofList

static member ofList(fields: (string * DataType) list) : PolarsSchema

Parameters

Name	Type	Description
fields	(string * DataType) list	-

---

ofMap

static member ofMap(m: Map<string, DataType>) : PolarsSchema

Parameters

Name	Type	Description
m	Map<string, DataType>	-

---

Operators

op_Equality

static member op_Equality(left: PolarsSchema, right: PolarsSchema) : bool

Parameters

Name	Type	Description
left	PolarsSchema	-
right	PolarsSchema	-

---

op_Inequality

static member op_Inequality(left: PolarsSchema, right: PolarsSchema) : bool

Parameters

Name	Type	Description
left	PolarsSchema	-
right	PolarsSchema	-

---

Instance Methods

ContainsKey

member ContainsKey(key: string) : bool

Parameters

Name	Type	Description
key	string	-

---

GetFields

member GetFields : unit -> seq<(string * DataType)>

---

Len

member Len : unit -> uint64

---

ToDataFrame

Creates an empty DataFrame from this Schema.

member ToDataFrame(?length: int64) : DataFrame

Parameters

Name	Type	Description
length	int64 (optional)	-

---

ToHtml

Generates a clean HTML table representation of the Schema for interactive environments.

member ToHtml : unit -> string

Returns: An HTML formatted string representing the schema fields and types.

---

ToLazyFrame

Creates an empty LazyFrame from this Schema.

member ToLazyFrame(?length: int64) : LazyFrame

Parameters

Name	Type	Description
length	int64 (optional)	-

---

ToList

Convert to F# ordered List of fields

member ToList : unit -> (string * DataType) list

---

ToMap

Convert to F# Map (Warning: Does not preserve column order!)

member ToMap : unit -> Map<string, DataType>

---

TryGetValue

member TryGetValue(key: string, value: byref<IPolarsDataType>) : bool

Parameters

Name	Type	Description
key	string	-
value	byref<IPolarsDataType>	-

---