internal

Documentation

Overview

Package internal contains neuron internal variables and interfaces, used by multiple packages.

Index

• Variables
• type AttributeGetter
• type AttributeModel
• type AttributeSetter
• type ControllerStoreKeyStruct
• type ForeignKeyGetter
• type ForeignKeyModel
• type ForeignKeySetter
• type IDGetter
• type IDModel
• type IDSetter
• type PreviousProcess
• type ReducedPrimariesStoreStruct
• type TxStateStoreStruct

Variables

var (
	// ControllerStoreKey is the store key used to store the controller.
	ControllerStoreKey = ControllerStoreKeyStruct{}

	//  TxStateStoreKey is the store key used to store the scope's transaction.
	TxStateStoreKey = TxStateStoreStruct{}

	// ReducedPrimariesStoreKey is the store key used to store the reduced
	// scope primary values.
	ReducedPrimariesStoreKey = ReducedPrimariesStoreStruct{}

	// PrimariesAlreadyChecked is the store key flag value used to notify that
	// the primaries for given process chain were already checked.
	PrimariesAlreadyChecked = primariesChecked{}

	// PreviousProcessStoreKey is the store key used to indicate what was the
	// previous query process.
	PreviousProcessStoreKey = PreviousProcess{}

	// AutoBeginStoreKey is the key that defines if query were started
	// with begin_transaction process.
	AutoBeginStoreKey = autoBegin{}

	// JustCreated is the store key that defines that the root scope's process is just after the creation process.
	JustCreated = created{}
)

Store keys

var Processes = make(map[string]struct{})

Processes is a mapping of the already registered query processes name.

Types

type AttributeGetter

type AttributeGetter interface {
	GetAttribute(name string) interface{}
}

AttributeGetter is the interface used to get the attribute value from the model instance.

type AttributeModel

type AttributeModel interface {
	AttributeGetter
	AttributeSetter
}

AttributeModel is the interface used for models that are allowed to get and set their attribute fields.

type AttributeSetter

type AttributeSetter interface {
	SetAttribute(name string, value interface{}) error
}

AttributeSetter sets the attribute value for given model instance.

type ControllerStoreKeyStruct

type ControllerStoreKeyStruct struct{}

ControllerStoreKeyStruct is the common struct used as a controller's key in the Stores.

type ForeignKeyGetter

type ForeignKeyGetter interface {
	GetForeignKey(name string) interface{}
}

ForeignKeyGetter is the interface used to get the value of the foreign key field with given name from the model instance.

type ForeignKeyModel

type ForeignKeyModel interface {
	ForeignKeyGetter
	ForeignKeySetter
}

ForeignKeyModel is the interface used for getting and setting the value of foreign key fields for given model.

type ForeignKeySetter

type ForeignKeySetter interface {
	SetForeignKey(name string, value interface{}) error
}

ForeignKeySetter is the interface used to set the value of the foreign key field for the provided name for the model instance

type IDGetter

type IDGetter interface {
	GetID() interface{}
}

IDGetter is the interface used to get the ID from the model instance.

type IDModel

type IDModel interface {
	IDGetter
	IDSetter
}

IDModel is the interface that is allowed to get and set the ID field.

type IDSetter

type IDSetter interface {
	SetID(id interface{}) error
}

IDSetter is the interface used to set the ID for the model instance.

type PreviousProcess

type PreviousProcess struct{}

PreviousProcess is a struct used as the Store key for getting the previous process.

type ReducedPrimariesStoreStruct

type ReducedPrimariesStoreStruct struct{}

ReducedPrimariesStoreStruct is the Store key that keeps the primary values in the patch scope.

type TxStateStoreStruct

type TxStateStoreStruct struct{}

TxStateStoreStruct is the common struct used as a transaction state key in the scope's Store.