cuedb

Documentation

Index

• Constants
• 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) GetInlinePath() string
  • func (d *DataSet) GetSupportedExtensions() []string
  • func (d *DataSet) ID() string
  • func (d *DataSet) IsSupportedExtension(ext string) bool
• type DataSetMetadata
• type Engine
  • func NewEngine() (*Engine, error)
  • func (r *Engine) CountDataSets() int
  • func (r *Engine) GetDataSet(name string) (DataSet, error)
  • func (r *Engine) GetDataSets() map[string]DataSet
  • 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) ReferentialIntegrity() error
  • func (r *Engine) RegisterSchema(cueString string) error
• type SchemaMetadata

Constants

const BaseConfig = `{
    data_dir: string
    schema_dir: string | *"schemas"
    build_dir: string | *"_build"
}`

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

Can't use dataSetField, yet.

const DefaultConfigName = "blox.cue"

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.

Types

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

AddDataMap

func (*DataSet) GetDefinitionPath

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

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) GetSupportedExtensions

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

func (*DataSet) ID

func (d *DataSet) ID() string

func (*DataSet) IsSupportedExtension

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

type DataSetMetadata

type DataSetMetadata struct {
	Plural              string
	SupportedExtensions []string
}

type Engine

type Engine struct {
	// configuration
	// 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) GetDataSet

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

func (*Engine) GetDataSets

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

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) 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 SchemaMetadata

type SchemaMetadata struct {
	Namespace string
	Name      string
}