← Back to branch summary

~ubuntu-branches/ubuntu/karmic/mergeant/karmic

« back to all changes in this revision

Viewing changes to doc/libmergeant/C/tmpl/mg-query.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo R. Montesino
  • Date: 2007-11-29 08:44:48 UTC
  • mfrom: (2.1.4 hardy)
  • Revision ID: james.westby@ubuntu.com-20071129084448-6aon73d22bv6hzfw
Tags: 0.67-3
* Re-enable installation of the mime files in mergeant.install
* mergeant.dirs: create usr/share/mime/packages to make dh_installmime add
  the update-mime-database code snippets

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/libmergeant/C/tmpl/mg-query.sgml
1
 
<!-- ##### SECTION Title ##### -->
2
 
MgQuery
3
 
 
4
 
<!-- ##### SECTION Short_Description ##### -->
5
 
Represents any kind of DML query
6
 
 
7
 
<!-- ##### SECTION Long_Description ##### -->
8
 
<para>
9
 
Any query (which can be of any type, see the #MgQueryType enum) can be represented by a #MgQuery object. Also a query may require some parameters
10
 
to be provided before in can be executed; each parameter is then represented by a #MgParameter object, and parameters required for a query
11
 
are organised within a #MgContext object.
12
 
</para>
13
 
<para>
14
 
It implements the #MgEntity, #MgXmlStorage, #MgReferer and #MgRenderer interfaces.
15
 
</para>
16
 
 
17
 
<!-- ##### SECTION See_Also ##### -->
18
 
<para>
19
 
 
20
 
</para>
21
 
 
22
 
<!-- ##### STRUCT MgQuery ##### -->
23
 
<para>
24
 
 
25
 
</para>
26
 
 
27
 
 
28
 
<!-- ##### SIGNAL MgQuery::condition-changed ##### -->
29
 
<para>
30
 
 
31
 
</para>
32
 
 
33
 
@mgquery: the object which received the signal.
34
 
 
35
 
<!-- ##### SIGNAL MgQuery::join-added ##### -->
36
 
<para>
37
 
 
38
 
</para>
39
 
 
40
 
@mgquery: the object which received the signal.
41
 
@arg1: 
42
 
 
43
 
<!-- ##### SIGNAL MgQuery::join-removed ##### -->
44
 
<para>
45
 
 
46
 
</para>
47
 
 
48
 
@mgquery: the object which received the signal.
49
 
@arg1: 
50
 
 
51
 
<!-- ##### SIGNAL MgQuery::join-updated ##### -->
52
 
<para>
53
 
 
54
 
</para>
55
 
 
56
 
@mgquery: the object which received the signal.
57
 
@arg1: 
58
 
 
59
 
<!-- ##### SIGNAL MgQuery::sub-query-added ##### -->
60
 
<para>
61
 
 
62
 
</para>
63
 
 
64
 
@mgquery: the object which received the signal.
65
 
@arg1: 
66
 
 
67
 
<!-- ##### SIGNAL MgQuery::sub-query-removed ##### -->
68
 
<para>
69
 
 
70
 
</para>
71
 
 
72
 
@mgquery: the object which received the signal.
73
 
@arg1: 
74
 
 
75
 
<!-- ##### SIGNAL MgQuery::sub-query-updated ##### -->
76
 
<para>
77
 
 
78
 
</para>
79
 
 
80
 
@mgquery: the object which received the signal.
81
 
@arg1: 
82
 
 
83
 
<!-- ##### SIGNAL MgQuery::target-added ##### -->
84
 
<para>
85
 
 
86
 
</para>
87
 
 
88
 
@mgquery: the object which received the signal.
89
 
@arg1: 
90
 
 
91
 
<!-- ##### SIGNAL MgQuery::target-removed ##### -->
92
 
<para>
93
 
 
94
 
</para>
95
 
 
96
 
@mgquery: the object which received the signal.
97
 
@arg1: 
98
 
 
99
 
<!-- ##### SIGNAL MgQuery::target-updated ##### -->
100
 
<para>
101
 
 
102
 
</para>
103
 
 
104
 
@mgquery: the object which received the signal.
105
 
@arg1: 
106
 
 
107
 
<!-- ##### SIGNAL MgQuery::type-changed ##### -->
108
 
<para>
109
 
 
110
 
</para>
111
 
 
112
 
@mgquery: the object which received the signal.
113
 
 
114
 
<!-- ##### ARG MgQuery:cond-serial ##### -->
115
 
<para>
116
 
 
117
 
</para>
118
 
 
119
 
<!-- ##### ARG MgQuery:field-serial ##### -->
120
 
<para>
121
 
 
122
 
</para>
123
 
 
124
 
<!-- ##### ARG MgQuery:really-all-fields ##### -->
125
 
<para>
126
 
 
127
 
</para>
128
 
 
129
 
<!-- ##### ARG MgQuery:target-serial ##### -->
130
 
<para>
131
 
 
132
 
</para>
133
 
 
134
 
<!-- ##### ENUM MgQueryType ##### -->
135
 
<para>
136
 
 
137
 
</para>
138
 
 
139
 
@MG_QUERY_TYPE_SELECT: 
140
 
@MG_QUERY_TYPE_INSERT: 
141
 
@MG_QUERY_TYPE_UPDATE: 
142
 
@MG_QUERY_TYPE_DELETE: 
143
 
@MG_QUERY_TYPE_UNION: Union of SELECT queries
144
 
@MG_QUERY_TYPE_INTERSECT: Intersection of SELECT queries
145
 
@MG_QUERY_TYPE_EXCEPT: A SELECT query minus another SELECT query
146
 
@MG_QUERY_TYPE_NON_PARSED_SQL: 
147
 
 
148
 
<!-- ##### FUNCTION mg_query_get_type ##### -->
149
 
<para>
150
 
 
151
 
</para>
152
 
 
153
 
@Returns: 
154
 
 
155
 
 
156
 
<!-- ##### FUNCTION mg_query_new ##### -->
157
 
<para>
158
 
 
159
 
</para>
160
 
 
161
 
@conf: 
162
 
@Returns: 
163
 
 
164
 
 
165
 
<!-- ##### FUNCTION mg_query_new_from_sql ##### -->
166
 
<para>
167
 
 
168
 
</para>
169
 
 
170
 
@conf: 
171
 
@sql: 
172
 
@error: 
173
 
@Returns: 
174
 
 
175
 
 
176
 
<!-- ##### FUNCTION mg_query_new_copy ##### -->
177
 
<para>
178
 
 
179
 
</para>
180
 
 
181
 
@orig: 
182
 
@replacements: 
183
 
@Returns: 
184
 
 
185
 
 
186
 
<!-- ##### FUNCTION mg_query_set_query_type ##### -->
187
 
<para>
188
 
 
189
 
</para>
190
 
 
191
 
@query: 
192
 
@type: 
193
 
 
194
 
 
195
 
<!-- ##### FUNCTION mg_query_get_query_type ##### -->
196
 
<para>
197
 
 
198
 
</para>
199
 
 
200
 
@query: 
201
 
@Returns: 
202
 
 
203
 
 
204
 
<!-- ##### FUNCTION mg_query_get_query_type_string ##### -->
205
 
<para>
206
 
 
207
 
</para>
208
 
 
209
 
@query: 
210
 
@Returns: 
211
 
 
212
 
 
213
 
<!-- ##### FUNCTION mg_query_is_select_query ##### -->
214
 
<para>
215
 
 
216
 
</para>
217
 
 
218
 
@query: 
219
 
@Returns: 
220
 
 
221
 
 
222
 
<!-- ##### FUNCTION mg_query_is_modif_query ##### -->
223
 
<para>
224
 
 
225
 
</para>
226
 
 
227
 
@query: 
228
 
@Returns: 
229
 
 
230
 
 
231
 
<!-- ##### FUNCTION mg_query_get_parent_query ##### -->
232
 
<para>
233
 
 
234
 
</para>
235
 
 
236
 
@query: 
237
 
@Returns: 
238
 
 
239
 
 
240
 
<!-- ##### FUNCTION mg_query_is_equal_to ##### -->
241
 
<para>
242
 
 
243
 
</para>
244
 
 
245
 
@query: 
246
 
@compare_to: 
247
 
@Returns: 
248
 
 
249
 
 
250
 
<!-- ##### FUNCTION mg_query_get_field_by_sql_naming ##### -->
251
 
<para>
252
 
 
253
 
</para>
254
 
 
255
 
@query: 
256
 
@sql_naming: 
257
 
@Returns: 
258
 
<!-- # Unused Parameters # -->
259
 
@sql_name: 
260
 
@sql_name: 
261
 
 
262
 
 
263
 
<!-- ##### FUNCTION mg_query_get_fields_by_target ##### -->
264
 
<para>
265
 
 
266
 
</para>
267
 
 
268
 
@query: 
269
 
@target: 
270
 
@visible_fields_only: 
271
 
@Returns: 
272
 
 
273
 
 
274
 
<!-- ##### FUNCTION mg_query_get_visible_field_by_ref_field ##### -->
275
 
<para>
276
 
 
277
 
</para>
278
 
 
279
 
@query: 
280
 
@target: 
281
 
@ref_field: 
282
 
@Returns: 
283
 
 
284
 
 
285
 
<!-- ##### FUNCTION mg_query_get_any_field_by_ref_field ##### -->
286
 
<para>
287
 
 
288
 
</para>
289
 
 
290
 
@query: 
291
 
@target: 
292
 
@ref_field: 
293
 
@Returns: 
294
 
 
295
 
 
296
 
<!-- ##### FUNCTION mg_query_set_sql_text ##### -->
297
 
<para>
298
 
 
299
 
</para>
300
 
 
301
 
@query: 
302
 
@sql: 
303
 
@error: 
304
 
 
305
 
 
306
 
<!-- ##### FUNCTION mg_query_get_sql_text ##### -->
307
 
<para>
308
 
 
309
 
</para>
310
 
 
311
 
@query: 
312
 
@Returns: 
313
 
 
314
 
 
315
 
<!-- ##### FUNCTION mg_query_get_sub_queries ##### -->
316
 
<para>
317
 
 
318
 
</para>
319
 
 
320
 
@query: 
321
 
@Returns: 
322
 
 
323
 
 
324
 
<!-- ##### FUNCTION mg_query_add_sub_query ##### -->
325
 
<para>
326
 
 
327
 
</para>
328
 
 
329
 
@query: 
330
 
@sub_query: 
331
 
 
332
 
 
333
 
<!-- ##### FUNCTION mg_query_del_sub_query ##### -->
334
 
<para>
335
 
 
336
 
</para>
337
 
 
338
 
@query: 
339
 
@sub_query: 
340
 
 
341
 
 
342
 
<!-- ##### FUNCTION mg_query_get_param_sources ##### -->
343
 
<para>
344
 
 
345
 
</para>
346
 
 
347
 
@query: 
348
 
@Returns: 
349
 
 
350
 
 
351
 
<!-- ##### FUNCTION mg_query_add_param_source ##### -->
352
 
<para>
353
 
 
354
 
</para>
355
 
 
356
 
@query: 
357
 
@param_source: 
358
 
 
359
 
 
360
 
<!-- ##### FUNCTION mg_query_del_param_source ##### -->
361
 
<para>
362
 
 
363
 
</para>
364
 
 
365
 
@query: 
366
 
@param_source: 
367
 
 
368
 
 
369
 
<!-- ##### FUNCTION mg_query_add_target ##### -->
370
 
<para>
371
 
 
372
 
</para>
373
 
 
374
 
@query: 
375
 
@target: 
376
 
@error: 
377
 
@Returns: 
378
 
 
379
 
 
380
 
<!-- ##### FUNCTION mg_query_del_target ##### -->
381
 
<para>
382
 
 
383
 
</para>
384
 
 
385
 
@query: 
386
 
@target: 
387
 
 
388
 
 
389
 
<!-- ##### FUNCTION mg_query_get_targets ##### -->
390
 
<para>
391
 
 
392
 
</para>
393
 
 
394
 
@query: 
395
 
@Returns: 
396
 
 
397
 
 
398
 
<!-- ##### FUNCTION mg_query_get_target_by_xml_id ##### -->
399
 
<para>
400
 
 
401
 
</para>
402
 
 
403
 
@query: 
404
 
@xml_id: 
405
 
@Returns: 
406
 
 
407
 
 
408
 
<!-- ##### FUNCTION mg_query_get_target_by_alias ##### -->
409
 
<para>
410
 
 
411
 
</para>
412
 
 
413
 
@query: 
414
 
@alias_or_name: 
415
 
@Returns: 
416
 
 
417
 
 
418
 
<!-- ##### FUNCTION mg_query_get_target_pkfields ##### -->
419
 
<para>
420
 
 
421
 
</para>
422
 
 
423
 
@query: 
424
 
@target: 
425
 
@Returns: 
426
 
 
427
 
 
428
 
<!-- ##### FUNCTION mg_query_get_joins ##### -->
429
 
<para>
430
 
 
431
 
</para>
432
 
 
433
 
@query: 
434
 
@Returns: 
435
 
 
436
 
 
437
 
<!-- ##### FUNCTION mg_query_get_join_by_targets ##### -->
438
 
<para>
439
 
 
440
 
</para>
441
 
 
442
 
@query: 
443
 
@target1: 
444
 
@target2: 
445
 
@Returns: 
446
 
 
447
 
 
448
 
<!-- ##### FUNCTION mg_query_add_join ##### -->
449
 
<para>
450
 
 
451
 
</para>
452
 
 
453
 
@query: 
454
 
@join: 
455
 
@Returns: 
456
 
 
457
 
 
458
 
<!-- ##### FUNCTION mg_query_del_join ##### -->
459
 
<para>
460
 
 
461
 
</para>
462
 
 
463
 
@query: 
464
 
@join: 
465
 
 
466
 
 
467
 
<!-- ##### FUNCTION mg_query_set_condition ##### -->
468
 
<para>
469
 
 
470
 
</para>
471
 
 
472
 
@query: 
473
 
@cond: 
474
 
 
475
 
 
476
 
<!-- ##### FUNCTION mg_query_get_condition ##### -->
477
 
<para>
478
 
 
479
 
</para>
480
 
 
481
 
@query: 
482
 
@Returns: 
483
 
 
484
 
 
485
 
<!-- ##### FUNCTION mg_query_get_main_conditions ##### -->
486
 
<para>
487
 
 
488
 
</para>
489
 
 
490
 
@query: 
491
 
@Returns: 
492
 
 
493
 
 
494
 
<!-- ##### FUNCTION mg_query_set_order_by_field ##### -->
495
 
<para>
496
 
 
497
 
</para>
498
 
 
499
 
@query: 
500
 
@field: 
501
 
@order: 
502
 
@ascendant: 
503
 
 
504
 
 
505
 
<!-- ##### FUNCTION mg_query_get_order_by_field ##### -->
506
 
<para>
507
 
 
508
 
</para>
509
 
 
510
 
@query: 
511
 
@field: 
512
 
@ascendant: 
513
 
@Returns: 
514
 
 
515
 
 
516
 
<!-- ##### FUNCTION mg_query_expand_all_field ##### -->
517
 
<para>
518
 
 
519
 
</para>
520
 
 
521
 
@query: 
522
 
@target: 
523
 
@Returns: 
524
 
 
525
 
 
526
 
<!-- ##### FUNCTION mg_query_order_fields_using_join_conds ##### -->
527
 
<para>
528
 
 
529
 
</para>
530
 
 
531
 
@query: 
532
 
 
533