soft_delete

README

Soft Delete

This plugin supports bool type for gorm soft delete plugin. The original library works only with int.

import "gorm.io/plugin/soft_delete"

type User struct {
  ID        uint
  Name      string
  DeletedAt soft_delete.IsDeleted
}

// Query
SELECT * FROM users WHERE is_deleted = FALSE;

// Delete
UPDATE users SET is_deleted = TRUE WHERE ID = 1;

Updates DeletedAt field

Plugin searches for tag DeletedAtField, it's value uses as the field name.

type User struct {
  ID        uint
  Name      string
  DeletedAt time.Time
  IsDel     soft_delete.DeletedAt `gorm:"DeletedAtField:DeletedAt"`
}

// Query
SELECT * FROM users WHERE is_del = FALSE;

// Delete
UPDATE users SET is_del = TRUE, deleted_at = /* current unix second */ WHERE ID = 1;

Documentation

Index

• type IsDeleted
  • func (IsDeleted) DeleteClauses(f *schema.Field) []clause.Interface
  • func (IsDeleted) QueryClauses(f *schema.Field) []clause.Interface
  • func (i *IsDeleted) Scan(value interface{}) error
  • func (IsDeleted) UpdateClauses(f *schema.Field) []clause.Interface
• type SoftDeleteDeleteClause
  • func (sd SoftDeleteDeleteClause) Build(clause.Builder)
  • func (sd SoftDeleteDeleteClause) MergeClause(*clause.Clause)
  • func (sd SoftDeleteDeleteClause) ModifyStatement(stmt *gorm.Statement)
  • func (sd SoftDeleteDeleteClause) Name() string
• type SoftDeleteQueryClause
  • func (sd SoftDeleteQueryClause) Build(clause.Builder)
  • func (sd SoftDeleteQueryClause) MergeClause(*clause.Clause)
  • func (sd SoftDeleteQueryClause) ModifyStatement(stmt *gorm.Statement)
  • func (sd SoftDeleteQueryClause) Name() string
• type SoftDeleteUpdateClause
  • func (sd SoftDeleteUpdateClause) Build(clause.Builder)
  • func (sd SoftDeleteUpdateClause) MergeClause(*clause.Clause)
  • func (sd SoftDeleteUpdateClause) ModifyStatement(stmt *gorm.Statement)
  • func (sd SoftDeleteUpdateClause) Name() string

Types

type IsDeleted

type IsDeleted bool

func (IsDeleted) DeleteClauses

func (IsDeleted) DeleteClauses(f *schema.Field) []clause.Interface

func (IsDeleted) QueryClauses

func (IsDeleted) QueryClauses(f *schema.Field) []clause.Interface

func (*IsDeleted) Scan

func (i *IsDeleted) Scan(value interface{}) error

func (IsDeleted) UpdateClauses

func (IsDeleted) UpdateClauses(f *schema.Field) []clause.Interface

type SoftDeleteDeleteClause

type SoftDeleteDeleteClause struct {
	Field         *schema.Field
	DeleteAtField *schema.Field
}

func (SoftDeleteDeleteClause) Build

func (sd SoftDeleteDeleteClause) Build(clause.Builder)

func (SoftDeleteDeleteClause) MergeClause

func (sd SoftDeleteDeleteClause) MergeClause(*clause.Clause)

func (SoftDeleteDeleteClause) ModifyStatement

func (sd SoftDeleteDeleteClause) ModifyStatement(stmt *gorm.Statement)

func (SoftDeleteDeleteClause) Name

func (sd SoftDeleteDeleteClause) Name() string

type SoftDeleteQueryClause

type SoftDeleteQueryClause struct {
	Field *schema.Field
}

func (SoftDeleteQueryClause) Build

func (sd SoftDeleteQueryClause) Build(clause.Builder)

func (SoftDeleteQueryClause) MergeClause

func (sd SoftDeleteQueryClause) MergeClause(*clause.Clause)

func (SoftDeleteQueryClause) ModifyStatement

func (sd SoftDeleteQueryClause) ModifyStatement(stmt *gorm.Statement)

func (SoftDeleteQueryClause) Name

func (sd SoftDeleteQueryClause) Name() string

type SoftDeleteUpdateClause

type SoftDeleteUpdateClause struct {
	Field *schema.Field
}

func (SoftDeleteUpdateClause) Build

func (sd SoftDeleteUpdateClause) Build(clause.Builder)

func (SoftDeleteUpdateClause) MergeClause

func (sd SoftDeleteUpdateClause) MergeClause(*clause.Clause)

func (SoftDeleteUpdateClause) ModifyStatement

func (sd SoftDeleteUpdateClause) ModifyStatement(stmt *gorm.Statement)

func (SoftDeleteUpdateClause) Name

func (sd SoftDeleteUpdateClause) Name() string