Akonadi: Difference between revisions

From KDE UserBase Wiki
(Describe the "Gentoo Assert")
(Remove KAlarm from list)
(108 intermediate revisions by 35 users not shown)
Line 1: Line 1:
== Troubleshooting Tips ==
<languages />
<translate>


* When reporting problems with the Akonadi server, always include the comprehensive self-test report. This report can be obtained from the self-test dialog which shows up whenever the Akonadi server was unable to start successfully. You also can access this dialog via systemsettings -> Advanced -> Akonadi -> Server Configuration -> Test.
==Introduction== <!--T:1-->


* Starting the Akonadi server manually on the command line can result in additional useful information. This can be done by running '''akonadictl start''' on a console. Similar, with '''akonadictl stop''' the Akonadi server can be stopped again.
<!--T:2-->
The '''Akonadi''' framework is responsible for providing applications with a centralized database to store, index and retrieve the user's personal information. This includes the user's emails, contacts, calendars, events, journals, alarms, notes, etc. In SC 4.4, [[Special:myLanguage/KAddressBook|KAddressBook]] became the first application to start using the '''Akonadi''' framework. In SC 4.7,
[[Special:myLanguage/KMail|KMail]], [[Special:myLanguage/KOrganizer|KOrganizer]], [[Special:myLanguage/KJots|KJots]], etc. were updated to use '''Akonadi''' as well. In addition, several [[Special:myLanguage/Plasma|Plasma]] widgets also use '''Akonadi''' to store and retrieve calendar events, notes, etc.


== Common Problems ==
<!--T:12-->
At the time of writing (August, 2011), the following applications are enabled to use the '''Akonadi''' framework to centrally store and access user data. Follow through to each application's page to learn more.


=== Apparmor ===
</translate><span id="ApplicationTable"></span><translate>
</translate>
:{|
{{AppItem|KMail|<translate>
<!--T:37-->
View-pim-mail.png|
KMail</translate>}}<translate><!--T:38-->
Mail Client
Uses '''Akonadi''' to store emails
</translate>
|-
{{AppItem|KAddressBook|<translate>
<!--T:39-->
View-pim-contacts.png|
KAddressBook</translate>}}<translate><!--T:40-->
Contact Manager
Uses '''Akonadi''' to store contact information
</translate>
|-
{{AppItem|KOrganizer|<translate>
<!--T:41-->
View-pim-calendar.png|
KOrganizer</translate>}}<translate><!--T:42-->
Personal Organizer
Uses '''Akonadi''' to store calendars, events, journals, etc.
</translate>
|-
{{AppItem|KJots|<translate>
<!--T:43-->
kjots.png|
KJots</translate>}}<translate><!--T:44-->
Note Taking Application
Uses '''Akonadi''' to store notes
</translate>
|}<translate>


Some distributions using Apparmor have it set up in a way that prevents Akonadi from running its internal database server. This can result in a variety of fuzzy error messages, including but not limited to the following:
* unknown error 255 when running akonadictl
* "DB error: 'Could not open required defaults file: /home/$username/.local/share/akonadi/mysql.conf"


You can solve this by running '''aa-complain mysqld''' with root privileges then reload apparmor.
<!--T:14-->
On KUbuntu this is:
In addition to this, plasma widgets like the '''Digital Clock''' widget, the '''Notes''' widget also use '''Akonadi''' to store and retrieve events and notes.
sudo aa-complain mysqld
sudo /etc/init.d/apparmor reload


Note that you might be using Apparmor even if it does not show up in the process list.
==Controlling the Akonadi server== <!--T:15-->


Also note that some distributions ship an additional ''mysqld'' binary called ''mysqld-akonadi'' which has AppArmor set up correctly. If that's the case on your system and you see this problem nevertheless, there are two possible reasons:
<!--T:59-->
* Akonadi still uses ''mysqld'' instead of ''mysqld-akonadi''. You can change that in Systemsettings -> Advanced -> Akonadi -> Server configuration.
The '''Akonadi''' control module started by the context menu of the '''Akonadi''' tray icon provides an easy means to starting, stopping, restarting and querying the status of the '''Akonadi''' server. You may also accomplish this from the commandline using the command <code>akonadictl</code>. Using this method, you can get additional useful information on the console.
* AppArmor is not setup correctly for ''mysqld-akonadi'' either. Try running the ''aa-complain'' command noted above with ''mysqld-akonadi'' instead of ''mysqld''.


=== Missing Prerequisite ===
<!--T:17-->
To start the '''Akonadi''' server,


To use Akonadi you need to have the following packages installed (names might differ depending on your distribution):
<!--T:18-->
{{Input|1=akonadictl start}}


* The MySQL server (called ''mysql'' on OpenSuse)
<!--T:19-->
* The Qt4 MySQL plugin (called ''libqt4-sql-mysql'' on OpenSuse)
To stop the '''Akonadi''' server,


If you compile Qt4 yourself, make sure to tell the ''configure'' script to build in MySQL support by passing it the '-plugin-sql-mysql' option.  If ''configure'' cannot locate the necessary MySQL client code (i.e, says "MySQL support cannot be enabled due to functionality tests") then ensure that the corresponding package is installed (typically called ''[lib]mysql[client]-dev[el]''). Also, depending on the install location of the MySQL headers, additional parameters to ''configure'' might be needed (eg. ''-I /usr/include/mysql'' on OpenSuse).
<!--T:20-->
{{Input|1=akonadictl stop}}


=== Environment Setup ===
<!--T:21-->
To restart a running '''Akonadi''' server,


The Akonadi server searches for Akonadi agents and resources in the paths defined in the '''XDG_DATA_DIRS''' environment variable. If Akonadi complains about not finding agents or resources, check if this variable is set correctly. Also keep in mind that even if set in a current console session, it might not have been set when starting the server. Starting the server manually in the current console session excludes this cause.
<!--T:22-->
{{Input|1=akonadictl restart}}


=== Restarting after a previous error ===
<!--T:23-->
To query the status of the '''Akonadi''' server,


If you had problems starting Akonadi and fixed those (such as a missing package or the Apparmor problem) make sure that the Akonadi server is completely shut down before trying to start it again, by calling '''akonadictl stop''' on the command line. You can confirm that it was indeed shut down completely by running '''akonadictl status'''.
<!--T:24-->
{{Input|1=akonadictl status}}


Under some circumstances the Akonadi server can be stuck in a partially running state after a failure which will prevent the next attempt to start it to fail as well. Please file a bug report if you run into this problem including the self-test report of the initial problem.
===Disabling the Akonadi subsystem=== <!--T:56-->


=== The so-called "Gentoo-Assert" ===
<!--T:57-->
The '''Akonadi''' server is started by any '''Akonadi'''-enabled application. If you don't want Akonadi to be started after login, you have to ensure that no '''Akonadi'''-enabled application is launched at login or thereafter. Remember to check '''Plasma''' widgets as well — the '''Digital Clock''' widget in the default panel, for instance uses '''Akonadi''' to (optionally) display calendar events and this is enabled in its settings by default (see the "Display Events" option) .  You must remove any widgets that may start it from your start-up, if you wish Akonadi to start only when you start '''KMail''' or other applications.


That's an especially nasty problem. It seems to only affect Gentoo users so far. It is named after MySQL assertions like the following example and is most likely caused by a MySQL protocol mismatch between the MySQL server and the client library or the Qt MySQL driver.


<code>
<!--T:26-->
akonadiserver: libmysql.c:4301: setup_one_fetch_function: Assertion `param->buffer_length != 0' failed.
{{Remember|1=If you don't want to have '''Akonadi''' running on your system at all, you can not use any of the '''Akonadi'''-enabled applications. Such applications will not work when '''Akonadi''' is disabled using the steps below. See the list of [[Special:myLanguage/Akonadi#ApplicationTable|Akonadi-enabled applications]]. Also note, that some '''Plasma''' widgets, such as the '''Digital Clock''' uses '''Akonadi'''.}}
</code>


It is extremely hard to diagnose as the assertion mentioned above are only triggered sometimes. Instead you'll get a wide range of weird symptoms:
<!--T:27-->
* ASAP protocol logs show successful creation of objects which are supposedly no longer available when the next commands accesses them again.
The '''Akonadi''' server is launched automatically at login whenever any '''Akonadi'''-enabled application requests access to it.
* SQL protocol logs show INSERT or UPDATE commands with values that mismatch the corresponding column types and nevertheless succeed.
* SQL protocol logs showing large apparently random record ids which are nevertheless considered valid.


References:
<!--T:28-->
* http://forum.kde.org/viewtopic.php?f=20&t=61738
To disable the '''Akonadi''' subsystem, shut down the running Akonadi server from the control module or the command line:
* http://bugs.gentoo.org/show_bug.cgi?id=267513
 
<!--T:29-->
{{Input|1=akonadictl stop}}
 
<!--T:58-->
To ensure that Akonadi is not started, check that no applications require it at login. In particular, open the Plasma clock applet preferences, go to <menuchoice>Calendar</menuchoice> and uncheck <menuchoice>Show events</menuchoice> to prevent Plasma from requesting information from Akonadi and thus allowing it to start.
 
==Frequently Asked Questions== <!--T:34-->
 
=== Where is my data now? === <!--T:45-->
 
<!--T:46-->
A full explanation of where the data is stored and Akonadi's interaction with it is available in [http://blogs.kde.org/node/4503 Andras Mantia's blog]
 
=== How to upgrade my PostgreSQL database? === <!--T:60-->
 
<!--T:61-->
After updating your PostgreSQL server to a new major version, sometimes you will have to convert your Akonadi database for use with this new version. Instructions can be found on [[Special:myLanguage/Akonadi/Postgres_update|this page]].
 
=== Migration problems === <!--T:47-->
 
<!--T:35-->
'''Akonadi's''' [[Special:myLanguage/Glossary#Akonadi|Glossary entry]] has a brief description of Akonadi's purpose, and other useful links. [[Special:myLanguage/Akonadi_and_AddressBook|This page]] explains how '''Akonadi''' and '''KAddressBook''' work together.
 
<!--T:9-->
[[Category:System]]
</translate>

Revision as of 22:37, 29 December 2020

Other languages:

Introduction

The Akonadi framework is responsible for providing applications with a centralized database to store, index and retrieve the user's personal information. This includes the user's emails, contacts, calendars, events, journals, alarms, notes, etc. In SC 4.4, KAddressBook became the first application to start using the Akonadi framework. In SC 4.7, KMail, KOrganizer, KJots, etc. were updated to use Akonadi as well. In addition, several Plasma widgets also use Akonadi to store and retrieve calendar events, notes, etc.

At the time of writing (August, 2011), the following applications are enabled to use the Akonadi framework to centrally store and access user data. Follow through to each application's page to learn more.

KMail

Mail Client

Uses Akonadi to store emails

KAddressBook

Contact Manager

Uses Akonadi to store contact information

KOrganizer

Personal Organizer

Uses Akonadi to store calendars, events, journals, etc.

KJots

Note Taking Application

Uses Akonadi to store notes

In addition to this, plasma widgets like the Digital Clock widget, the Notes widget also use Akonadi to store and retrieve events and notes.

Controlling the Akonadi server

The Akonadi control module started by the context menu of the Akonadi tray icon provides an easy means to starting, stopping, restarting and querying the status of the Akonadi server. You may also accomplish this from the commandline using the command akonadictl. Using this method, you can get additional useful information on the console.

To start the Akonadi server, 

akonadictl start

To stop the Akonadi server, 

akonadictl stop

To restart a running Akonadi server, 

akonadictl restart

To query the status of the Akonadi server, 

akonadictl status

Disabling the Akonadi subsystem

The Akonadi server is started by any Akonadi-enabled application. If you don't want Akonadi to be started after login, you have to ensure that no Akonadi-enabled application is launched at login or thereafter. Remember to check Plasma widgets as well — the Digital Clock widget in the default panel, for instance uses Akonadi to (optionally) display calendar events and this is enabled in its settings by default (see the "Display Events" option) . You must remove any widgets that may start it from your start-up, if you wish Akonadi to start only when you start KMail or other applications.


Remember

If you don't want to have Akonadi running on your system at all, you can not use any of the Akonadi-enabled applications. Such applications will not work when Akonadi is disabled using the steps below. See the list of Akonadi-enabled applications. Also note, that some Plasma widgets, such as the Digital Clock uses Akonadi.


The Akonadi server is launched automatically at login whenever any Akonadi-enabled application requests access to it.

To disable the Akonadi subsystem, shut down the running Akonadi server from the control module or the command line: 

akonadictl stop

To ensure that Akonadi is not started, check that no applications require it at login. In particular, open the Plasma clock applet preferences, go to Calendar and uncheck Show events to prevent Plasma from requesting information from Akonadi and thus allowing it to start.

Frequently Asked Questions

Where is my data now?

A full explanation of where the data is stored and Akonadi's interaction with it is available in Andras Mantia's blog

How to upgrade my PostgreSQL database?

After updating your PostgreSQL server to a new major version, sometimes you will have to convert your Akonadi database for use with this new version. Instructions can be found on this page.

Migration problems

Akonadi's Glossary entry has a brief description of Akonadi's purpose, and other useful links. This page explains how Akonadi and KAddressBook work together.

Retrieved from "https://userbase.kde.org/index.php?title=Akonadi&oldid=462121"