schema

Documentation

Index

• Constants
• Variables
• type Column
  • func NewColumn(name string, tokenType scanner.TokenType) (*Column, error)
  • func (c *Column) Equal(o *Column) bool
• type DataType
  • func GetDataType(tokenType scanner.TokenType) (DataType, error)
  • func (i DataType) String() string
• type Manager
  • func (m *Manager) AddTable(t *Table) error
  • func (m *Manager) DropTable(t *Table) error
  • func (m *Manager) LoadSchema() error
  • func (m *Manager) NewManager(store kv.Store) (*Manager, error)
• type Schema
  • func NewSchema() *Schema
  • func SchemaFromBytes(tablesBytes [][]byte) (*Schema, error)
  • func (s *Schema) AddTable(t *Table) error
  • func (s *Schema) DropTable(key string) error
  • func (s *Schema) GetTable(key string) (*Table, error)
• type Table
  • func NewTable(name string, columns []*Column, pkey []string) (*Table, error)
  • func NewTableFromBytes(tableBytes []byte) (*Table, error)
  • func (t *Table) AddColumn(name string, tokenType scanner.TokenType) error
  • func (t *Table) Equal(other *Table) bool
  • func (t *Table) GetColumn(name string) *Column
  • func (t *Table) Key() string
  • func (t *Table) Prefix() *keys.Key
  • func (t *Table) PrefixEnd() *keys.Key
  • func (t *Table) Value() ([]byte, error)

Constants

const MetaTableName = "__schema__"

Meta Table Name

const NAME_VALIDATION_REGEXP = "[A-z0-9_]"

const SchemaTableName = "__schema__"

Variables

var CATALOG_KEYS_END = CATALOG_KEYS_PREFIX.Next()

var CATALOG_KEYS_PREFIX = keys.New("__tables")

System Table Keys

var ErrDropMetaTable = errors.New("cannot drop meta table")

Custom error for dropping the Meta table.

var ErrNilColumns = errors.New("nil columns passed into NewTable")

var MetaTable = &Table{
	Name: MetaTableName,
	Columns: []*Column{
		{
			Name:     "name",
			DataType: STRING,
		},
	},
	PrimaryKey: []string{"name"},
}

var ReservedInternalKeyName = "___zkey"

Types

type Column

type Column struct {
	Name     string
	DataType DataType
}

func NewColumn

func NewColumn(name string, tokenType scanner.TokenType) (*Column, error)

NewColumn is a utility function which turns a name and a scanned token into a schema column.

func (*Column) Equal

func (c *Column) Equal(o *Column) bool

type DataType

type DataType int

const (
	UNKNOWN DataType = iota
	STRING
	NUMBER
	BOOLEAN
)

func GetDataType

func GetDataType(tokenType scanner.TokenType) (DataType, error)

func (DataType) String

func (i DataType) String() string

type Manager

type Manager struct {
	Schema *Schema
	Store  kv.Store
}

Manager is responsible for holding the entire schema as well as keeping it in sync with the underlying data store.

func (*Manager) AddTable

func (m *Manager) AddTable(t *Table) error

func (*Manager) DropTable

func (m *Manager) DropTable(t *Table) error

func (*Manager) LoadSchema

func (m *Manager) LoadSchema() error

func (*Manager) NewManager

func (m *Manager) NewManager(store kv.Store) (*Manager, error)

type Schema

type Schema struct {
	Tables map[string]*Table
}

func NewSchema

func NewSchema() *Schema

func SchemaFromBytes

func SchemaFromBytes(tablesBytes [][]byte) (*Schema, error)

func (*Schema) AddTable

func (s *Schema) AddTable(t *Table) error

func (*Schema) DropTable

func (s *Schema) DropTable(key string) error

func (*Schema) GetTable

func (s *Schema) GetTable(key string) (*Table, error)

type Table

type Table struct {
	Name       string
	Columns    []*Column
	PrimaryKey []string
}

func NewTable

func NewTable(name string, columns []*Column, pkey []string) (*Table, error)

func NewTableFromBytes

func NewTableFromBytes(tableBytes []byte) (*Table, error)

func (*Table) AddColumn

func (t *Table) AddColumn(name string, tokenType scanner.TokenType) error

func (*Table) Equal

func (t *Table) Equal(other *Table) bool

func (*Table) GetColumn

func (t *Table) GetColumn(name string) *Column

func (*Table) Key

func (t *Table) Key() string

Utility functions for the schema table

func (*Table) Prefix

func (t *Table) Prefix() *keys.Key

func (*Table) PrefixEnd

func (t *Table) PrefixEnd() *keys.Key

func (*Table) Value

func (t *Table) Value() ([]byte, error)