← Back to branch summary

~cyphermox/ubuntu/quantal/evolution-data-server/autopkgtests

« back to all changes in this revision

Viewing changes to docs/reference/camel/tmpl/camel-db.sgml

  • Committer: Package Import Robot
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-09-19 12:15:29 UTC
  • mfrom: (1.1.93 upstream)
  • Revision ID: package-import@ubuntu.com-20110919121529-nsmfnges77ec7hux
Tags: 3.1.92-0ubuntu1
https://launchpad.net/bugs/852277
https://launchpad.net/bugs/853905
https://launchpad.net/bugs/660626
* New upstream release.
  - Cannot add more than one appointment per session (LP: #852277)
  - Contacts calendar backend doesn't show events (LP: #853905)
  - Set X-Evolution-Source header consistently (LP: #660626)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/tmpl/camel-db.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
CamelDB
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
 
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
<para>
 
9
 
 
10
</para>
 
11
 
 
12
<!-- ##### SECTION See_Also ##### -->
 
13
<para>
 
14
 
 
15
</para>
 
16
 
 
17
<!-- ##### SECTION Stability_Level ##### -->
 
18
 
 
19
 
 
20
<!-- ##### SECTION Image ##### -->
 
21
 
 
22
 
 
23
<!-- ##### MACRO CAMEL_DB_FILE ##### -->
 
24
<para>
 
25
 
 
26
</para>
 
27
 
 
28
 
 
29
 
 
30
<!-- ##### MACRO CAMEL_DB_IN_MEMORY_TABLE ##### -->
 
31
<para>
 
32
 
 
33
</para>
 
34
 
 
35
 
 
36
 
 
37
<!-- ##### MACRO CAMEL_DB_IN_MEMORY_DB ##### -->
 
38
<para>
 
39
 
 
40
</para>
 
41
 
 
42
 
 
43
 
 
44
<!-- ##### MACRO CAMEL_DB_IN_MEMORY_TABLE_LIMIT ##### -->
 
45
<para>
 
46
 
 
47
</para>
 
48
 
 
49
 
 
50
 
 
51
<!-- ##### MACRO CAMEL_DB_FREE_CACHE_SIZE ##### -->
 
52
<para>
 
53
 
 
54
</para>
 
55
 
 
56
 
 
57
 
 
58
<!-- ##### MACRO CAMEL_DB_SLEEP_INTERVAL ##### -->
 
59
<para>
 
60
 
 
61
</para>
 
62
 
 
63
 
 
64
 
 
65
<!-- ##### MACRO CAMEL_DB_RELEASE_SQLITE_MEMORY ##### -->
 
66
<para>
 
67
 
 
68
</para>
 
69
 
 
70
 
 
71
 
 
72
<!-- ##### MACRO CAMEL_DB_USE_SHARED_CACHE ##### -->
 
73
<para>
 
74
 
 
75
</para>
 
76
 
 
77
 
 
78
 
 
79
<!-- ##### USER_FUNCTION CamelDBCollate ##### -->
 
80
<para>
 
81
 
 
82
</para>
 
83
 
 
84
@Param1: 
 
85
@Param2: 
 
86
@Param3: 
 
87
@Param4: 
 
88
@Param5: 
 
89
@Returns: 
 
90
 
 
91
 
 
92
<!-- ##### STRUCT CamelDB ##### -->
 
93
<para>
 
94
 
 
95
</para>
 
96
 
 
97
@db: 
 
98
@lock: 
 
99
@priv: 
 
100
 
 
101
<!-- ##### STRUCT CamelMIRecord ##### -->
 
102
<para>
 
103
 
 
104
</para>
 
105
 
 
106
@uid: 
 
107
@flags: 
 
108
@msg_type: 
 
109
@dirty: 
 
110
@read: 
 
111
@deleted: 
 
112
@replied: 
 
113
@important: 
 
114
@junk: 
 
115
@attachment: 
 
116
@size: 
 
117
@dsent: 
 
118
@dreceived: 
 
119
@subject: 
 
120
@from: 
 
121
@to: 
 
122
@cc: 
 
123
@mlist: 
 
124
@followup_flag: 
 
125
@followup_completed_on: 
 
126
@followup_due_by: 
 
127
@part: 
 
128
@labels: 
 
129
@usertags: 
 
130
@cinfo: 
 
131
@bdata: 
 
132
@bodystructure: 
 
133
 
 
134
<!-- ##### STRUCT CamelFIRecord ##### -->
 
135
<para>
 
136
 
 
137
</para>
 
138
 
 
139
@folder_name: 
 
140
@version: 
 
141
@flags: 
 
142
@nextuid: 
 
143
@time: 
 
144
@saved_count: 
 
145
@unread_count: 
 
146
@deleted_count: 
 
147
@junk_count: 
 
148
@visible_count: 
 
149
@jnd_count: 
 
150
@bdata: 
 
151
 
 
152
<!-- ##### USER_FUNCTION CamelDBSelectCB ##### -->
 
153
<para>
 
154
 
 
155
</para>
 
156
 
 
157
@data: 
 
158
@ncol: 
 
159
@colvalues: 
 
160
@colnames: 
 
161
@Returns: 
 
162
 
 
163
 
 
164
<!-- ##### FUNCTION camel_db_open ##### -->
 
165
<para>
 
166
 
 
167
</para>
 
168
 
 
169
@path: 
 
170
@error: 
 
171
@Returns: 
 
172
 
 
173
 
 
174
<!-- ##### FUNCTION camel_db_clone ##### -->
 
175
<para>
 
176
 
 
177
</para>
 
178
 
 
179
@cdb: 
 
180
@error: 
 
181
@Returns: 
 
182
 
 
183
 
 
184
<!-- ##### FUNCTION camel_db_close ##### -->
 
185
<para>
 
186
 
 
187
</para>
 
188
 
 
189
@cdb: 
 
190
 
 
191
 
 
192
<!-- ##### FUNCTION camel_db_command ##### -->
 
193
<para>
 
194
 
 
195
</para>
 
196
 
 
197
@cdb: 
 
198
@stmt: 
 
199
@error: 
 
200
@Returns: 
 
201
 
 
202
 
 
203
<!-- ##### FUNCTION camel_db_transaction_command ##### -->
 
204
<para>
 
205
 
 
206
</para>
 
207
 
 
208
@cdb: 
 
209
@qry_list: 
 
210
@error: 
 
211
@Returns: 
 
212
 
 
213
 
 
214
<!-- ##### FUNCTION camel_db_begin_transaction ##### -->
 
215
<para>
 
216
 
 
217
</para>
 
218
 
 
219
@cdb: 
 
220
@error: 
 
221
@Returns: 
 
222
 
 
223
 
 
224
<!-- ##### FUNCTION camel_db_add_to_transaction ##### -->
 
225
<para>
 
226
 
 
227
</para>
 
228
 
 
229
@cdb: 
 
230
@query: 
 
231
@error: 
 
232
@Returns: 
 
233
 
 
234
 
 
235
<!-- ##### FUNCTION camel_db_end_transaction ##### -->
 
236
<para>
 
237
 
 
238
</para>
 
239
 
 
240
@cdb: 
 
241
@error: 
 
242
@Returns: 
 
243
 
 
244
 
 
245
<!-- ##### FUNCTION camel_db_abort_transaction ##### -->
 
246
<para>
 
247
 
 
248
</para>
 
249
 
 
250
@cdb: 
 
251
@error: 
 
252
@Returns: 
 
253
 
 
254
 
 
255
<!-- ##### FUNCTION camel_db_clear_folder_summary ##### -->
 
256
<para>
 
257
 
 
258
</para>
 
259
 
 
260
@cdb: 
 
261
@folder: 
 
262
@error: 
 
263
@Returns: 
 
264
 
 
265
 
 
266
<!-- ##### FUNCTION camel_db_rename_folder ##### -->
 
267
<para>
 
268
 
 
269
</para>
 
270
 
 
271
@cdb: 
 
272
@old_folder: 
 
273
@new_folder: 
 
274
@error: 
 
275
@Returns: 
 
276
 
 
277
 
 
278
<!-- ##### FUNCTION camel_db_delete_folder ##### -->
 
279
<para>
 
280
 
 
281
</para>
 
282
 
 
283
@cdb: 
 
284
@folder: 
 
285
@error: 
 
286
@Returns: 
 
287
 
 
288
 
 
289
<!-- ##### FUNCTION camel_db_delete_uid ##### -->
 
290
<para>
 
291
 
 
292
</para>
 
293
 
 
294
@cdb: 
 
295
@folder: 
 
296
@uid: 
 
297
@error: 
 
298
@Returns: 
 
299
 
 
300
 
 
301
<!-- ##### FUNCTION camel_db_delete_uids ##### -->
 
302
<para>
 
303
 
 
304
</para>
 
305
 
 
306
@cdb: 
 
307
@folder_name: 
 
308
@uids: 
 
309
@error: 
 
310
@Returns: 
 
311
 
 
312
 
 
313
<!-- ##### FUNCTION camel_db_delete_vuids ##### -->
 
314
<para>
 
315
 
 
316
</para>
 
317
 
 
318
@cdb: 
 
319
@folder_name: 
 
320
@shash: 
 
321
@uids: 
 
322
@error: 
 
323
@Returns: 
 
324
 
 
325
 
 
326
<!-- ##### FUNCTION camel_db_create_folders_table ##### -->
 
327
<para>
 
328
 
 
329
</para>
 
330
 
 
331
@cdb: 
 
332
@error: 
 
333
@Returns: 
 
334
 
 
335
 
 
336
<!-- ##### FUNCTION camel_db_select ##### -->
 
337
<para>
 
338
 
 
339
</para>
 
340
 
 
341
@cdb: 
 
342
@stmt: 
 
343
@callback: 
 
344
@data: 
 
345
@error: 
 
346
@Returns: 
 
347
 
 
348
 
 
349
<!-- ##### FUNCTION camel_db_write_folder_info_record ##### -->
 
350
<para>
 
351
 
 
352
</para>
 
353
 
 
354
@cdb: 
 
355
@record: 
 
356
@error: 
 
357
@Returns: 
 
358
 
 
359
 
 
360
<!-- ##### FUNCTION camel_db_read_folder_info_record ##### -->
 
361
<para>
 
362
 
 
363
</para>
 
364
 
 
365
@cdb: 
 
366
@folder_name: 
 
367
@record: 
 
368
@error: 
 
369
@Returns: 
 
370
 
 
371
 
 
372
<!-- ##### FUNCTION camel_db_prepare_message_info_table ##### -->
 
373
<para>
 
374
 
 
375
</para>
 
376
 
 
377
@cdb: 
 
378
@folder_name: 
 
379
@error: 
 
380
@Returns: 
 
381
 
 
382
 
 
383
<!-- ##### FUNCTION camel_db_write_message_info_record ##### -->
 
384
<para>
 
385
 
 
386
</para>
 
387
 
 
388
@cdb: 
 
389
@folder_name: 
 
390
@record: 
 
391
@error: 
 
392
@Returns: 
 
393
 
 
394
 
 
395
<!-- ##### FUNCTION camel_db_write_fresh_message_info_record ##### -->
 
396
<para>
 
397
 
 
398
</para>
 
399
 
 
400
@cdb: 
 
401
@folder_name: 
 
402
@record: 
 
403
@error: 
 
404
@Returns: 
 
405
 
 
406
 
 
407
<!-- ##### FUNCTION camel_db_read_message_info_records ##### -->
 
408
<para>
 
409
 
 
410
</para>
 
411
 
 
412
@cdb: 
 
413
@folder_name: 
 
414
@p: 
 
415
@read_mir_callback: 
 
416
@error: 
 
417
@Returns: 
 
418
 
 
419
 
 
420
<!-- ##### FUNCTION camel_db_read_message_info_record_with_uid ##### -->
 
421
<para>
 
422
 
 
423
</para>
 
424
 
 
425
@cdb: 
 
426
@folder_name: 
 
427
@uid: 
 
428
@p: 
 
429
@read_mir_callback: 
 
430
@error: 
 
431
@Returns: 
 
432
 
 
433
 
 
434
<!-- ##### FUNCTION camel_db_count_junk_message_info ##### -->
 
435
<para>
 
436
 
 
437
</para>
 
438
 
 
439
@cdb: 
 
440
@table_name: 
 
441
@count: 
 
442
@error: 
 
443
@Returns: 
 
444
 
 
445
 
 
446
<!-- ##### FUNCTION camel_db_count_unread_message_info ##### -->
 
447
<para>
 
448
 
 
449
</para>
 
450
 
 
451
@cdb: 
 
452
@table_name: 
 
453
@count: 
 
454
@error: 
 
455
@Returns: 
 
456
 
 
457
 
 
458
<!-- ##### FUNCTION camel_db_count_deleted_message_info ##### -->
 
459
<para>
 
460
 
 
461
</para>
 
462
 
 
463
@cdb: 
 
464
@table_name: 
 
465
@count: 
 
466
@error: 
 
467
@Returns: 
 
468
 
 
469
 
 
470
<!-- ##### FUNCTION camel_db_count_total_message_info ##### -->
 
471
<para>
 
472
 
 
473
</para>
 
474
 
 
475
@cdb: 
 
476
@table_name: 
 
477
@count: 
 
478
@error: 
 
479
@Returns: 
 
480
 
 
481
 
 
482
<!-- ##### FUNCTION camel_db_count_visible_message_info ##### -->
 
483
<para>
 
484
 
 
485
</para>
 
486
 
 
487
@cdb: 
 
488
@table_name: 
 
489
@count: 
 
490
@error: 
 
491
@Returns: 
 
492
 
 
493
 
 
494
<!-- ##### FUNCTION camel_db_count_visible_unread_message_info ##### -->
 
495
<para>
 
496
 
 
497
</para>
 
498
 
 
499
@cdb: 
 
500
@table_name: 
 
501
@count: 
 
502
@error: 
 
503
@Returns: 
 
504
 
 
505
 
 
506
<!-- ##### FUNCTION camel_db_count_junk_not_deleted_message_info ##### -->
 
507
<para>
 
508
 
 
509
</para>
 
510
 
 
511
@cdb: 
 
512
@table_name: 
 
513
@count: 
 
514
@error: 
 
515
@Returns: 
 
516
 
 
517
 
 
518
<!-- ##### FUNCTION camel_db_count_message_info ##### -->
 
519
<para>
 
520
 
 
521
</para>
 
522
 
 
523
@cdb: 
 
524
@query: 
 
525
@count: 
 
526
@error: 
 
527
@Returns: 
 
528
 
 
529
 
 
530
<!-- ##### FUNCTION camel_db_camel_mir_free ##### -->
 
531
<para>
 
532
 
 
533
</para>
 
534
 
 
535
@record: 
 
536
 
 
537
 
 
538
<!-- ##### FUNCTION camel_db_create_vfolder ##### -->
 
539
<para>
 
540
 
 
541
</para>
 
542
 
 
543
@db: 
 
544
@folder_name: 
 
545
@error: 
 
546
@Returns: 
 
547
 
 
548
 
 
549
<!-- ##### FUNCTION camel_db_recreate_vfolder ##### -->
 
550
<para>
 
551
 
 
552
</para>
 
553
 
 
554
@db: 
 
555
@folder_name: 
 
556
@error: 
 
557
@Returns: 
 
558
 
 
559
 
 
560
<!-- ##### FUNCTION camel_db_delete_uid_from_vfolder ##### -->
 
561
<para>
 
562
 
 
563
</para>
 
564
 
 
565
@db: 
 
566
@folder_name: 
 
567
@vuid: 
 
568
@error: 
 
569
@Returns: 
 
570
 
 
571
 
 
572
<!-- ##### FUNCTION camel_db_delete_uid_from_vfolder_transaction ##### -->
 
573
<para>
 
574
 
 
575
</para>
 
576
 
 
577
@db: 
 
578
@folder_name: 
 
579
@vuid: 
 
580
@error: 
 
581
@Returns: 
 
582
 
 
583
 
 
584
<!-- ##### FUNCTION camel_db_get_vuids_from_vfolder ##### -->
 
585
<para>
 
586
 
 
587
</para>
 
588
 
 
589
@db: 
 
590
@folder_name: 
 
591
@filter: 
 
592
@error: 
 
593
@Returns: 
 
594
 
 
595
 
 
596
<!-- ##### FUNCTION camel_db_add_to_vfolder ##### -->
 
597
<para>
 
598
 
 
599
</para>
 
600
 
 
601
@db: 
 
602
@folder_name: 
 
603
@vuid: 
 
604
@error: 
 
605
@Returns: 
 
606
 
 
607
 
 
608
<!-- ##### FUNCTION camel_db_add_to_vfolder_transaction ##### -->
 
609
<para>
 
610
 
 
611
</para>
 
612
 
 
613
@db: 
 
614
@folder_name: 
 
615
@vuid: 
 
616
@error: 
 
617
@Returns: 
 
618
 
 
619
 
 
620
<!-- ##### FUNCTION camel_db_get_folder_uids ##### -->
 
621
<para>
 
622
 
 
623
</para>
 
624
 
 
625
@db: 
 
626
@folder_name: 
 
627
@sort_by: 
 
628
@collate: 
 
629
@array: 
 
630
@error: 
 
631
@Returns: 
 
632
 
 
633
 
 
634
<!-- ##### FUNCTION camel_db_get_folder_junk_uids ##### -->
 
635
<para>
 
636
 
 
637
</para>
 
638
 
 
639
@db: 
 
640
@folder_name: 
 
641
@error: 
 
642
@Returns: 
 
643
 
 
644
 
 
645
<!-- ##### FUNCTION camel_db_get_folder_deleted_uids ##### -->
 
646
<para>
 
647
 
 
648
</para>
 
649
 
 
650
@db: 
 
651
@folder_name: 
 
652
@error: 
 
653
@Returns: 
 
654
 
 
655
 
 
656
<!-- ##### FUNCTION camel_db_sqlize_string ##### -->
 
657
<para>
 
658
 
 
659
</para>
 
660
 
 
661
@string: 
 
662
@Returns: 
 
663
 
 
664
 
 
665
<!-- ##### FUNCTION camel_db_free_sqlized_string ##### -->
 
666
<para>
 
667
 
 
668
</para>
 
669
 
 
670
@string: 
 
671
 
 
672
 
 
673
<!-- ##### FUNCTION camel_db_get_column_name ##### -->
 
674
<para>
 
675
 
 
676
</para>
 
677
 
 
678
@raw_name: 
 
679
@Returns: 
 
680
 
 
681
 
 
682
<!-- ##### FUNCTION camel_db_set_collate ##### -->
 
683
<para>
 
684
 
 
685
</para>
 
686
 
 
687
@cdb: 
 
688
@col: 
 
689
@collate: 
 
690
@func: 
 
691
@Returns: 
 
692
 
 
693
 
 
694
<!-- ##### FUNCTION camel_db_migrate_vfolders_to_14 ##### -->
 
695
<para>
 
696
 
 
697
</para>
 
698
 
 
699
@cdb: 
 
700
@folder: 
 
701
@error: 
 
702
@Returns: 
 
703
 
 
704
 
 
705
<!-- ##### FUNCTION camel_db_start_in_memory_transactions ##### -->
 
706
<para>
 
707
 
 
708
</para>
 
709
 
 
710
@cdb: 
 
711
@error: 
 
712
@Returns: 
 
713
 
 
714
 
 
715
<!-- ##### FUNCTION camel_db_flush_in_memory_transactions ##### -->
 
716
<para>
 
717
 
 
718
</para>
 
719
 
 
720
@cdb: 
 
721
@folder_name: 
 
722
@error: 
 
723
@Returns: 
 
724
 
 
725
 
 
726
<!-- ##### FUNCTION camel_db_get_folder_preview ##### -->
 
727
<para>
 
728
 
 
729
</para>
 
730
 
 
731
@db: 
 
732
@folder_name: 
 
733
@error: 
 
734
@Returns: 
 
735
 
 
736
 
 
737
<!-- ##### FUNCTION camel_db_write_preview_record ##### -->
 
738
<para>
 
739
 
 
740
</para>
 
741
 
 
742
@db: 
 
743
@folder_name: 
 
744
@uid: 
 
745
@msg: 
 
746
@error: 
 
747
@Returns: 
 
748
 
 
749
 
 
750
<!-- ##### FUNCTION camel_db_reset_folder_version ##### -->
 
751
<para>
 
752
 
 
753
</para>
 
754
 
 
755
@cdb: 
 
756
@folder_name: 
 
757
@reset_version: 
 
758
@error: 
 
759
@Returns: 
 
760
 
 
761