collection

Documentation

Overview

Copyright (c) 2023 the go-mongr8 Authors and Contributors [@see Authors file]

Licensed under the MIT License (https://opensource.org/licenses/MIT)

Index

• func SpecsFromFields(fields []Field) []field.Spec
• type Collection
  • func NewCollection(metadata Metadata, fields []Field, indexes []Index) Collection
• type Field
  • func FieldFromType(name string, _type field.FieldType) Field
  • func FieldsFromSpecs(arrFields *[]field.Spec) []Field
• type Index
• type Metadata

Functions

func SpecsFromFields

func SpecsFromFields(fields []Field) []field.Spec

Types

type Collection

type Collection interface {
	Collection() Metadata
	Fields() []Field
	Indexes() []Index
}

Collection entity manages a single MongoDB collection

func NewCollection

func NewCollection(metadata Metadata, fields []Field, indexes []Index) Collection

type Field

type Field interface {
	Spec() *field.Spec
}

func FieldFromType

func FieldFromType(name string, _type field.FieldType) Field

func FieldsFromSpecs

func FieldsFromSpecs(arrFields *[]field.Spec) []Field

type Index

type Index interface {
	Spec() *index.Spec
}

type Metadata

type Metadata interface {
	Spec() *metadata.Spec
}

stores basic informations of a collection this also holds type of usage: collection or view