infra

Documentation

Overview

Package infra defines dnote structure

Index

• Variables
• func InitDB(ctx DnoteCtx) error
• func InitSystem(ctx DnoteCtx) error
• type Book
• type Config
• type Dnote
• type DnoteCtx
  • func NewCtx(apiEndpoint, versionTag string) (DnoteCtx, error)
• type Note
• type Timestamp

Variables

var (
	// DnoteDirName is the name of the directory containing dnote files
	DnoteDirName = ".dnote"

	// SystemSchema is the key for schema in the system table
	SystemSchema = "schema"
)

Functions

func InitDB

func InitDB(ctx DnoteCtx) error

InitDB initializes the database. Ideally this process must be a part of migration sequence. But it is performed seaprately because it is a prerequisite for legacy migration.

func InitSystem

func InitSystem(ctx DnoteCtx) error

InitSystem inserts system data if missing

Types

type Book

type Book struct {
	Name  string `json:"name"`
	Notes []Note `json:"notes"`
}

Book holds a metadata and its notes

type Config

type Config struct {
	Editor string
	APIKey string
}

Config holds dnote configuration

type Dnote

type Dnote map[string]Book

Dnote holds the whole dnote data

type DnoteCtx

type DnoteCtx struct {
	HomeDir     string
	DnoteDir    string
	APIEndpoint string
	Version     string
	DB          *sql.DB
}

DnoteCtx is a context holding the information of the current runtime

func NewCtx

func NewCtx(apiEndpoint, versionTag string) (DnoteCtx, error)

NewCtx returns a new dnote context

type Note

type Note struct {
	UUID     string `json:"uuid"`
	Content  string `json:"content"`
	AddedOn  int64  `json:"added_on"`
	EditedOn int64  `json:"edited_on"`
	Public   bool   `json:"public"`
}

Note represents a single microlesson

type Timestamp

type Timestamp struct {
	LastUpgrade int64 `yaml:"last_upgrade"`
	// id of the most recent action synced from the server
	Bookmark int `yaml:"bookmark"`
	// timestamp of the most recent action performed by the cli
	LastAction int64 `yaml:"last_action"`
}

Timestamp holds time information