flaarum_shared

README

flaarum_shared

flaarum_shared is a package of functions shared by the executables of this project.

Some of these functions is expected to run on the same machine as a flaarum server.

Documentation

Overview

This package contains functions shared by the programs of this project. Some of these functions is expected to run on the same machine as a flaarum server.

Index

• Constants
• Variables
• func CleanWord(word string) string
• func DoesPathExists(p string) bool
• func DoesTableExists(projName, tableName string) bool
• func FindIn(container []string, elem string) int
• func G(objectName string) string
• func GetConfigPath() (string, error)
• func GetCtlConfigPath() (string, error)
• func GetCurrentVersionNum(projName, tableName string) (int, error)
• func GetDataPath() (string, error)
• func GetFieldType(projName, tableName, fieldName string) string
• func GetFlaarumPath(fileName string) (string, error)
• func GetKeyStrPath() string
• func GetSetting(settingName string) string
• func IsNotIndexedFieldVersioned(projName, tableName, fieldName, version string) bool
• func MakeIndex(projName, tableName, fieldName, newData, rowId string) error
• func MakeSafeIndexName(v string) string
• func NameValidate(name string) error
• func UntestedRandomString(length int) string
• func WriteIntIndexesToFile(in []IntIndexes, intIndexesFile string) error
• func WriteTimeIndexesToFile(in []TimeIndexes, timeIndexesFile, dataType string) error
• type FKeyStruct
• type FTSStmtStruct
  • func ParseFTSStmt(stmt string) FTSStmtStruct
• type FieldStruct
• type IntIndexes
  • func AppendToIntIndexes(container []IntIndexes, intKey, rowId int64) []IntIndexes
  • func ReadIntIndexesFromFile(intIndexesFile string) ([]IntIndexes, error)
  • func RemoveFromIntIndexes(container []IntIndexes, intKey, rowId int64) []IntIndexes
• type StmtStruct
  • func ParseSearchStmt(stmt string) (StmtStruct, error)
• type TableStruct
  • func GetTableStructureParsed(projName, tableName string, versionNum int) (TableStruct, error)
  • func ParseTableStructureStmt(stmt string) (TableStruct, error)
• type TimeIndexes
  • func AppendToTimeIndexes(container []TimeIndexes, newTimeValue time.Time, rowId int64) []TimeIndexes
  • func ReadTimeIndexesFromFile(timeIndexesFile string, dataType string) ([]TimeIndexes, error)
  • func RemoveFromTimeIndexes(container []TimeIndexes, newTimeValue time.Time, rowId int64) []TimeIndexes
• type WhereStruct

Constants

const (
	DATE_FORMAT       = "2006-01-02"
	DATETIME_FORMAT   = "2006-01-02T15:04 MST"
	STRING_MAX_LENGTH = 100
	TEXT_INTR_DELIM   = "~~~"
	BACKUP_EXT        = "flaa1"
	PORT              = 22318
)

Variables

var ALLOWED_CHARS = "abcdefghijklmnopqrstuvwxyz0123456789"

var RootConfigTemplate = `` /* 365-byte string literal not displayed */

Functions

func CleanWord

func CleanWord(word string) string

func DoesPathExists

func DoesPathExists(p string) bool

func DoesTableExists

func DoesTableExists(projName, tableName string) bool

func FindIn

func FindIn(container []string, elem string) int

func G

func G(objectName string) string

func GetConfigPath

func GetConfigPath() (string, error)

func GetCtlConfigPath

func GetCtlConfigPath() (string, error)

func GetCurrentVersionNum

func GetCurrentVersionNum(projName, tableName string) (int, error)

func GetDataPath

func GetDataPath() (string, error)

func GetFieldType

func GetFieldType(projName, tableName, fieldName string) string

func GetFlaarumPath

func GetFlaarumPath(fileName string) (string, error)

func GetKeyStrPath

func GetKeyStrPath() string

func GetSetting

func GetSetting(settingName string) string

func IsNotIndexedFieldVersioned

func IsNotIndexedFieldVersioned(projName, tableName, fieldName, version string) bool

func MakeIndex

func MakeIndex(projName, tableName, fieldName, newData, rowId string) error

func MakeSafeIndexName

func MakeSafeIndexName(v string) string

func NameValidate

func NameValidate(name string) error

func UntestedRandomString

func UntestedRandomString(length int) string

func WriteIntIndexesToFile

func WriteIntIndexesToFile(in []IntIndexes, intIndexesFile string) error

func WriteTimeIndexesToFile

func WriteTimeIndexesToFile(in []TimeIndexes, timeIndexesFile, dataType string) error

Types

type FKeyStruct

type FKeyStruct struct {
	FieldName    string
	PointedTable string
	OnDelete     string // expects one of "on_delete_restrict", "on_delete_empty", "on_delete_delete"
}

type FTSStmtStruct

type FTSStmtStruct struct {
	Optional   []string
	Compulsory []string
	Excluded   []string
}

Full text search statement

func ParseFTSStmt

func ParseFTSStmt(stmt string) FTSStmtStruct

type FieldStruct

type FieldStruct struct {
	FieldName  string
	FieldType  string
	Required   bool
	Unique     bool
	NotIndexed bool
}

type IntIndexes

type IntIndexes struct {
	IntIndex int64
	Ids      []int64
}

func AppendToIntIndexes

func AppendToIntIndexes(container []IntIndexes, intKey, rowId int64) []IntIndexes

func ReadIntIndexesFromFile

func ReadIntIndexesFromFile(intIndexesFile string) ([]IntIndexes, error)

func RemoveFromIntIndexes

func RemoveFromIntIndexes(container []IntIndexes, intKey, rowId int64) []IntIndexes

type StmtStruct

type StmtStruct struct {
	TableName      string
	Fields         []string
	Expand         bool
	Distinct       bool
	StartIndex     int64
	Limit          int64
	OrderBy        string
	OrderDirection string // one of 'asc' or 'desc'
	WhereOptions   []WhereStruct
}

func ParseSearchStmt

func ParseSearchStmt(stmt string) (StmtStruct, error)

type TableStruct

type TableStruct struct {
	TableName    string
	TableType    string // one or "proper" or "logs"
	Fields       []FieldStruct
	ForeignKeys  []FKeyStruct
	UniqueGroups [][]string
}

func GetTableStructureParsed

func GetTableStructureParsed(projName, tableName string, versionNum int) (TableStruct, error)

func ParseTableStructureStmt

func ParseTableStructureStmt(stmt string) (TableStruct, error)

type TimeIndexes

type TimeIndexes struct {
	GoTimeValue time.Time
	Ids         []int64
}

func AppendToTimeIndexes

func AppendToTimeIndexes(container []TimeIndexes, newTimeValue time.Time, rowId int64) []TimeIndexes

func ReadTimeIndexesFromFile

func ReadTimeIndexesFromFile(timeIndexesFile string, dataType string) ([]TimeIndexes, error)

func RemoveFromTimeIndexes

func RemoveFromTimeIndexes(container []TimeIndexes, newTimeValue time.Time, rowId int64) []TimeIndexes

type WhereStruct

type WhereStruct struct {
	FieldName   string
	Relation    string // eg. '=', '!=', '<', etc.
	FieldValue  string
	Joiner      string   // one of 'and', 'or', 'orf'
	FieldValues []string // for 'in' and 'nin' queries
}