Difference between revisions of "Baloo/Architecture"

(Created page with "Baloo is a metadata and search framework for KDE. '''Mailing List: ''' [email protected] <br/> '''IRC Channel:''' #baloo on freenode == Architecture == Baloo focuses on dec...")
 
(highlights that Baloo is only a file indexer, no emails/contacts/PIM)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Baloo is a metadata and search framework for KDE.
+
Baloo is a metadata and search framework by KDE.
  
'''Mailing List: ''' [email protected] <br/>
+
Baloo focuses on providing a very small memory footprint along with with extremely fast searching. It also supports storing additional file based metadata via extended attributes.
'''IRC Channel:''' #baloo on freenode
+
 
 +
* '''Mailing List: ''' [email protected]
 +
* '''IRC Channel:''' #kde-baloo on freenode
  
 
== Architecture ==
 
== Architecture ==
 +
{{Remember|2=Outdated architecture|1=The architecture evolved and Baloo is '''only''' a file indexer. The reference to PIM resources (emails, contacts) is historical. KDE PIM uses its own indexing system, which has a similar architecture.}}
  
Baloo focuses on decentralization of data, and does not have any central database. At its core it is a set of 3 services -
+
Baloo focuses on decentralization of data, and does not have any central database. At its core it is a set of 3 services:
 
 
 
* Data Stores
 
* Data Stores
 
* Search Stores
 
* Search Stores
Line 13: Line 15:
  
 
=== Data Store ===
 
=== Data Store ===
 
+
A Data Store is a place to permanently store data. Its format and APIs are not dictated by Baloo, and can be in any way that is most efficient for the data in question.
A Data Store is a place to permanently store data. Its format and APIs are not dictated by Baloo, and can in any way that is most efficient for the data in question.
 
  
 
=== Search Store ===
 
=== Search Store ===
 
 
A Search Store is a plugin which provides search capabilities for a specific kind of data. Each of these stores provide a plugin which can be used to search through the data using a consistent API. At this moment there are 3 search stores that have been implemented -
 
A Search Store is a plugin which provides search capabilities for a specific kind of data. Each of these stores provide a plugin which can be used to search through the data using a consistent API. At this moment there are 3 search stores that have been implemented -
  
Line 28: Line 28:
  
 
=== Relations ===
 
=== Relations ===
 
 
Baloo can be used to create relations between two uniquely identifiable identifiers. The key aspect is that when creating a relation between A and B, both of them are uniquely identifiable. For most of the PIM data, Akonadi already provides a unique identifier of the 'akonadi:?item=x'. For File data, Baloo provides unique identifiers of the form 'file:x'.
 
Baloo can be used to create relations between two uniquely identifiable identifiers. The key aspect is that when creating a relation between A and B, both of them are uniquely identifiable. For most of the PIM data, Akonadi already provides a unique identifier of the 'akonadi:?item=x'. For File data, Baloo provides unique identifiers of the form 'file:x'.
  
Line 37: Line 36:
 
== Implementation ==
 
== Implementation ==
 
=== Files ===
 
=== Files ===
 
 
Baloo concentrates heavily on files, and provides both a data store and search store for files. These are stored using a combination of sqlite and xapian.
 
Baloo concentrates heavily on files, and provides both a data store and search store for files. These are stored using a combination of sqlite and xapian.
  
 
=== Akonadi ===
 
=== Akonadi ===
 
 
In the case of PIM, since Akonadi already stores (caches) the data, only a Search Store is required. There are currently separate search stores for contacts and emails. They are both implemented using Xapian.
 
In the case of PIM, since Akonadi already stores (caches) the data, only a Search Store is required. There are currently separate search stores for contacts and emails. They are both implemented using Xapian.
  
 
=== Tags ===
 
=== Tags ===
 
 
Tags are stored in a custom format. In order to relate tags with files / email, a TagRelation is provided.
 
Tags are stored in a custom format. In order to relate tags with files / email, a TagRelation is provided.

Latest revision as of 13:30, 31 January 2017

Baloo is a metadata and search framework by KDE.

Baloo focuses on providing a very small memory footprint along with with extremely fast searching. It also supports storing additional file based metadata via extended attributes.

Architecture

Flag-red.png
 
Outdated architecture
The architecture evolved and Baloo is only a file indexer. The reference to PIM resources (emails, contacts) is historical. KDE PIM uses its own indexing system, which has a similar architecture.


Baloo focuses on decentralization of data, and does not have any central database. At its core it is a set of 3 services:

  • Data Stores
  • Search Stores
  • Relations

Data Store

A Data Store is a place to permanently store data. Its format and APIs are not dictated by Baloo, and can be in any way that is most efficient for the data in question.

Search Store

A Search Store is a plugin which provides search capabilities for a specific kind of data. Each of these stores provide a plugin which can be used to search through the data using a consistent API. At this moment there are 3 search stores that have been implemented -

  • File Search
  • Email Search
  • Contact Search


Each Store can also provide custom APIs for searching the data.

Relations

Baloo can be used to create relations between two uniquely identifiable identifiers. The key aspect is that when creating a relation between A and B, both of them are uniquely identifiable. For most of the PIM data, Akonadi already provides a unique identifier of the 'akonadi:?item=x'. For File data, Baloo provides unique identifiers of the form 'file:x'.

Each relation is stored in an independent store in the desired mechanism. A sample sqlite implementation is provided which maps both the identifiers in a 2 column sqlite database.

For example, there exists a TagRelation which maps a Tag and any unique identifier. Similarly, there can be an ActivityRelation, and relations for other aspects such as mapping a file received via Bluetooth to a Bluetooth device.

Implementation

Files

Baloo concentrates heavily on files, and provides both a data store and search store for files. These are stored using a combination of sqlite and xapian.

Akonadi

In the case of PIM, since Akonadi already stores (caches) the data, only a Search Store is required. There are currently separate search stores for contacts and emails. They are both implemented using Xapian.

Tags

Tags are stored in a custom format. In order to relate tags with files / email, a TagRelation is provided.


This page was last edited on 31 January 2017, at 13:30. Content is available under Creative Commons License SA 4.0 unless otherwise noted.