Table of Contents

Interface IDB2Read

Namespace
TCSystem.MetaDataDB
Assembly
TCSystem.MetaDataDB.dll

Defines read and query operations for a metadata database.

public interface IDB2Read

Properties

Version

Gets the metadata database schema version.

string Version { get; }

Property Value

string

Methods

EnableDefaultMode()

Restores the default durable SQLite settings.

void EnableDefaultMode()

EnableUnsafeMode()

Enables faster SQLite settings that reduce durability guarantees.

void EnableUnsafeMode()

GetAllAddressesLike(string)

Gets addresses matching an optional SQL-like filter.

IList<Address> GetAllAddressesLike(string filter = null)

Parameters

filter string

Returns

IList<Address>

GetAllFaceInfos(bool)

Gets flattened face information, optionally restricted to visible faces.

IList<FaceInfo> GetAllFaceInfos(bool visibleOnly)

Parameters

visibleOnly bool

Returns

IList<FaceInfo>

GetAllFileAndModifiedDates()

Gets every stored file and its modification date.

IDictionary<string, DateTimeOffset> GetAllFileAndModifiedDates()

Returns

IDictionary<string, DateTimeOffset>

GetAllFilesLike(string)

Gets file names matching an optional SQL-like filter.

IList<string> GetAllFilesLike(string filter = null)

Parameters

filter string

Returns

IList<string>

GetAllLocations()

Gets all stored locations.

IList<Location> GetAllLocations()

Returns

IList<Location>

GetAllPersonNamesLike(string)

Gets person names matching an optional SQL-like filter.

IList<string> GetAllPersonNamesLike(string filter = null)

Parameters

filter string

Returns

IList<string>

GetAllProcessingInformation()

Gets processing information for every stored file.

IList<(string FileName, ProcessingInfos ProcessingInfo)> GetAllProcessingInformation()

Returns

IList<(string FileName, ProcessingInfos ProcessingInfo)>

GetAllTagsLike(string)

Gets tags matching an optional SQL-like filter.

IList<string> GetAllTagsLike(string filter = null)

Parameters

filter string

Returns

IList<string>

GetAllTagsLikeOrderByNewestFile(string)

Gets matching tags ordered by the newest associated file.

IList<string> GetAllTagsLikeOrderByNewestFile(string filter = null)

Parameters

filter string

Returns

IList<string>

GetAllYears()

Gets the distinct years represented by image dates.

IList<DateTimeOffset> GetAllYears()

Returns

IList<DateTimeOffset>

GetDateModified(string)

Gets the stored modification date for a file.

DateTimeOffset GetDateModified(string fileName)

Parameters

fileName string

Returns

DateTimeOffset

GetFileAndPersonTagFromFaceId(long, bool)

Gets the file and person tag associated with a face identifier.

FileAndPersonTag GetFileAndPersonTagFromFaceId(long faceId, bool visibleOnly)

Parameters

faceId long
visibleOnly bool

Returns

FileAndPersonTag

GetFileAndPersonTagsOfPerson(string, bool)

Gets file and person-tag associations for a person.

IList<FileAndPersonTag> GetFileAndPersonTagsOfPerson(string name, bool visibleOnly)

Parameters

name string
visibleOnly bool

Returns

IList<FileAndPersonTag>

GetFilesOfAddress(Address, bool)

Gets files matching an address.

IList<string> GetFilesOfAddress(Address address, bool useProvinceAlsoIfEmpty)

Parameters

address Address
useProvinceAlsoIfEmpty bool

Returns

IList<string>

GetFilesOfFolder(string)

Gets files directly contained in a folder.

IList<string> GetFilesOfFolder(string folder)

Parameters

folder string

Returns

IList<string>

GetFilesOfPerson(string)

Gets files associated with a person.

IList<string> GetFilesOfPerson(string person)

Parameters

person string

Returns

IList<string>

GetFilesOfTag(string)

Gets files associated with a tag.

IList<string> GetFilesOfTag(string tag)

Parameters

tag string

Returns

IList<string>

GetFilesOfYear(DateTimeOffset)

Gets files taken in a year.

IList<string> GetFilesOfYear(DateTimeOffset year)

Parameters

year DateTimeOffset

Returns

IList<string>

GetLocation(string)

Gets the location associated with a file.

Location GetLocation(string fileName)

Parameters

fileName string

Returns

Location

GetMetaData(string)

Gets the metadata for a file, or null when it is absent.

Image GetMetaData(string fileName)

Parameters

fileName string

Returns

Image

GetNotThisPersonInformation()

Gets, for each face identifier, the person identifiers rejected as matches.

IDictionary<long, IList<long>> GetNotThisPersonInformation()

Returns

IDictionary<long, IList<long>>

A dictionary from face identifiers to rejected person identifiers.

GetNumAutoDetectedFaces()

Gets the number of automatically detected faces.

long GetNumAutoDetectedFaces()

Returns

long

GetNumFaces()

Gets the number of stored faces.

long GetNumFaces()

Returns

long

GetNumFiles()

Gets the number of stored files.

long GetNumFiles()

Returns

long

GetNumFilesOfAddress(Address, bool)

Gets the number of files matching an address.

long GetNumFilesOfAddress(Address address, bool useProvinceAlsoIfEmpty)

Parameters

address Address
useProvinceAlsoIfEmpty bool

Returns

long

GetNumFilesOfFolder(string)

Gets the number of files directly contained in a folder.

long GetNumFilesOfFolder(string folder)

Parameters

folder string

Returns

long

GetNumFilesOfPerson(string)

Gets the number of files associated with a person.

long GetNumFilesOfPerson(string person)

Parameters

person string

Returns

long

GetNumFilesOfTag(string)

Gets the number of files associated with a tag.

long GetNumFilesOfTag(string tag)

Parameters

tag string

Returns

long

GetNumFilesOfYear(DateTimeOffset)

Gets the number of files taken in a year.

long GetNumFilesOfYear(DateTimeOffset year)

Parameters

year DateTimeOffset

Returns

long

GetNumLocations()

Gets the number of stored locations.

long GetNumLocations()

Returns

long

GetNumPersons()

Gets the number of stored people.

long GetNumPersons()

Returns

long

GetNumTags()

Gets the number of distinct tags.

long GetNumTags()

Returns

long

GetOrientation(string)

Gets the stored orientation for a file.

OrientationMode GetOrientation(string fileName)

Parameters

fileName string

Returns

OrientationMode

GetPersonFromId(long)

Gets a person by identifier.

Person GetPersonFromId(long personId)

Parameters

personId long

Returns

Person

GetPersonFromName(string)

Gets a person by name.

Person GetPersonFromName(string name)

Parameters

name string

Returns

Person

GetPersonIdFromName(string)

Gets a person's identifier by name.

long GetPersonIdFromName(string name)

Parameters

name string

Returns

long

SearchForFiles(string)

Searches file metadata using the supplied filter text.

IList<string> SearchForFiles(string searchFilter)

Parameters

searchFilter string

Returns

IList<string>