README.md

MODM

MODM is a MongoDB wrapper built on top of the mongo-go-driver, leveraging the powerful features of Go generics. It provides a convenient interface for CRUD operations, allowing direct return of structured data without the need for code generation.

Features

• Structured Data for CRUD Operations: Directly return structured data from CRUD operations, providing a seamless development experience.

• No Code Generation Required: Leverage Go 1.18's generics features to minimize code volume and enhance development efficiency.

• Flexible Hooks: Support automated field updates, providing a more adaptable approach to data handling.

• Easy-to-Use Index Management: Effortlessly create MongoDB indexes through code for streamlined management.

• Simple Transactions: Simplify transaction usage, empowering developers to effortlessly employ MongoDB transactions.

Requirements

• Go 1.18 and Above: MODM is designed to take full advantage of the features introduced in Go 1.18 and later versions.

Comparison with mongo-go-driver

When using mongodb, the typical approach is to define models and collections as follows:

With mongo-go-driver

type User struct {
	DefaultField `bson:",inline"`
	Name         string `bson:"name,omitempty" json:"name"`
	Age          int    `bson:"age,omitempty" json:"age"`
}

coll := db.Collection("users")

// When using find(), it's necessary to predefine the return structure and manually iterate through the cursor
users := make([]*User, 0)
cursor, err := coll.Find(context.TODO(), bson.D{})
if err != nil {
	log.Fatal(err)
}
if err = cursor.All(context.TODO(), &users); err != nil {
	log.Fatal(err)
}

With modm

On the other hand, modm offers a simpler approach:

type User struct {
	DefaultField `bson:",inline"`
	Name         string `bson:"name,omitempty" json:"name"`
	Age          int    `bson:"age,omitempty" json:"age"`
}

coll := modm.NewRepo[*User](db.Collection("users"))

// No need to predefine the return structure, and the cursor management is automatic
users, err := coll.Find(context.TODO(), bson.D{})
if err != nil {
	log.Fatal(err)
}

Here, Find() returns []*User, error.

Performance tests show that the efficiency of the two methods is comparable.

Installation

go get github.com/miilord/modm

Getting Started

Connecting to the database

To use MODM, you only need to pass *mongo.Collection in mongo-go-driver, so MODM is compatible with all libraries based on the official driver, e.g. qmgo.

Below is an example of the official driver:

ctx := context.Background()
client, err := mongo.Connect(ctx, options.Client().ApplyURI("your mongodb uri"))
if err != nil {
	panic(err)
}
defer client.Disconnect(ctx)
database := client.Database("test")

Importing MODM

type User struct {
	modm.DefaultField `bson:",inline"`
	Name              string `bson:"name,omitempty" json:"name"`
	Age               int    `bson:"age,omitempty" json:"age"`
}

type DB struct {
	Users *modm.Repo[*User]
}

func main() {
	...
	db := DB{
		Users: modm.NewRepo[*User](database.Collection("users")),
	}
	db.Users.InsertOne(ctx, &User{Name: "gooooo", Age: 6})

	// To query for documents containing zero values, use bson.M, bson.D, or a map.
	// Alternatively, consider using pointers for the appropriate fields.
	user, _ := db.Users.FindOne(ctx, &User{Name: "gooooo"})
	fmt.Println(user.Age) // 6

	// Find() returns ([]*User, error)
	users, _ := db.Users.Find(ctx, &User{Age: 6})
}

Contributions

Contributions are welcome! Feel free to open issues, submit pull requests, or provide suggestions to improve MODM.

License

MODM is licensed under the MIT License - see the LICENSE file for details.