database

package

v0.0.8 Latest Latest Go to latest Published: Aug 5, 2021 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bengarrett/dupers

Links

Open Source Insights

Documentation ¶

Overview ¶

Package database interacts with Dupers bbolt database and buckets.

Index ¶

Constants
Variables
func Abs(bucket string) ([]byte, error)
func AllBuckets() (names []string, err error)
func Backup() (name string, written int64, err error)
func Clean(quiet, debug bool, buckets ...string) error
func Compact(debug bool) error
func CopyFile(name, dest string) (int64, error)
func Count(b *bolt.Bucket, db *bolt.DB) (int, error)
func DB() (string, error)
func Info() (string, error)
func IsEmpty() (bool, error)
func RM(name string) error
func Seek(sum [32]byte, bucket string, db *bolt.DB) (finds []string, records int, err error)
type Bucket
type Filepath
type Lists
- func List(bucket string) (ls Lists, err error)
type Matches
- func Compare(s string, buckets ...string) (*Matches, error)
- func CompareBase(s string, buckets ...string) (*Matches, error)
- func CompareBaseNoCase(s string, buckets ...string) (*Matches, error)
- func CompareNoCase(s string, buckets ...string) (*Matches, error)

Constants ¶

View Source

const (
	FileMode   fs.FileMode = 0600
	PrivateDir fs.FileMode = 0700
)

Variables ¶

View Source

var (
	ErrNoBucket  = errors.New("bucket does not exist")
	ErrDB        = errors.New("database does not exist")
	ErrDBClean   = errors.New("database had nothing to clean")
	ErrDBCompact = errors.New("database compression has not reduced the size")
)

Functions ¶

func Abs ¶

func Abs(bucket string) ([]byte, error)

Abs returns an absolute representation of the named bucket.

func AllBuckets ¶

func AllBuckets() (names []string, err error)

AllBuckets lists all the stored bucket names in the database.

func Backup ¶

func Backup() (name string, written int64, err error)

Backup makes a copy of the database to the named location.

func Clean ¶

func Clean(quiet, debug bool, buckets ...string) error

Clean the stale items from database buckets. Stale items are file pointers that no longer exist on the host file system.

func Compact ¶

func Compact(debug bool) error

Compact the database by reclaiming space.

func CopyFile ¶

func CopyFile(name, dest string) (int64, error)

CopyFile duplicates the named file to the destination filepath.

func Count ¶ added in v0.0.8

func Count(b *bolt.Bucket, db *bolt.DB) (int, error)

func DB ¶

func DB() (string, error)

DB returns the absolute path of the Bolt database.

func Info ¶

func Info() (string, error)

Info returns a printout of the buckets and their statistics.

func IsEmpty ¶

func IsEmpty() (bool, error)

IsEmpty returns true if the database has no buckets.

func RM ¶

func RM(name string) error

RM removes the named bucket from the database.

func Seek ¶

func Seek(sum [32]byte, bucket string, db *bolt.DB) (finds []string, records int, err error)

Seek searches a bucket for an exact SHA256 checksum match.

Types ¶

type Bucket ¶

type Bucket string

Bucket is the absolute path to a directory that's used as the bucket name.

type Filepath ¶

type Filepath string

Filepath is the absolute path to a file used as a map key.

type Lists ¶

type Lists map[Filepath][32]byte

Lists are a collection of fetched filepaths and their SHA256 checksums.

func List ¶

func List(bucket string) (ls Lists, err error)

List returns the file paths and SHA256 checksums stored in the bucket.

type Matches ¶

type Matches map[Filepath]Bucket

Matches are a collection of fetched filepaths and the bucket they were sourced from.

func Compare ¶

func Compare(s string, buckets ...string) (*Matches, error)

Compare finds exact matches of the string contained within the stored filenames and paths.

func CompareBase ¶

func CompareBase(s string, buckets ...string) (*Matches, error)

CompareBase finds exact matches of the string contained within the stored filenames.

func CompareBaseNoCase ¶

func CompareBaseNoCase(s string, buckets ...string) (*Matches, error)

CompareBaseNoCase finds case insensitive matches of the string contained within the stored filenames.

func CompareNoCase ¶

func CompareNoCase(s string, buckets ...string) (*Matches, error)

CompareNoCase finds case insensitive matches of the string contained within the stored filenames and paths.

Source Files ¶

View all Source files

database.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL