Skip to content

API Reference

The goose package provides a robust API for interacting with MongoDB.

Godoc Reference

For comprehensive API documentation, including all exported types, interfaces, and methods, please refer to the official Go documentation:

pkg.go.dev/github.com/devsamahd/goose

Core Types

  • goose.Model[T]: The primary interface for interacting with a collection.
  • goose.Schema: Defines the structure, indexes, hooks, and virtuals of a document.
  • goose.Query[T]: A chainable builder for MongoDB read/write queries.
  • goose.Cursor[T]: A type-safe iterator for query results.
  • goose.AggregationCursor[T]: A builder and iterator for aggregation pipelines.