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
|
<?xml version='1.0' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "entities.inc">
%myents;
]>
<!-- Condition System -->
<reference id="ref-conditions">
<title>CLSQL Condition System</title>
<partintro>
<para>
&clsql; provides and uses a condition system in which all errors
and warnings are of type <link
linkend="sql-condition"><errortype>sql-condition</errortype></link>. This
section describes the various subclasses of <link
linkend="sql-condition"><errortype>sql-condition</errortype></link>
defined by &clsql;. Details are also provided for how they are
used in &clsql; and intended to be signalled in user
code. Finally, slot accessors for some of the condition types
are described.
</para>
</partintro>
<refentry id="backend-warning-behavior">
<refmeta>
<refentrytitle>*BACKEND-WARNING-BEHAVIOR*</refentrytitle>
</refmeta>
<refnamediv>
<refname>*BACKEND-WARNING-BEHAVIOR*</refname>
<refpurpose>Controls behaviour on warnings from underlying RDBMS.</refpurpose>
<refclass>Variable</refclass>
</refnamediv>
<refsect1>
<title>Value Type</title>
<para>
Meaningful values are <symbol>:warn</symbol>,
<symbol>:error</symbol>, <symbol>:ignore</symbol> and &nil;.
</para>
</refsect1>
<refsect1>
<title>Initial Value</title>
<para><symbol>:warn</symbol></para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
Action to perform on warning messages
from backend. Default is to <symbol>:warn</symbol>. May also be
set to <symbol>:error</symbol> to signal an error or
<symbol>:ignore</symbol> or &nil; to silently ignore the
warning.
</para>
</refsect1>
<refsect1>
<title>Examples</title>
<screen>
<!-- examples -->
</screen>
</refsect1>
<refsect1>
<title>Affected By</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>Notes</title>
<para><symbol>*backend-warning-behaviour*</symbol> is a &clsql;
extension.</para>
</refsect1>
</refentry>
<refentry id="sql-condition">
<refmeta>
<refentrytitle>SQL-CONDITION</refentrytitle>
</refmeta>
<refnamediv>
<refname>SQL-CONDITION</refname>
<refpurpose>the super-type of all
&clsql;-specific
conditions</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Class Precedence List</title>
<para>
<simplelist type="inline">
<member><link linkend="sql-condition"><errortype>sql-condition</errortype></link></member>
<member><errortype>condition</errortype></member>
<member><errortype>t</errortype></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This is the super-type of all &clsql;-specific conditions
defined by &clsql;, or any of it's database-specific
interfaces. There are no defined initialization arguments nor
any accessors.
</para>
</refsect1>
<refsect1>
<title>Notes</title>
<para><errortype>sql-condition</errortype> is a &clsql;
extension.</para>
</refsect1>
</refentry>
<refentry id="sql-error">
<refmeta>
<refentrytitle>SQL-ERROR</refentrytitle>
</refmeta>
<refnamediv>
<refname>SQL-ERROR</refname>
<refpurpose>the super-type of all
&clsql;-specific
errors</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Class Precedence List</title>
<para>
<simplelist type="inline">
<member><link linkend="sql-error"><errortype>sql-error</errortype></link></member>
<member><errortype>simple-error</errortype></member>
<member><errortype>simple-condition</errortype></member>
<member><errortype>error</errortype></member>
<member><errortype>serious-condition</errortype></member>
<member><link linkend="sql-condition"><errortype>sql-condition</errortype></link></member>
<member><errortype>condition</errortype></member>
<member><errortype>t</errortype></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This is the super-type of all &clsql;-specific conditions that
represent errors, as defined by &clsql;, or any of it's
database-specific interfaces. There are no defined
initialization arguments nor any accessors.
</para>
</refsect1>
<refsect1>
<title>Notes</title>
<para><errortype>sql-error</errortype> is a &clsql; extension.</para>
</refsect1>
</refentry>
<refentry id="sql-warning">
<refmeta>
<refentrytitle>SQL-WARNING</refentrytitle>
</refmeta>
<refnamediv>
<refname>SQL-WARNING</refname>
<refpurpose>the super-type of all
&clsql;-specific
warnings</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Class Precedence List</title>
<para>
<simplelist type="inline">
<member><link linkend="sql-warning"><errortype>sql-warning</errortype></link></member>
<member><errortype>warning</errortype></member>
<member><link linkend="sql-condition"><errortype>sql-condition</errortype></link></member>
<member><errortype>condition</errortype></member>
<member><errortype>t</errortype></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This is the super-type of all &clsql;-specific conditions that
represent warnings, as defined by &clsql;, or any of it's
database-specific interfaces. There are no defined
initialization arguments nor any accessors.
</para>
</refsect1>
<refsect1>
<title>Notes</title>
<para><errortype>sql-warning</errortype> is a &clsql; extension.</para>
</refsect1>
</refentry>
<refentry id="sql-database-warning">
<refmeta>
<refentrytitle>SQL-DATABASE-WARNING</refentrytitle>
</refmeta>
<refnamediv>
<refname>SQL-DATABASE-WARNING</refname>
<refpurpose>Used to warn while accessing a
&clsql; database.</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Class Precedence List</title>
<para>
<simplelist type="inline">
<member><link linkend="sql-database-warning"><errortype>sql-database-warning</errortype></link></member>
<member><link linkend="sql-warning"><errortype>sql-warning</errortype></link></member>
<member><errortype>warning</errortype></member>
<member><link linkend="sql-condition"><errortype>sql-condition</errortype></link></member>
<member><errortype>condition</errortype></member>
<member><errortype>t</errortype></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This condition represents warnings signalled while accessing
a database.
</para>
<para>
The following initialization arguments and accessors exist:
</para>
<segmentedlist>
<segtitle>Initarg</segtitle>
<segtitle>Accessor</segtitle>
<segtitle>Description</segtitle>
<seglistitem>
<seg><symbol>:database</symbol></seg>
<seg><function>sql-warning-database</function></seg>
<seg>The database object that was involved in the
incident.</seg>
</seglistitem>
</segmentedlist>
</refsect1>
<refsect1>
<title>Notes</title>
<para><errortype>sql-database-warning</errortype> is a &clsql;
extension.</para>
</refsect1>
</refentry>
<!-- Specific Conditions -->
<refentry id="sql-user-error">
<refmeta>
<refentrytitle>SQL-USER-ERROR</refentrytitle>
</refmeta>
<refnamediv>
<refname>SQL-USER-ERROR</refname>
<refpurpose>condition representing errors because of invalid
parameters from the library user.</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Class Precedence List</title>
<para>
<simplelist type="inline">
<member><errortype>sql-user-error</errortype></member>
<member><link linkend="sql-error"><errortype>sql-error</errortype></link></member>
<member><errortype>simple-error</errortype></member>
<member><errortype>simple-condition</errortype></member>
<member><errortype>error</errortype></member>
<member><errortype>serious-condition</errortype></member>
<member><link linkend="sql-condition"><errortype>sql-condition</errortype></link></member>
<member><errortype>condition</errortype></member>
<member><errortype>t</errortype></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This condition represents errors that occur because the user
supplies invalid data to &clsql;. This includes errors such
as an invalid format connection specification or an error in
the syntax for the <function>LOOP</function> macro extensions.
</para>
<para>
The following initialization arguments and accessors exist:
</para>
<segmentedlist>
<segtitle>Initarg</segtitle>
<segtitle>Accessor</segtitle>
<segtitle>Description</segtitle>
<seglistitem>
<seg><symbol>:message</symbol></seg>
<seg><function>sql-user-error-message</function></seg>
<seg>The error message.</seg>
</seglistitem>
</segmentedlist>
</refsect1>
<refsect1>
<title>Notes</title>
<para>The slot accessor
<function>sql-user-error-message</function> is a &clsql;
extension.</para>
</refsect1>
</refentry>
<refentry id="sql-database-error">
<refmeta>
<refentrytitle>SQL-DATABASE-ERROR</refentrytitle>
</refmeta>
<refnamediv>
<refname>SQL-DATABASE-ERROR</refname>
<refpurpose>condition representing errors during query or
command execution</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Class Precedence List</title>
<para>
<simplelist type="inline">
<member><link linkend="sql-database-error"><errortype>sql-database-error</errortype></link></member>
<member><link linkend="sql-error"><errortype>sql-error</errortype></link></member>
<member><errortype>simple-error</errortype></member>
<member><errortype>simple-condition</errortype></member>
<member><errortype>error</errortype></member>
<member><errortype>serious-condition</errortype></member>
<member><link linkend="sql-condition"><errortype>sql-condition</errortype></link></member>
<member><errortype>condition</errortype></member>
<member><errortype>t</errortype></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This condition represents errors that occur while executing
SQL statements, either as part of query operations or command
execution, either explicitly or implicitly, as caused e.g. by
<function>with-transaction</function>.
</para>
<para>
The following initialization arguments and accessors exist:
</para>
<segmentedlist>
<segtitle>Initarg</segtitle>
<segtitle>Accessor</segtitle>
<segtitle>Description</segtitle>
<seglistitem>
<seg><symbol>:database</symbol></seg>
<seg><function>sql-error-database</function></seg>
<seg>The database object that was involved in the
incident.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:error-id</symbol></seg>
<seg><function>sql-error-error-id</function></seg>
<seg>The numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:secondary-error-id</symbol></seg>
<seg><function>sql-error-secondary-error-id</function></seg>
<seg>The secondary numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:message</symbol></seg>
<seg><function>sql-error-database-message</function></seg>
<seg>A string describing the problem that occurred,
possibly one returned by the database back-end.</seg>
</seglistitem>
</segmentedlist>
</refsect1>
<refsect1>
<title>Notes</title>
<para>
The slot accessor
<function>sql-error-database</function> is a &clsql;
extension.
</para>
</refsect1>
</refentry>
<refentry id="sql-connection-error">
<refmeta>
<refentrytitle>SQL-CONNECTION-ERROR</refentrytitle>
</refmeta>
<refnamediv>
<refname>SQL-CONNECTION-ERROR</refname>
<refpurpose>condition representing errors during
connection</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Class Precedence List</title>
<para>
<simplelist type="inline">
<member><link linkend="sql-connection-error"><errortype>sql-connection-error</errortype></link></member>
<member><link linkend="sql-database-error"><errortype>sql-database-error</errortype></link></member>
<member><link linkend="sql-error"><errortype>sql-error</errortype></link></member>
<member><errortype>simple-error</errortype></member>
<member><errortype>simple-condition</errortype></member>
<member><errortype>error</errortype></member>
<member><errortype>serious-condition</errortype></member>
<member><link linkend="sql-condition"><errortype>sql-condition</errortype></link></member>
<member><errortype>condition</errortype></member>
<member><errortype>t</errortype></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This condition represents errors that occur while trying to
connect to a database.
</para>
<para>
The following initialization arguments and accessors exist:
</para>
<segmentedlist>
<segtitle>Initarg</segtitle>
<segtitle>Accessor</segtitle>
<segtitle>Description</segtitle>
<seglistitem>
<seg><symbol>:database-type</symbol></seg>
<seg><function>sql-error-database-type</function></seg>
<seg>Database type for the connection attempt</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:connection-spec</symbol></seg>
<seg><function>sql-error-connection-spec</function></seg>
<seg>The connection specification used in the
connection attempt.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:database</symbol></seg>
<seg><function>sql-error-database</function></seg>
<seg>The database object that was involved in the
incident.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:error-id</symbol></seg>
<seg><function>sql-error-error-id</function></seg>
<seg>The numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:secondary-error-id</symbol></seg>
<seg><function>sql-error-secondary-error-id</function></seg>
<seg>The secondary numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:message</symbol></seg>
<seg><function>sql-database-error-error</function></seg>
<seg>A string describing the problem that occurred,
possibly one returned by the database back-end.</seg>
</seglistitem>
</segmentedlist>
</refsect1>
<refsect1>
<title>Notes</title>
<para>
The slot accessors
<function>sql-error-database</function>,
<function>sql-error-database-type</function> and
<function>sql-error-connection-spec</function> are
&clsql; extensions.
</para>
</refsect1>
</refentry>
<refentry id="sql-database-data-error">
<refmeta>
<refentrytitle>SQL-DATABASE-DATA-ERROR</refentrytitle>
</refmeta>
<refnamediv>
<refname>SQL-DATABASE-DATA-ERROR</refname>
<refpurpose>Used to signal an error with the SQL data passed
to a database.</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Class Precedence List</title>
<para>
<simplelist type="inline">
<member><errortype>sql-database-data-error</errortype></member>
<member><link linkend="sql-database-error"><errortype>sql-database-error</errortype></link></member>
<member><link linkend="sql-error"><errortype>sql-error</errortype></link></member>
<member><errortype>simple-error</errortype></member>
<member><errortype>simple-condition</errortype></member>
<member><errortype>error</errortype></member>
<member><errortype>serious-condition</errortype></member>
<member><link linkend="sql-condition"><errortype>sql-condition</errortype></link></member>
<member><errortype>condition</errortype></member>
<member><errortype>t</errortype></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>This condition represents errors that occur while
executing SQL statements, specifically as a result of
malformed SQL expressions.
</para>
<para>
The following initialization arguments and accessors exist:
</para>
<segmentedlist>
<segtitle>Initarg</segtitle>
<segtitle>Accessor</segtitle>
<segtitle>Description</segtitle>
<seglistitem>
<seg><symbol>:expression</symbol></seg>
<seg><function>sql-error-expression</function></seg>
<seg>The SQL expression whose execution caused the error.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:database</symbol></seg>
<seg><function>sql-error-database</function></seg>
<seg>The database object that was involved in the
incident.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:error-id</symbol></seg>
<seg><function>sql-error-error-id</function></seg>
<seg>The numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:secondary-error-id</symbol></seg>
<seg><function>sql-error-secondary-error-id</function></seg>
<seg>The secondary numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:message</symbol></seg>
<seg><function>sql-error-database-message</function></seg>
<seg>A string describing the problem that occurred,
possibly one returned by the database back-end.</seg>
</seglistitem>
</segmentedlist>
</refsect1>
<refsect1>
<title>Notes</title>
<para>
The slot accessors
<function>sql-error-database</function> and
<function>sql-error-expression</function> are
&clsql; extensions.
</para>
</refsect1>
</refentry>
<refentry id="sql-temporary-error">
<refmeta>
<refentrytitle>SQL-TEMPORARY-ERROR</refentrytitle>
</refmeta>
<refnamediv>
<refname>SQL-TEMPORARY-ERROR</refname>
<refpurpose>Used to signal a temporary error in the database
backend.</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Class Precedence List</title>
<para>
<simplelist type="inline">
<member><errortype>sql-temporary-error</errortype></member>
<member><link linkend="sql-database-error"><errortype>sql-database-error</errortype></link></member>
<member><link linkend="sql-error"><errortype>sql-error</errortype></link></member>
<member><errortype>simple-error</errortype></member>
<member><errortype>simple-condition</errortype></member>
<member><errortype>error</errortype></member>
<member><errortype>serious-condition</errortype></member>
<member><link linkend="sql-condition"><errortype>sql-condition</errortype></link></member>
<member><errortype>condition</errortype></member>
<member><errortype>t</errortype></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This condition represents errors occurring when the database
cannot currently process a valid interaction because, for
example, it is still executing another command possibly issued
by another user.
</para>
<para>
The following initialization arguments and accessors exist:
</para>
<segmentedlist>
<segtitle>Initarg</segtitle>
<segtitle>Accessor</segtitle>
<segtitle>Description</segtitle>
<seglistitem>
<seg><symbol>:database</symbol></seg>
<seg><function>sql-error-database</function></seg>
<seg>The database object that was involved in the
incident.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:error-id</symbol></seg>
<seg><function>sql-error-error-id</function></seg>
<seg>The numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:secondary-error-id</symbol></seg>
<seg><function>sql-error-secondary-error-id</function></seg>
<seg>The secondary numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:message</symbol></seg>
<seg><function>sql-error-database-message</function></seg>
<seg>A string describing the problem that occurred,
possibly one returned by the database back-end.</seg>
</seglistitem>
</segmentedlist>
</refsect1>
<refsect1>
<title>Notes</title>
<para>
The slot accessor
<function>sql-error-database</function> is a &clsql;
extension.
</para>
</refsect1>
</refentry>
<refentry id="sql-timeout-error">
<refmeta>
<refentrytitle>SQL-TIMEOUT-ERROR</refentrytitle>
</refmeta>
<refnamediv>
<refname>SQL-TIMEOUT-ERROR</refname>
<refpurpose>condition representing errors when a connection
times out.</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Class Precedence List</title>
<para>
<simplelist type="inline">
<member><link linkend="sql-connection-error"><errortype>sql-connection-error</errortype></link></member>
<member><link linkend="sql-database-error"><errortype>sql-database-error</errortype></link></member>
<member><link linkend="sql-error"><errortype>sql-error</errortype></link></member>
<member><errortype>simple-error</errortype></member>
<member><errortype>simple-condition</errortype></member>
<member><errortype>error</errortype></member>
<member><errortype>serious-condition</errortype></member>
<member><link linkend="sql-condition"><errortype>sql-condition</errortype></link></member>
<member><errortype>condition</errortype></member>
<member><errortype>t</errortype></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>This condition represents errors that occur when the
database times out while processing some operation. The
following initialization arguments and accessors exist:</para>
<segmentedlist>
<segtitle>Initarg</segtitle>
<segtitle>Accessor</segtitle>
<segtitle>Description</segtitle>
<seglistitem>
<seg><symbol>:database-type</symbol></seg>
<seg><function>sql-error-database-type</function></seg>
<seg>Database type for the connection attempt</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:connection-spec</symbol></seg>
<seg><function>sql-error-connection-spec</function></seg>
<seg>The connection specification used in the
connection attempt.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:database</symbol></seg>
<seg><function>sql-error-database</function></seg>
<seg>The database object that was involved in the
incident.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:error-id</symbol></seg>
<seg><function>sql-error-error-id</function></seg>
<seg>The numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:secondary-error-id</symbol></seg>
<seg><function>sql-error-secondary-error-id</function></seg>
<seg>The secondary numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:message</symbol></seg>
<seg><function>sql-error-database-message</function></seg>
<seg>A string describing the problem that occurred,
possibly one returned by the database back-end.</seg>
</seglistitem>
</segmentedlist>
</refsect1>
<refsect1>
<title>Notes</title>
<para>
The slot accessors
<function>sql-error-database</function>,
<function>sql-error-database-type</function> and
<function>sql-error-connection-spec</function> are
&clsql; extensions.
</para>
</refsect1>
</refentry>
<refentry id="sql-fatal-error">
<refmeta>
<refentrytitle>SQL-FATAL-ERROR</refentrytitle>
</refmeta>
<refnamediv>
<refname>SQL-FATAL-ERROR</refname>
<refpurpose>condition representing a fatal error in a database
connection</refpurpose>
<refclass>Condition Type</refclass>
</refnamediv>
<refsect1>
<title>Class Precedence List</title>
<para>
<simplelist type="inline">
<member><link linkend="sql-connection-error"><errortype>sql-connection-error</errortype></link></member>
<member><link linkend="sql-database-error"><errortype>sql-database-error</errortype></link></member>
<member><link linkend="sql-error"><errortype>sql-error</errortype></link></member>
<member><errortype>simple-error</errortype></member>
<member><errortype>simple-condition</errortype></member>
<member><errortype>error</errortype></member>
<member><errortype>serious-condition</errortype></member>
<member><link linkend="sql-condition"><errortype>sql-condition</errortype></link></member>
<member><errortype>condition</errortype></member>
<member><errortype>t</errortype></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>This condition represents errors occurring when the
database connection is no longer usable.
</para>
<para>
The following initialization arguments and accessors exist:
</para>
<segmentedlist>
<segtitle>Initarg</segtitle>
<segtitle>Accessor</segtitle>
<segtitle>Description</segtitle>
<seglistitem>
<seg><symbol>:database-type</symbol></seg>
<seg><function>sql-error-database-type</function></seg>
<seg>Database type for the connection attempt</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:connection-spec</symbol></seg>
<seg><function>sql-error-connection-spec</function></seg>
<seg>The connection specification used in the
connection attempt.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:database</symbol></seg>
<seg><function>sql-error-database</function></seg>
<seg>The database object that was involved in the
incident.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:error-id</symbol></seg>
<seg><function>sql-error-error-id</function></seg>
<seg>The numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:secondary-error-id</symbol></seg>
<seg><function>sql-error-secondary-error-id</function></seg>
<seg>The secondary numeric or symbolic error specification
returned by the database back-end. The values and
semantics of this are interface specific.</seg>
</seglistitem>
<seglistitem>
<seg><symbol>:message</symbol></seg>
<seg><function>sql-error-database-message</function></seg>
<seg>A string describing the problem that occurred,
possibly one returned by the database back-end.</seg>
</seglistitem>
</segmentedlist>
</refsect1>
<refsect1>
<title>Notes</title>
<para>
The slot accessors
<function>sql-error-database</function>,
<function>sql-error-database-type</function> and
<function>sql-error-connection-spec</function> are
&clsql; extensions.
</para>
</refsect1>
</refentry>
</reference>
|