sqlitefs

README

SQLiteFS

SQLiteFS is a Go package that implements the fs.FS interface using SQLite as a storage backend. This allows you to store and access files directly from a SQLite database, which can be useful for embedded applications, resource-constrained systems, or when you need a unified storage for both files and metadata.

Features

• Implementation of the fs.FS interface
• File storage in SQLite database
• Support for concurrent writes through a shared channel
• Fragmented file storage for efficient handling of large files
• Automatic MIME type detection for files

Installation

To use SQLiteFS in your Go project, run the following command:

go get github.com/jilio/sqlitefs

Usage

Here's a simple example of how to use SQLiteFS:

package main

import (
 "database/sql"
 "fmt"
 "io/fs"
 "log"

 "github.com/jilio/sqlitefs"
 _ "modernc.org/sqlite"
)

func main() {
 // Open a connection to the SQLite database
 db, err := sql.Open("sqlite", "files.db")
 if err != nil {
  log.Fatal(err)
 }
 defer db.Close()

 // Create a new instance of SQLiteFS
 sqliteFS, err := sqlitefs.NewSQLiteFS(db)
 if err != nil {
  log.Fatal(err)
 }
 defer sqliteFS.Close()

 // Write a file
 writer := sqliteFS.NewWriter("example.txt")
 _, err = writer.Write([]byte("Hello, SQLiteFS!"))
 if err != nil {
  log.Fatal(err)
 }
 err = writer.Close()
 if err != nil {
  log.Fatal(err)
 }

 // Read a file
 file, err := sqliteFS.Open("example.txt")
 if err != nil {
  log.Fatal(err)
 }
 defer file.Close()

 content, err := fs.ReadFile(sqliteFS, "example.txt")
 if err != nil {
  log.Fatal(err)
 }

 fmt.Printf("File content: %s\n", content)
}

License

MIT License

Documentation

Index

• type PathError
  • func (e *PathError) Error() string
• type SQLiteFS
  • func NewSQLiteFS(db *sql.DB) (*SQLiteFS, error)
  • func (fs *SQLiteFS) Close() error
  • func (fs *SQLiteFS) Error(msg, path string) error
  • func (fs *SQLiteFS) NewWriter(path string) *SQLiteWriter
  • func (fs *SQLiteFS) Open(name string) (fs.File, error)
• type SQLiteFile
  • func NewSQLiteFile(db *sql.DB, path string) (*SQLiteFile, error)
  • func (f *SQLiteFile) Close() error
  • func (f *SQLiteFile) Read(p []byte) (int, error)
  • func (f *SQLiteFile) ReadDir(n int) ([]fs.DirEntry, error)
  • func (f *SQLiteFile) Readdir(count int) ([]os.FileInfo, error)
  • func (f *SQLiteFile) Seek(offset int64, whence int) (int64, error)
  • func (f *SQLiteFile) Stat() (os.FileInfo, error)
• type SQLiteWriter
  • func NewSQLiteWriter(fs *SQLiteFS, path string) *SQLiteWriter
  • func (w *SQLiteWriter) Close() error
  • func (w *SQLiteWriter) Write(p []byte) (n int, err error)

Types

type PathError

type PathError struct {
	Op   string
	Path string
	Err  error
}

PathError records an error and the operation and file path that caused it.

func (*PathError) Error

func (e *PathError) Error() string

type SQLiteFS

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

func NewSQLiteFS

func NewSQLiteFS(db *sql.DB) (*SQLiteFS, error)

NewSQLiteFS создает новый экземпляр SQLiteFS с заданной базой данных. Проверяет наличие необходимых таблиц и создает их при отсутствии.

func (*SQLiteFS) Close

func (fs *SQLiteFS) Close() error

func (*SQLiteFS) Error

func (fs *SQLiteFS) Error(msg, path string) error

Error returns a formatted error that includes the path

func (*SQLiteFS) NewWriter

func (fs *SQLiteFS) NewWriter(path string) *SQLiteWriter

NewWriter creates a new writer for the specified path.

func (*SQLiteFS) Open

func (fs *SQLiteFS) Open(name string) (fs.File, error)

Open opens the named file.

type SQLiteFile

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

SQLiteFile implements the fs.File and fs.ReadDirFile interfaces.

func NewSQLiteFile

func NewSQLiteFile(db *sql.DB, path string) (*SQLiteFile, error)

NewSQLiteFile creates a new SQLiteFile instance for the given path.

func (*SQLiteFile) Close

func (f *SQLiteFile) Close() error

func (*SQLiteFile) Read

func (f *SQLiteFile) Read(p []byte) (int, error)

func (*SQLiteFile) ReadDir

func (f *SQLiteFile) ReadDir(n int) ([]fs.DirEntry, error)

ReadDir implements the fs.ReadDirFile interface.

func (*SQLiteFile) Readdir

func (f *SQLiteFile) Readdir(count int) ([]os.FileInfo, error)

Readdir is kept for backward compatibility

func (*SQLiteFile) Seek

func (f *SQLiteFile) Seek(offset int64, whence int) (int64, error)

func (*SQLiteFile) Stat

func (f *SQLiteFile) Stat() (os.FileInfo, error)

type SQLiteWriter

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

func NewSQLiteWriter

func NewSQLiteWriter(fs *SQLiteFS, path string) *SQLiteWriter

NewSQLiteWriter creates a new SQLiteWriter for the specified path. Deprecated: Use SQLiteFS.NewWriter instead.

func (*SQLiteWriter) Close

func (w *SQLiteWriter) Close() error

func (*SQLiteWriter) Write

func (w *SQLiteWriter) Write(p []byte) (n int, err error)