/usr/share/gtk-doc/html/libgda-4.0/GdaMetaStruct.html is in libgda-4.0-doc 4.2.8-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaMetaStruct</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GNOME Data Access 4 manual">
<link rel="up" href="gda-dict.html" title="Dictionary - metadata">
<link rel="prev" href="GdaMetaStore.html" title="GdaMetaStore">
<link rel="next" href="ch20.html" title="Data definition (DDL) queries">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GdaMetaStore.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gda-dict.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Data Access 4 manual</th>
<td><a accesskey="n" href="ch20.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdaMetaStruct.synopsis" class="shortcut">Top</a>
|
<a href="#GdaMetaStruct.description" class="shortcut">Description</a>
|
<a href="#GdaMetaStruct.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdaMetaStruct.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdaMetaStruct"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaMetaStruct.top_of_page"></a>GdaMetaStruct</span></h2>
<p>GdaMetaStruct — In memory representation of some database objects</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdaMetaStruct.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GdaMetaStruct.html#GdaMetaStruct-struct" title="GdaMetaStruct">GdaMetaStruct</a>;
enum <a class="link" href="GdaMetaStruct.html#GdaMetaStructFeature" title="enum GdaMetaStructFeature">GdaMetaStructFeature</a>;
enum <a class="link" href="GdaMetaStruct.html#GdaMetaStructError" title="enum GdaMetaStructError">GdaMetaStructError</a>;
enum <a class="link" href="GdaMetaStruct.html#GdaMetaDbObjectType" title="enum GdaMetaDbObjectType">GdaMetaDbObjectType</a>;
<a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject">GdaMetaDbObject</a>;
#define <a class="link" href="GdaMetaStruct.html#GDA-META-DB-OBJECT:CAPS" title="GDA_META_DB_OBJECT()">GDA_META_DB_OBJECT</a> (dbo)
#define <a class="link" href="GdaMetaStruct.html#GDA-META-TABLE:CAPS" title="GDA_META_TABLE()">GDA_META_TABLE</a> (dbobj)
#define <a class="link" href="GdaMetaStruct.html#GDA-META-VIEW:CAPS" title="GDA_META_VIEW()">GDA_META_VIEW</a> (dbobj)
<a class="link" href="GdaMetaStruct.html#GdaMetaTable" title="GdaMetaTable">GdaMetaTable</a>;
<a class="link" href="GdaMetaStruct.html#GdaMetaView" title="GdaMetaView">GdaMetaView</a>;
<a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn">GdaMetaTableColumn</a>;
#define <a class="link" href="GdaMetaStruct.html#GDA-META-TABLE-COLUMN:CAPS" title="GDA_META_TABLE_COLUMN()">GDA_META_TABLE_COLUMN</a> (col)
const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * <a class="link" href="GdaMetaStruct.html#gda-meta-table-column-get-attribute" title="gda_meta_table_column_get_attribute ()">gda_meta_table_column_get_attribute</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a> *tcol</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdaMetaStruct.html#gda-meta-table-column-set-attribute" title="gda_meta_table_column_set_attribute ()">gda_meta_table_column_set_attribute</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a> *tcol</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);
#define <a class="link" href="GdaMetaStruct.html#gda-meta-table-column-set-attribute-static" title="gda_meta_table_column_set_attribute_static()">gda_meta_table_column_set_attribute_static</a>(column,
attribute,
value)
<span class="returnvalue">void</span> <a class="link" href="GdaMetaStruct.html#gda-meta-table-column-foreach-attribute" title="gda_meta_table_column_foreach_attribute ()">gda_meta_table_column_foreach_attribute</a>
(<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a> *tcol</code></em>,
<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManagerFunc" title="GdaAttributesManagerFunc ()"><span class="type">GdaAttributesManagerFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
enum <a class="link" href="GdaMetaStruct.html#GdaMetaForeignKeyPolicy" title="enum GdaMetaForeignKeyPolicy">GdaMetaForeignKeyPolicy</a>;
<a class="link" href="GdaMetaStruct.html#GdaMetaTableForeignKey" title="GdaMetaTableForeignKey">GdaMetaTableForeignKey</a>;
#define <a class="link" href="GdaMetaStruct.html#GDA-META-TABLE-FOREIGN-KEY:CAPS" title="GDA_META_TABLE_FOREIGN_KEY()">GDA_META_TABLE_FOREIGN_KEY</a> (fk)
#define <a class="link" href="GdaMetaStruct.html#GDA-META-TABLE-FOREIGN-KEY-ON-UPDATE-POLICY:CAPS" title="GDA_META_TABLE_FOREIGN_KEY_ON_UPDATE_POLICY()">GDA_META_TABLE_FOREIGN_KEY_ON_UPDATE_POLICY</a>(fk)
#define <a class="link" href="GdaMetaStruct.html#GDA-META-TABLE-FOREIGN-KEY-ON-DELETE-POLICY:CAPS" title="GDA_META_TABLE_FOREIGN_KEY_ON_DELETE_POLICY()">GDA_META_TABLE_FOREIGN_KEY_ON_DELETE_POLICY</a>(fk)
#define <a class="link" href="GdaMetaStruct.html#GDA-META-TABLE-FOREIGN-KEY-IS-DECLARED:CAPS" title="GDA_META_TABLE_FOREIGN_KEY_IS_DECLARED()">GDA_META_TABLE_FOREIGN_KEY_IS_DECLARED</a>(fk)
#define <a class="link" href="GdaMetaStruct.html#GDA-META-STRUCT-ERROR:CAPS" title="GDA_META_STRUCT_ERROR">GDA_META_STRUCT_ERROR</a>
<a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="returnvalue">GdaMetaStruct</span></a> * <a class="link" href="GdaMetaStruct.html#gda-meta-struct-new" title="gda_meta_struct_new ()">gda_meta_struct_new</a> (<em class="parameter"><code><a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a> *store</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaStructFeature" title="enum GdaMetaStructFeature"><span class="type">GdaMetaStructFeature</span></a> features</code></em>);
<a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="returnvalue">GdaMetaDbObject</span></a> * <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement" title="gda_meta_struct_complement ()">gda_meta_struct_complement</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaDbObjectType" title="enum GdaMetaDbObjectType"><span class="type">GdaMetaDbObjectType</span></a> type</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *catalog</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *schema</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement-schema" title="gda_meta_struct_complement_schema ()">gda_meta_struct_complement_schema</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *catalog</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *schema</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement-default" title="gda_meta_struct_complement_default ()">gda_meta_struct_complement_default</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement-all" title="gda_meta_struct_complement_all ()">gda_meta_struct_complement_all</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement-depend" title="gda_meta_struct_complement_depend ()">gda_meta_struct_complement_depend</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> *dbo</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
enum <a class="link" href="GdaMetaStruct.html#GdaMetaSortType" title="enum GdaMetaSortType">GdaMetaSortType</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaMetaStruct.html#gda-meta-struct-sort-db-objects" title="gda_meta_struct_sort_db_objects ()">gda_meta_struct_sort_db_objects</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaSortType" title="enum GdaMetaSortType"><span class="type">GdaMetaSortType</span></a> sort_type</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="GdaMetaStruct.html#gda-meta-struct-get-all-db-objects" title="gda_meta_struct_get_all_db_objects ()">gda_meta_struct_get_all_db_objects</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>);
<a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="returnvalue">GdaMetaDbObject</span></a> * <a class="link" href="GdaMetaStruct.html#gda-meta-struct-get-db-object" title="gda_meta_struct_get_db_object ()">gda_meta_struct_get_db_object</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *catalog</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *schema</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *name</code></em>);
<a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="returnvalue">GdaMetaTableColumn</span></a> * <a class="link" href="GdaMetaStruct.html#gda-meta-struct-get-table-column" title="gda_meta_struct_get_table_column ()">gda_meta_struct_get_table_column</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaTable" title="GdaMetaTable"><span class="type">GdaMetaTable</span></a> *table</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *col_name</code></em>);
enum <a class="link" href="GdaMetaStruct.html#GdaMetaGraphInfo" title="enum GdaMetaGraphInfo">GdaMetaGraphInfo</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GdaMetaStruct.html#gda-meta-struct-dump-as-graph" title="gda_meta_struct_dump_as_graph ()">gda_meta_struct_dump_as_graph</a> (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaGraphInfo" title="enum GdaMetaGraphInfo"><span class="type">GdaMetaGraphInfo</span></a> info</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdaMetaStruct.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----GdaMetaStruct
</pre>
</div>
<div class="refsect1">
<a name="GdaMetaStruct.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GdaMetaStruct.html#GdaMetaStruct--features" title='The "features" property'>features</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct Only
"<a class="link" href="GdaMetaStruct.html#GdaMetaStruct--meta-store" title='The "meta-store" property'>meta-store</a>" <a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="GdaMetaStruct.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object reads data from a <a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a> object and
creates an easy to use in memory representation for some database objects. For example one can easily
analyze the columns of a table (or its foreign keys) using a <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a>.
</p>
<p>
When created, the new <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object is empty (it does not have any information about any database object).
Information about database objects is computed upon request using the <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement" title="gda_meta_struct_complement ()"><code class="function">gda_meta_struct_complement()</code></a> method. Information
about individual database objects is represented by <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> structures, which can be obtained using
<a class="link" href="GdaMetaStruct.html#gda-meta-struct-get-db-object" title="gda_meta_struct_get_db_object ()"><code class="function">gda_meta_struct_get_db_object()</code></a> or <a class="link" href="GdaMetaStruct.html#gda-meta-struct-get-all-db-objects" title="gda_meta_struct_get_all_db_objects ()"><code class="function">gda_meta_struct_get_all_db_objects()</code></a>.
</p>
<p>
Note that the <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> structures may change or may be removed or replaced by others, so it not
advised to keep pointers to these structures: pointers to these structures should be considered valid
as long as <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement" title="gda_meta_struct_complement ()"><code class="function">gda_meta_struct_complement()</code></a> and other similar functions have not been called.
</p>
<p>
In the following code sample, one prints the columns names and types of a table:
</p>
<pre class="programlisting">
GdaMetaStruct *mstruct;
GdaMetaDbObject *dbo;
GValue *catalog, *schema, *name;
/* Define name (and optionnally catalog and schema) */
[...]
mstruct = gda_meta_struct_new ();
gda_meta_struct_complement (mstruct, store, GDA_META_DB_TABLE, catalog, schema, name, NULL);
dbo = gda_meta_struct_get_db_object (mstruct, catalog, schema, name);
if (!dbo)
g_print ("Table not found\n");
else {
GSList *list;
for (list = GDA_META_TABLE (dbo)->columns; list; list = list->next) {
GdaMetaTableColumn *tcol = GDA_META_TABLE_COLUMN (list->data);
g_print ("COLUMN: %s (%s)\n", tcol->column_name, tcol->column_type);
}
}
gda_meta_struct_free (mstruct);
</pre>
<p>
If now the database object type is not known, one can use the following code:
</p>
<pre class="programlisting">
GdaMetaStruct *mstruct;
GdaMetaDbObject *dbo;
GValue *catalog, *schema, *name;
/* Define name (and optionnally catalog and schema) */
[...]
mstruct = gda_meta_struct_new ();
gda_meta_struct_complement (mstruct, store, GDA_META_DB_UNKNOWN, catalog, schema, name, NULL);
dbo = gda_meta_struct_get_db_object (mstruct, catalog, schema, name);
if (!dbo)
g_print ("Object not found\n");
else {
if ((dbo->obj_type == GDA_META_DB_TABLE) || (dbo->obj_type == GDA_META_DB_VIEW)) {
if (dbo->obj_type == GDA_META_DB_TABLE)
g_print ("Is a table\n");
else if (dbo->obj_type == GDA_META_DB_VIEW) {
g_print ("Is a view, definition is:\n");
g_print ("%s\n", GDA_META_VIEW (dbo)->view_def);
}
GSList *list;
for (list = GDA_META_TABLE (dbo)->columns; list; list = list->next) {
GdaMetaTableColumn *tcol = GDA_META_TABLE_COLUMN (list->data);
g_print ("COLUMN: %s (%s)\n", tcol->column_name, tcol->column_type);
}
}
else
g_print ("Not a table or a view\n");
}
gda_meta_struct_free (mstruct);
</pre>
<p>
</p>
</div>
<div class="refsect1">
<a name="GdaMetaStruct.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaMetaStruct-struct"></a><h3>GdaMetaStruct</h3>
<pre class="programlisting">typedef struct _GdaMetaStruct GdaMetaStruct;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaStructFeature"></a><h3>enum GdaMetaStructFeature</h3>
<pre class="programlisting">typedef enum {
GDA_META_STRUCT_FEATURE_NONE = 0,
GDA_META_STRUCT_FEATURE_FOREIGN_KEYS = 1 << 0,
GDA_META_STRUCT_FEATURE_VIEW_DEPENDENCIES = 1 << 1,
GDA_META_STRUCT_FEATURE_ALL = GDA_META_STRUCT_FEATURE_FOREIGN_KEYS |
GDA_META_STRUCT_FEATURE_VIEW_DEPENDENCIES
} GdaMetaStructFeature;
</pre>
<p>
Controls which features are computed about database objects.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GDA-META-STRUCT-FEATURE-NONE:CAPS"></a><span class="term"><code class="literal">GDA_META_STRUCT_FEATURE_NONE</code></span></p></td>
<td>database objects only have their own attributes
</td>
</tr>
<tr>
<td><p><a name="GDA-META-STRUCT-FEATURE-FOREIGN-KEYS:CAPS"></a><span class="term"><code class="literal">GDA_META_STRUCT_FEATURE_FOREIGN_KEYS</code></span></p></td>
<td>foreign keys are computed for tables
</td>
</tr>
<tr>
<td><p><a name="GDA-META-STRUCT-FEATURE-VIEW-DEPENDENCIES:CAPS"></a><span class="term"><code class="literal">GDA_META_STRUCT_FEATURE_VIEW_DEPENDENCIES</code></span></p></td>
<td>for views, the tables they use are also computed
</td>
</tr>
<tr>
<td><p><a name="GDA-META-STRUCT-FEATURE-ALL:CAPS"></a><span class="term"><code class="literal">GDA_META_STRUCT_FEATURE_ALL</code></span></p></td>
<td>all the features are computed
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaStructError"></a><h3>enum GdaMetaStructError</h3>
<pre class="programlisting">typedef enum {
GDA_META_STRUCT_UNKNOWN_OBJECT_ERROR,
GDA_META_STRUCT_DUPLICATE_OBJECT_ERROR,
GDA_META_STRUCT_INCOHERENCE_ERROR
} GdaMetaStructError;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaDbObjectType"></a><h3>enum GdaMetaDbObjectType</h3>
<pre class="programlisting">typedef enum {
GDA_META_DB_UNKNOWN,
GDA_META_DB_TABLE,
GDA_META_DB_VIEW
} GdaMetaDbObjectType;
</pre>
<p>
Type of database object which can be handled as a <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GDA-META-DB-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GDA_META_DB_UNKNOWN</code></span></p></td>
<td>unknown type
</td>
</tr>
<tr>
<td><p><a name="GDA-META-DB-TABLE:CAPS"></a><span class="term"><code class="literal">GDA_META_DB_TABLE</code></span></p></td>
<td>represents a table
</td>
</tr>
<tr>
<td><p><a name="GDA-META-DB-VIEW:CAPS"></a><span class="term"><code class="literal">GDA_META_DB_VIEW</code></span></p></td>
<td>represents a view
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaDbObject"></a><h3>GdaMetaDbObject</h3>
<pre class="programlisting">typedef struct {
union {
GdaMetaTable meta_table;
GdaMetaView meta_view;
} extra;
GdaMetaDbObjectType obj_type;
gboolean outdated;
gchar *obj_catalog;
gchar *obj_schema;
gchar *obj_name;
gchar *obj_short_name;
gchar *obj_full_name;
gchar *obj_owner;
GSList *depend_list;
} GdaMetaDbObject;
</pre>
<p>
Struture to hold information about each database object (tables, views, ...),
its contents must not be modified.
</p>
<p>
Note: <em class="parameter"><code>obj_catalog</code></em>, <em class="parameter"><code>obj_schema</code></em>, <em class="parameter"><code>obj_name</code></em>, <em class="parameter"><code>obj_short_name</code></em> and <em class="parameter"><code>obj_full_name</code></em> respect the
<a class="link" href="information_schema.html#information_schema:sql_identifiers" title="SQL identifiers">SQL identifiers</a> convention used in
<a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a> objects. Before using these SQL identifiers, you should check the
<a class="link" href="GdaSqlParser.html#gda-sql-identifier-quote" title="gda_sql_identifier_quote ()"><code class="function">gda_sql_identifier_quote()</code></a> to know if is it is necessary to surround by double quotes
before using in an SQL statement.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="GdaMetaStruct.html#GdaMetaDbObjectType" title="enum GdaMetaDbObjectType"><span class="type">GdaMetaDbObjectType</span></a> <em class="structfield"><code><a name="GdaMetaDbObject.obj-type"></a>obj_type</code></em>;</span></p></td>
<td>the type of object (table, view)</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GdaMetaDbObject.outdated"></a>outdated</code></em>;</span></p></td>
<td>set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the information in this <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> may be outdated because the <a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a> has been updated</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaMetaDbObject.obj-catalog"></a>obj_catalog</code></em>;</span></p></td>
<td>the catalog the object is in</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaMetaDbObject.obj-schema"></a>obj_schema</code></em>;</span></p></td>
<td>the schema the object is in</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaMetaDbObject.obj-name"></a>obj_name</code></em>;</span></p></td>
<td>the object's name</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaMetaDbObject.obj-short-name"></a>obj_short_name</code></em>;</span></p></td>
<td>the shortest way to name the object</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaMetaDbObject.obj-full-name"></a>obj_full_name</code></em>;</span></p></td>
<td>the full name of the object (in the <schema>.<nameagt; notation</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaMetaDbObject.obj-owner"></a>obj_owner</code></em>;</span></p></td>
<td>object's owner</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *<em class="structfield"><code><a name="GdaMetaDbObject.depend-list"></a>depend_list</code></em>;</span></p></td>
<td>list of <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> pointers on which this object depends (through foreign keys
or tables used for views)</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GDA-META-DB-OBJECT:CAPS"></a><h3>GDA_META_DB_OBJECT()</h3>
<pre class="programlisting">#define GDA_META_DB_OBJECT(dbo) ((GdaMetaDbObject*)(dbo))
</pre>
<p>
Casts <em class="parameter"><code>dbo</code></em> to a <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a>, no check is made on the validity of <em class="parameter"><code>dbo</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dbo</code></em> :</span></p></td>
<td>a pointer</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to a <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GDA-META-TABLE:CAPS"></a><h3>GDA_META_TABLE()</h3>
<pre class="programlisting">#define GDA_META_TABLE(dbobj) (&((dbobj)->extra.meta_table))
</pre>
<p>
Casts <em class="parameter"><code>dbo</code></em> to a <a class="link" href="GdaMetaStruct.html#GdaMetaTable" title="GdaMetaTable"><span class="type">GdaMetaTable</span></a>, no check is made on the validity of <em class="parameter"><code>dbo</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to a <a class="link" href="GdaMetaStruct.html#GdaMetaTable" title="GdaMetaTable"><span class="type">GdaMetaTable</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GDA-META-VIEW:CAPS"></a><h3>GDA_META_VIEW()</h3>
<pre class="programlisting">#define GDA_META_VIEW(dbobj) (&((dbobj)->extra.meta_view))
</pre>
<p>
Casts <em class="parameter"><code>dbo</code></em> to a <a class="link" href="GdaMetaStruct.html#GdaMetaView" title="GdaMetaView"><span class="type">GdaMetaView</span></a>, no check is made on the validity of <em class="parameter"><code>dbo</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to a <a class="link" href="GdaMetaStruct.html#GdaMetaView" title="GdaMetaView"><span class="type">GdaMetaView</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaTable"></a><h3>GdaMetaTable</h3>
<pre class="programlisting">typedef struct {
GSList *columns;
/* PK fields index */
gint *pk_cols_array;
gint pk_cols_nb;
/* Foreign keys */
GSList *reverse_fk_list; /* list of GdaMetaTableForeignKey where @depend_on == this GdaMetaDbObject */
GSList *fk_list; /* list of GdaMetaTableForeignKey where @meta_table == this GdaMetaDbObject */
} GdaMetaTable;
</pre>
<p>
This structure specifies a <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> to represent a table's specific attributes,
its contents must not be modified.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *<em class="structfield"><code><a name="GdaMetaTable.columns"></a>columns</code></em>;</span></p></td>
<td>list of <a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a> structures, one for each column in the table</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *<em class="structfield"><code><a name="GdaMetaTable.pk-cols-array"></a>pk_cols_array</code></em>;</span></p></td>
<td>index of the columns part of the primary key for the table (WARNING: columns numbering
here start at 0)</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GdaMetaTable.pk-cols-nb"></a>pk_cols_nb</code></em>;</span></p></td>
<td>size of the <em class="parameter"><code>pk_cols_array</code></em> array</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *<em class="structfield"><code><a name="GdaMetaTable.reverse-fk-list"></a>reverse_fk_list</code></em>;</span></p></td>
<td>list of <a class="link" href="GdaMetaStruct.html#GdaMetaTableForeignKey" title="GdaMetaTableForeignKey"><span class="type">GdaMetaTableForeignKey</span></a> where the referenced table is this table</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *<em class="structfield"><code><a name="GdaMetaTable.fk-list"></a>fk_list</code></em>;</span></p></td>
<td>list of <a class="link" href="GdaMetaStruct.html#GdaMetaTableForeignKey" title="GdaMetaTableForeignKey"><span class="type">GdaMetaTableForeignKey</span></a> for this table</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaView"></a><h3>GdaMetaView</h3>
<pre class="programlisting">typedef struct {
GdaMetaTable table;
gchar *view_def;
gboolean is_updatable;
} GdaMetaView;
</pre>
<p>
This structure specifies a <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> to represent a view's specific attributes,
its contents must not be modified.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="GdaMetaStruct.html#GdaMetaTable" title="GdaMetaTable"><span class="type">GdaMetaTable</span></a> <em class="structfield"><code><a name="GdaMetaView.table"></a>table</code></em>;</span></p></td>
<td>a view is also a table as it has columns</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaMetaView.view-def"></a>view_def</code></em>;</span></p></td>
<td>views' definition</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GdaMetaView.is-updatable"></a>is_updatable</code></em>;</span></p></td>
<td>tells if the view's contents can be updated</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaTableColumn"></a><h3>GdaMetaTableColumn</h3>
<pre class="programlisting">typedef struct {
gchar *column_name;
gchar *column_type;
GType gtype;
gboolean pkey;
gboolean nullok;
gchar *default_value;
} GdaMetaTableColumn;
</pre>
<p>
This structure represents a table of view's column, its contents must not be modified.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaMetaTableColumn.column-name"></a>column_name</code></em>;</span></p></td>
<td>the column's name</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaMetaTableColumn.column-type"></a>column_type</code></em>;</span></p></td>
<td>the column's DBMS's type</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> <em class="structfield"><code><a name="GdaMetaTableColumn.gtype"></a>gtype</code></em>;</span></p></td>
<td>the detected column's <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GdaMetaTableColumn.pkey"></a>pkey</code></em>;</span></p></td>
<td>tells if the column is part of a primary key</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GdaMetaTableColumn.nullok"></a>nullok</code></em>;</span></p></td>
<td>tells if the column can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaMetaTableColumn.default-value"></a>default_value</code></em>;</span></p></td>
<td>the column's default value</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GDA-META-TABLE-COLUMN:CAPS"></a><h3>GDA_META_TABLE_COLUMN()</h3>
<pre class="programlisting">#define GDA_META_TABLE_COLUMN(col) ((GdaMetaTableColumn*)(col))
</pre>
<p>
Casts <em class="parameter"><code>col</code></em> to a <a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a>, no check is made
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>a pointer</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<em class="parameter"><code>col</code></em>, casted to a <a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-table-column-get-attribute"></a><h3>gda_meta_table_column_get_attribute ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * gda_meta_table_column_get_attribute (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a> *tcol</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute</code></em>);</pre>
<p>
Get the value associated to a named attribute.
</p>
<p>
Attributes can have any name, but Libgda proposes some default names, see this section.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tcol</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
<td>attribute name as a string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a read-only <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not attribute named <em class="parameter"><code>attribute</code></em> has been set for <em class="parameter"><code>column</code></em>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-table-column-set-attribute"></a><h3>gda_meta_table_column_set_attribute ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_meta_table_column_set_attribute (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a> *tcol</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
<p>
Set the value associated to a named attribute.
</p>
<p>
Attributes can have any name, but Libgda proposes some default names, see this section.
If there is already an attribute named <em class="parameter"><code>attribute</code></em> set, then its value is replaced with the new <em class="parameter"><code>value</code></em>,
except if <em class="parameter"><code>value</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, in which case the attribute is removed.
</p>
<p>
Warning: <em class="parameter"><code>attribute</code></em> is not copied, if it needs to be freed when not used anymore, then <em class="parameter"><code>destroy</code></em> should point to
the functions which will free it (typically <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>). If <em class="parameter"><code>attribute</code></em> does not need to be freed, then <em class="parameter"><code>destroy</code></em> can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tcol</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
<td>attribute name as a static string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
<td>function called when <em class="parameter"><code>attribute</code></em> has to be freed, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-table-column-set-attribute-static"></a><h3>gda_meta_table_column_set_attribute_static()</h3>
<pre class="programlisting">#define gda_meta_table_column_set_attribute_static(column,attribute,value) gda_meta_table_column_set_attribute((column),(attribute),(value),NULL)
</pre>
<p>
This function is similar to <a class="link" href="GdaMetaStruct.html#gda-meta-table-column-set-attribute" title="gda_meta_table_column_set_attribute ()"><code class="function">gda_meta_table_column_set_attribute()</code></a> but for static strings
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>column</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
<td>attribute's name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-table-column-foreach-attribute"></a><h3>gda_meta_table_column_foreach_attribute ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_meta_table_column_foreach_attribute
(<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a> *tcol</code></em>,
<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManagerFunc" title="GdaAttributesManagerFunc ()"><span class="type">GdaAttributesManagerFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
Calls <em class="parameter"><code>func</code></em> for each attribute set to tcol
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tcol</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManagerFunc" title="GdaAttributesManagerFunc ()"><span class="type">GdaAttributesManagerFunc</span></a> function. <span class="annotation">[<a href="http://foldoc.org/scope%20call"><span class="acronym">scope call</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>user data to be passed as last argument of <em class="parameter"><code>func</code></em> each time it is called. <span class="annotation">[<a href="http://foldoc.org/closure"><span class="acronym">closure</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaForeignKeyPolicy"></a><h3>enum GdaMetaForeignKeyPolicy</h3>
<pre class="programlisting">typedef enum {
GDA_META_FOREIGN_KEY_UNKNOWN,
GDA_META_FOREIGN_KEY_NONE,
GDA_META_FOREIGN_KEY_NO_ACTION,
GDA_META_FOREIGN_KEY_RESTRICT,
GDA_META_FOREIGN_KEY_CASCADE,
GDA_META_FOREIGN_KEY_SET_NULL,
GDA_META_FOREIGN_KEY_SET_DEFAULT
} GdaMetaForeignKeyPolicy;
</pre>
<p>
Defines the filtering policy of a foreign key when invoked on an UPDATE
or DELETE operation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GDA-META-FOREIGN-KEY-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GDA_META_FOREIGN_KEY_UNKNOWN</code></span></p></td>
<td>unspecified policy
</td>
</tr>
<tr>
<td><p><a name="GDA-META-FOREIGN-KEY-NONE:CAPS"></a><span class="term"><code class="literal">GDA_META_FOREIGN_KEY_NONE</code></span></p></td>
<td>not enforced policy
</td>
</tr>
<tr>
<td><p><a name="GDA-META-FOREIGN-KEY-NO-ACTION:CAPS"></a><span class="term"><code class="literal">GDA_META_FOREIGN_KEY_NO_ACTION</code></span></p></td>
<td>return an error, no action taken
</td>
</tr>
<tr>
<td><p><a name="GDA-META-FOREIGN-KEY-RESTRICT:CAPS"></a><span class="term"><code class="literal">GDA_META_FOREIGN_KEY_RESTRICT</code></span></p></td>
<td>same as <em class="parameter"><code>GDA_META_FOREIGN_KEY_NO_ACTION</code></em>, not deferrable
</td>
</tr>
<tr>
<td><p><a name="GDA-META-FOREIGN-KEY-CASCADE:CAPS"></a><span class="term"><code class="literal">GDA_META_FOREIGN_KEY_CASCADE</code></span></p></td>
<td>policy is to delete any rows referencing the deleted row, or update the value of the referencing column to the new value of the referenced column, respectively
</td>
</tr>
<tr>
<td><p><a name="GDA-META-FOREIGN-KEY-SET-NULL:CAPS"></a><span class="term"><code class="literal">GDA_META_FOREIGN_KEY_SET_NULL</code></span></p></td>
<td>policy is to set the referencing column to NULL
</td>
</tr>
<tr>
<td><p><a name="GDA-META-FOREIGN-KEY-SET-DEFAULT:CAPS"></a><span class="term"><code class="literal">GDA_META_FOREIGN_KEY_SET_DEFAULT</code></span></p></td>
<td>policy is to set the referencing column to its default value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaTableForeignKey"></a><h3>GdaMetaTableForeignKey</h3>
<pre class="programlisting">typedef struct {
GdaMetaDbObject *meta_table;
GdaMetaDbObject *depend_on;
gint cols_nb;
gint *fk_cols_array; /* FK fields index */
gchar **fk_names_array; /* FK fields names */
gint *ref_pk_cols_array; /* Ref PK fields index */
gchar **ref_pk_names_array; /* Ref PK fields names */
gchar *fk_name;
} GdaMetaTableForeignKey;
</pre>
<p>
This structure represents a foreign key constraint, its contents must not be modified.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> *<em class="structfield"><code><a name="GdaMetaTableForeignKey.meta-table"></a>meta_table</code></em>;</span></p></td>
<td>the <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> for which this structure represents a foreign key</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> *<em class="structfield"><code><a name="GdaMetaTableForeignKey.depend-on"></a>depend_on</code></em>;</span></p></td>
<td>the <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> which is referenced by the foreign key</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GdaMetaTableForeignKey.cols-nb"></a>cols_nb</code></em>;</span></p></td>
<td>the size of the <em class="parameter"><code>fk_cols_array</code></em>, <em class="parameter"><code>fk_names_array</code></em>, <em class="parameter"><code>ref_pk_cols_array</code></em> and <em class="parameter"><code>ref_pk_names_array</code></em> arrays</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *<em class="structfield"><code><a name="GdaMetaTableForeignKey.fk-cols-array"></a>fk_cols_array</code></em>;</span></p></td>
<td>the columns' indexes in <em class="parameter"><code>meta_table</code></em> which participate in the constraint (WARNING: columns numbering
here start at 1)</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **<em class="structfield"><code><a name="GdaMetaTableForeignKey.fk-names-array"></a>fk_names_array</code></em>;</span></p></td>
<td>the columns' names in <em class="parameter"><code>meta_table</code></em> which participate in the constraint</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *<em class="structfield"><code><a name="GdaMetaTableForeignKey.ref-pk-cols-array"></a>ref_pk_cols_array</code></em>;</span></p></td>
<td>the columns' indexes in <em class="parameter"><code>depend_on</code></em> which participate in the constraint (WARNING: columns numbering
here start at 1)</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **<em class="structfield"><code><a name="GdaMetaTableForeignKey.ref-pk-names-array"></a>ref_pk_names_array</code></em>;</span></p></td>
<td>the columns' names in <em class="parameter"><code>depend_on</code></em> which participate in the constraint</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaMetaTableForeignKey.fk-name"></a>fk_name</code></em>;</span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GDA-META-TABLE-FOREIGN-KEY:CAPS"></a><h3>GDA_META_TABLE_FOREIGN_KEY()</h3>
<pre class="programlisting">#define GDA_META_TABLE_FOREIGN_KEY(fk) ((GdaMetaTableForeignKey*)(fk))
</pre>
<p>
Casts <em class="parameter"><code>fk</code></em> to a <a class="link" href="GdaMetaStruct.html#GdaMetaTableForeignKey" title="GdaMetaTableForeignKey"><span class="type">GdaMetaTableForeignKey</span></a> (no check is actuelly being done on <em class="parameter"><code>fk</code></em>'s validity)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fk</code></em> :</span></p></td>
<td>a pointer</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<em class="parameter"><code>col</code></em>, casted to a <a class="link" href="GdaMetaStruct.html#GdaMetaTableForeignKey" title="GdaMetaTableForeignKey"><span class="type">GdaMetaTableForeignKey</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GDA-META-TABLE-FOREIGN-KEY-ON-UPDATE-POLICY:CAPS"></a><h3>GDA_META_TABLE_FOREIGN_KEY_ON_UPDATE_POLICY()</h3>
<pre class="programlisting">#define GDA_META_TABLE_FOREIGN_KEY_ON_UPDATE_POLICY(fk) ((GdaMetaForeignKeyPolicy) GPOINTER_TO_INT ((GdaMetaTableForeignKey*)(fk)->on_update_policy))
</pre>
<p>
Tells the actual policy implemented by <em class="parameter"><code>fk</code></em> when used in the context of an UPDATE.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fk</code></em> :</span></p></td>
<td>a pointer to a <a class="link" href="GdaMetaStruct.html#GdaMetaTableForeignKey" title="GdaMetaTableForeignKey"><span class="type">GdaMetaTableForeignKey</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the policy as a <a class="link" href="GdaMetaStruct.html#GdaMetaForeignKeyPolicy" title="enum GdaMetaForeignKeyPolicy"><span class="type">GdaMetaForeignKeyPolicy</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GDA-META-TABLE-FOREIGN-KEY-ON-DELETE-POLICY:CAPS"></a><h3>GDA_META_TABLE_FOREIGN_KEY_ON_DELETE_POLICY()</h3>
<pre class="programlisting">#define GDA_META_TABLE_FOREIGN_KEY_ON_DELETE_POLICY(fk) ((GdaMetaForeignKeyPolicy) GPOINTER_TO_INT ((GdaMetaTableForeignKey*)(fk)->on_delete_policy))
</pre>
<p>
Tells the actual policy implemented by <em class="parameter"><code>fk</code></em> when used in the context of a DELETE.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fk</code></em> :</span></p></td>
<td>a pointer to a <a class="link" href="GdaMetaStruct.html#GdaMetaTableForeignKey" title="GdaMetaTableForeignKey"><span class="type">GdaMetaTableForeignKey</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the policy as a <a class="link" href="GdaMetaStruct.html#GdaMetaForeignKeyPolicy" title="enum GdaMetaForeignKeyPolicy"><span class="type">GdaMetaForeignKeyPolicy</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GDA-META-TABLE-FOREIGN-KEY-IS-DECLARED:CAPS"></a><h3>GDA_META_TABLE_FOREIGN_KEY_IS_DECLARED()</h3>
<pre class="programlisting">#define GDA_META_TABLE_FOREIGN_KEY_IS_DECLARED(fk) ((((GdaMetaTableForeignKey*)(fk))->declared) ? TRUE : FALSE)
</pre>
<p>
Tells if <em class="parameter"><code>fk</code></em> is an actual foreign key defined in the database's schema, or if it is an indication which
has been added to help Libgda understand the database schema.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fk</code></em> :</span></p></td>
<td>a pointer to a <a class="link" href="GdaMetaStruct.html#GdaMetaTableForeignKey" title="GdaMetaTableForeignKey"><span class="type">GdaMetaTableForeignKey</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>fk</code></em> has been declared in the database's meta data and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>fk</code></em> is an actual foreign key defined in the database's schema</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GDA-META-STRUCT-ERROR:CAPS"></a><h3>GDA_META_STRUCT_ERROR</h3>
<pre class="programlisting">#define GDA_META_STRUCT_ERROR gda_meta_struct_error_quark ()
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-struct-new"></a><h3>gda_meta_struct_new ()</h3>
<pre class="programlisting"><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="returnvalue">GdaMetaStruct</span></a> * gda_meta_struct_new (<em class="parameter"><code><a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a> *store</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaStructFeature" title="enum GdaMetaStructFeature"><span class="type">GdaMetaStructFeature</span></a> features</code></em>);</pre>
<p>
Creates a new <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object. The <em class="parameter"><code>features</code></em> specifies the extra features which will also be computed:
the more features, the more time it takes to run. Features such as table's columns, each column's attributes, etc
are not optional and will always be computed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a> from which the new <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object will fetch information</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>features</code></em> :</span></p></td>
<td>the kind of extra information the new <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object will compute</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly created <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-struct-complement"></a><h3>gda_meta_struct_complement ()</h3>
<pre class="programlisting"><a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="returnvalue">GdaMetaDbObject</span></a> * gda_meta_struct_complement (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaDbObjectType" title="enum GdaMetaDbObjectType"><span class="type">GdaMetaDbObjectType</span></a> type</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *catalog</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *schema</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Creates a new <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> structure in <em class="parameter"><code>mstruct</code></em> to represent the database object (of type <em class="parameter"><code>type</code></em>)
which can be uniquely identified as <em class="parameter"><code>catalog</code></em>.<em class="parameter"><code>schema</code></em>.<em class="parameter"><code>name</code></em>.
</p>
<p>
If <em class="parameter"><code>catalog</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then <em class="parameter"><code>schema</code></em> should not be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<p>
If both <em class="parameter"><code>catalog</code></em> and <em class="parameter"><code>schema</code></em> are <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the database object will be the one which is
"visible" by default (that is which can be accessed only by its short <em class="parameter"><code>name</code></em> name).
</p>
<p>
If <em class="parameter"><code>catalog</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and <em class="parameter"><code>schema</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the database object will be the one which
can be accessed by its <em class="parameter"><code>schema</code></em>.<em class="parameter"><code>name</code></em> name.
</p>
<p>
Important note: <em class="parameter"><code>catalog</code></em>, <em class="parameter"><code>schema</code></em> and <em class="parameter"><code>name</code></em> will be used using the following convention:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>be surrounded by double quotes for a case sensitive search</p></li>
<li class="listitem"><p>otherwise for case insensitive search</p></li>
</ul></div>
<p>
</p>
<p>
For more information, see the <a class="link" href="information_schema.html#information_schema:sql_identifiers" title="SQL identifiers">
meta data section about SQL identifiers</a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mstruct</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>the type of object to add (which can be GDA_META_DB_UNKNOWN)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>catalog</code></em> :</span></p></td>
<td>the catalog the object belongs to (as a G_TYPE_STRING GValue), or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>schema</code></em> :</span></p></td>
<td>the schema the object belongs to (as a G_TYPE_STRING GValue), or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the object's name (as a G_TYPE_STRING GValue), not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> corresponding to the database object if no error occurred, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-struct-complement-schema"></a><h3>gda_meta_struct_complement_schema ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_meta_struct_complement_schema (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *catalog</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *schema</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
This method is similar to <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement" title="gda_meta_struct_complement ()"><code class="function">gda_meta_struct_complement()</code></a> but creates <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> for all the
database object which are in the <em class="parameter"><code>schema</code></em> schema (and in the <em class="parameter"><code>catalog</code></em> catalog).
If <em class="parameter"><code>catalog</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then any catalog will be used, and
if <em class="parameter"><code>schema</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then any schema will be used (if <em class="parameter"><code>schema</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then catalog must also be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).
</p>
<p>
Please refer to <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement" title="gda_meta_struct_complement ()"><code class="function">gda_meta_struct_complement()</code></a> form more information.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mstruct</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>catalog</code></em> :</span></p></td>
<td>name of a catalog, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>schema</code></em> :</span></p></td>
<td>name of a schema, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if no error occurred</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-struct-complement-default"></a><h3>gda_meta_struct_complement_default ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_meta_struct_complement_default (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
This method is similar to <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement" title="gda_meta_struct_complement ()"><code class="function">gda_meta_struct_complement()</code></a> and <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement-all" title="gda_meta_struct_complement_all ()"><code class="function">gda_meta_struct_complement_all()</code></a>
but creates <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> for all the
database object which are usable using only their short name (that is which do not need to be prefixed by
the schema in which they are to be used).
</p>
<p>
Please refer to <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement" title="gda_meta_struct_complement ()"><code class="function">gda_meta_struct_complement()</code></a> form more information.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mstruct</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if no error occurred</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-struct-complement-all"></a><h3>gda_meta_struct_complement_all ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_meta_struct_complement_all (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
This method is similar to <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement" title="gda_meta_struct_complement ()"><code class="function">gda_meta_struct_complement()</code></a> and <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement-default" title="gda_meta_struct_complement_default ()"><code class="function">gda_meta_struct_complement_default()</code></a>
but creates <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> for all the database object.
</p>
<p>
Please refer to <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement" title="gda_meta_struct_complement ()"><code class="function">gda_meta_struct_complement()</code></a> form more information.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mstruct</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if no error occurred</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-struct-complement-depend"></a><h3>gda_meta_struct_complement_depend ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_meta_struct_complement_depend (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> *dbo</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
This method is similar to <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement" title="gda_meta_struct_complement ()"><code class="function">gda_meta_struct_complement()</code></a> but creates <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> for all the dependencies
of <em class="parameter"><code>dbo</code></em>.
</p>
<p>
Please refer to <a class="link" href="GdaMetaStruct.html#gda-meta-struct-complement" title="gda_meta_struct_complement ()"><code class="function">gda_meta_struct_complement()</code></a> form more information.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mstruct</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dbo</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> part of <em class="parameter"><code>mstruct</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if no error occurred</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaSortType"></a><h3>enum GdaMetaSortType</h3>
<pre class="programlisting">typedef enum {
GDA_META_SORT_ALHAPETICAL,
GDA_META_SORT_DEPENDENCIES
} GdaMetaSortType;
</pre>
<p>
Types of sorting
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GDA-META-SORT-ALHAPETICAL:CAPS"></a><span class="term"><code class="literal">GDA_META_SORT_ALHAPETICAL</code></span></p></td>
<td>sort alphabetically
</td>
</tr>
<tr>
<td><p><a name="GDA-META-SORT-DEPENDENCIES:CAPS"></a><span class="term"><code class="literal">GDA_META_SORT_DEPENDENCIES</code></span></p></td>
<td>sort by dependencies
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-struct-sort-db-objects"></a><h3>gda_meta_struct_sort_db_objects ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_meta_struct_sort_db_objects (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaSortType" title="enum GdaMetaSortType"><span class="type">GdaMetaSortType</span></a> sort_type</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Reorders the list of database objects within <em class="parameter"><code>mstruct</code></em> in a way specified by <em class="parameter"><code>sort_type</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mstruct</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sort_type</code></em> :</span></p></td>
<td>the kind of sorting requested</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if no error occurred</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-struct-get-all-db-objects"></a><h3>gda_meta_struct_get_all_db_objects ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * gda_meta_struct_get_all_db_objects (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>);</pre>
<p>
Get a list of all the <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> structures representing database objects in <em class="parameter"><code>mstruct</code></em>. Note that
no <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> structure must not be modified.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mstruct</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> list of pointers to <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> structures which must be destroyed after usage using <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#g-slist-free"><code class="function">g_slist_free()</code></a>. The individual <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> must not be modified. <span class="annotation">[<a href="http://foldoc.org/transfer%20container"><span class="acronym">transfer container</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-struct-get-db-object"></a><h3>gda_meta_struct_get_db_object ()</h3>
<pre class="programlisting"><a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="returnvalue">GdaMetaDbObject</span></a> * gda_meta_struct_get_db_object (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *catalog</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *schema</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *name</code></em>);</pre>
<p>
Tries to locate the <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> structure representing the database object named after
<em class="parameter"><code>catalog</code></em>, <em class="parameter"><code>schema</code></em> and <em class="parameter"><code>name</code></em>.
</p>
<p>
If one or both of <em class="parameter"><code>catalog</code></em> and <em class="parameter"><code>schema</code></em> are <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, and more than one database object matches the name, then
the return value is also <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mstruct</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>catalog</code></em> :</span></p></td>
<td>the catalog the object belongs to (as a G_TYPE_STRING GValue), or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>schema</code></em> :</span></p></td>
<td>the schema the object belongs to (as a G_TYPE_STRING GValue), or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the object's name (as a G_TYPE_STRING GValue), not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="GdaMetaStruct.html#GdaMetaDbObject" title="GdaMetaDbObject"><span class="type">GdaMetaDbObject</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not found. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-struct-get-table-column"></a><h3>gda_meta_struct_get_table_column ()</h3>
<pre class="programlisting"><a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="returnvalue">GdaMetaTableColumn</span></a> * gda_meta_struct_get_table_column (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaTable" title="GdaMetaTable"><span class="type">GdaMetaTable</span></a> *table</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *col_name</code></em>);</pre>
<p>
Tries to find the <a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a> representing the column named <em class="parameter"><code>col_name</code></em> in <em class="parameter"><code>table</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mstruct</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>the <a class="link" href="GdaMetaStruct.html#GdaMetaTable" title="GdaMetaTable"><span class="type">GdaMetaTable</span></a> structure to find the column for</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col_name</code></em> :</span></p></td>
<td>the name of the column to find (as a G_TYPE_STRING GValue)</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="GdaMetaStruct.html#GdaMetaTableColumn" title="GdaMetaTableColumn"><span class="type">GdaMetaTableColumn</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not found. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaGraphInfo"></a><h3>enum GdaMetaGraphInfo</h3>
<pre class="programlisting">typedef enum {
GDA_META_GRAPH_COLUMNS = 1 << 0
} GdaMetaGraphInfo;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-meta-struct-dump-as-graph"></a><h3>gda_meta_struct_dump_as_graph ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gda_meta_struct_dump_as_graph (<em class="parameter"><code><a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> *mstruct</code></em>,
<em class="parameter"><code><a class="link" href="GdaMetaStruct.html#GdaMetaGraphInfo" title="enum GdaMetaGraphInfo"><span class="type">GdaMetaGraphInfo</span></a> info</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Creates a new graph (in the GraphViz syntax) representation of <em class="parameter"><code>mstruct</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mstruct</code></em> :</span></p></td>
<td>a <a class="link" href="GdaMetaStruct.html" title="GdaMetaStruct"><span class="type">GdaMetaStruct</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>informs what kind of information to show in the resulting graph</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GdaMetaStruct.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdaMetaStruct--features"></a><h3>The <code class="literal">"features"</code> property</h3>
<pre class="programlisting"> "features" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct Only</pre>
<p></p>
<p>Allowed values: <= G_MAXINT</p>
<p>Default value: 3</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaMetaStruct--meta-store"></a><h3>The <code class="literal">"meta-store"</code> property</h3>
<pre class="programlisting"> "meta-store" <a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a>* : Read / Write / Construct Only</pre>
<p>GdaMetaStore object to fetch information from.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|