expressionStorage

package
v3.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 22, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Exposees an interface to access expression and modules from mongo DB. References the structures exposed by inner packages

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ExpressionDB

type ExpressionDB interface {
	// Expression storage
	ListExpressions(userID string, includeShared bool, retrieveUpdatedUserInfo bool) (expressions.DataExpressionLookup, error)
	GetExpression(expressionID string, retrieveUpdatedUserInfo bool) (expressions.DataExpression, error)
	CreateExpression(input expressions.DataExpressionInput, creator pixlUser.UserInfo, createShared bool) (expressions.DataExpression, error)
	UpdateExpression(
		expressionID string,
		input expressions.DataExpressionInput,
		creator pixlUser.UserInfo,
		createdUnixTimeSec int64,
		isShared bool,
		existingSourceCode string,
	) (expressions.DataExpression, error)
	StoreExpressionRecentRunStats(expressionID string, stats expressions.DataExpressionExecStats) error
	DeleteExpression(expressionID string) error
	PublishExpressionToZenodo(expressionID string, zipData []byte, zenodoURI string, zenodoToken string) (expressions.DataExpression, error)

	// Module storage
	ListModules(retrieveUpdatedUserInfo bool) (modules.DataModuleWireLookup, error)
	GetModule(moduleID string, version *modules.SemanticVersion, retrieveUpdatedUserInfo bool) (modules.DataModuleSpecificVersionWire, error)
	CreateModule(input modules.DataModuleInput, creator pixlUser.UserInfo, publishDOI bool) (modules.DataModuleSpecificVersionWire, error)
	AddModuleVersion(moduleID string, input modules.DataModuleVersionInput, publishDOI bool) (modules.DataModuleSpecificVersionWire, error)

	// Helper to decide what kind of error was returned
	IsNotFoundError(err error) bool
}

Directories

Path Synopsis
Contains all functionality to access expressions and modules from Mongo DB
Contains all functionality to access expressions and modules from Mongo DB
Data structures used to store expressions (both Lua and PIXLang expression code)
Data structures used to store expressions (both Lua and PIXLang expression code)
Data structures used to store and version modules (code in Lua environment)
Data structures used to store and version modules (code in Lua environment)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL