Interface Record

BaseFilesPath returns the storage dir path used by the record.

CleanCopy returns a copy of the current record model populated only with its LATEST data state and everything else reset to the defaults.

Collection returns the Collection model associated to the current Record model.

ColumnValueMap implements [ColumnValueMapper] interface.

Email returns the "email" auth record data value.

Verified returns the "emailVisibility" auth record data value.

Expand returns a shallow copy of the current Record model expand data.

ExpandedAll retrieves a slice of relation Records from the already loaded expand data of the current model.

If the requested expand relation is single, this method normalizes the return result and will wrap the single model as a slice.

Returns nil slice if there is no such expand relation loaded.

ExpandedOne retrieves a single relation Record from the already loaded expand data of the current model.

If the requested expand relation is multiple, this method returns only first available Record from the expanded relation.

Returns nil if there is no such expand relation loaded.

FindFileFieldByFile returns the first file type field for which any of the record's data contains the provided filename.

Get returns a normalized single record model data value for "key".

GetBool returns the data value for "key" as a bool.

GetDateTime returns the data value for "key" as a DateTime instance.

GetFloat returns the data value for "key" as a float64.

GetInt returns the data value for "key" as an int.

GetString returns the data value for "key" as a string.

GetStringSlice returns the data value for "key" as a slice of unique strings.

GetTime returns the data value for "key" as a [time.Time] instance.

IgnoreEmailVisibility toggles the flag to ignore the auth record email visibility check.

LastLoginAlertSentAt returns the "lastLoginAlertSentAt" auth record data value.

LastResetSentAt returns the "lastResentSentAt" auth record data value.

LastVerificationSentAt returns the "lastVerificationSentAt" auth record data value.

Load bulk loads the provided data into the current Record model.

MarshalJSON implements the [json.Marshaler] interface.

Only the data exported by PublicExport() will be serialized.

MergeExpand merges recursively the provided expand data into the current model's expand (if any).

Note that if an expanded prop with the same key is a slice (old or new expand) then both old and new records will be merged into a new slice (aka. a :merge: [b,c] => [a,b,c]). Otherwise the "old" expanded record will be replace with the "new" one (aka. a :merge: aNew => aNew).

OriginalCopy returns a copy of the current record model populated with its ORIGINAL data state (aka. the initially loaded) and everything else reset to the defaults.

PasswordHash returns the "passwordHash" auth record data value.

PublicExport exports only the record fields that are safe to be public.

For auth records, to force the export of the email field you need to set m.IgnoreEmailVisibility(true).

RefreshTokenKey generates and sets new random auth record "tokenKey".

Returns an error if the record is not from an auth collection.

ReplaceModifers returns a new map with applied modifier values based on the current record and the specified data.

The resolved modifier keys will be removed.

Multiple modifiers will be applied one after another, while reusing the previous base key value result (eg. 1; -5; +2 => -2).

Example usage:

  newData := record.ReplaceModifers(data)
   // record:  {"field": 10}
   // data:    {"field+": 5}
   // newData: {"field": 15}
Copy

SchemaData returns a shallow copy ONLY of the defined record schema fields data.

Set sets the provided key-value data pair for the current Record model.

If the record collection has field with name matching the provided "key", the value will be further normalized according to the field rules.

SetEmail sets the "email" auth record data value.

This method doesn't check whether the provided value is a valid email.

Returns an error if the record is not from an auth collection.

SetEmailVisibility sets the "emailVisibility" auth record data value.

Returns an error if the record is not from an auth collection.

SetExpand shallow copies the provided data to the current Record model's expand.

SetLastLoginAlertSentAt sets an "lastLoginAlertSentAt" auth record data value.

Returns an error if the record is not from an auth collection.

SetLastResetSentAt sets the "lastResentSentAt" auth record data value.

Returns an error if the record is not from an auth collection.

SetLastVerificationSentAt sets an "lastVerificationSentAt" auth record data value.

Returns an error if the record is not from an auth collection.

SetPassword sets cryptographically secure string to the auth record "password" field. This method also resets the "lastResetSentAt" and the "tokenKey" fields.

Returns an error if the record is not from an auth collection or an empty password is provided.

SetTokenKey sets the "tokenKey" auth record data value.

Returns an error if the record is not from an auth collection.

SetUsername sets the "username" auth record data value.

This method doesn't check whether the provided value is a valid username.

Returns an error if the record is not from an auth collection.

SetVerified sets the "verified" auth record data value.

Returns an error if the record is not from an auth collection.

TableName returns the table name associated to the current Record model.

TokenKey returns the "tokenKey" auth record data value.

UnknownData returns a shallow copy ONLY of the unknown record fields data, aka. fields that are neither one of the base and special system ones, nor defined by the collection schema.

UnmarshalJSON implements the [json.Unmarshaler] interface.

Retrieves the "key" json field value and unmarshals it into "result".

Example

 result := struct {
     FirstName string `json:"first_name"`
 }{}
 err := m.UnmarshalJSONField("my_field_name", &result)
Copy

Username returns the "username" auth record data value.

ValidatePassword validates a plain password against the auth record password.

Returns false if the password is incorrect or record is not from an auth collection.

Verified returns the "verified" auth record data value.

WithUnknownData toggles the export/serialization of unknown data fields (false by default).