api_interpreter

Documentation

Overview

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

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

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

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

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

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

Index

• type SubActionApi
  • func GetSubActionApis(subActions []dt.Pair[migrator.Migration, si.SubAction], ...) []SubActionApi
  • func SubActionApiConvertField(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi
  • func SubActionApiCreateCollection(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi
  • func SubActionApiCreateField(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi
  • func SubActionApiCreateIndex(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi
  • func SubActionApiDropCollection(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi
  • func SubActionApiDropField(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi
  • func SubActionApiDropIndex(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi

Types

type SubActionApi

type SubActionApi struct {
	Migration migrator.Migration
	// TODO: decide whether SubAction is always attached to SubActionApi (?), since not direct usage required
	SubAction si.SubAction
	Execute   func(ctx context.Context, db *mongo.Database) error
}

func GetSubActionApis

func GetSubActionApis(subActions []dt.Pair[migrator.Migration, si.SubAction], dbSchemas []collection.Collection) []SubActionApi

This returns the list of SubActionApi(s) `subActions` retrieved from migration files `dbSchemas` is current schema from database formatted in Collection manner

func SubActionApiConvertField

func SubActionApiConvertField(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi

func SubActionApiCreateCollection

func SubActionApiCreateCollection(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi

func SubActionApiCreateField

func SubActionApiCreateField(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi

func SubActionApiCreateIndex

func SubActionApiCreateIndex(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi

func SubActionApiDropCollection

func SubActionApiDropCollection(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi

func SubActionApiDropField

func SubActionApiDropField(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi

func SubActionApiDropIndex

func SubActionApiDropIndex(subAction dt.Pair[migrator.Migration, si.SubAction]) SubActionApi