sqlitefile

Documentation

Overview

Package sqlitefile provides bytes buffers backed by a temporary SQLite table.

Index

• type Buffer
  • func NewBuffer(conn *sqlite.Conn) (*Buffer, error)
  • func NewBufferSize(conn *sqlite.Conn, pageSize int) (*Buffer, error)
  • func (bb *Buffer) Cap() (n int64)
  • func (bb *Buffer) Close() error
  • func (bb *Buffer) Len() (n int64)
  • func (bb *Buffer) Read(p []byte) (n int, err error)
  • func (bb *Buffer) ReadByte() (byte, error)
  • func (bb *Buffer) Reset()
  • func (bb *Buffer) UnreadByte() error
  • func (bb *Buffer) Write(p []byte) (n int, err error)
  • func (bb *Buffer) WriteByte(c byte) error
  • func (bb *Buffer) WriteString(p string) (n int, err error)
• type File
  • func NewFile(conn *sqlite.Conn) (*File, error)
  • func NewFileSize(conn *sqlite.Conn, initSize int) (*File, error)
  • func (bb *File) Cap() (n int64)
  • func (bb *File) Close() error
  • func (bb *File) Len() (n int64)
  • func (bb *File) Read(p []byte) (n int, err error)
  • func (bb *File) Seek(offset int64, whence int) (int64, error)
  • func (bb *File) Truncate(size int64) error
  • func (bb *File) Write(p []byte) (n int, err error)

Types

type Buffer

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

A Buffer is a variable-sized bytes buffer backed by SQLite blobs.

The bytes are broken into pages, with the first and last pages stored in memory, and intermediate pages loaded into blobs. Unlike a single SQLite blob, a Buffer can grow beyond its initial size. The blobs are allocated in a temporary table.

A Buffer is very similar to a bytes.Buffer.

func NewBuffer

func NewBuffer(conn *sqlite.Conn) (*Buffer, error)

NewBuffer creates a Buffer with 16KB pages.

func NewBufferSize

func NewBufferSize(conn *sqlite.Conn, pageSize int) (*Buffer, error)

NewBufferSize creates a Buffer with a specified page size.

func (*Buffer) Cap

func (bb *Buffer) Cap() (n int64)

Cap returns the number of bytes that have been allocated for this buffer, both in memory as well as in the database.

func (*Buffer) Close

func (bb *Buffer) Close() error

Close releases all resources associated with the file, removing the storage from the database.

func (*Buffer) Len

func (bb *Buffer) Len() (n int64)

Len returns the number of unread bytes written to the buffer.

func (*Buffer) Read

func (bb *Buffer) Read(p []byte) (n int, err error)

Read reads data from the beginning of the buffer.

func (*Buffer) ReadByte

func (bb *Buffer) ReadByte() (byte, error)

ReadByte reads a byte from the beginning of the buffer, or returns io.EOF if the buffer is empty.

func (*Buffer) Reset

func (bb *Buffer) Reset()

Reset empties the buffer, but retains the blobs written to the database for future writes.

func (*Buffer) UnreadByte

func (bb *Buffer) UnreadByte() error

func (*Buffer) Write

func (bb *Buffer) Write(p []byte) (n int, err error)

Write appends bytes to the buffer, growing it as needed.

func (*Buffer) WriteByte

func (bb *Buffer) WriteByte(c byte) error

WriteByte appends a byte to the buffer, growing it as needed.

func (*Buffer) WriteString

func (bb *Buffer) WriteString(p string) (n int, err error)

WriteString appends a string to the buffer, growing it as needed.

type File

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

File is a readable, writable, and seekable series of temporary SQLite blobs.

func NewFile

func NewFile(conn *sqlite.Conn) (*File, error)

NewFile creates a new File with a reasonable initial capacity.

func NewFileSize

func NewFileSize(conn *sqlite.Conn, initSize int) (*File, error)

NewFileSize creates a new File with the given number of bytes of capacity.

func (*File) Cap

func (bb *File) Cap() (n int64)

Cap returns the allocated capacity of the file in bytes.

func (*File) Close

func (bb *File) Close() error

Close releases all resources associated with the file, removing the storage from the database.

func (*File) Len

func (bb *File) Len() (n int64)

Len returns the size of the file in bytes.

func (*File) Read

func (bb *File) Read(p []byte) (n int, err error)

Read reads data into p. See io.Reader for details.

func (*File) Seek

func (bb *File) Seek(offset int64, whence int) (int64, error)

Seek changes the read/write position in the file. See io.Seeker for details.

func (*File) Truncate

func (bb *File) Truncate(size int64) error

Truncate changes the size of the file.

func (*File) Write

func (bb *File) Write(p []byte) (n int, err error)

Write writes p to the file. See io.Writer for details.