repository

README

MongoDB Embed

Description

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!

Add your files

• Create or upload files
• Add files using the command line or push an existing Git repository with the following command:

cd existing_repo
git remote add origin https://gitlab.com/pedroalvesk/mongodb-embed.git
git branch -M main
git push -uf origin main

Integrate with your tools

• Set up project integrations

Collaborate with your team

• Invite team members and collaborators
• Create a new merge request
• Automatically close issues from merge requests
• Enable merge request approvals
• Automatically merge when pipeline succeeds

Test and Deploy

Use the built-in continuous integration in GitLab.

• Get started with GitLab CI/CD
• Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)
• Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy
• Use pull-based deployments for improved Kubernetes management
• Set up protected environments

---

Editing this README

MongoDB Embed

Description

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

Installation

go get TBA

Usage

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

Roadmap

• Generic Repository
• Embedded structures

License

MIT

Documentation

Index

• Variables
• func NewConfig(uri string, dbName string, certificatePath string) *config
• func NewConfigWithClient(client *mongo.Client, database *mongo.Database) *config
• type Filter
• type IDType
• type Object
• type Repository
  • func NewRepository(cfg *config) (Repository, error)
• type StorableObject

Variables

var ErrNoResults = errors.New("no documents in result")

Functions

func NewConfig

func NewConfig(uri string, dbName string, certificatePath string) *config

func NewConfigWithClient

func NewConfigWithClient(client *mongo.Client, database *mongo.Database) *config

Types

type Filter

type Filter struct {
	Key   string
	Value interface{}
}

type IDType

type IDType uint

const (
	String IDType = iota
	ObjectID
)

type Object

type Object interface {
	GetID() string
	SetID(id string)
}

type Repository

type Repository interface {
	Create(ctx context.Context, object StorableObject) error
	Update(ctx context.Context, objectID string, object StorableObject) error
	GetBy(ctx context.Context, object StorableObject, filters ...Filter) error
	GetByID(ctx context.Context, objectID string, object StorableObject) error
	Fetch(ctx context.Context, object StorableObject, out interface{}, filters ...Filter) error

	WithTransaction(ctx context.Context, fn func(sc context.Context) error) error
	Aggregate(ctx context.Context, object StorableObject, query string, out interface{}) error
	Count(ctx context.Context, object StorableObject, filter interface{}) (int64, error)

	Preload(ctx context.Context, object Object) error
}

func NewRepository

func NewRepository(cfg *config) (Repository, error)

type StorableObject

type StorableObject interface {
	Object
	GetCollection() string
}