Toggle the table of contents

Baloo: Difference between revisions

From KDE Community Wiki

Revision as of 15:17, 11 June 2019

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: [email protected] (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).

Retrieved from "https://community.kde.org/index.php?title=Baloo&oldid=84915"

@@ Line 1: / Line 1: @@
-[https://projects.kde.org/projects/kde/kdelibs/baloo Baloo] is the file indexing and file search framework for KDE.
+[[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.
+== Ways to communicate ==
 :Mailing List: [email protected] ([https://mail.kde.org/mailman/listinfo/kde-devel info page])
-:IRC Channel: #kde-baloo on freenode
+: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 internally uses a mixture of sqlite along with Xapian to store the file index.
+== 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
+== Useful pages ==
+* [[Baloo/Architecture | Architecture]]
+* [[Baloo/Configuration]]
+* [[Baloo/Debugging]]
+* [[Baloo/NepomukPort]]
+* [[Baloo/Tasks]]
+* [[Baloo/XapianAlternatives]]
+* [[Baloo/XapianProblems]]
 == Using Baloo ==
-Like its predecessor [https://userbase.kde.org/Nepomuk Nepomuk], Baloo is not an application, but a component which can be used by developers within applications.  Applications like the Kontact Suite, Dolphin and Gwenview, as well as the Plasma Desktop itself, use the Baloo framework to provide search results.
+Baloo is not an application, but a daemon to index files.  Applications can use the Baloo framework to provide file search results.
-The configuration file is described [[Baloo/Configuration | here]].
-== Contributing to Baloo ==
-The Baloo developers maintain a list of currently active tasks over [https://todo.kde.org/?controller=board&action=show&project_id=12 here]. Additionally there is also the bug tracker.
-=== What about 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]].
-As of KDE version 4.13, [https://dot.kde.org/2014/02/24/kdes-next-generation-semantic-search Baloo has replaced Nepomuk].
+== balooctl ==
-The Nepomuk project in KDE aimed at implementing the vision of "The Semantic Desktop" using RDF. After years of trying the developers felt that while many of the ideas behind "The Semantic Desktop" were great. Implementing them using RDF and classical semantics was not the way to go.
+<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]].
-The Baloo project is just a file indexing solution for KDE. Everything that Nepomuk provided is now handled by other software which are part of the KDE Umbrella.
+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]).