mongoschema

Undocumented in source.

Modules

aliases module mongoschema.aliases: Undocumented in source.
date module mongoschema.date: This module provides Date serialization with an extra added magic value to serialize the current date at serialization time.
db module mongoschema.db: This module provides the database utility tools which make the whole project useful.
query module mongoschema.query: This module provides a typesafe querying framework. For now only very basic queries are supported
variant module mongoschema.variant: This module provides a utility class to store different type values inside a single field. This can for example be used to model inheritance.

mongoBackground enum mongoBackground: Background index construction allows read and write operations to continue while building the index.
mongoDropDuplicates enum mongoDropDuplicates: Drops duplicates in the database. Only for Mongo versions less than 3.0
mongoForceIndex enum mongoForceIndex: Will create an index with (by default) no flags.
mongoSparse enum mongoSparse: Sparse indexes are like non-sparse indexes, except that they omit references to documents that do not include the indexed field.
mongoUnique enum mongoUnique: MongoDB allows you to specify a unique constraint on an index. These constraints prevent applications from inserting documents that have duplicate values for the inserted fields.
schemaIgnore enum schemaIgnore: Will ignore the variables and not encode/decode them.

bsonToMember T bsonToMember(T member, Bson value): Converts any bson value to a given type
fromSchemaBson T fromSchemaBson(Bson bson): Generates a struct/class object from a Bson node
getSerializableMembers string[] getSerializableMembers(): Undocumented in source. Be warned that the author may not have intended to support it.
memberToBson Bson memberToBson(T member): Converts any value to a bson value
toSchemaBson Bson toSchemaBson(T obj): Generates a Bson document from a struct/class object

binaryType struct binaryType: Encodes the value as binary value. Must be an array with one byte wide elements.
decode struct decode: Custom decode function. func is the name of the function which must be present as child.
encode struct encode: Custom encode function. func is the name of the function which must be present as child.
mongoExpire struct mongoExpire: TTL indexes expire documents after the specified number of seconds has passed since the indexed field value; i.e. the expiration threshold is the indexed field value plus the specified number of seconds. Field must be a SchemaDate/BsonDate. You must update the time using collMod.
schemaName struct schemaName: Custom name for special characters.