sqlfs

README

sqlfs

The package sqlfs provides an io.ReadCloser and an io.WriteCloser that treats a SQL database a filesystem, where each table in the database is like a file. The schema of the table is very simple -- it has only one column of BLOB type. All the rows consist the storage.

sqlfs provides the following features.

Create a file

To create a table named "hello" in a database "mydb" for writing, we can call Create.

f, e := sqlfs.Create(db, "mydb.hello")
f.Write([]byte("hello world!\n"))
f.Close()

where db comes from a call to database/sql.Open.

Append to a file

f, e := sqlfs.Append(db, "mydb.hello")
f.Write([]byte("hello world!\n")
f.Close()

Read from a file

f, e := sqlfs.Open(db, "mydb.hello")
buf := make([]byte, 1024)
f.Read(buf)
f.Close()

Remove a file

DropTable(db, "mydb.hello")

Check if a file exists

HasTable(db, "mydb.hello")

Other I/O operations

Feel free to use standard packages io, ioutil, etc with sqlfs. For example, we can call io.Copy to copy everything from the standard input to a table.

f, e := sqlfs.Create(db, "mydb.hello")
io.Copy(f, os.Stdin)
f.Close()

Documentation

Index

• func Create(db *database.DB, table string, session *pb.Session) (io.WriteCloser, error)
• type Reader
  • func Open(db *sql.DB, table string) (*Reader, error)
  • func (r *Reader) Close() error
  • func (r *Reader) Read(p []byte) (n int, e error)

Functions

func Create

func Create(db *database.DB, table string, session *pb.Session) (io.WriteCloser, error)

Create creates a new table or truncates an existing table and returns a writer.

Types

type Reader

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

Reader implements io.ReadCloser

func Open

func Open(db *sql.DB, table string) (*Reader, error)

Open returns a reader to read from the given table in db.

func (*Reader) Close

func (r *Reader) Close() error

Close the reader connection to sqlfs

func (*Reader) Read

func (r *Reader) Read(p []byte) (n int, e error)