sqlfilestore

README

SQL File Store

Similar

• https://github.com/snechholt/simplefs-sql

Documentation

Index

• Constants
• type NewStoreOptions
• type Record
  • func NewDirectory() *Record
  • func NewFile() *Record
  • func NewRecord() *Record
  • func NewRecordFromExistingData(data map[string]string) *Record
  • func (o *Record) Contents() string
  • func (o *Record) CreatedAt() string
  • func (o *Record) DeletedAt() string
  • func (o *Record) Extension() string
  • func (o *Record) ID() string
  • func (o *Record) IsDirectory() bool
  • func (o *Record) IsFile() bool
  • func (o *Record) Name() string
  • func (o *Record) ParentID() string
  • func (o *Record) Path() string
  • func (o *Record) SetContents(fileContents string) *Record
  • func (o *Record) SetCreatedAt(createdAt string) *Record
  • func (o *Record) SetDeletedAt(deletedAt string) *Record
  • func (o *Record) SetExtension(extension string) *Record
  • func (o *Record) SetID(id string) *Record
  • func (o *Record) SetName(name string) *Record
  • func (o *Record) SetParentID(parentID string) *Record
  • func (o *Record) SetPath(filePath string) *Record
  • func (o *Record) SetSize(fileSize string) *Record
  • func (o *Record) SetType(fileType string) *Record
  • func (o *Record) SetUpdatedAt(updatedAt string) *Record
  • func (o *Record) Size() string
  • func (o *Record) Type() string
  • func (o *Record) UpdatedAt() string
• type RecordQueryOptions
• type Store
  • func NewStore(opts NewStoreOptions) (*Store, error)
  • func (store *Store) AutoMigrate() error
  • func (st *Store) EnableDebug(debug bool)
  • func (st *Store) RecordCount(options RecordQueryOptions) (int64, error)
  • func (store *Store) RecordCreate(record *Record) error
  • func (store *Store) RecordDelete(record *Record) error
  • func (store *Store) RecordDeleteByID(id string) error
  • func (store *Store) RecordFindByID(id string, options RecordQueryOptions) (*Record, error)
  • func (store *Store) RecordFindByPath(path string, options RecordQueryOptions) (*Record, error)
  • func (store *Store) RecordList(options RecordQueryOptions) ([]Record, error)
  • func (store *Store) RecordRecalculatePath(record *Record, parentRecord *Record) error
  • func (store *Store) RecordSoftDelete(record *Record) error
  • func (store *Store) RecordSoftDeleteByID(id string) error
  • func (store *Store) RecordUpdate(record *Record) error

Constants

const COLUMN_CONTENTS = "contents"

const COLUMN_CREATED_AT = "created_at"

const COLUMN_DELETED_AT = "deleted_at"

const COLUMN_EXTENSION = "extension"

const COLUMN_ID = "id"

const COLUMN_NAME = "name"

const COLUMN_PARENT_ID = "parent_id"

const COLUMN_PATH = "path"

const COLUMN_SIZE = "size"

const COLUMN_TYPE = "type"

const COLUMN_UPDATED_AT = "updated_at"

const PATH_SEPARATOR = "/"

const ROOT_ID = "0"

const ROOT_PATH = PATH_SEPARATOR

const TYPE_DIRECTORY = "directory"

const TYPE_FILE = "file"

Types

type NewStoreOptions

type NewStoreOptions struct {
	TableName          string
	DB                 *sql.DB
	DbDriverName       string
	AutomigrateEnabled bool
	DebugEnabled       bool
}

NewStoreOptions define the options for creating a new block store

type Record

type Record struct {
	dataobject.DataObject
}

func NewDirectory

func NewDirectory() *Record

func NewFile

func NewFile() *Record

func NewRecord

func NewRecord() *Record

func NewRecordFromExistingData

func NewRecordFromExistingData(data map[string]string) *Record

func (*Record) Contents

func (o *Record) Contents() string

func (*Record) CreatedAt

func (o *Record) CreatedAt() string

func (*Record) DeletedAt

func (o *Record) DeletedAt() string

func (*Record) Extension

func (o *Record) Extension() string

func (*Record) ID

func (o *Record) ID() string

func (*Record) IsDirectory

func (o *Record) IsDirectory() bool

func (*Record) IsFile

func (o *Record) IsFile() bool

func (*Record) Name

func (o *Record) Name() string

func (*Record) ParentID

func (o *Record) ParentID() string

func (*Record) Path

func (o *Record) Path() string

func (*Record) SetContents

func (o *Record) SetContents(fileContents string) *Record

func (*Record) SetCreatedAt

func (o *Record) SetCreatedAt(createdAt string) *Record

func (*Record) SetDeletedAt

func (o *Record) SetDeletedAt(deletedAt string) *Record

func (*Record) SetExtension

func (o *Record) SetExtension(extension string) *Record

func (*Record) SetID

func (o *Record) SetID(id string) *Record

func (*Record) SetName

func (o *Record) SetName(name string) *Record

func (*Record) SetParentID

func (o *Record) SetParentID(parentID string) *Record

func (*Record) SetPath

func (o *Record) SetPath(filePath string) *Record

SetPath sets the file path. As all paths must start with "/" adds a "/" if not present. Any trailing spaces is also trimmed

func (*Record) SetSize

func (o *Record) SetSize(fileSize string) *Record

func (*Record) SetType

func (o *Record) SetType(fileType string) *Record

func (*Record) SetUpdatedAt

func (o *Record) SetUpdatedAt(updatedAt string) *Record

func (*Record) Size

func (o *Record) Size() string

func (*Record) Type

func (o *Record) Type() string

func (*Record) UpdatedAt

func (o *Record) UpdatedAt() string

type RecordQueryOptions

type RecordQueryOptions struct {
	ID                   string
	IDIn                 []string
	ParentID             string
	Type                 string
	Path                 string
	PathStartsWith       string
	CreatedAtLessThan    string
	CreatedAtGreaterThan string
	UpdatedAtLessThan    string
	UpdatedAtGreaterThan string
	Columns              []string
	Offset               int
	Limit                int
	SortOrder            string
	OrderBy              string
	CountOnly            bool
	WithSoftDeleted      bool
}

type Store

type Store struct {
	// contains filtered or unexported fields
}

func NewStore

func NewStore(opts NewStoreOptions) (*Store, error)

NewStore creates a new block store

func (*Store) AutoMigrate

func (store *Store) AutoMigrate() error

AutoMigrate auto migrate

func (*Store) EnableDebug

func (st *Store) EnableDebug(debug bool)

EnableDebug - enables the debug option

func (*Store) RecordCount

func (st *Store) RecordCount(options RecordQueryOptions) (int64, error)

func (*Store) RecordCreate

func (store *Store) RecordCreate(record *Record) error

func (*Store) RecordDelete

func (store *Store) RecordDelete(record *Record) error

func (*Store) RecordDeleteByID

func (store *Store) RecordDeleteByID(id string) error

func (*Store) RecordFindByID

func (store *Store) RecordFindByID(id string, options RecordQueryOptions) (*Record, error)

func (*Store) RecordFindByPath

func (store *Store) RecordFindByPath(path string, options RecordQueryOptions) (*Record, error)

func (*Store) RecordList

func (store *Store) RecordList(options RecordQueryOptions) ([]Record, error)

func (*Store) RecordRecalculatePath

func (store *Store) RecordRecalculatePath(record *Record, parentRecord *Record) error

func (*Store) RecordSoftDelete

func (store *Store) RecordSoftDelete(record *Record) error

func (*Store) RecordSoftDeleteByID

func (store *Store) RecordSoftDeleteByID(id string) error

func (*Store) RecordUpdate

func (store *Store) RecordUpdate(record *Record) error