/usr/share/gtk-doc/html/libgda-5.0/ch21.html is in libgda-5.0-doc 5.2.4-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Data definition (DDL) queries: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="part_libgda_api.html" title="Part II. API reference">
<link rel="prev" href="GdaMetaStruct.html" title="GdaMetaStruct">
<link rel="next" href="GdaServerOperation.html" title="GdaServerOperation">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="part_libgda_api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdaMetaStruct.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaServerOperation.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="chapter">
<div class="titlepage"><div><div><h2 class="title">
<a name="id-1.3.12"></a>Data definition (DDL) queries</h2></div></div></div>
<div class="toc"><dl class="toc">
<dt>
<span class="refentrytitle"><a href="GdaServerOperation.html">GdaServerOperation</a></span><span class="refpurpose"> — Handles any DDL query in an abstract way</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgda-5.0-GdaServerOperation-individual-nodes.html">GdaServerOperation: individual nodes</a></span><span class="refpurpose"> — Getting information about parts (nodes) composing a path</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgda-5.0-GdaServerOperation-sequences.html">GdaServerOperation: sequences</a></span><span class="refpurpose"> — Manipulating sequences</span>
</dt>
</dl></div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="DDLIntro"></a>General words about DDL queries</h3></div></div></div>
<p>
On the contrary to data manipulation (DML) queries, data definition queries are not very well standardized (the SQL varies a
lot from one DBMS to the other), and <span class="application">Libgda</span> proposes to bypass the SQL usage and uses a different approach based on the
information required to perform a task (or operation, thus the <a class="link" href="GdaServerOperation.html" title="GdaServerOperation">GdaServerOperation</a>
object).
</p>
<p>
Here is an overview the steps involved:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>Make sure the database provider (associated to the connection) supports the requested operation using the
<a class="link" href="GdaServerProvider.html#gda-server-provider-supports-operation" title="gda_server_provider_supports_operation ()">gda_server_provider_supports_operation()</a> method</p></li>
<li class="listitem">
<p>Ask the provider to create a <a class="link" href="GdaServerOperation.html" title="GdaServerOperation">GdaServerOperation</a> object
using the <a class="link" href="GdaServerProvider.html#gda-server-provider-create-operation" title="gda_server_provider_create_operation ()">gda_server_provider_create_operation()</a> method.
The resulting new object will hold all the information required (and some optional) to perform the requested
operation. For example to create a table, the required information will be the table name and the description of its
columns, and the optional information might be the schema in which to create the table for a PostgreSQL provider.</p>
<p>
Additionally some options can be passed when using that function in the form of named parameters, see <a class="link" href="ch21.html#gda-server-op-information-std" title="Standard named information">this section</a> for more information.
</p>
</li>
<li class="listitem"><p>Fill in the values (required or optional) of the <a class="link" href="GdaServerOperation.html" title="GdaServerOperation">GdaServerOperation</a>
object (see the GdaServerOperation object's <a class="link" href="GdaServerOperation.html" title="GdaServerOperation">documentation</a> for more information).
</p></li>
<li class="listitem"><p>Use that object to request the actual operation to be done using the
<a class="link" href="GdaServerProvider.html#gda-server-provider-perform-operation" title="gda_server_provider_perform_operation ()">gda_server_provider_perform_operation()</a> method.
Afterwards that object can be discarded using <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref()</a></p></li>
</ul></div>
<p>
The information stored within a <a class="link" href="GdaServerOperation.html" title="GdaServerOperation">GdaServerOperation</a> object can also be stored within
an XML structure and re-loaded later, which for example allows to create "scripts" of operations to do.
</p>
<div class="sect3">
<div class="titlepage"><div><div><h4 class="title">
<a name="id-1.3.12.2.4"></a>Organization of the required information</h4></div></div></div>
<p>
The required information to perform an operation is stored entirely in a
<a class="link" href="GdaServerOperation.html" title="GdaServerOperation">GdaServerOperation</a> object using named paths which are strings like
"/TABLE_DEF_P/TABLE_NAME" or "/TABLE_CONSTRAINTS_S/0/CONSTRAINT_STRING" (for details about the path format, refer to the
<a class="link" href="GdaServerOperation.html#gda-server-operation-set-value-at" title="gda_server_operation_set_value_at ()">gda_server_operation_set_value_at()</a> method).
Each path is similar to a Unix file path
(names separated by a '/'). Each part of the path corresponds to a node (represented as a
<a class="link" href="libgda-5.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNode" title="GdaServerOperationNode">GdaServerOperationNode</a> structure) which has a type listed as
a <a class="link" href="libgda-5.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNodeType" title="enum GdaServerOperationNodeType">GdaServerOperationNodeType</a>; basically the types of node are:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>a node containing a <a class="link" href="GdaHolder.html" title="GdaHolder">GdaHolder</a> object which just contains one value</p></li>
<li class="listitem"><p>a node containing a <a class="link" href="GdaSet.html" title="GdaSet">GdaSet</a> object which is just a list
of named parameters (for example all the attributes of the table to create such as the table's name and
storage type for a MySQL provider)</p></li>
<li class="listitem"><p>a node containing a <a class="link" href="GdaDataModel.html" title="GdaDataModel">GdaDataModel</a> object when the needed information
is tabular (rows and columns), for example the definition of all the columns to create in a table, each column having
a name, type, CHECK constraint, etc</p></li>
<li class="listitem"><p>a node defining a sequence of items: the sequence node can have zero or more items composed of nodes.
For example when
defining the foreign keys for a new table, a sequence node can be created which can contain zero or more foreign key
definition items (each composed of the referenced table, the referenced fields, the referential integrity rules, etc)
</p></li>
<li class="listitem"><p>a node representing an 'item' in a sequence node (that is a list of nodes).</p></li>
<li class="listitem"><p>a node representing a data model's column.</p></li>
</ul></div>
<p>
</p>
<p>
Note: the list and complete structure of the information required to perform an operation is imposed by each provider and cannot
be modified. The information stored in each node can be modified (depending on the node's type):
</p>
</div>
<div class="sect3">
<div class="titlepage"><div><div><h4 class="title">
<a name="gda-server-op-information-specif"></a>Provider specific information</h4></div></div></div>
<p>
To list the possible/required parameters for each provider, use the
<a class="link" href="libgda-list-server-op.html" title="gda-list-server-op-5.0">gda-list-server-op</a> tool.
</p>
</div>
<div class="sect3">
<div class="titlepage"><div><div><h4 class="title">
<a name="gda-server-op-information-std"></a>Standard named information</h4></div></div></div>
<p>
For most of the possible operations, the required information from one provider to the other does not vary, only the
optional features correspond to optional information, so <span class="application">Libgda</span> imposes the names of the required information for
some of the most common operations, which is shown next. Some optional information which is shared by several providers
is also named but not enforced.
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<p>Named and required information for GDA_SERVER_OPERATION_CREATE_DB:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.1.1.1"></a><p class="title"><b>Table 10. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Path</th>
<th align="justify">Type</th>
<th align="justify">Required?</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">/DB_DEF_P</td>
<td align="justify">PARAMLIST</td>
<td align="justify">Yes</td>
<td align="justify">Database's description</td>
</tr>
<tr>
<td align="justify">/DB_DEF_P/DB_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Database name (string)</td>
</tr>
<tr>
<td align="justify">/DB_DEF_P/DB_CSET</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Character set (string)</td>
</tr>
<tr>
<td align="justify">/DB_DEF_P/DB_OWNER</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Database owner (string)</td>
</tr>
<tr>
<td align="justify">/DB_DEF_P/DB_TABLESPACE</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Tablespace the database is in (string)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
Note also that if creating a database requires an access to a server, then the access parameters to that server
will all be in the "/SERVER_CNX_P" PARAMLIST, as shown:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.1.1.2"></a><p class="title"><b>Table 11. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Path</th>
<th align="justify">Type</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">/SERVER_CNX_P</td>
<td align="justify">PARAMLIST</td>
<td align="justify">Parameters to connect to a server</td>
</tr>
<tr>
<td align="justify">/SERVER_CNX_P/HOST</td>
<td align="justify">PARAM</td>
<td align="justify">Name of the server (string)</td>
</tr>
<tr>
<td align="justify">/SERVER_CNX_P/PORT</td>
<td align="justify">PARAM</td>
<td align="justify">Port number on the server (gint)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
</li>
<li class="listitem">
<p>Named and required information for GDA_SERVER_OPERATION_DROP_DB:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.2.1.1"></a><p class="title"><b>Table 12. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Path</th>
<th align="justify">Type</th>
<th align="justify">Required?</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">/DB_DESC_P</td>
<td align="justify">PARAMLIST</td>
<td align="justify">Yes</td>
<td align="justify">Database's description</td>
</tr>
<tr>
<td align="justify">/DB_DESC_P/DB_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Database name (string)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
Note also that if creating a database requires an access to a server, then the access parameters to that server
will all be in the "/SERVER_CNX_P" PARAMLIST, as for the GDA_SERVER_OPERATION_CREATE_DB operation.
</p>
</li>
<li class="listitem">
<p>Named and required information for GDA_SERVER_OPERATION_CREATE_TABLE:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.3.1.1"></a><p class="title"><b>Table 13. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Path</th>
<th align="justify">Type</th>
<th align="justify">Required?</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">/TABLE_DEF_P</td>
<td align="justify">PARAMLIST</td>
<td align="justify">Yes</td>
<td align="justify">Table's description</td>
</tr>
<tr>
<td align="justify">/TABLE_DEF_P/TABLE_TABLESPACE</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Tablespace in which to create the table (string)</td>
</tr>
<tr>
<td align="justify">/TABLE_DEF_P/TABLE_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Table name (string)</td>
</tr>
<tr>
<td align="justify">/TABLE_DEF_P/TABLE_TEMP</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">TRUE if the table to create is temporary (boolean)</td>
</tr>
<tr>
<td align="justify">/TABLE_DEF_P/TABLE_COMMENT</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Comment on a table (string)</td>
</tr>
<tr>
<td align="justify">/FIELDS_A</td>
<td align="justify">DATA_MODEL</td>
<td align="justify">Yes</td>
<td align="justify">Table's fields description</td>
</tr>
<tr>
<td align="justify">/FIELDS_A/@COLUMN_NAME</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify">Yes</td>
<td align="justify">A table's field name (string)</td>
</tr>
<tr>
<td align="justify">/FIELDS_A/@COLUMN_TYPE</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify">Yes</td>
<td align="justify">A table's field type (string)</td>
</tr>
<tr>
<td align="justify">/FIELDS_A/@COLUMN_SIZE</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify"> </td>
<td align="justify">A table's field defined size (unsigned integer)</td>
</tr>
<tr>
<td align="justify">/FIELDS_A/@COLUMN_SCALE</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify"> </td>
<td align="justify">A table's field number of decimals (unsigned integer)</td>
</tr>
<tr>
<td align="justify">/FIELDS_A/@COLUMN_NNUL</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify"> </td>
<td align="justify">TRUE if table's field can't be NULL (boolean)</td>
</tr>
<tr>
<td align="justify">/FIELDS_A/@COLUMN_AUTOINC</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify"> </td>
<td align="justify">TRUE if table's field must be auto incremented (boolean)</td>
</tr>
<tr>
<td align="justify">/FIELDS_A/@COLUMN_UNIQUE</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify"> </td>
<td align="justify">TRUE if table's field must be unique (boolean)</td>
</tr>
<tr>
<td align="justify">/FIELDS_A/@COLUMN_PKEY</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify"> </td>
<td align="justify">TRUE if table's field is a primary key (boolean)</td>
</tr>
<tr>
<td align="justify">/FIELDS_A/@COLUMN_DEFAULT</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify"> </td>
<td align="justify">A table's field default value (string)</td>
</tr>
<tr>
<td align="justify">/FIELDS_A/@COLUMN_CHECK</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify"> </td>
<td align="justify">A table's field CHECK condition (string)</td>
</tr>
<tr>
<td align="justify">/FIELDS_A/@COLUMN_COMMENT</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify"> </td>
<td align="justify">A comment on the table's field (string)</td>
</tr>
<tr>
<td align="justify">/FKEY_S</td>
<td align="justify">DATA_SEQUENCE</td>
<td align="justify"> </td>
<td align="justify">Sequence representing foreign keys description</td>
</tr>
<tr>
<td align="justify">/FKEY_S/FKEY_REF_TABLE</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">The foreign key's referenced table (string)</td>
</tr>
<tr>
<td align="justify">/FKEY_S/FKEY_FIELDS_A</td>
<td align="justify">DATA_MODEL</td>
<td align="justify"> </td>
<td align="justify">The foreign key's field's being used</td>
</tr>
<tr>
<td align="justify">/FKEY_S/FKEY_FIELDS_A/@FK_FIELD</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify"> </td>
<td align="justify">A foreign key's field's from the table to create</td>
</tr>
<tr>
<td align="justify">/FKEY_S/FKEY_FIELDS_A/@FK_REF_PK_FIELD</td>
<td align="justify">DATA_MODEL_COLUMN</td>
<td align="justify"> </td>
<td align="justify">A foreign key's field's from the referenced table</td>
</tr>
<tr>
<td align="justify">/FKEY_S/FKEY_ONUPDATE</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">The action to take when the referenced field is updated (string)</td>
</tr>
<tr>
<td align="justify">/FKEY_S/FKEY_ONDELETE</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">The action to take when the referenced field is deleted (string)</td>
</tr>
<tr>
<td align="justify">/FKEY_S/FKEY_DEFERRABLE</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">TRUE if the foreign key is deferrable until the end of a transaction (boolean)</td>
</tr>
<tr>
<td align="justify">/TABLE_CONSTRAINTS_S</td>
<td align="justify">SEQUENCE</td>
<td align="justify"> </td>
<td align="justify">Sequence representing table constraints</td>
</tr>
<tr>
<td align="justify">/TABLE_CONSTRAINTS_S/CONSTRAINT_STRING</td>
<td align="justify">SEQUENCE</td>
<td align="justify"> </td>
<td align="justify">A table constraint (string)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
</li>
<li class="listitem">
<p>Named and required information for GDA_SERVER_OPERATION_DROP_TABLE:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.4.1.1"></a><p class="title"><b>Table 14. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Path</th>
<th align="justify">Type</th>
<th align="justify">Required?</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">/TABLE_DESC_P</td>
<td align="justify">PARAMLIST</td>
<td align="justify">Yes</td>
<td align="justify">Table's description</td>
</tr>
<tr>
<td align="justify">/TABLE_DESC_P/TABLE_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Table's name (string)</td>
</tr>
<tr>
<td align="justify">/TABLE_DESC_P/REFERENCED_ACTION</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Action to perform for objects referencing the table to drop (CASCADE, RESTRICT, ...) (string)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
<p>
Optional parameters for the creation of a GdaServerOperation object for such an operation type:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.4.1.2.1"></a><p class="title"><b>Table 15. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Id</th>
<th align="justify">Type</th>
<th align="justify">Description</th>
</tr></thead>
<tbody><tr>
<td align="justify">TABLE_DESC_P/TABLE_NAME</td>
<td align="justify">string</td>
<td align="justify">Name of the table to delete</td>
</tr></tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
<p>
</p>
</li>
<li class="listitem">
<p>Named and required information for GDA_SERVER_OPERATION_RENAME_TABLE:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.5.1.1"></a><p class="title"><b>Table 16. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Path</th>
<th align="justify">Type</th>
<th align="justify">Required?</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">/TABLE_DESC_P</td>
<td align="justify">PARAMLIST</td>
<td align="justify">Yes</td>
<td align="justify">Table's description</td>
</tr>
<tr>
<td align="justify">/TABLE_DESC_P/TABLE_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Table's name (string)</td>
</tr>
<tr>
<td align="justify">/TABLE_DESC_P/TABLE_NEW_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Table's new name (string)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
</li>
<li class="listitem">
<p>Named and required information for GDA_SERVER_OPERATION_ADD_COLUMN:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.6.1.1"></a><p class="title"><b>Table 17. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Path</th>
<th align="justify">Type</th>
<th align="justify">Required?</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">/COLUMN_DEF_P</td>
<td align="justify">PARAMLIST</td>
<td align="justify">Yes</td>
<td align="justify">Column's description</td>
</tr>
<tr>
<td align="justify">/COLUMN_DEF_P/TABLE_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Name of the table to add a column to (string)</td>
</tr>
<tr>
<td align="justify">/COLUMN_DEF_P/COLUMN_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">New column's name (string)</td>
</tr>
<tr>
<td align="justify">/COLUMN_DEF_P/COLUMN_TYPE</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">New column's type (string)</td>
</tr>
<tr>
<td align="justify">/COLUMN_DEF_P/COLUMN_SIZE</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">New column's defined size (unsigned integer)</td>
</tr>
<tr>
<td align="justify">/COLUMN_DEF_P/COLUMN_SCALE</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">New column's number of decimals (unsigned integer)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
<p>
The other bits of information for the column description, which are not required, are the same as for "/FIELDS_A" array of
the GDA_SERVER_OPERATION_CREATE_TABLE (replace "/FIELDS_A" with "/COLUMN_DEF_P").
</p>
</li>
<li class="listitem">
<p>Named and required information for GDA_SERVER_OPERATION_DROP_COLUMN:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.7.1.1"></a><p class="title"><b>Table 18. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Path</th>
<th align="justify">Type</th>
<th align="justify">Required?</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">/COLUMN_DESC_P</td>
<td align="justify">PARAMLIST</td>
<td align="justify">Yes</td>
<td align="justify">Column's description</td>
</tr>
<tr>
<td align="justify">/COLUMN_DESC_P/TABLE_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Name of the table to remove a column from (string)</td>
</tr>
<tr>
<td align="justify">/COLUMN_DESC_P/COLUMN_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Name of the column to remove (string)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
</li>
<li class="listitem">
<p>Named and required information for GDA_SERVER_OPERATION_CREATE_INDEX:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.8.1.1"></a><p class="title"><b>Table 19. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Path</th>
<th align="justify">Type</th>
<th align="justify">Required?</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">/INDEX_DEF_P</td>
<td align="justify">PARAMLIST</td>
<td align="justify">Yes</td>
<td align="justify">Index's description</td>
</tr>
<tr>
<td align="justify">/INDEX_DEF_P/INDEX_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Index name (string)</td>
</tr>
<tr>
<td align="justify">/INDEX_DEF_P/INDEX_TYPE</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Index type: UNIQUE, etc (string)</td>
</tr>
<tr>
<td align="justify">/INDEX_DEF_P/INDEX_ON_TABLE</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Table on which the index is applied (string)</td>
</tr>
<tr>
<td align="justify">/INDEX_FIELDS_S</td>
<td align="justify">SEQUENCE</td>
<td align="justify">Yes</td>
<td align="justify">List of fields on which the index is applied (min: 1 item)</td>
</tr>
<tr>
<td align="justify">/INDEX_FIELDS_S/INDEX_FIELD</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">A field on which the index is applied (string)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
</li>
<li class="listitem">
<p>Named and required information for GDA_SERVER_OPERATION_DROP_INDEX:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.9.1.1"></a><p class="title"><b>Table 20. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Path</th>
<th align="justify">Type</th>
<th align="justify">Required?</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">/INDEX_DESC_P</td>
<td align="justify">PARAMLIST</td>
<td align="justify">Yes</td>
<td align="justify">Index's description</td>
</tr>
<tr>
<td align="justify">/INDEX_DESC_P/INDEX_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">Index's name (string)</td>
</tr>
<tr>
<td align="justify">/INDEX_DEF_P/INDEX_ON_TABLE</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Table on which the index is applied (string)</td>
</tr>
<tr>
<td align="justify">/INDEX_DESC_P/REFERENCED_ACTION</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Action to perform for objects referencing the index to drop (CASCADE, RESTRICT, ...) (string)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
</li>
<li class="listitem">
<p>Named and required information for GDA_SERVER_OPERATION_CREATE_USER:
</p>
<div class="table">
<a name="id-1.3.12.2.6.3.10.1.1"></a><p class="title"><b>Table 21. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Path</th>
<th align="justify">Type</th>
<th align="justify">Required?</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">/USER_DEF_P</td>
<td align="justify">PARAMLIST</td>
<td align="justify">Yes</td>
<td align="justify">User's description</td>
</tr>
<tr>
<td align="justify">/USER_DEF_P/USER_NAME</td>
<td align="justify">PARAM</td>
<td align="justify">Yes</td>
<td align="justify">User name (string)</td>
</tr>
<tr>
<td align="justify">/USER_DEF_P/PASSWORD</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">User's password (string)</td>
</tr>
<tr>
<td align="justify">/USER_DEF_P/CAP_CREATEDB</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Set to TRUE if the user is allowed to create databases (boolean)</td>
</tr>
<tr>
<td align="justify">/USER_DEF_P/CAP_CREATEUSER</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Set to TRUE if the user is allowed to create users (boolean)</td>
</tr>
<tr>
<td align="justify">/USER_DEF_P/VALIDITY</td>
<td align="justify">PARAM</td>
<td align="justify"> </td>
<td align="justify">Set the expiration timestamp (timestamp)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
</li>
</ul></div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|