Meow

Object Document Mapper for MongoDB

import Meow

Overview

The Meow Framework provides type-checked APIs for all common operations when working with MongoDB.

Meow makes use of a protocol called Model, which you need to adopt onto any database models. Models simply need to conform to Codable, and provide a stored property named _id containing an instance’s unique identifier.

You can access the CRUD APIs through MeowCollection, a type-checked alternative to MongoKitten’s MongoCollection.

The Meow documentation assumes familiarity with MongoKitten, and you must at least have connected to MongoDB through MongoKitten.

Members

Typealiases

typealias MeowIdentifier
All Meow models must have an identifier that is Codable and Hashable, as well as representable by a Primitive.
typealias Model
The default supported Model is a KeyPathQueryableModel that is also a MutableModel. Meaning it’s a read-write capable entity that supports type checked APIs’.

Functions

func SortedIndex<M, T>(named: String, field: QuerySubject<M, T>, order: Sorting.Order) -> _MongoIndex
Creates an index on the specified field. Allows faster lookups for queries targetting this field. Useful for optimising commonly queries fields, especially in large datasets, and allows for faster sorting on this field.
func TTLIndex<M, T>(named: String, field: QuerySubject<M, T>, expireAfterSeconds: Int) -> _MongoIndex
func TextScoreIndex<M, T>(named: String, field: QuerySubject<M, T>) -> _MongoIndex
func UniqueIndex<M, T>(named: String, field: QuerySubject<M, T>, order: Sorting.Order) -> _MongoIndex
Creates an index with uniqueness on the specified field. Allows faster lookups for queries targetting this field. Useful for optimising commonly queries fields, especially in large datasets, and allows for faster sorting on this field.

Operators

Enumerations

enum MeowHook
enum MeowModelError
Generic errors thrown by the generator

Structures

struct Field
The @Field property wrapper is used on all stored properties of a Model to allow key path based queries.
struct Group
struct Limit
struct Lookup
struct Match
struct MeowAggregate
struct MeowCheckedAggregateBuilder
struct MeowCollection
A wrapper around MongoCollection, that allows you to query the collection while assuming a Model format
struct MeowOperationResult
struct MeowUncheckedAggregateBuilder
struct ModelGrouper
A helper type used to construct type-checked $group queries
struct ModelProjector
Used for projecting the values in Base into Result
struct ModelUpdateQuery
A helper type used to construct type-checked atomic updates
struct ModelUpdater
A helper/proxy type that changes values on the subjected model, and keeps track of all changed fields
struct PartialModel
struct PartialUpdate
A partial update, as result of Model.makePartialUpdate that can be executed on a collection to atomically $set these changes
struct Project
struct QueryMatcher
A helper type used in keypath queries that is used as a “virtual model” for constructing type-checked mongodb queries.
struct QuerySubject
A type, similar to a Swift KeyPath, that refers to a value within the entity M, inside the database.
struct QuerySubjectComparison
A public type, used internally by Meow to provide syntactically pleasing APIs on QuerySubjects
struct QuerySubjectSizeComparator
A size comparator that counts the amount of entites in an array, and can compare the result of that against another value
struct QueryableField
A wrapper around a value, that can be aware of its full keypath within the Model
struct Reference
Reference to a Model by wrapping it’s _id. Supports wrapping models with any MeowIdentifier, including custom Codable types.
struct ReferenceField
A property wrapper helper type that holds a reference to another entity
struct Sort
struct Unwind

Classes

class MeowDatabase
A Meow wrapper around MongoDatabase, that allows subscripting with a Model type to get a MeowCollection A MeowDatabase can exist in a ransaction state, at which point it’s actually a subclass names MeowTransactionDatabase.
class MeowTransactionDatabase
A Meow wrapper around MongoDatabase, that allows subscripting with a Model type to get a MeowCollection. A MeowTransactionDatabase is used to do all operations within a transaction context
class Migrator

Protocols

protocol BaseModel
The base specification of any Meow model, containing a collectionName and a _id
protocol KeyPathQueryable
protocol KeyPathQueryableModel
protocol MeowAggregateStage
protocol ModelProjection
protocol MutableModel
The base specification of any readable Meow model, containing a collectionName and a _id. MutableModel must be implemented using Codable, and always implements ReadableModel. MutableModels can be saved, whereas Readableodels cannot
protocol QuerySubjectComparator
A comparator, exclusively to be internally implemented by Meow, to provide syntactically pleasing APIs on QuerySubjects
protocol ReadableModel
The base specification of any readable Meow model, containing a collectionName and a _id. ReadableModel must be implemented using Decodable. ReadableModel is currently used for any entity that is queryable. MutableModels can be saved, whereas Readableodels cannot
protocol Resolvable
A protocol that provides a uniform syntax for ‘resolving’ something