Noizu.Entity.Meta.Field (NoizuLabs Entities v0.2.1)

Meta Data Record for Field Settings.

Summary

Types

Field ACL permissions

Field Default Value

Field Name

Field Internal/User Options

Field PII level (Personally Identifiable Information).

Field Metadata entry

Field Persistence Store Settings

Is field ephermal (not persisted)?

Field Type, used to populate changesets and perform embedded/nestd object management.

Types

field_acl()

@type field_acl() :: term()

Field ACL permissions

field_default()

@type field_default() :: term()

Field Default Value

field_name()

@type field_name() :: term()

Field Name

field_options()

@type field_options() :: term()

Field Internal/User Options

field_pii()

@type field_pii() :: boolean() | term()

Field PII level (Personally Identifiable Information).

field_settings()

@type field_settings() ::
  {:field_settings, name :: field_name(), store :: field_store(),
   type :: field_type(), transient :: field_transient(), pii :: field_pii(),
   default :: field_default(), acl :: field_acl(), options :: field_options()}

Field Metadata entry

field_store()

@type field_store() :: [term()]

Field Persistence Store Settings

field_transient()

@type field_transient() :: boolean()

Is field ephermal (not persisted)?

field_type()

@type field_type() :: term()

Field Type, used to populate changesets and perform embedded/nestd object management.

def_entity do
    id :uuid
    field :title, nil, :string # A Ecto String - so changesets specify a string field.
    field :body, nil, :string
    field :time_stamp, nil, Noizu.Entity.TimeStamp # A embedded object, changeset converts back and forth to inserted_at, updated_at, and deleted_at date time fields.
end

Functions

field_settings(args \\ [])

(macro)

field_settings(record, args)

(macro)