seika/tagstudio
1
0
Fork 0
mirror of https://github.com/TagStudioDev/TagStudio.git synced 2024-07-30 21:27:34 +00:00
Code Issues Projects Releases Packages Wiki Activity
tagstudio/doc/Entry.md
Gawi e1cd46d010
Wiki/Docs Updates (#194) 
* split file + link fix

* Cleanup & Minimum Fill

* polish & link

* Update doc/Tag.md

Co-authored-by: Travis Abendshien <46939827+CyanVoxel@users.noreply.github.com>

---------
2024-05-25 13:49:12 -07:00

1.4 KiB
Raw Blame History

Entry

Entries are the units that fill a library. Each one corresponds to a file, holding a reference to it along with the metadata associated with it.

Entry Object Structure

  1. id:
    • Int, Unique, Required
    • The ID for the Entry.
    • Used for internal processing
  2. filename:
    • String, Required
    • The filename with extension of the referenced media file.
  3. path:
    • String, Required, OS Agnostic
    • The folder path in which the media file is located in.
  4. fields:
    • List of dicts, Optional
    • A list of Field ID/Value dicts.

NOTE: Entries currently have several unused optional fields intended for later features.

Retrieving Entries based on Tag Cluster

By default when querying Entries, each Entry's tags list (stored in the form of Tag ids) is compared against the Tag ids in a given Tag cluster (list of Tag ids) or appended clusters in the case of multi-term queries. The type of comparison depends on the type of query and whether or not it is an inclusive or exclusive query, or a combination of both. This default searching behavior is done in O(n) time, but can be sped up in the future by building indexes on certain search terms. These indexes can be stored on disk and loaded back into memory in future sessions. These indexes will also need to be updated as new Tags and Entries are added or edited.