cuedb

Documentation

Index

• Constants
• func CueValueToGraphQlField(existingObjects map[string]GraphQlObjectGlue, dataSet DataSet, ...) (graphql.Fields, error)
• func CueValueToGraphQlType(value cue.Value) (*graphql.Scalar, error)
• type DagNode
  • func (d *DagNode) ID() string
• type DataSet
  • func (d *DataSet) CueDataPath() cue.Path
  • func (d *DataSet) GetDataDirectory() string
  • func (d *DataSet) GetDataMapCue() string
  • func (d *DataSet) GetDefinitionPath() cue.Path
  • func (d *DataSet) GetDefinitionPath2() cue.Path
  • func (d *DataSet) GetExternalName() string
  • func (d *DataSet) GetInlinePath() string
  • func (d *DataSet) GetPluralName() string
  • func (d *DataSet) GetSchemaCue() cue.Value
  • func (d *DataSet) GetSupportedExtensions() []string
  • func (d *DataSet) ID() string
  • func (d *DataSet) IsSupportedExtension(ext string) bool
  • func (d *DataSet) String() string
• type DataSetMetadata
• type Engine
  • func NewEngine() (*Engine, error)
  • func (r *Engine) CountDataSets() int
  • func (r *Engine) GetAllData(dataSetName string) cue.Value
  • func (r *Engine) GetDataSet(name string) (DataSet, error)
  • func (r *Engine) GetDataSetByPlural(plural string) (DataSet, error)
  • func (r *Engine) GetDataSets() map[string]DataSet
  • func (r *Engine) GetDataSetsDAG() *dag.DAG
  • func (r *Engine) GetOutput() (cue.Value, error)
  • func (r *Engine) Insert(dataSet DataSet, record map[string]interface{}) error
  • func (r *Engine) MarshalJSON() ([]byte, error)
  • func (r *Engine) MarshalString() (string, error)
  • func (r *Engine) ReferentialIntegrity() error
  • func (r *Engine) RegisterSchema(cueString string) error
• type GraphQlObjectGlue
• type SchemaMetadata

Constants

const DataSetMetadataCue = `{
	_dataset: {
		plural: string
		supportedExtensions: [...string]
	}
}`

Can't use dataSetField, yet.

const RecordBaseCue = `{
	id: string
}`

RecordBaseCue is the "Base" configuration that blox expects to exist, but doesn't enforce in user-land. We'll inject this Cue into each DataSet definition.

const SchemaMetadataCue = `{
	_schema: {
		namespace: string
		name: string
	}
}`

Can't use schemaField, yet.

Functions

func CueValueToGraphQlField

func CueValueToGraphQlField(existingObjects map[string]GraphQlObjectGlue, dataSet DataSet, cueValue cue.Value) (graphql.Fields, error)

func CueValueToGraphQlType

func CueValueToGraphQlType(value cue.Value) (*graphql.Scalar, error)

Types

type DagNode

type DagNode struct {
	Name string
}

func (*DagNode) ID

func (d *DagNode) ID() string

type DataSet

type DataSet struct {
	// contains filtered or unexported fields
}

func (*DataSet) CueDataPath

func (d *DataSet) CueDataPath() cue.Path

func (*DataSet) GetDataDirectory

func (d *DataSet) GetDataDirectory() string

func (*DataSet) GetDataMapCue

func (d *DataSet) GetDataMapCue() string

func (*DataSet) GetDefinitionPath

func (d *DataSet) GetDefinitionPath() cue.Path

func (*DataSet) GetDefinitionPath2

func (d *DataSet) GetDefinitionPath2() cue.Path

func (*DataSet) GetExternalName

func (d *DataSet) GetExternalName() string

func (*DataSet) GetInlinePath

func (d *DataSet) GetInlinePath() string

GetInlinePath returns an inline cue.Path that can be used within a Cue document like "some: key: #Here"

func (*DataSet) GetPluralName

func (d *DataSet) GetPluralName() string

func (*DataSet) GetSchemaCue

func (d *DataSet) GetSchemaCue() cue.Value

func (*DataSet) GetSupportedExtensions

func (d *DataSet) GetSupportedExtensions() []string

func (*DataSet) ID

func (d *DataSet) ID() string

func (*DataSet) IsSupportedExtension

func (d *DataSet) IsSupportedExtension(ext string) bool

func (*DataSet) String

func (d *DataSet) String() string

type DataSetMetadata

type DataSetMetadata struct {
	Plural              string
	SupportedExtensions []string
}

type Engine

type Engine struct {
	// embedded runtime database
	*blox.Runtime
	// contains filtered or unexported fields
}

func NewEngine

func NewEngine() (*Engine, error)

func (*Engine) CountDataSets

func (r *Engine) CountDataSets() int

func (*Engine) GetAllData

func (r *Engine) GetAllData(dataSetName string) cue.Value

func (*Engine) GetDataSet

func (r *Engine) GetDataSet(name string) (DataSet, error)

func (*Engine) GetDataSetByPlural

func (r *Engine) GetDataSetByPlural(plural string) (DataSet, error)

GetDataSetByID returns a DataSet by its plural name.

func (*Engine) GetDataSets

func (r *Engine) GetDataSets() map[string]DataSet

func (*Engine) GetDataSetsDAG

func (r *Engine) GetDataSetsDAG() *dag.DAG

func (*Engine) GetOutput

func (r *Engine) GetOutput() (cue.Value, error)

func (*Engine) Insert

func (r *Engine) Insert(dataSet DataSet, record map[string]interface{}) error

func (*Engine) MarshalJSON

func (r *Engine) MarshalJSON() ([]byte, error)

MarshalJSON returns the database encoded in JSON format

func (*Engine) MarshalString

func (r *Engine) MarshalString() (string, error)

MarshalJSON returns the database encoded in JSON format

func (*Engine) ReferentialIntegrity

func (r *Engine) ReferentialIntegrity() error

ReferentialIntegrity checks the relationships between the records in the content database

func (*Engine) RegisterSchema

func (r *Engine) RegisterSchema(cueString string) error

type GraphQlObjectGlue

type GraphQlObjectGlue struct {
	Object   *graphql.Object
	Engine   *Engine
	Resolver func(p graphql.ResolveParams) (interface{}, error)
}

type SchemaMetadata

type SchemaMetadata struct {
	Namespace string
	Name      string
}