CSVRowModel

Inherits: RefCounted < Object

Schema-driven typed row converter for CSV data.

Description

CSVRowModel stores a dictionary schema and applies it to CSV rows. It can cast dictionaries or array rows into typed dictionaries, apply defaults, validate required fields and enum values, and serialize rows for CSV export.

Methods

Dictionary	cast_row(row: Variant) const
Array	cast_rows(rows: Array) const
CSVRowModel	from_file(path: String) static
CSVRowModel	from_schema(schema: Dictionary) static
PackedStringArray	get_field_names() const
Dictionary	get_schema() const
CSVRowModel	infer_from_rows(rows: Array, options: Dictionary = {}) static
CSVRowModel	infer_from_table(table: CSVTable, options: Dictionary = {}) static
Error	load_schema(path: String)
Error	save_schema(path: String) const
Dictionary	serialize_row(row: Variant, include_defaults: bool = true) const
Array	serialize_rows(rows: Array, include_defaults: bool = true) const
void	set_schema(schema: Dictionary)
Dictionary	validate_row(row: Variant) const
Array	validate_rows(rows: Array) const

---

Method Descriptions

Dictionary cast_row(row: Variant) const 🔗

Returns a typed dictionary for row, applying defaults where available.

---

Array cast_rows(rows: Array) const 🔗

Casts each row in rows.

---

CSVRowModel from_file(path: String) static 🔗

Creates a row model by loading a schema dictionary from path.

---

CSVRowModel from_schema(schema: Dictionary) static 🔗

Creates a row model from schema.

---

PackedStringArray get_field_names() const 🔗

Returns schema field names in declaration order.

---

Dictionary get_schema() const 🔗

Returns a copy of the current schema.

---

CSVRowModel infer_from_rows(rows: Array, options: Dictionary = {}) static 🔗

Creates a model by inferring schema definitions from dictionaries or array rows. String values are parsed with DotCSV conversion rules before type inference.

---

CSVRowModel infer_from_table(table: CSVTable, options: Dictionary = {}) static 🔗

Creates a model by inferring schema definitions from the rows in table.

---

Error load_schema(path: String) 🔗

Loads a schema dictionary from path and replaces the current schema.

---

Error save_schema(path: String) const 🔗

Saves the current schema dictionary to path.

---

Dictionary serialize_row(row: Variant, include_defaults: bool = true) const 🔗

Returns a dictionary suitable for CSV export. Values are cast first; missing defaulted fields are included when include_defaults is true.

---

Array serialize_rows(rows: Array, include_defaults: bool = true) const 🔗

Serializes each row in rows.

---

void set_schema(schema: Dictionary) 🔗

Replaces the current schema.

---

Dictionary validate_row(row: Variant) const 🔗

Validates row and returns a report with ok, errors, and casted row data.

---

Array validate_rows(rows: Array) const 🔗

Validates each row and includes its row index in each report.