Expr.Struct (StructOps)

Namespace: Polars.FSharp

Properties & Indexers

Property	Type	Description
.[index: int] / .[name: string] / .[names: string[]]	Expr	Access the fields of the struct by index. Access the fields of the struct by name. Access the fields of the struct by multiple names.

Instance Methods

Drop

Drop one or more fields from the struct.

member Drop(names: seq<string>, ?strict: bool) : Expr

Parameters

Name	Type	Description
names	seq<string>	Names of the fields to drop.
strict	bool (optional)	If True, raise an error if any of the specified fields do not exist in the struct.

---

Field

Retrieve a field from the struct by name.

Retrieve a field by its index.

member Field([<ParamArray>] names: string[]) : Expr
member Field(index: int) : Expr

Parameters

Name	Type	Description
names	string[]	-
index	int	-

---

JsonEncode

Convert the struct column into a JSON string column. Useful for debugging or exporting to systems that support JSON strings.

member JsonEncode : unit -> Expr

---

RenameFields

Rename the fields of the struct.

member RenameFields([<ParamArray>] names: string[]) : Expr

Parameters

Name	Type	Description
names	string[]	The new names for the fields.

---

Unnest

Expand the struct into its individual fields.Alias for Expr.Struct.field("*").

member Unnest : unit -> Expr

---

WithFields

Add or overwrite fields of this struct.This is similar to with_columns on DataFrame.

member WithFields([<ParamArray>] fields: Expr[]) : Expr

Parameters

Name	Type	Description
fields	Expr[]	-

---