digikam

Documentation

Overview

Package digikam provides utilities accessing SQLite3-based Digikam databases.

It could be updated for other databases that Digikam might use in the future.

Index

• type SQLStore
  • func (s *SQLStore) Close()
  • func (s *SQLStore) FindFileWithNameAndCam(name string, camMaker, camModel string) (string, error)
• type Store
  • func New(path string) (Store, error)
  • func NewWithDB(db *sql.DB) (Store, error)
  • func NewWithDriver(driver, path string) (Store, error)

Types

type SQLStore

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

SQLStore is an implementation of Store.

func (*SQLStore) Close

func (s *SQLStore) Close()

Close cleans up the resources and closes the backing database.

func (*SQLStore) FindFileWithNameAndCam

func (s *SQLStore) FindFileWithNameAndCam(name string, camMaker, camModel string) (string, error)

FindFileWithNameAndCam returns the filesystem path to the image matching the basename, the camera maker and the camera model (to distinguish pictures from different cameras that happen to have the same basename).

This could match on date proximity as well, or matching whether a year or year+month appears in the filepath, or similar attributes that could disambiguate in case name+camMaker+camModel result in multiple results, but it currently does not.

Bug: There is no detection if multiple matches are present in the Digikam database.

type Store

type Store interface {
	Close()
	FindFileWithNameAndCam(name string, camMaker, camModel string) (string, error)
}

Store is a wrapper around a Digikam store, and has utility functions querying and accessing a Digikam database.

func New

func New(path string) (Store, error)

New returns a Store at the passed local filesystem path, loaded with the default database/sql driver "sqlite3".

Deprecated: use NewWithDriver. Will likely be updated to accept same args as NewWithDriver.

func NewWithDB

func NewWithDB(db *sql.DB) (Store, error)

NewWithDB returns a Store based on a preopened sql.DB. The database should be opened with the sqlite3 driver.

func NewWithDriver

func NewWithDriver(driver, path string) (Store, error)

NewWithDriver returns a Store at the passed local filesystem path, loaded with the passed database/sql driver.

Currently must be sqlite3. If another driver should be attempted, add "force:" prefix, which will be stripped before being used in sql.Open.