arepo

README

arepo

Documentation

Index

• Variables
• func DeleteOne(ctx context.Context, collection *mongo.Collection, filter any, ...) error
• func DeleteOneByID(ctx context.Context, collection *mongo.Collection, id primitive.ObjectID, ...) error
• func Find[T any](ctx context.Context, collection *mongo.Collection, filter any, ...) ([]*T, error)
• func FindOne[T any](ctx context.Context, collection *mongo.Collection, filter any, ...) (*T, error)
• func FindOneAndUpdate[T any](ctx context.Context, collection *mongo.Collection, filter, update any, ...) (*T, error)
• func FindOneByID[T any](ctx context.Context, collection *mongo.Collection, id primitive.ObjectID, ...) (*T, error)
• func NewAbstractRepository[T any](collection *mongo.Collection) *abstractRepo[T]
• func NewRepositoryWithCache[T any, K ~string](repo *abstractRepo[T], cache cache[K], radicalKey K, expCache time.Duration) *abstractRepoWithCache[T, K]
• func UpdateOneByID(ctx context.Context, collection *mongo.Collection, id primitive.ObjectID, ...) error

Variables

var (
	ErrNotFound   = errors.New("not found")
	ErrNotUpdated = errors.New("not updated")
	ErrNotDeleted = errors.New("not deleted")
)

var ErrNotSelectOmitFields = errors.New("not select/omit fields")

Functions

func DeleteOne

func DeleteOne(ctx context.Context, collection *mongo.Collection, filter any, opts ...*options.DeleteOptions) error

DeleteOne exclui um único documento do MongoDB com base no filtro especificado.

Parâmetros:

• ctx (context.Context): O contexto da execução da função.
• collection (*mongo.Collection): A coleção MongoDB na qual a operação será executada.
• filter (any): O filtro para identificar o documento a ser excluído.
• opts ([]*options.DeleteOptions): Opções adicionais para a operação de exclusão.

Retorna:

• error: Retorna ErrNotDeleted se o valor de 'DeletedCount' for igual a zero. Retorna o erro do MongoDB se ocorrer um problema durante a operação de exclusão.

func DeleteOneByID

func DeleteOneByID(ctx context.Context, collection *mongo.Collection, id primitive.ObjectID, opts ...*options.DeleteOptions) error

DeleteOneByID exclui um único documento do MongoDB com base no ID especificado.

Parâmetros:

• ctx (context.Context): O contexto da execução da função.
• collection (*mongo.Collection): A coleção MongoDB na qual a operação será executada.
• id (primitive.ObjectID): O ID do documento a ser excluído.
• opts ([]*options.DeleteOptions): Opções adicionais para a operação de exclusão.

Retorna:

• error: Retorna ErrNotDeleted se o valor de 'DeletedCount' for igual a zero. Retorna o erro do MongoDB se ocorrer um problema durante a operação de exclusão.

func Find

func Find[T any](ctx context.Context, collection *mongo.Collection, filter any, opts ...*options.FindOptions) ([]*T, error)

Find executa uma operação de consulta no MongoDB e retorna uma lista de documentos que correspondem ao filtro especificado.

Parâmetros:

• ctx (context.Context): O contexto da execução da função.
• collection (*mongo.Collection): A coleção MongoDB na qual a operação será executada.
• filter (any): O filtro que seleciona os documentos a serem recuperados.
• opts (...*options.FindOptions): Opções adicionais para a operação de consulta. (Opcional)

Retorna:

• ([]*T): Uma lista de ponteiros para os documentos correspondentes ao filtro.
• error: Retorna o erro do MongoDB se ocorrer um problema durante a operação de consulta.

func FindOne

func FindOne[T any](ctx context.Context, collection *mongo.Collection, filter any, opts ...*options.FindOneOptions) (*T, error)

FindOne realiza uma busca no banco de dados MongoDB e retorna um único documento correspondente ao filtro especificado.

Parâmetros:

• ctx (context.Context): O contexto da execução da função.
• collection (*mongo.Collection): A coleção MongoDB na qual a busca será realizada.
• filter (any): O filtro para a busca no banco de dados.
• opts (...*options.FindOneOptions): Opções adicionais para a operação de busca. (Opcional)

Retorna:

• (*T): Um ponteiro para o documento encontrado, se existir.
• error: Retorna ErrNotFound se nenhum documento correspondente for encontrado. Retorna o erro do MongoDB se ocorrer um problema durante a busca.

func FindOneAndUpdate

func FindOneAndUpdate[T any](ctx context.Context, collection *mongo.Collection, filter, update any, opts ...*options.FindOneAndUpdateOptions) (*T, error)

FindOneAndUpdate executa uma operação de atualização atômica em um único documento no MongoDB e retorna o documento antes da atualização.

Parâmetros:

• ctx (context.Context): O contexto da execução da função.
• collection (*mongo.Collection): A coleção MongoDB na qual a operação será executada.
• filter (any): O filtro que seleciona o documento a ser atualizado.
• update (any): As atualizações a serem aplicadas no documento.
• opts (...*options.FindOneAndUpdateOptions): Opções adicionais para a operação de atualização. (Opcional)

Retorna:

• (*T): Um ponteiro para o documento antes da atualização, se existir.
• error: Retorna ErrNotFound se nenhum documento correspondente for encontrado. Retorna o erro do MongoDB se ocorrer um problema durante a operação de atualização.

func FindOneByID

func FindOneByID[T any](ctx context.Context, collection *mongo.Collection, id primitive.ObjectID, opts ...*options.FindOneOptions) (*T, error)

FindOneByID realiza uma busca no banco de dados MongoDB e retorna um único documento com base no ID especificado.

Parâmetros:

• ctx (context.Context): O contexto da execução da função.
• collection (*mongo.Collection): A coleção MongoDB na qual a busca será realizada.
• id (primitive.ObjectID): O ID do documento a ser encontrado.
• opts (...*options.FindOneOptions): Opções adicionais para a operação de busca. (Opcional)

Retorna:

• (*T): Um ponteiro para o documento encontrado, se existir.
• error: Retorna ErrNotFound se nenhum documento correspondente for encontrado. Retorna o erro do MongoDB se ocorrer um problema durante a busca.

func NewAbstractRepository

func NewAbstractRepository[T any](collection *mongo.Collection) *abstractRepo[T]

func NewRepositoryWithCache

func NewRepositoryWithCache[T any, K ~string](
	repo *abstractRepo[T],
	cache cache[K],
	radicalKey K,
	expCache time.Duration,
) *abstractRepoWithCache[T, K]

func UpdateOneByID

func UpdateOneByID(ctx context.Context, collection *mongo.Collection, id primitive.ObjectID, update any) error

UpdateOneByID atualiza um único documento no MongoDB com base no ID especificado.

Parâmetros:

• ctx (context.Context): O contexto da execução da função.
• collection (*mongo.Collection): A coleção MongoDB na qual a operação será executada.
• id (primitive.ObjectID): O ID do documento a ser atualizado.
• update (any): As atualizações a serem aplicadas ao documento.

Retorna:

• error: Retorna ErrNotFound ou ErrNotUpdated se nenhum documento correspondente for encontrado ou atualizado. Retorna o erro do MongoDB se ocorrer um problema durante a operação de atualização.