Documentation
¶
Index ¶
- Constants
- Variables
- func GetSchemaVersion(schema cue.Value) (string, error)
- type Database
- func (d *Database) DumpAll()
- func (d *Database) GetConfigString(key string) (string, error)
- func (d *Database) GetTable(name string) (Table, error)
- func (d *Database) GetTableDataDir(table Table) string
- func (d *Database) GetTables() map[string]Table
- func (d *Database) Insert(table Table, record map[string]interface{}) error
- func (d *Database) LoadConfig() error
- func (d *Database) MarshalJSON() ([]byte, error)
- func (d *Database) ReferentialIntegrity() error
- func (d *Database) RegisterTables(cueString string) error
- type Model
- type ModelV1Metadata
- type SchemaV1Metadata
- type Table
Constants ¶
const ModelV1MetadataCue = `
{
_model: {
plural: string
supportedExtensions: [...string]
}
}
`
const SchemaV1MetadataCue = `
{
_schema: {
namespace: string
name: string
}
}
`
SchemaV1MetadataCue is the cue representation of SchemaV1Metadata
Variables ¶
var BaseConfig string
var GET_VERSION_CUE = `
{
_schema: {
version: string
}
}
`
GET_VERSION_CUE is a constant? that is added to cue models
Functions ¶
Types ¶
type Database ¶
type Database struct {
// contains filtered or unexported fields
}
Database is the "world" struct. We can "insert" records into it and know immediately if they're valid or not.
func NewDatabase ¶
NewDatabase creates a "world" struct to store records
func (*Database) GetConfigString ¶ added in v0.2.1
func (*Database) GetTableDataDir ¶ added in v0.2.1
func (*Database) LoadConfig ¶ added in v0.2.1
func (*Database) MarshalJSON ¶
MarshalJSON returns the database encoded in JSON format
func (*Database) ReferentialIntegrity ¶
ReferentialIntegrity checks the relationships between the records in the content database
func (*Database) RegisterTables ¶
RegisterTables ensures that the cueString schema is a valid schema and parses the Cue to find Models within. Each Model is registered as a Table, provided the name is available.
type ModelV1Metadata ¶ added in v0.2.1
V1_MODEL is the cue representation of Model metadata
func GetV1Model ¶
func GetV1Model(schema cue.Value) (ModelV1Metadata, error)
GetV1Model returns the V1_MODEL information from a cue.Value
type SchemaV1Metadata ¶
SchemaV1Metadata stores information about the schema that is shared
func GetSchemaV1Metadata ¶
func GetSchemaV1Metadata(schema cue.Value) (SchemaV1Metadata, error)
GetSchemaV1Metadata returns the metadata for a cue.Value
type Table ¶
type Table struct {
// contains filtered or unexported fields
}
Table represents a schema record
Source Files