Calendar database

m (Calendar Database moved to Calendar database: capitalisation)
(reformat page, condense information to one table per database table)
Line 1: Line 1:
The [[Open development/Maemo roadmap/Fremantle|Maemo 5]] calendar database can be found in <code>/home/user/.calendar/calendardb</code>. The goal of this article is to provide enough information on the calendar database in order to implement mass modifying/adding/deleting events verifying some criterias (string match in title, locations, comments for example). It could be easy then to write a small shell script using zenity and sqlite3 to perform this tasks.
The [[Open development/Maemo roadmap/Fremantle|Maemo 5]] calendar database can be found in <code>/home/user/.calendar/calendardb</code>. The goal of this article is to provide enough information on the calendar database in order to implement mass modifying/adding/deleting events verifying some criterias (string match in title, locations, comments for example). It could be easy then to write a small shell script using zenity and sqlite3 to perform this tasks.
-
If you want to help editing this article and writing useful informations on fields or new scripts, feel free to copy your own database on your computer and analyze it with some tools like "SQLite Database Browser" (Linux/Debian).
+
If you want to help editing this article and writing useful informations on fields or new scripts, feel free to copy your own database on your computer and analyze it with some tools like "SQLite Database Browser" (Linux/Debian). The datatypes are those listed in the [http://www.sqlite.org/datatype3.html SQLite documentation].
-
 
+
-
== [[#toc|Scripts]] ==
+
== [[#toc|Structure]] ==
== [[#toc|Structure]] ==
=== [[#toc|Tables & fields]] ===
=== [[#toc|Tables & fields]] ===
-
----
 
==== [[#toc|ALARM]] ====
==== [[#toc|ALARM]] ====
-
----
+
 
===== Id =====
===== Id =====
===== Trigger =====
===== Trigger =====
Line 19: Line 16:
===== Attach =====
===== Attach =====
-
----
 
==== [[#toc|Birthdays]] ====
==== [[#toc|Birthdays]] ====
-
----
+
 
===== Id =====
===== Id =====
===== DayMonth =====
===== DayMonth =====
===== Year =====
===== Year =====
-
----
 
==== [[#toc|Calendars]] ====
==== [[#toc|Calendars]] ====
-
----
 
-
===== CalendarId =====
 
-
:{| class="wikitable"
 
-
|-
 
-
| <int> || primary key
 
-
|-
 
-
|}
 
-
===== Name =====
 
-
:{| class="wikitable"
 
-
|-
 
-
| <txt> || name of the calendar
 
-
|-
 
-
|}
 
-
===== Colour =====
 
-
:{| class="wikitable"
 
-
|-
 
-
| 0 || dark blue
 
-
|-
 
-
| 1 || green
 
-
|-
 
-
| 2 || dark pink
 
-
|-
 
-
| 3 || orange
 
-
|-
 
-
| 4 || purple
 
-
|-
 
-
| 5 || yellow
 
-
|-
 
-
| 6 || white
 
-
|-
 
-
| 7 || light blue
 
-
|-
 
-
| 8 || light pink
 
-
|-
 
-
| 9 || yellow-green
 
-
|}
 
-
===== IsVisible =====
+
{| class="wikitable"
-
:{| class="wikitable"
+
|+ Calendars table
|-
|-
-
| 0 || not visible
+
! Field !! Type !! Description
|-
|-
-
| 1 || visible
+
| CalendarId || integer || primary key
|-
|-
-
|}
+
| Name || text || name of the calendar
-
 
+
-
===== IsReadonly =====
+
-
:{| class="wikitable"
+
|-
|-
-
| 0 || writeable
+
| Colour || integer || 0 = dark blue, 1 = green, 2 = dark pink, 3 = orange, 4 = purple, 5 = yellow, 6 = white, 7 = light blue, 8 = light pink, 9 = yellow-green
|-
|-
-
| 1 || not writeable
+
| isVisible || integer || 0 = not visible, 1 = visible
|-
|-
-
|}
+
| isReadonly || integer || 0 = writeable, 1 = not writeable
-
 
+
-
===== CalendarType =====
+
-
:{| class="wikitable"
+
|-
|-
-
| 0 || local
+
| CalendarType || integer || 0 = local, 1 = intelligent, 2 = ?, 3 = private, 4 = synchronized
|-
|-
-
| 1 || intelligent
+
| CalendarTune || text || Path to the calendar alarm sound. Default path: <code>/usr/share/sounds/ui-calendar_alarm_default.aac</code>
|-
|-
-
| 2 ||  
+
| CalendarVersion || ||
-
|-
+
-
| 3 || private
+
-
|-
+
-
| 4 || synchronized
+
|-
|-
 +
| CalendarProfile || ||
|}
|}
-
===== CalendarTune =====
+
==== [[#toc|ComponentDetails]] ====
-
:{| class="wikitable"
+
-
|-
+
-
| <txt> || path to the calendar alarm sound
+
-
|-
+
-
| <code>/usr/share/sounds/ui-calendar_alarm_default.aac</code> || default alarm
+
-
|-
+
-
|}
+
-
===== CalendarVersion =====
 
-
===== CalendarProfile =====
 
-
 
-
----
 
-
 
-
==== [[#toc|ComponentDetails]] ====
 
-
----
 
===== Id =====
===== Id =====
===== ComponentType =====
===== ComponentType =====
Line 133: Line 69:
===== Completed =====
===== Completed =====
-
----
 
==== [[#toc|Components]] ====
==== [[#toc|Components]] ====
-
----
 
-
===== Id =====
 
-
:{| class="wikitable"
 
-
|-
 
-
| <int> || primary key
 
-
|-
 
-
|}
 
-
===== CalendarId =====
 
-
:{| class="wikitable"
 
-
|-
 
-
| <int> || [[#CalendarId|calendar identifier]] associated to the component
 
-
|-
 
-
|}
 
-
===== ComponentType =====
+
{| class="wikitable"
-
:{| class="wikitable"
+
|+ Components table
|-
|-
-
| 1 || event
+
! Field !! Type !! Description
|-
|-
-
| 2 || task
+
| Id || integer || primary key
|-
|-
-
| 3 || note
+
| CalendarId || integer || association with the corresponding [[#Calendar|calender]]
|-
|-
-
| 4 || birthday
+
| ComponentType || integer || 1 = event, 2 = task, 3 = note, 4 = birthday
|-
|-
-
|}
+
| Flags || ||
-
 
+
-
===== Flags =====
+
-
===== DateStart =====
+
-
:{| class="wikitable"
+
|-
|-
-
| <int> || UTC start date in Unix Time Format (number of seconds since 01/01/1970)
+
| DateStart || integer || UTC start date in Unix Time Format (number of seconds since 01/01/1970)
|-
|-
-
|}
+
| DateEnd || integer || -1 = undefined, otherwise UTC end date in Unix Time Format (number of seconds since 01/01/1970)
-
 
+
-
===== DateEnd =====
+
-
:{| class="wikitable"
+
|-
|-
-
| -1 || undefined
+
| Summary || text || title [event, task, note, birthday]
|-
|-
-
| <int> || UTC end date in Unix Time Format (number of seconds since 01/01/1970)
+
| Location || text || location [event]
|-
|-
-
|}
+
| Description || text || comments [event, task, note]
-
 
+
-
===== Summary =====
+
-
:{| class="wikitable"
+
|-
|-
-
| <txt> || title [event, task, note, birthday]
+
| Status || integer || -1 = undefined [event, note]. 0 = incomplete [task], 1 = complete [task], yyyy = year [birthday]
|-
|-
-
|}
+
| Uid || ||
-
 
+
-
===== Location =====
+
-
:{| class="wikitable"
+
|-
|-
-
| <txt> || location [event]
+
| Until || integer || -1 = none [event, tastk, note], 2145913199 = end of calendar / limit of the Unix Time Format, other integer = end date of a recurrence [event, birthday]
|-
|-
-
|}
+
| AllDay || integer || 0 = in limited time [event, task, note], 1 = all day [event, birthday]
-
 
+
-
===== Description =====
+
-
:{| class="wikitable"
+
|-
|-
-
| <txt> || comments [event, task, note]
+
| CreatedTime || integer || date of creation
|-
|-
-
|}
+
| ModifiedTime || integer || last date of modification
-
 
+
-
===== Status =====
+
-
:{| class="wikitable"
+
|-
|-
-
| -1 || undefined [event, note]
+
| Tzid || text || time zone identifier, for example "<code>Europe/Paris</code>"
-
|-
+
-
| 0 || uncomplete [task]
+
-
|-
+
-
| 1 || complete [task]
+
-
|-
+
-
| <yyyy> || year [birthday]
+
|-
|-
 +
| TzOffset || text || time zone offset in seconds compared to UTC, for example "<code>7200</code>" (2 hours)
|}
|}
-
===== Uid =====
+
==== [[#toc|IDMAP]] ====
-
===== Until =====
+
-
:{| class="wikitable"
+
-
|-
+
-
| -1 || none [event, task, note]
+
-
|-
+
-
| <int> || end date of a recurrence [event, birthday]
+
-
|-
+
-
| 2145913199 || end of calendar / limit of the Unix Time Format
+
-
|}
+
-
===== AllDay =====
 
-
:{| class="wikitable"
 
-
|-
 
-
| 0 || in limited time [event, task, note]
 
-
|-
 
-
| 1 || all day [event, birthday]
 
-
|-
 
-
|}
 
-
 
-
===== CreatedTime =====
 
-
:{| class="wikitable"
 
-
|-
 
-
| <int> || date of creation
 
-
|-
 
-
|}
 
-
 
-
===== ModifiedTime =====
 
-
:{| class="wikitable"
 
-
|-
 
-
| <int> || last date of modification
 
-
|-
 
-
|}
 
-
 
-
===== Tzid =====
 
-
:{| class="wikitable"
 
-
|-
 
-
| <txt> || time zone identifier
 
-
|-
 
-
| :Europe/Paris || France time zone
 
-
|-
 
-
|}
 
-
 
-
===== TzOffset =====
 
-
:{| class="wikitable"
 
-
|-
 
-
| <txt> || time zone offset in seconds compared to UTC
 
-
|-
 
-
| 7200 || France time zone offset (2 hours)
 
-
|-
 
-
|}
 
-
 
-
----
 
-
 
-
==== [[#toc|IDMAP]] ====
 
-
----
 
===== LocalId =====
===== LocalId =====
===== ExternalId =====
===== ExternalId =====
-
----
 
==== [[#toc|Instances]] ====
==== [[#toc|Instances]] ====
-
----
+
 
===== Id =====
===== Id =====
===== DateStart =====
===== DateStart =====
===== DateEnd =====
===== DateEnd =====
-
----
 
==== [[#toc|Parameters]] ====
==== [[#toc|Parameters]] ====
-
----
+
 
===== ComponentId =====
===== ComponentId =====
===== PropertyType =====
===== PropertyType =====
Line 288: Line 130:
===== ParamValue =====
===== ParamValue =====
-
----
 
==== [[#toc|RECURSIVE]] ====
==== [[#toc|RECURSIVE]] ====
-
----
+
 
===== Id =====
===== Id =====
===== Rrule =====
===== Rrule =====
Line 299: Line 140:
===== Rtype =====
===== Rtype =====
-
----
 
==== [[#toc|TIMEZONE]] ====
==== [[#toc|TIMEZONE]] ====
-
----
+
 
===== Location =====
===== Location =====
===== Tzid =====
===== Tzid =====
Line 313: Line 153:
===== DSTFlag =====
===== DSTFlag =====
-
----
+
 
==== [[#toc|Trash]] ====
==== [[#toc|Trash]] ====
-
----
+
 
===== ComponentId =====
===== ComponentId =====
===== CalendarId =====
===== CalendarId =====
Line 322: Line 162:
===== CreatedTime =====
===== CreatedTime =====
-
----
 
==== [[#toc|XProperties]] ====
==== [[#toc|XProperties]] ====
-
----
+
 
===== ComponentId =====
===== ComponentId =====
===== XPropertyName =====
===== XPropertyName =====
===== XPropertyValue =====
===== XPropertyValue =====
-
----
 
==== [[#toc|sqlite_sequence]] ====
==== [[#toc|sqlite_sequence]] ====
-
----
+
 
===== name =====
===== name =====
===== seq =====
===== seq =====
-
 
=== [[#toc|Indices]] ===
=== [[#toc|Indices]] ===

Revision as of 10:50, 3 March 2011

The Maemo 5 calendar database can be found in /home/user/.calendar/calendardb. The goal of this article is to provide enough information on the calendar database in order to implement mass modifying/adding/deleting events verifying some criterias (string match in title, locations, comments for example). It could be easy then to write a small shell script using zenity and sqlite3 to perform this tasks.

If you want to help editing this article and writing useful informations on fields or new scripts, feel free to copy your own database on your computer and analyze it with some tools like "SQLite Database Browser" (Linux/Debian). The datatypes are those listed in the SQLite documentation.

Contents

Structure

Tables & fields

ALARM

Id
Trigger
Repeat
Duration
Action
CookieId
Attach

Birthdays

Id
DayMonth
Year

Calendars

Calendars table
Field Type Description
CalendarId integer primary key
Name text name of the calendar
Colour integer 0 = dark blue, 1 = green, 2 = dark pink, 3 = orange, 4 = purple, 5 = yellow, 6 = white, 7 = light blue, 8 = light pink, 9 = yellow-green
isVisible integer 0 = not visible, 1 = visible
isReadonly integer 0 = writeable, 1 = not writeable
CalendarType integer 0 = local, 1 = intelligent, 2 = ?, 3 = private, 4 = synchronized
CalendarTune text Path to the calendar alarm sound. Default path: /usr/share/sounds/ui-calendar_alarm_default.aac
CalendarVersion
CalendarProfile

ComponentDetails

Id
ComponentType
Class
Geo
Priority
DateStamp
Sequence
Transparency
Uid
Url
Attach
Category
Comment
Contact
Related
Resources
Percent
Completed

Components

Components table
Field Type Description
Id integer primary key
CalendarId integer association with the corresponding calender
ComponentType integer 1 = event, 2 = task, 3 = note, 4 = birthday
Flags
DateStart integer UTC start date in Unix Time Format (number of seconds since 01/01/1970)
DateEnd integer -1 = undefined, otherwise UTC end date in Unix Time Format (number of seconds since 01/01/1970)
Summary text title [event, task, note, birthday]
Location text location [event]
Description text comments [event, task, note]
Status integer -1 = undefined [event, note]. 0 = incomplete [task], 1 = complete [task], yyyy = year [birthday]
Uid
Until integer -1 = none [event, tastk, note], 2145913199 = end of calendar / limit of the Unix Time Format, other integer = end date of a recurrence [event, birthday]
AllDay integer 0 = in limited time [event, task, note], 1 = all day [event, birthday]
CreatedTime integer date of creation
ModifiedTime integer last date of modification
Tzid text time zone identifier, for example "Europe/Paris"
TzOffset text time zone offset in seconds compared to UTC, for example "7200" (2 hours)

IDMAP

LocalId
ExternalId

Instances

Id
DateStart
DateEnd

Parameters

ComponentId
PropertyType
PropertyValue
ParamName
ParamValue

RECURSIVE

Id
Rrule
Rdates
Exdates
Exrule
RecurrenceId
Rtype

TIMEZONE

Location
Tzid
DtStartStd
DtStartDst
TzOffsetStd
TzOffsetDst
RRuleStd
RRuleDst
TzName
DSTFlag

Trash

ComponentId
CalendarId
ComponentType
DeletedTime
CreatedTime

XProperties

ComponentId
XPropertyName
XPropertyValue

sqlite_sequence

name
seq

Indices

IDX_ALARM

IDX_BIRTHDAYS_DATE

IDX_BIRTHDAYS_IDS

IDX_CALENDAR

IDX_COMPONENT

IDX_DETAILS

IDX_INST

IDX_RECURSIVE

IDX_TIMEZONE

IDX_TRASH

Retrieved from "http://wiki.maemo.org/Calendar_database"