README
¶
Sqlfsync
Automatically syncronize your SQL database and filesystem. Built using fsnotify and gorm.
Installation
go get github.com/mattcarp12/sqlfsync
Usage
package main
import (
"github.com/mattcarp12/sqlfsync"
"gorm.io/driver/sqlite"
"gorm.io/gorm"
"time"
)
type MyFile struct {
ID uint
Path string `sqlfsync:"path"`
CreatedAt time.Time
}
var done chan bool
func main() {
db, _ := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
sfs := sqlfsync.New(db)
sfs.AddWatch("/my/files", &MyFile{})
defer sfs.Close()
done = make(chan bool)
<-done
}
Contributing
Pull requests are encouraged.
License
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SqlFSync ¶
type SqlFSync struct {
// pointer to database connection
DB *gorm.DB
// list of directories to watch
Watches []WatchEntry
}
SqlFSync watches a set of directories for created or deleted files, and inserts or deletes from the database, respectively.
type WatchEntry ¶
type WatchEntry struct {
// full path to directory
Path string
// Pointer to struct that represents
// the entity in the database
Model interface{}
// Watches Path for create or delete events
FSWatcher *fsnotify.Watcher
}
WatchEntry represents a single directory
Source Files
Click to show internal directories.
Click to hide internal directories.