remove

fun DocumentEditor.remove(fieldId: String, rowId: String, schemaId: String? = null)

Removes a specific row from a table.

This function permanently deletes a row from the table. The operation cannot be undone and will trigger appropriate change events. The function supports both regular table fields and collection table fields.

Usage Examples:

// Remove a specific row by its ID
editor.remove(
fieldId = "employees_table",
rowId = "row_123"
)

// Remove a row from a collection table field
editor.remove(
fieldId = "department_employees",
rowId = "row_456",
schemaId = "sales_department"
)

Parameters

fieldId

The unique identifier of the table field containing the row to remove. This can be either a regular table field or a collection table field.

rowId

The unique identifier of the row to remove. The row must exist in the table.

schemaId

Optional schema identifier for collection fields. This is required when working with collection table fields to specify which schema to use. For regular table fields, this parameter is ignored.

Throws

if the fieldId doesn't correspond to a valid table field.

if the rowId doesn't exist in the table.