added base model and repositories for modifying and reading data from db.

Author: Amit

Readme.md

@@ -1,4 +1,4 @@
-# go-mongodb-client
+# ✅ go-mongodb-client
 
 A simple utility Go package for connecting to MongoDB.  
 This package provides the following features:
@@ -9,13 +9,15 @@ This package provides the following features:
 
 ---
 
-## 📦 Installation
+# 📦 Installation
 
 ```bash
 go get github.com/amitjangid80/go-mongodb-client@latest
 ```
 
-## 📦 Usage
+# 📦 Usage
+
+## 📦 Creating Mongodb Config
 
 ### You can add this in your main.go file or wherever you are setting up your db connection
 
@@ -83,5 +85,165 @@ func CreateCollections(config *config.Config) {
 		}
 	}
 }
+```
+
+## 📦 Usage of Base Model and Repository Functions
+
+### 📦 Base DML Model
+### You can use this Base model in your own domain model which will by default come with below structure
+
+```go
+package mongodb_domain
+
+type BaseDmlModel interface {
+	SetCreatedBy(by string)
+	SetCreatedOn(on string)
+	SetModifiedBy(by string)
+	SetModifiedOn(on string)
+	GetId() string
+	SetId(id string)
+}
+
+type DmlModel struct {
+	Id         string `json:"id,omitempty" bson:"_id,omitempty"`
+	CreatedOn  string `json:"createdOn,omitempty" bson:"createdOn,omitempty"`
+	CreatedBy  string `json:"createdBy" bson:"createdBy"`
+	ModifiedOn string `json:"modifiedOn,omitempty" bson:"modifiedOn,omitempty"`
+	ModifiedBy string `json:"modifiedBy" bson:"modifiedBy"`
+}
+
+// Implement Auditable interface
+func (d *DmlModel) SetCreatedBy(by string)  { d.CreatedBy = by }
+func (d *DmlModel) SetCreatedOn(on string)  { d.CreatedOn = on }
+func (d *DmlModel) SetModifiedBy(by string) { d.ModifiedBy = by }
+func (d *DmlModel) SetModifiedOn(on string) { d.ModifiedOn = on }
+func (d *DmlModel) GetId() string           { return d.Id }
+func (d *DmlModel) SetId(id string)         { d.Id = id }
+```
+
+### Example User Model or Domain
+
+```go
+type User struct {
+	FirstName      string   `json:"firstName" bson:"firstName"`
+	LastName       string   `json:"lastName" bson:"lastName"`
+	MobileNumber   string   `json:"mobileNo" bson:"mobileNo"`
+	EmailId        string   `json:"emailId" bson:"emailId"`
+	Username       string   `json:"username" bson:"username"`
+	Password       string   `json:"password" bson:"password"`
+	DmlModel       `bson:",inline"` // Add the Base DML Model Here in your domain or model
+}
+```
+
+## 📦 Repository Functions
+
+### Create or Insert document in a collection
+
+```go
+func RegisterUser(user *domain.User) {
+	// This function returns the result or error
+	result, err := base_repository.CreateRepository[*domain.User]().Create(
+		user, 
+		"YOUR_DB_NAME", 
+		"YOUR_COLLECTION_NAME", 
+		"username", // Username who is creating this document to store in createdBy, modifiedBy
+	)
+}
+```
+
+### Update document in a collection
 
+```go
+func UpdateUser(user *domain.User) {
+	// This function returns the result or error
+	result, err := base_repository.UpdateRepository[*domain.User]().Update(
+		user, // Include id in user data to update the document
+		"YOUR_DB_NAME",
+		"YOUR_COLLECTION_NAME",
+		"username", // Username who is creating this document to store in modifiedBy
+	)
+}
+```
+
+### Delete document from a collection
+
+```go
+func DeleteUser(id string) {
+	// This function returns the result or error
+	result, err := base_repository.DeleteRepository[*domain.User]().Delete(
+		id,
+		"YOUR_DB_NAME",
+		"YOUR_COLLECTION_NAME"
+	)
+}
+```
+
+### Get data by using Get By Filter Repository from a collection and db
+
+```go
+func GetUser(username string, password string) []*domain.User {
+	// create options for mongo db query to get the document or documents
+	// You can refer mongodb documents for available options
+	filterOptions := options.Find()
+
+	// filter for mongodb query to get the document or documents
+	filter := bson.M{
+		"username": username,
+		"password": password,
+	}
+
+	// This function will return the result or error
+	results, err := base_repository.GetByFilterRepository[*domain.User]().GetByFilter(
+		filter,
+		filterOptions,
+		"YOUR_DB_NAME",
+		"YOUR_COLLECTION_NAME",
+	)
+
+	if err != nil {
+		results = make([]*domain.User, 0)
+		log.Printf("Failed to get client from DB: %v", err)
+	}
+
+	return results
+}
+```
+
+### Get data by using Get All Repository from a collection and db
+
+```go
+func GetUser() []*domain.User {
+	// This function will return the result or error
+	results, err := base_repository.GetAllRepository[*domain.User]().GetAll(
+		"YOUR_DB_NAME",
+		"YOUR_COLLECTION_NAME",
+	)
+
+	if err != nil {
+		results = make([]*domain.User, 0)
+		log.Printf("Failed to get client from DB: %v", err)
+	}
+
+	return results
+}
+```
+
+### Get data by using Get By Id Repository from a collection and db
+
+```go
+func GetUserById(id string) []*domain.User {
+	// This function will return the result or error
+	results, err := base_repository.GetByIdRepository[*domain.User]().GetById(
+		id,
+		"YOUR_DB_NAME",
+		"YOUR_COLLECTION_NAME",
+	)
+
+	if err != nil {
+		results = make([]*domain.User, 0)
+		log.Printf("Failed to get client from DB: %v", err)
+	}
+
+	return results
+}
 ```

mongodb_domain/base.go

@@ -0,0 +1,26 @@
+package mongodb_domain
+
+type BaseDmlModel interface {
+	SetCreatedBy(by string)
+	SetCreatedOn(on string)
+	SetModifiedBy(by string)
+	SetModifiedOn(on string)
+	GetId() string
+	SetId(id string)
+}
+
+type DmlModel struct {
+	Id         string `json:"id,omitempty" bson:"_id,omitempty"`
+	CreatedOn  string `json:"createdOn,omitempty" bson:"createdOn,omitempty"`
+	CreatedBy  string `json:"createdBy" bson:"createdBy"`
+	ModifiedOn string `json:"modifiedOn,omitempty" bson:"modifiedOn,omitempty"`
+	ModifiedBy string `json:"modifiedBy" bson:"modifiedBy"`
+}
+
+// Implement Auditable interface
+func (d *DmlModel) SetCreatedBy(by string)  { d.CreatedBy = by }
+func (d *DmlModel) SetCreatedOn(on string)  { d.CreatedOn = on }
+func (d *DmlModel) SetModifiedBy(by string) { d.ModifiedBy = by }
+func (d *DmlModel) SetModifiedOn(on string) { d.ModifiedOn = on }
+func (d *DmlModel) GetId() string           { return d.Id }
+func (d *DmlModel) SetId(id string)         { d.Id = id }

mongodb_repositories/cmd/create.go

@@ -0,0 +1,50 @@
+package mongodb_repositories
+
+import (
+	"context"
+	"log"
+	"time"
+
+	"github.com/amitjangid80/go-mongodb-client/mongodb_client"
+	"github.com/amitjangid80/go-mongodb-client/mongodb_domain"
+	"go.mongodb.org/mongo-driver/bson/primitive"
+)
+
+type ICreateRepository[T mongodb_domain.BaseDmlModel] interface {
+	Create(data T, dbName string, collectionName string, username string) (*T, error)
+}
+
+type CreateRepositoryImpl[T mongodb_domain.BaseDmlModel] struct{}
+
+func CreateRepository[T mongodb_domain.BaseDmlModel]() ICreateRepository[T] {
+	return &CreateRepositoryImpl[T]{}
+}
+
+// Create implements ICreateRepository.
+func (g *CreateRepositoryImpl[T]) Create(data T, dbName string, collectionName string, username string) (*T, error) {
+	bgCtx := context.Background()
+	ctx, cancel := context.WithTimeout(bgCtx, 5*time.Second)
+	defer cancel()
+
+	now := time.Now().UTC().Format(time.RFC3339)
+
+	data.SetCreatedBy(username)
+	data.SetCreatedOn(now)
+	data.SetModifiedBy(username)
+	data.SetModifiedOn(now)
+
+	collection := mongodb_client.GetDb(dbName).Collection(collectionName)
+	result, err := collection.InsertOne(ctx, data)
+
+	if err != nil {
+		log.Printf("❌ [Create] Failed to insert data in collection '%s', error: %v", collectionName, err)
+		return nil, err
+	}
+
+	// Convert ObjectID to hex string and set in response
+	if oid, ok := result.InsertedID.(primitive.ObjectID); ok {
+		data.SetId(oid.Hex())
+	}
+
+	return &data, nil
+}

mongodb_repositories/cmd/delete.go

@@ -0,0 +1,60 @@
+package mongodb_repositories
+
+import (
+	"context"
+	"errors"
+	"log"
+	"time"
+
+	"github.com/amitjangid80/go-mongodb-client/mongodb_client"
+	"github.com/amitjangid80/go-mongodb-client/mongodb_domain"
+	"go.mongodb.org/mongo-driver/bson"
+	"go.mongodb.org/mongo-driver/bson/primitive"
+	"go.mongodb.org/mongo-driver/mongo"
+)
+
+type IDeleteRepository[T mongodb_domain.BaseDmlModel] interface {
+	Delete(id string, dbName string, collectionName string) (*T, error)
+}
+
+type DeleteRepositoryImpl[T mongodb_domain.BaseDmlModel] struct{}
+
+func DeleteRepository[T mongodb_domain.BaseDmlModel]() IDeleteRepository[T] {
+	return &DeleteRepositoryImpl[T]{}
+}
+
+func (r *DeleteRepositoryImpl[T]) Delete(id, dbName, collectionName string) (*T, error) {
+	var deletedDoc T
+
+	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
+	defer cancel()
+
+	objectID, err := primitive.ObjectIDFromHex(id)
+
+	if err != nil {
+		log.Printf("[Delete] Invalid id: %s", id)
+		return nil, err
+	}
+
+	filter := bson.M{"_id": objectID}
+
+	collection := mongodb_client.GetDb(dbName).Collection(collectionName)
+	result := collection.FindOneAndDelete(ctx, filter)
+
+	if err := result.Err(); err != nil {
+		if errors.Is(err, mongo.ErrNoDocuments) {
+			log.Printf("❌ [Delete] No document found for ID: %s", id)
+			return nil, err
+		}
+
+		log.Printf("❌ [Delete] Error deleting document: %v", err)
+		return nil, err
+	}
+
+	if err := result.Decode(&deletedDoc); err != nil {
+		log.Printf("❌ [Delete] Failed to decode deleted document: %v", err)
+		return nil, err
+	}
+
+	return &deletedDoc, nil
+}