/usr/share/doc/postgresql-9.5-plr/plr-pgsql-support-funcs.html is in postgresql-9.5-plr 1:8.3.0.16-1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>PostgreSQL Support Functions</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PL/R User's Guide - R Procedural Language"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="RPostgreSQL Compatibility Support"
HREF="plr-spi-rsupport-funcs-compat.html"><LINK
REL="NEXT"
TITLE="Aggregate Functions"
HREF="plr-aggregate-funcs.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2015-02-13T14:44:26"></HEAD
><BODY
CLASS="CHAPTER"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="4"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PL/R User's Guide - R Procedural Language</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="RPostgreSQL Compatibility Support"
HREF="plr-spi-rsupport-funcs-compat.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="Aggregate Functions"
HREF="plr-aggregate-funcs.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="PLR-PGSQL-SUPPORT-FUNCS"
></A
>Chapter 7. PostgreSQL Support Functions</H1
><P
> The following commands are available to use in PostgreSQL queries
to aid in the use of PL/R functions:
</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><CODE
CLASS="FUNCTION"
>plr_version</CODE
>()</DT
><DD
><P
> Displays PL/R version as a text string.
</P
></DD
><DT
><CODE
CLASS="FUNCTION"
>install_rcmd</CODE
>
(<TT
CLASS="TYPE"
>text</TT
> <TT
CLASS="REPLACEABLE"
><I
>R_code</I
></TT
>)</DT
><DD
><P
> Install R code, given as a string, into the interpreter. See
<A
HREF="plr-global-data.html"
>Chapter 5</A
> for an example.
</P
></DD
><DT
><CODE
CLASS="FUNCTION"
>reload_plr_modules</CODE
>
()</DT
><DD
><P
> Force re-loading of R code from the <TT
CLASS="LITERAL"
>plr_modules</TT
>
table. It is useful after modifying the contents of
<TT
CLASS="LITERAL"
>plr_modules</TT
>, so that the change will have an
immediate effect.
</P
></DD
><DT
><CODE
CLASS="FUNCTION"
>plr_singleton_array</CODE
>
(<TT
CLASS="TYPE"
>float8</TT
> <TT
CLASS="REPLACEABLE"
><I
>first_element</I
></TT
>)</DT
><DD
><P
> Creates a new PostgreSQL array, using element
<TT
CLASS="REPLACEABLE"
><I
>first_element</I
></TT
>. This function is predefined
to accept one float8 value and return a float8 array. The C function
that implements this PostgreSQL function is capable of accepting and
returning other data types, although the return type must be an array
of the input parameter type. It can also accept multiple input
parameters. For example, to define a <CODE
CLASS="FUNCTION"
>plr_array</CODE
>
function to create a text array from two input text values:
</P><PRE
CLASS="PROGRAMLISTING"
>CREATE OR REPLACE FUNCTION plr_array (text, text)
RETURNS text[]
AS '$libdir/plr','plr_array'
LANGUAGE 'C' WITH (isstrict);
select plr_array('hello','world');
plr_array
---------------
{hello,world}
(1 row)
</PRE
><P>
</P
></DD
><DT
><CODE
CLASS="FUNCTION"
>plr_array_push</CODE
>
(<TT
CLASS="TYPE"
>float8[]</TT
> <TT
CLASS="REPLACEABLE"
><I
>array</I
></TT
>,
<TT
CLASS="TYPE"
>float8</TT
> <TT
CLASS="REPLACEABLE"
><I
>next_element</I
></TT
>)</DT
><DD
><P
> Pushes a new element onto the end of an existing PostgreSQL array.
This function is predefined to accept one float8 array and a float8
value, and return a float8 array. The C function that implements this
PostgreSQL function is capable of accepting and returning other data
types. For example, to define a <CODE
CLASS="FUNCTION"
>plr_array_push</CODE
>
function to add a text value to an existing text array:
</P><PRE
CLASS="PROGRAMLISTING"
>CREATE OR REPLACE FUNCTION plr_array_push (_text, text)
RETURNS text[]
AS '$libdir/plr','plr_array_push'
LANGUAGE 'C' WITH (isstrict);
select plr_array_push(plr_array('hello','world'), 'how are you');
plr_array_push
-----------------------------
{hello,world,"how are you"}
(1 row)
</PRE
><P>
</P
></DD
><DT
><CODE
CLASS="FUNCTION"
>plr_array_accum</CODE
>
(<TT
CLASS="TYPE"
>float8[]</TT
> <TT
CLASS="REPLACEABLE"
><I
>state_value</I
></TT
>,
<TT
CLASS="TYPE"
>float8</TT
> <TT
CLASS="REPLACEABLE"
><I
>next_element</I
></TT
>)</DT
><DD
><P
> Creates a new array using <TT
CLASS="REPLACEABLE"
><I
>next_element</I
></TT
> if
<TT
CLASS="REPLACEABLE"
><I
>state_value</I
></TT
> is NULL. Otherwise, pushes
<TT
CLASS="REPLACEABLE"
><I
>next_element</I
></TT
> onto the end of
<TT
CLASS="REPLACEABLE"
><I
>state_value</I
></TT
>. This function is predefined
to accept one float8 array and a float8 value, and return a float8
array. The C function that implements this PostgreSQL function is
capable of accepting and returning other data types. For example,
to define a <CODE
CLASS="FUNCTION"
>plr_array_accum</CODE
> function to add an
int4 value to an existing int4 array:
</P><PRE
CLASS="PROGRAMLISTING"
>CREATE OR REPLACE FUNCTION plr_array_accum (_int4, int4)
RETURNS int4[]
AS '$libdir/plr','plr_array_accum'
LANGUAGE 'C';
select plr_array_accum(NULL, 42);
plr_array_accum
-------------
{42}
(1 row)
select plr_array_accum('{23,35}', 42);
plr_array_accum
-----------------
{23,35,42}
(1 row)
</PRE
><P>
This function may be useful for creating custom aggregates. See
<A
HREF="plr-aggregate-funcs.html"
>Chapter 8</A
> for an example.
</P
></DD
><DT
><CODE
CLASS="FUNCTION"
>load_r_typenames</CODE
>()</DT
><DD
><P
> Installs datatype Oid variables into the R interpreter
as globals. See also <CODE
CLASS="FUNCTION"
>r_typenames</CODE
> below.
</P
></DD
><DT
><CODE
CLASS="FUNCTION"
>r_typenames</CODE
>()</DT
><DD
><P
> Displays the datatype Oid variables installed into the R interpreter
as globals. See <A
HREF="plr-spi-rsupport-funcs.html"
>Chapter 6</A
> for an example.
</P
></DD
><DT
><CODE
CLASS="FUNCTION"
>plr_environ</CODE
>()</DT
><DD
><P
> Displays the environment under which the Postmaster is currently
running. This may be useful to debug issues related to R specific
environment variables. This function is installed with EXECUTE
permission revoked from PUBLIC.
</P
></DD
><DT
><CODE
CLASS="FUNCTION"
>plr_set_display</CODE
>(<TT
CLASS="TYPE"
>text</TT
> <TT
CLASS="REPLACEABLE"
><I
>display</I
></TT
>)</DT
><DD
><P
> Sets the DISPLAY environment vaiable under which the Postmaster is currently
running. This may be useful if using R to plot to a virtual frame buffer.
This function is installed with EXECUTE permission revoked from PUBLIC.
</P
></DD
><DT
><CODE
CLASS="FUNCTION"
>plr_get_raw</CODE
>(<TT
CLASS="TYPE"
>bytea</TT
> <TT
CLASS="REPLACEABLE"
><I
>serialized_object</I
></TT
>)</DT
><DD
><P
> By default, when R objects are returned as type <TT
CLASS="TYPE"
>bytea</TT
>, the
R object is serialized using an internal R function prior to sending to PostgreSQL.
This function unserializes the R object using another internal R function, and
returns the pure raw bytes to PostgreSQL. This is useful, for example, if the R
object being returned is a JPEG or PNG graphic for use outside of R.
</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="plr-spi-rsupport-funcs-compat.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="plr-aggregate-funcs.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>RPostgreSQL Compatibility Support</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
> </TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Aggregate Functions</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
|