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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="pgsql.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry xml:id="constant.pgsql-libpq-version">
<term>
<constant>PGSQL_LIBPQ_VERSION</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
Short libpq version that contains only numbers and dots.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-libpq-version-str">
<term>
<constant>PGSQL_LIBPQ_VERSION_STR</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
Prior to PHP 8.0.0, the long libpq version that includes compiler information.
As of PHP 8.0.0, the value is identical to <constant>PGSQL_LIBPQ_VERSION</constant>,
and using <constant>PGSQL_LIBPQ_VERSION_STR</constant> is deprecated.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-assoc">
<term>
<constant>PGSQL_ASSOC</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_fetch_array</function>. Return an associative array of field
names and values.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-num">
<term>
<constant>PGSQL_NUM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_fetch_array</function>. Return a numerically indexed array of field
numbers and values.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-both">
<term>
<constant>PGSQL_BOTH</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_fetch_array</function>. Return an array of field values
that is both numerically indexed (by field number) and associated (by field name).
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-connect-force-new">
<term>
<constant>PGSQL_CONNECT_FORCE_NEW</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_connect</function> to force the creation of a new connection,
rather than re-using an existing identical connection.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-connect-async">
<term>
<constant>PGSQL_CONNECT_ASYNC</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_connect</function> to create an asynchronous
connection.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-connection-auth-ok">
<term>
<constant>PGSQL_CONNECTION_AUTH_OK</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-connection-awaiting-response">
<term>
<constant>PGSQL_CONNECTION_AWAITING_RESPONSE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-connection-bad">
<term>
<constant>PGSQL_CONNECTION_BAD</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_connection_status</function> indicating that the database
connection is in an invalid state.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-connection-made">
<term>
<constant>PGSQL_CONNECTION_MADE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-connection-ok">
<term>
<constant>PGSQL_CONNECTION_OK</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_connection_status</function> indicating that the database
connection is in a valid state.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-connection-setenv">
<term>
<constant>PGSQL_CONNECTION_SETENV</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-connection-ssl-startup">
<term>
<constant>PGSQL_CONNECTION_SSL_STARTUP</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-connection-started">
<term>
<constant>PGSQL_CONNECTION_STARTED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-seek-set">
<term>
<constant>PGSQL_SEEK_SET</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_lo_seek</function>. Seek operation is to begin
from the start of the object.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-seek-cur">
<term>
<constant>PGSQL_SEEK_CUR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_lo_seek</function>. Seek operation is to begin
from the current position.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-seek-end">
<term>
<constant>PGSQL_SEEK_END</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_lo_seek</function>. Seek operation is to begin
from the end of the object.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-empty-query">
<term>
<constant>PGSQL_EMPTY_QUERY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_result_status</function>. The string sent to the server
was empty.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-command-ok">
<term>
<constant>PGSQL_COMMAND_OK</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_result_status</function>. Successful completion of a
command returning no data.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-tuples-ok">
<term>
<constant>PGSQL_TUPLES_OK</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_result_status</function>. Successful completion of a command
returning data (such as a <literal>SELECT</literal> or <literal>SHOW</literal>).
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-tuples-chunk">
<term>
<constant>PGSQL_TUPLES_CHUNK</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_result_status</function>.
Indicates the successful completion of a command returning data in chunked mode.
Returned for <literal>SELECT</literal> commands when
<function>pg_set_chunked_rows_size</function> is set.
The result set is divided into multiple chunks, each containing a predefined number of rows.
Available as of PHP 8.4.0 and libpq 17.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-copy-out">
<term>
<constant>PGSQL_COPY_OUT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_result_status</function>. Copy Out (from server) data
transfer started.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-copy-in">
<term>
<constant>PGSQL_COPY_IN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_result_status</function>. Copy In (to server) data
transfer started.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-bad-response">
<term>
<constant>PGSQL_BAD_RESPONSE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_result_status</function>. The server's response
was not understood.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-nonfatal-error">
<term>
<constant>PGSQL_NONFATAL_ERROR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_result_status</function>. A nonfatal error
(a notice or warning) occurred.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-fatal-error">
<term>
<constant>PGSQL_FATAL_ERROR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_result_status</function>. A fatal error
occurred.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-transaction-idle">
<term>
<constant>PGSQL_TRANSACTION_IDLE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_transaction_status</function>. Connection is
currently idle, not in a transaction.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-transaction-active">
<term>
<constant>PGSQL_TRANSACTION_ACTIVE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_transaction_status</function>. A command
is in progress on the connection. A query has been sent via the connection
and not yet completed.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-transaction-intrans">
<term>
<constant>PGSQL_TRANSACTION_INTRANS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_transaction_status</function>. The connection
is idle, in a transaction block.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-transaction-inerror">
<term>
<constant>PGSQL_TRANSACTION_INERROR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_transaction_status</function>. The connection
is idle, in a failed transaction block.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-transaction-unknown">
<term>
<constant>PGSQL_TRANSACTION_UNKNOWN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_transaction_status</function>. The connection
is bad.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-severity">
<term>
<constant>PGSQL_DIAG_SEVERITY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
The severity; the field contents are <literal>ERROR</literal>,
<literal>FATAL</literal>, or <literal>PANIC</literal> (in an error message), or
<literal>WARNING</literal>, <literal>NOTICE</literal>, <literal>DEBUG</literal>,
<literal>INFO</literal>, or <literal>LOG</literal> (in a notice message), or a localized
translation of one of these. Always present.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-sqlstate">
<term>
<constant>PGSQL_DIAG_SQLSTATE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
The SQLSTATE code for the error. The SQLSTATE code identifies the type of error
that has occurred; it can be used by front-end applications to perform specific
operations (such as error handling) in response to a particular database error.
This field is not localizable, and is always present.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-message-primary">
<term>
<constant>PGSQL_DIAG_MESSAGE_PRIMARY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
The primary human-readable error message (typically one line). Always present.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-message-detail">
<term>
<constant>PGSQL_DIAG_MESSAGE_DETAIL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
Detail: an optional secondary error message carrying more detail about the problem. May run to multiple lines.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-message-hint">
<term>
<constant>PGSQL_DIAG_MESSAGE_HINT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
Hint: an optional suggestion what to do about the problem. This is intended to differ from detail in that it
offers advice (potentially inappropriate) rather than hard facts. May run to multiple lines.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-statement-position">
<term>
<constant>PGSQL_DIAG_STATEMENT_POSITION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
A string containing a decimal integer indicating an error cursor position as an index into the original
statement string. The first character has index 1, and positions are measured in characters not bytes.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-internal-position">
<term>
<constant>PGSQL_DIAG_INTERNAL_POSITION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
This is defined the same as the <constant>PG_DIAG_STATEMENT_POSITION</constant> field, but
it is used when the cursor position refers to an internally generated
command rather than the one submitted by the client. The
<constant>PG_DIAG_INTERNAL_QUERY</constant> field will always appear when this
field appears.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-internal-query">
<term>
<constant>PGSQL_DIAG_INTERNAL_QUERY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
The text of a failed internally-generated command. This could be, for example, a
SQL query issued by a PL/pgSQL function.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-context">
<term>
<constant>PGSQL_DIAG_CONTEXT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
An indication of the context in which the error occurred. Presently
this includes a call stack traceback of active procedural language
functions and internally-generated queries. The trace is one entry
per line, most recent first.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-source-file">
<term>
<constant>PGSQL_DIAG_SOURCE_FILE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
The file name of the PostgreSQL source-code location where the error
was reported.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-source-line">
<term>
<constant>PGSQL_DIAG_SOURCE_LINE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
The line number of the PostgreSQL source-code location where the
error was reported.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-source-function">
<term>
<constant>PGSQL_DIAG_SOURCE_FUNCTION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_error_field</function>.
The name of the PostgreSQL source-code function reporting the error.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-schema-name">
<term>
<constant>PGSQL_DIAG_SCHEMA_NAME</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available since PHP 7.3.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-table-name">
<term>
<constant>PGSQL_DIAG_TABLE_NAME</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available since PHP 7.3.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-column-name">
<term>
<constant>PGSQL_DIAG_COLUMN_NAME</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available since PHP 7.3.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-datatype-name">
<term>
<constant>PGSQL_DIAG_DATATYPE_NAME</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available since PHP 7.3.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-constraint-name">
<term>
<constant>PGSQL_DIAG_CONSTRAINT_NAME</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available since PHP 7.3.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-errors-terse">
<term>
<constant>PGSQL_ERRORS_TERSE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_set_error_verbosity</function>.
Specified that returned messages include severity, primary text,
and position only; this will normally fit on a single line.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-errors-default">
<term>
<constant>PGSQL_ERRORS_DEFAULT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_set_error_verbosity</function>.
The default mode produces messages that include the above
plus any detail, hint, or context fields (these may span
multiple lines).
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-errors-verbose">
<term>
<constant>PGSQL_ERRORS_VERBOSE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_set_error_verbosity</function>.
The verbose mode includes all available fields.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-errors-sqlstate">
<term>
<constant>PGSQL_ERRORS_SQLSTATE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_set_error_verbosity</function>.
Includes only the error severity and the <literal>SQLSTATE</literal> error code.
If no error code is available, the output is like
<constant>PGSQL_ERRORS_TERSE</constant> mode.
Before PostgreSQL 11.1, the output is always the same
as in <constant>PGSQL_ERRORS_TERSE</constant> mode.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-notice-last">
<term>
<constant>PGSQL_NOTICE_LAST</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Used by <function>pg_last_notice</function>.
Available since PHP 7.1.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-notice-all">
<term>
<constant>PGSQL_NOTICE_ALL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Used by <function>pg_last_notice</function>.
Available since PHP 7.1.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-notice-clear">
<term>
<constant>PGSQL_NOTICE_CLEAR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Used by <function>pg_last_notice</function>.
Available since PHP 7.1.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-status-long">
<term>
<constant>PGSQL_STATUS_LONG</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_status</function>. Indicates that
numerical result code is desired.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-status-string">
<term>
<constant>PGSQL_STATUS_STRING</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_result_status</function>. Indicates that
textual result command tag is desired.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-conv-ignore-default">
<term>
<constant>PGSQL_CONV_IGNORE_DEFAULT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_convert</function>.
Ignore default values in the table during conversion.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-conv-force-null">
<term>
<constant>PGSQL_CONV_FORCE_NULL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_convert</function>.
Use SQL <literal>NULL</literal> in place of an empty <type>string</type>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-conv-ignore-not-null">
<term>
<constant>PGSQL_CONV_IGNORE_NOT_NULL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_convert</function>.
Ignore conversion of &null; into SQL <literal>NOT NULL</literal> columns.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-dml-no-conv">
<term>
<constant>PGSQL_DML_NO_CONV</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_insert</function>, <function>pg_select</function>,
<function>pg_update</function> and <function>pg_delete</function>.
All parameters passed as is. Manual escape is required
if parameters contain user supplied data. Use <function>pg_escape_string</function>
for it.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-dml-exec">
<term>
<constant>PGSQL_DML_EXEC</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_insert</function>, <function>pg_select</function>,
<function>pg_update</function> and <function>pg_delete</function>.
Execute query by these functions.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-dml-async">
<term>
<constant>PGSQL_DML_ASYNC</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_insert</function>, <function>pg_select</function>,
<function>pg_update</function> and <function>pg_delete</function>.
Execute asynchronous query by these functions.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-dml-string">
<term>
<constant>PGSQL_DML_STRING</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_insert</function>, <function>pg_select</function>,
<function>pg_update</function> and <function>pg_delete</function>.
Return executed query string.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-dml-escape">
<term>
<constant>PGSQL_DML_ESCAPE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Passed to <function>pg_insert</function>, <function>pg_select</function>,
<function>pg_update</function> and <function>pg_delete</function>.
Apply escape to all parameters instead of calling <function>pg_convert</function>
internally. This option omits meta data look up. Query could be as fast as
<function>pg_query</function> and <function>pg_send_query</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-polling-failed">
<term>
<constant>PGSQL_POLLING_FAILED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_connect_poll</function> to indicate that the
connection attempt failed.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-polling-reading">
<term>
<constant>PGSQL_POLLING_READING</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_connect_poll</function> to indicate that the
connection is waiting for the PostgreSQL socket to be readable.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-polling-writing">
<term>
<constant>PGSQL_POLLING_WRITING</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_connect_poll</function> to indicate that the
connection is waiting for the PostgreSQL socket to be writable.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-polling-ok">
<term>
<constant>PGSQL_POLLING_OK</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_connect_poll</function> to indicate that the
connection is ready to be used.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-polling-active">
<term>
<constant>PGSQL_POLLING_ACTIVE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Returned by <function>pg_connect_poll</function> to indicate that the
connection is currently active.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-diag-severity-nonlocalized">
<term>
<constant>PGSQL_DIAG_SEVERITY_NONLOCALIZED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The severity; the field contents are ERROR, FATAL, or PANIC (in an error message), or WARNING, NOTICE, DEBUG, INFO, or LOG (in a notice message). This is identical to the PG_DIAG_SEVERITY field except that the contents are never localized. This is present only in versions 9.6 and later / PHP 7.3.0 and later.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-show-context-never">
<term>
<constant>PGSQL_SHOW_CONTEXT_NEVER</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
To be used with <function>pg_set_error_context_visibility</function>,
the context is never shown.
Available as of PHP 8.3.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-show-context-errors">
<term>
<constant>PGSQL_SHOW_CONTEXT_ERRORS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
To be used with <function>pg_set_error_context_visibility</function>,
the context's fields are included in error messages only.
This is the default behaviour.
Available as of PHP 8.3.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-show-context-always">
<term>
<constant>PGSQL_SHOW_CONTEXT_ALWAYS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
To be used with <function>pg_set_error_context_visibility</function>,
the context's fields are included in error, notice and warning messages.
Available as of PHP 8.3.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-trace-suppress-timestamps">
<term>
<constant>PGSQL_TRACE_SUPPRESS_TIMESTAMPS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
To be used with <function>pg_trace</function>,
the timestamp is not included in the trace's messages.
Available as of PHP 8.3.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-trace-regress-mode">
<term>
<constant>PGSQL_TRACE_REGRESS_MODE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
To be used with <function>pg_trace</function>,
fields such as OIDs are included in the trace's messages.
Available as of PHP 8.3.0.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|