Documentation

exec/update.go

@@ -10,11 +10,21 @@ import (
 	log "gitlab.com/gdulai/simpleloglvl"
 )
 
+// Update represents an update operation.
 type Update[T any] struct {
-	target   schema.Table
-	toUpdate T
+	target   schema.Table // The table where records will be updated.
+	toUpdate T            // A model instance with the new values.
 }
 
+// NewUpdate creates a new instance of Update.
+//
+// Parameters:
+// - orm: The ORM instance that manages the database connection and schema
+// - toUpdate: A model instance with new values
+//
+// Returns:
+// - Update[T]: A new Update operation instance
+// - error: An error if the table could not be found in the schema cache
 func NewUpdate[T any](orm *simpleorm.ORM, toUpdate T) (Update[T], error) {
 	table, ok := orm.Cache().Get(reflect.TypeFor[T]().Name())
 	if !ok {
@@ -24,10 +34,19 @@ func NewUpdate[T any](orm *simpleorm.ORM, toUpdate T) (Update[T], error) {
 	return Update[T]{target: *table, toUpdate: toUpdate}, nil
 }
 
+// Execute executes the update operation.
 func (u Update[T]) Execute(conn *simpleorm.DBConnection) error {
 	return u.execute(conn, nil)
 }
 
+// execute constructs and executes the UPDATE SQL statement.
+//
+// Parameters:
+// - conn: The database connection to use for executing the query
+// - tx: Optional transaction to use instead of a connection
+//
+// Returns:
+// - error: An error if the operation fails
 func (u Update[T]) execute(conn *simpleorm.DBConnection, tx *sql.Tx) error {
 	dml, err := u.target.GetUpdateDML()
 	if err != nil {