odm

package module

Go to main page

Versions in this module

v1

v1.0.0

Nov 4, 2022

Changes in this version

type Options

+ func (o *Options) Client() *mongo.Client

+ func (o *Options) Database() *mongo.Database

v0

v0.1.4

Nov 7, 2021

Changes in this version

type Collection

+ func (c *Collection) DeleteOneByPk(ctx context.Context, id interface{}, opts ...*options.DeleteOptions) error

+ func (c *Collection) RestoreOneByPK(ctx context.Context, id interface{}, opts ...*options.UpdateOptions) error

+ func (c *Collection) SoftDeleteOneByPK(ctx context.Context, pk interface{}, opts ...*options.UpdateOptions) error

v0.1.3

Nov 5, 2021

Changes in this version

type Options

+ func (o *Options) CollWithName(m IModel, meta string, opts ...*options.CollectionOptions) *Collection

v0.1.2

Oct 22, 2021

Changes in this version

type Collection

+ func (c *Collection) FindByPK(ctx context.Context, id interface{}, result interface{}, ...) error

v0.1.1

Oct 19, 2021

Changes in this version

+ var InvalidatedModels = errors.New("invalidated models input\n try []*YourModel")

+ var UnableSoftDeletable = errors.New("unable soft-delete")

+ func CollName(m IModel) string

+ func ToSnakeCase(str string) string

+ func TransactionWithClient(ctx context.Context, client *mongo.Client, f TransactionFunc) error

+ type Collection struct

+ func (c *Collection) Count(ctx context.Context, filter bson.M, opts ...*options.CountOptions) (int64, error)

+ func (c *Collection) Create(ctx context.Context, model IModel, opts ...*options.InsertOneOptions) error

+ func (c *Collection) CreateMany(ctx context.Context, input interface{}, opts ...*options.InsertManyOptions) error

+ func (c *Collection) DeleteMany(ctx context.Context, filter interface{}, opts ...*options.DeleteOptions) error

+ func (c *Collection) DeleteOne(ctx context.Context, model IModel, opts ...*options.DeleteOptions) error

+ func (c *Collection) Find(ctx context.Context, filter bson.M, result interface{}, ...) error

+ func (c *Collection) FindOne(ctx context.Context, filter bson.M, result interface{}, ...) error

+ func (c *Collection) RestoreMany(ctx context.Context, filter bson.M, opts ...*options.UpdateOptions) error

+ func (c *Collection) RestoreOne(ctx context.Context, model IModel, opts ...*options.UpdateOptions) error

+ func (c *Collection) SoftDeleteMany(ctx context.Context, filter bson.M, opts ...*options.UpdateOptions) error

+ func (c *Collection) SoftDeleteOne(ctx context.Context, model IModel, opts ...*options.UpdateOptions) error

+ func (c *Collection) UpdateOne(ctx context.Context, model IModel, opts ...*options.UpdateOptions) error

+ type CollectionGetter interface

+ Collection func() *mongo.Collection

+ type CollectionNameGetter interface

+ CollectionName func() string

+ type Collections sync.Map

+ type CreatedHook interface

+ Created func(ctx context.Context) error

+ type CreatingHook interface

+ Creating func(ctx context.Context, cfg *FieldsConfig) error

+ type DefaultModel struct

+ func (f *DefaultModel) Creating(ctx context.Context, cfg *FieldsConfig) error

+ func (f *DefaultModel) Restoring(ctx context.Context, cfg *FieldsConfig) error

+ func (f *DefaultModel) Saving(ctx context.Context, cfg *FieldsConfig) error

+ func (f *DefaultModel) SoftDeleting(ctx context.Context, cfg *FieldsConfig) error

+ type DeletedAtField struct

+ DeletedAt time.Time

+ type DeletedHook interface

+ Deleted func(ctx context.Context, result *mongo.DeleteResult) error

+ type DeletingHook interface

+ Deleting func(ctx context.Context, cfg *FieldsConfig) error

+ type FieldInfo struct

+ BsonName string

+ Index []int

+ Name string

+ RawTag string

+ Tags []string

+ type FieldsConfig struct

+ AutoCreateTimeField string

+ AutoUpdateTimeField string

+ DeleteTimeBsonField string

+ DeleteTimeField string

+ PrimaryIDBsonField string

+ PrimaryIDField string

+ func (info FieldsConfig) SoftDeletable() bool

+ type FieldsInfo []FieldInfo

+ type IDField struct

+ ID primitive.ObjectID

+ func (f *IDField) GetID() interface{}

+ func (f *IDField) PrepareID(id interface{}) (interface{}, error)

+ func (f *IDField) SetID(id interface{})

+ type IModel interface

+ Creating func(ctx context.Context, cfg *FieldsConfig) error

+ GetID func() interface{}

+ PrepareID func(id interface{}) (interface{}, error)

+ Saving func(ctx context.Context, cfg *FieldsConfig) error

+ SetID func(id interface{})

+ SoftDeleting func(ctx context.Context, cfg *FieldsConfig) error

+ type IModels []IModel

+ func (models IModels) At(i int) IModel

+ func (models IModels) Interfaces() (output []interface{})

+ type Option func(opts *Options) error

+ func SetDatabase(url string, dbName string, opts ...*options.ClientOptions) Option

+ type Options struct

+ func DefaultOpts(opts ...Option) (*Options, error)

+ func NewOpts(opts ...Option) (*Options, error)

+ func (o *Options) Clone() *Options

+ func (o *Options) Coll(m IModel, opts ...*options.CollectionOptions) *Collection

+ func (o *Options) NewCollection(m IModel, name string, opts ...*options.CollectionOptions) *Collection

+ func (o Options) TransactionWithCtx(ctx context.Context, f TransactionFunc) error

+ type RestoredHook interface

+ Restored func(ctx context.Context, result *mongo.UpdateResult) error

+ type RestoringHook interface

+ Restoring func(ctx context.Context, cfg *FieldsConfig) error

+ type SavedHook interface

+ Saved func(ctx context.Context) error

+ type SavingHook interface

+ Saving func(ctx context.Context, cfg *FieldsConfig) error

+ type SoftDeletedHook interface

+ SoftDeleted func(ctx context.Context, result *mongo.UpdateResult) error

+ type SoftDeletingHook interface

+ SoftDeleting func(ctx context.Context, cfg *FieldsConfig) error

+ type TimestampFields struct

+ CreatedAt time.Time

+ UpdatedAt time.Time

+ type TransactionFunc func(session mongo.Session, sc mongo.SessionContext) error

+ type UpdatedHook interface

+ Updated func(ctx context.Context, result *mongo.UpdateResult) error

+ type UpdatingHook interface

+ Updating func(ctx context.Context) error

v0.1.0-alpha

Oct 19, 2021

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