Mercurial > hg > xemacs-beta

comparison man/lispref/postgresql.texi @ 1738:f43f9ca6c7d9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[xemacs-hg @ 2003-10-10 12:39:27 by stephent] @var -> @code <87ad89mfs3.fsf_-_@tleepslib.sk.tsukuba.ac.jp>
author stephent
date Fri, 10 Oct 2003 12:39:45 +0000
parents 5aa1854ad537
children 9fae6227ede5
comparison
equal deleted inserted replaced
1737:68ed93de81b7 1738:f43f9ca6c7d9
102 convenient access to Lisp Code. These variables are passed to the 102 convenient access to Lisp Code. These variables are passed to the
103 backend database server during the establishment of a database 103 backend database server during the establishment of a database
104 connection and when the @code{pq-setenv} call is made. 104 connection and when the @code{pq-setenv} call is made.
105 105
106 @defvar pg:host 106 @defvar pg:host
107 Initialized from the @var{PGHOST} environment variable. The default 107 Initialized from the @code{PGHOST} environment variable. The default
108 host to connect to. 108 host to connect to.
109 @end defvar 109 @end defvar
110 110
111 @defvar pg:user 111 @defvar pg:user
112 Initialized from the @var{PGUSER} environment variable. The default 112 Initialized from the @code{PGUSER} environment variable. The default
113 database user name. 113 database user name.
114 @end defvar 114 @end defvar
115 115
116 @defvar pg:options 116 @defvar pg:options
117 Initialized from the @var{PGOPTIONS} environment variable. Default 117 Initialized from the @code{PGOPTIONS} environment variable. Default
118 additional server options. 118 additional server options.
119 @end defvar 119 @end defvar
120 120
121 @defvar pg:port 121 @defvar pg:port
122 Initialized from the @var{PGPORT} environment variable. The default TCP 122 Initialized from the @code{PGPORT} environment variable. The default
123 port to connect to. 123 TCP port to connect to.
124 @end defvar 124 @end defvar
125 125
126 @defvar pg:tty 126 @defvar pg:tty
127 Initialized from the @var{PGTTY} environment variable. The default 127 Initialized from the @code{PGTTY} environment variable. The default
128 debugging TTY. 128 debugging TTY.
129 129
130 Compatibility note: Debugging TTYs are turned off in the XEmacs Lisp 130 Compatibility note: Debugging TTYs are turned off in the XEmacs Lisp
131 binding. 131 binding.
132 @end defvar 132 @end defvar
133 133
134 @defvar pg:database 134 @defvar pg:database
135 Initialized from the @var{PGDATABASE} environment variable. The default 135 Initialized from the @code{PGDATABASE} environment variable. The
136 database to connect to. 136 default database to connect to.
137 @end defvar 137 @end defvar
138 138
139 @defvar pg:realm 139 @defvar pg:realm
140 Initialized from the @var{PGREALM} environment variable. The default 140 Initialized from the @code{PGREALM} environment variable. The default
141 Kerberos realm. 141 Kerberos realm.
142 @end defvar 142 @end defvar
143 143
144 @defvar pg:client-encoding 144 @defvar pg:client-encoding
145 Initialized from the @var{PGCLIENTENCODING} environment variable. The 145 Initialized from the @code{PGCLIENTENCODING} environment variable. The
146 default client encoding. 146 default client encoding.
147 147
148 Compatibility note: This variable is not present in non-Mule XEmacsen. 148 Compatibility note: This variable is not present in non-Mule XEmacsen.
149 This variable is not present in versions of libpq prior to 7.0. 149 This variable is not present in versions of libpq prior to 7.0.
150 In the current implementation, client encoding is equivalent to the 150 In the current implementation, client encoding is equivalent to the
151 @code{file-name-coding-system} format. 151 @code{file-name-coding-system} format.
152 @end defvar 152 @end defvar
153 153
154 @c unused 154 @c unused
155 @defvar pg:authtype 155 @defvar pg:authtype
156 Initialized from the @var{PGAUTHTYPE} environment variable. The default 156 Initialized from the @code{PGAUTHTYPE} environment variable. The
157 authentication scheme used. 157 default authentication scheme used.
158 158
159 Compatibility note: This variable is unused in versions of libpq after 159 Compatibility note: This variable is unused in versions of libpq after
160 6.5. It is not implemented at all in the XEmacs Lisp binding. 160 6.5. It is not implemented at all in the XEmacs Lisp binding.
161 @end defvar 161 @end defvar
162 162
163 @defvar pg:geqo 163 @defvar pg:geqo
164 Initialized from the @var{PGGEQO} environment variable. Genetic 164 Initialized from the @code{PGGEQO} environment variable. Genetic
165 optimizer options. 165 optimizer options.
166 @end defvar 166 @end defvar
167 167
168 @defvar pg:cost-index 168 @defvar pg:cost-index
169 Initialized from the @var{PGCOSTINDEX} environment variable. Cost index 169 Initialized from the @code{PGCOSTINDEX} environment variable. Cost
170 index options.
171 @end defvar
172
173 @defvar pg:cost-heap
174 Initialized from the @code{PGCOSTHEAP} environment variable. Cost heap
170 options. 175 options.
171 @end defvar 176 @end defvar
172 177
173 @defvar pg:cost-heap
174 Initialized from the @var{PGCOSTHEAP} environment variable. Cost heap
175 options.
176 @end defvar
177
178 @defvar pg:tz 178 @defvar pg:tz
179 Initialized from the @var{PGTZ} environment variable. Default 179 Initialized from the @code{PGTZ} environment variable. Default
180 timezone. 180 timezone.
181 @end defvar 181 @end defvar
182 182
183 @defvar pg:date-style 183 @defvar pg:date-style
184 Initialized from the @var{PGDATESTYLE} environment variable. Default 184 Initialized from the @code{PGDATESTYLE} environment variable. Default
185 date style in returned date objects. 185 date style in returned date objects.
186 @end defvar 186 @end defvar
187 187
188 @defvar pg-coding-system 188 @defvar pg-coding-system
189 This is a variable controlling which coding system is used to encode 189 This is a variable controlling which coding system is used to encode
336 Copy In data transfer is in progress. 336 Copy In data transfer is in progress.
337 @item pgres::bad-response 337 @item pgres::bad-response
338 An unexpected response was received from the backend. 338 An unexpected response was received from the backend.
339 @item pgres::nonfatal-error 339 @item pgres::nonfatal-error
340 Undocumented. This value is returned when the libpq function 340 Undocumented. This value is returned when the libpq function
341 @code{PQresultStatus} is called with a @var{NULL} pointer. 341 @code{PQresultStatus} is called with a @code{NULL} pointer.
342 @item pgres::fatal-error 342 @item pgres::fatal-error
343 Undocumented. An error has occurred in processing the query and the 343 Undocumented. An error has occurred in processing the query and the
344 operation was not completed. 344 operation was not completed.
345 @end table 345 @end table
346 @end defun 346 @end defun
508 @result{} 8 508 @result{} 8
509 @end example 509 @end example
510 @end defun 510 @end defun
511 511
512 @defun pq-get-is-null result tup-num field-num 512 @defun pq-get-is-null result tup-num field-num
513 Return t if the specific value is the SQL @var{NULL}. 513 Return t if the specific value is the SQL @code{NULL}.
514 @var{result} is a PGresult object. 514 @var{result} is a PGresult object.
515 @var{tup-num} selects which tuple to fetch from. 515 @var{tup-num} selects which tuple to fetch from.
516 @var{field-num} selects which field to fetch from. 516 @var{field-num} selects which field to fetch from.
517 @end defun 517 @end defun
518 518
646 @end example 646 @end example
647 647
648 The following options are available in the options string: 648 The following options are available in the options string:
649 @table @code 649 @table @code
650 @item authtype 650 @item authtype
651 Authentication type. Same as @var{PGAUTHTYPE}. This is no longer used. 651 Authentication type. Same as @code{PGAUTHTYPE}. This is no longer used.
652 @item user 652 @item user
653 Database user name. Same as @var{PGUSER}. 653 Database user name. Same as @code{PGUSER}.
654 @item password 654 @item password
655 Database password. 655 Database password.
656 @item dbname 656 @item dbname
657 Database name. Same as @var{PGDATABASE} 657 Database name. Same as @code{PGDATABASE}
658 @item host 658 @item host
659 Symbolic hostname. Same as @var{PGHOST}. 659 Symbolic hostname. Same as @code{PGHOST}.
660 @item hostaddr 660 @item hostaddr
661 Host address as four octets (eg. like 192.168.1.1). 661 Host address as four octets (eg. like 192.168.1.1).
662 @item port 662 @item port
663 TCP port to connect to. Same as @var{PGPORT}. 663 TCP port to connect to. Same as @code{PGPORT}.
664 @item tty 664 @item tty
665 Debugging TTY. Same as @var{PGTTY}. This value is suppressed in the 665 Debugging TTY. Same as @code{PGTTY}. This value is suppressed in the
666 XEmacs Lisp API. 666 XEmacs Lisp API.
667 @item options 667 @item options
668 Extra backend database options. Same as @var{PGOPTIONS}. 668 Extra backend database options. Same as @code{PGOPTIONS}.
669 @end table 669 @end table
670 A database connection object is returned regardless of whether a 670 A database connection object is returned regardless of whether a
671 connection was established or not. 671 connection was established or not.
672 @end defun 672 @end defun
673 673
895 Compatibility note: This function did not exist prior to libpq-7.0 and 895 Compatibility note: This function did not exist prior to libpq-7.0 and
896 does not exist in a non-Mule XEmacs. 896 does not exist in a non-Mule XEmacs.
897 @end defun 897 @end defun
898 898
899 @defun pq-env-2-encoding 899 @defun pq-env-2-encoding
900 Return the integer code representing the coding system in @var{PGCLIENTENCODING}. 900 Return the integer code representing the coding system in
901 @code{PGCLIENTENCODING}.
901 902
902 @example 903 @example
903 (pq-env-2-encoding) 904 (pq-env-2-encoding)
904 @result{} 0 905 @result{} 0
905 @end example 906 @end example