mixin

package

v0.3.2 Latest Latest Go to latest Published: Feb 21, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/datumforge/datum

Links

Open Source Insights

Documentation ¶

Overview ¶

Package mixin contains the mixin package

Index ¶

Variables
func AuditHook(next ent.Mutator) ent.Mutator
type AuditMixin
- func (AuditMixin) Fields() []ent.Field
- func (AuditMixin) Hooks() []ent.Hook
type IDMixin
- func (IDMixin) Fields() []ent.Field
type SoftDeleteMixin
type UnexpectedAuditError
- func (e *UnexpectedAuditError) Error() string
type UnexpectedMutationTypeError
- func (e *UnexpectedMutationTypeError) Error() string
type UserOwnedMutationPolicyMixin
- func (mixin UserOwnedMutationPolicyMixin) Policy() ent.Policy
type UserOwnedQueryPolicyMixin
- func (mixin UserOwnedQueryPolicyMixin) Policy() ent.Policy

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrInvalidTokenSize is returned when session token size is invalid
	ErrInvalidTokenSize = errors.New("invalid token size")
)

Functions ¶

func AuditHook ¶

func AuditHook(next ent.Mutator) ent.Mutator

AuditHook sets and returns the created_at, updated_at, etc., fields

Types ¶

type AuditMixin ¶

type AuditMixin struct {
	mixin.Schema
}

AuditMixin provides auditing for all records where enabled. The created_at, created_by, updated_at, and updated_by records are automatically populated when this mixin is enabled.

func (AuditMixin) Fields ¶

func (AuditMixin) Fields() []ent.Field

Fields of the AuditMixin

func (AuditMixin) Hooks ¶

func (AuditMixin) Hooks() []ent.Hook

Hooks of the AuditMixin

type IDMixin ¶

type IDMixin struct {
	mixin.Schema
}

IDMixin holds the schema definition for the ID

func (IDMixin) Fields ¶

func (IDMixin) Fields() []ent.Field

Fields of the IDMixin.

type SoftDeleteMixin ¶

type SoftDeleteMixin struct {
	mixin.Schema
}

SoftDeleteMixin implements the soft delete pattern for schemas.

func (SoftDeleteMixin) Fields ¶

func (SoftDeleteMixin) Fields() []ent.Field

Fields of the SoftDeleteMixin.

func (SoftDeleteMixin) Hooks ¶

func (d SoftDeleteMixin) Hooks() []ent.Hook

Hooks of the SoftDeleteMixin.

func (SoftDeleteMixin) Interceptors ¶

func (d SoftDeleteMixin) Interceptors() []ent.Interceptor

Interceptors of the SoftDeleteMixin.

func (SoftDeleteMixin) P ¶

func (d SoftDeleteMixin) P(w interface{ WhereP(...func(*sql.Selector)) })

P adds a storage-level predicate to the queries and mutations.

func (SoftDeleteMixin) SoftDeleteHook ¶

func (d SoftDeleteMixin) SoftDeleteHook(next ent.Mutator) ent.Mutator

SoftDeleteHook will soft delete records, by changing the delete mutation to an update and setting the deleted_at and deleted_by fields, unless the softDeleteSkipKey is set

type UnexpectedAuditError ¶

type UnexpectedAuditError struct {
	MutationType ent.Mutation
}

UnexpectedAuditError is returned when an unexpected audit log call is received

func (*UnexpectedAuditError) Error ¶

func (e *UnexpectedAuditError) Error() string

Error returns the UnexpectedAuditError in string format

type UnexpectedMutationTypeError ¶

type UnexpectedMutationTypeError struct {
	MutationType ent.Mutation
}

UnexpectedMutationTypeError is returned when an unexpected mutation type is parsed

func (*UnexpectedMutationTypeError) Error ¶

func (e *UnexpectedMutationTypeError) Error() string

Error returns the UnexpectedAuditError in string format

type UserOwnedMutationPolicyMixin ¶ added in v0.2.4

type UserOwnedMutationPolicyMixin struct {
	mixin.Schema
	AllowAdminMutation bool
}

func (UserOwnedMutationPolicyMixin) Policy ¶ added in v0.2.4

func (mixin UserOwnedMutationPolicyMixin) Policy() ent.Policy

Policy sets the policy for updating owned fields by the user

type UserOwnedQueryPolicyMixin ¶ added in v0.2.4

type UserOwnedQueryPolicyMixin struct {
	mixin.Schema
}

func (UserOwnedQueryPolicyMixin) Policy ¶ added in v0.2.4

func (mixin UserOwnedQueryPolicyMixin) Policy() ent.Policy

Policy sets the policy for querying owned fields by the user

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL