record

github.com/dal-go/record defines the small, persistence-neutral vocabulary for identifying records, carrying record data, and describing changes to records.

It exists so API, rendering, command, and facade layers can depend on a stable record model without importing database sessions, queries, transactions, or an adapter. Database access belongs to DALgo: DALgo accepts these values at its boundary and executes a record.Changes envelope through dal.ApplyChanges.

The module contains two packages:

• record for identity, data, envelopes, and change batches.
• record/update for declarative field-update commands.

API

Every exported type and function is listed below. Links lead to its API documentation.

record

Errors

• Variables: ErrNoError, ErrRecordNotFound.
• Function: IsNotFound.

Keys and composite IDs

• Types: Key, KeyOption, and FieldVal.
• Key constructors: NewKeyWithID, NewKeyWithParentAndID, NewIncompleteKey, NewKeyWithFields, and NewKeyWithOptions.
• Key options: WithKeyID, WithStringID, WithIntID, WithFields, and WithParentKey.
• Key helpers: EscapeID and EqualKeys.
• Methods: Key.String, Key.CollectionPath, Key.Level, Key.Parent, Key.Collection, Key.Validate, Key.Equal, and FieldVal.Validate.

Record envelopes

• Types: Record, WithID, and DataWithID.
• Constructors: NewRecord, NewRecordWithData, NewRecordWithIncompleteKey, NewRecordWithoutKey, NewWithID, and NewDataWithID.
• Helper: AnyRecordWithError.
• Method: WithID.String.

Change envelopes and data mapping

• Types: Updates and Changes.
• Changes methods: RecordsToInsert, QueueForInsert, and Reset.
• Mapping functions: DataToMap and MapToData.

record/update

• Types: FieldPath and Update.
• Functions: ByFieldName, ByFieldPath, DeleteByFieldName, and DeleteByFieldPath.
• Values: DeleteField and ServerTimestamp.