Difference between revisions of "Baloo"

Jump to: navigation, search
(Top bugs and feature requests)
 
(19 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[https://projects.kde.org/projects/kde/kdelibs/baloo Baloo] is the next generation of the Nepomuk project. It's responsible for handling user metadata such as tags, rating and comments. It also handles indexing and searching for files, emails, contacts, and so on. Information for end users can be found [http://dot.kde.org/2014/02/24/kdes-next-generation-semantic-search in this dot article].
+
[[File:Mascot konqi-support-search.png|thumbnail|right|Help [[Konqi]] find what he wants!]]
 +
Baloo is the file indexing and file search framework for KDE Plasma, with a focus on providing a very small memory footprint along with with extremely fast searching.
  
Mailing List: kde-devel@kde.org  
+
== Ways to communicate ==
IRC Channel: #kde-baloo on freenode
+
:Mailing List: kde-devel@kde.org ([https://mail.kde.org/mailman/listinfo/kde-devel info page])
 +
:IRC Channel: #kde-devel on freenode
 +
:Phabricator project: https://phabricator.kde.org/project/view/261
  
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.
+
== Top bugs and feature requests ==
 +
'''Bugs:''' https://bugs.kde.org/buglist.cgi?bug_severity=critical&bug_severity=grave&bug_severity=major&bug_severity=crash&bug_severity=normal&bug_severity=minor&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=ASSIGNED&bug_status=REOPENED&list_id=1629910&priority=VHI&priority=HI&product=frameworks-baloo&query_format=advanced
 +
<br/><br/>
 +
'''Feature requests:''' https://bugs.kde.org/buglist.cgi?bug_severity=wishlist&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=ASSIGNED&bug_status=REOPENED&list_id=1629911&priority=VHI&priority=HI&product=frameworks-baloo&query_format=advanced
  
== Contributing to Baloo ==
+
== Useful pages ==
 +
* [[Baloo/Architecture | Architecture]]
 +
* [[Baloo/Configuration]]
 +
* [[Baloo/Debugging]]
 +
* [[Baloo/NepomukPort]]
 +
* [[Baloo/Tasks]]
 +
* [[Baloo/XapianAlternatives]]
 +
* [[Baloo/XapianProblems]]
  
There is abstract list of higher level tasks which can be found over here - http://community.kde.org/Baloo/Tasks
+
== Using Baloo ==
  
For junior jobs please have a look at the kde bug tracker.
+
Baloo is not an application, but a daemon to index files.  Applications can use the Baloo framework to provide file search results.
  
== Why change Nepomuk? ==
+
An [http://vhanda.in/blog/2014/04/desktop-search-configuration/ intentionally limited number of settings] are provided via the KDE System Settings "Desktop Search" icon.  Other adjustments can be made directly to the [[Baloo/Configuration | configuration file]].
  
The Nepomuk project started as a research project in the European Union. The goal was to explore the use of relations between data for finding what you are looking for. It was build completely on top of RDF. While RDF is a great from a theoretical point of view, it is not the simplest tool to understand or optimize. The databases which currently exist for RDF are not suited for desktop use.
+
== balooctl ==
  
The Nepomuk developers have tried very hard over the last years to optimize the indexing and searching infrastructure, and they have now come to the conclusion that Nepomuk cannot be further optimized without migrating away from RDF.
+
<code>balooctl</code> is a CLI command to perform certain operations on Baloo. The operations are indicated by '''arguments'''. All available arguments can be listed by issuing <code>balooctl --help</code> in terminal app, such as [[userbase:Konsole]].
  
RDF also heavily relied on ontologies. These ontologies are a way to describe how the data should be stored and represented. They used the ontologies from the original EU research project - Shared Desktop Ontologies. These ontologies were not designed in a time when it was not very clear how they would work and have sub-optimal performance and ease of use. They are quite vague in certain areas and often duplicate information. This leads to scenarios where it takes forever to figure out how the data should be stored. Additionally, since all the data needs to be stored in RDF, one cannot optimize for one specific data type.
+
To be noted, argument <code>checkDb</code> is only meant to be used by developers for debugging. All it does is to print some messages but not to sanitize the database. And the execution time grows exponentially with the number of indexed files (see [https://bugs.kde.org/show_bug.cgi?id=380465#c5 Comment 5 under bug #380465]).
 
+
Given these shortcomings and the many lessons learned over the last years the Nepomuk developers decided to drop RDF and rechristen the project under the name of Baloo. You can find more [http://community.kde.org/Baloo/Architecture technical background and info on its architecture here].
+
 
+
= Migrating data from Nepomuk to Baloo =
+
 
+
Nepomuk was used to store the tags, ratings, and user comments in Files. This data can be migrated by running the <tt>nepomukbaloomigrator</tt>. There is no continuous synchronization between Baloo and Nepomuk. Nepomuk was also used to store indexed information about Files, Emails and Contacts. Baloo shall reindex this information directly from the source.
+
 
+
= Running Nepomuk and Baloo together =
+
 
+
Nepomuk and Baloo can both coexist without issues. However, it may not be the best idea to run both of them on the same system as they both would then be indexing your files, emails and other data and taxing the system heavily, populating their databases.
+
 
+
Tags, ratings and comments will be not be synchronized between Nepomuk and Baloo after the initial migration.
+
 
+
= Baloo, Nepomuk, KDE Platform 4 and KF5 =
+
 
+
The Nepomuk project will not be ported to Qt5 and KF5. The Baloo project will be ported to KF5. This ported version of Baloo will continue to use the same database as the KDE Platform 4 version and will be completely compatible.
+
 
+
= Porting your Application to use Baloo =
+
 
+
Baloo is not a drop in replacement for Nepomuk. Applications relying on Nepomuk will have to port to Baloo. Their progress can be tracked on http://community.kde.org/Baloo/NepomukPort
+
 
+
The majority of Nepomuk applications just rely on its tags, ratings and comments features. Baloo offers a simple asynchronous API for modifying that file metadata. This metadata is now stored with the extended attributes of the file instead of storing it in a separate database.
+
 
+
Baloo also offers a search API which is similar to that of Nepomuk in some ways.
+

Latest revision as of 15:17, 11 June 2019

Help Konqi find what he wants!

Baloo is the file indexing and file search framework for KDE Plasma, with a focus on providing a very small memory footprint along with with extremely fast searching.

Ways to communicate

Mailing List: kde-devel@kde.org (info page)
IRC Channel: #kde-devel on freenode
Phabricator project: https://phabricator.kde.org/project/view/261

Top bugs and feature requests

Bugs: https://bugs.kde.org/buglist.cgi?bug_severity=critical&bug_severity=grave&bug_severity=major&bug_severity=crash&bug_severity=normal&bug_severity=minor&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=ASSIGNED&bug_status=REOPENED&list_id=1629910&priority=VHI&priority=HI&product=frameworks-baloo&query_format=advanced

Feature requests: https://bugs.kde.org/buglist.cgi?bug_severity=wishlist&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=ASSIGNED&bug_status=REOPENED&list_id=1629911&priority=VHI&priority=HI&product=frameworks-baloo&query_format=advanced

Useful pages

Using Baloo

Baloo is not an application, but a daemon to index files. Applications can use the Baloo framework to provide file search results.

An intentionally limited number of settings are provided via the KDE System Settings "Desktop Search" icon. Other adjustments can be made directly to the configuration file.

balooctl

balooctl is a CLI command to perform certain operations on Baloo. The operations are indicated by arguments. All available arguments can be listed by issuing balooctl --help in terminal app, such as userbase:Konsole.

To be noted, argument checkDb is only meant to be used by developers for debugging. All it does is to print some messages but not to sanitize the database. And the execution time grows exponentially with the number of indexed files (see Comment 5 under bug #380465).


This page was last modified on 11 June 2019, at 15:17. Content is available under Creative Commons License SA 4.0 unless otherwise noted.