Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit e3f3a16

Browse files
author
Liudmila Mantrova
committed
DOC: updated pg-variables docs as per PGPRO-1420
1 parent 56fe710 commit e3f3a16

File tree

1 file changed

+36
-23
lines changed

1 file changed

+36
-23
lines changed

doc/src/sgml/pg_variables.sgml

Lines changed: 36 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
example:
1414
</para>
1515
<programlisting>
16-
SELECT pgv_set_int('vars', 'int1', 101);
16+
postgres=# SELECT pgv_set_int('vars', 'int1', 101);
1717
BEGIN;
18-
SELECT pgv_set_int('vars', 'int2', 102);
18+
postgres=# SELECT pgv_set_int('vars', 'int2', 102);
1919
ROLLBACK;
2020

21-
SELECT * FROM pgv_list() order by package, name;
21+
postgres=# SELECT * FROM pgv_list() ORDER BY package, name;
2222
package | name
2323
---------+------
2424
vars | int1
@@ -27,8 +27,21 @@ SELECT * FROM pgv_list() order by package, name;
2727
</programlisting>
2828
</sect2>
2929

30+
<sect2>
31+
<title>Installation</title>
32+
<para>
33+
The <filename>pg_variables</filename> extension is included into
34+
&productname;. Once you have &productname; installed, you must
35+
execute the <xref linkend="sql-createextension"> command to enable
36+
<filename>pg_variables</filename>, as follows:
37+
<programlisting>
38+
CREATE EXTENSION pg_variables;
39+
</programlisting>
40+
</para>
41+
</sect2>
42+
3043
<sect2 id="pg-variables-functions">
31-
<title>Module functions</title>
44+
<title>Functions</title>
3245

3346
<para>
3447
The functions provided by the <filename>pg_variables</filename> module are
@@ -47,7 +60,7 @@ SELECT * FROM pgv_list() order by package, name;
4760
</para>
4861

4962
<programlisting>
50-
SELECT pgv_get_int('vars', 'int1');
63+
postgres=# SELECT pgv_get_int('vars', 'int1');
5164
ERROR: unrecognized package "vars"
5265
</programlisting>
5366

@@ -56,7 +69,7 @@ ERROR: unrecognized package "vars"
5669
</para>
5770

5871
<programlisting>
59-
SELECT pgv_get_int('vars', 'int1');
72+
postgres=# SELECT pgv_get_int('vars', 'int1');
6073
ERROR: unrecognized variable "int1"
6174
</programlisting>
6275

@@ -66,7 +79,7 @@ ERROR: unrecognized variable "int1"
6679
</para>
6780

6881
<programlisting>
69-
SELECT pgv_get_text('vars', 'int1');
82+
postgres=# SELECT pgv_get_text('vars', 'int1');
7083
ERROR: variable "int1" requires "integer" value
7184
</programlisting>
7285

@@ -537,16 +550,16 @@ ERROR: variable "int1" requires "integer" value
537550
It is easy to use functions to work with scalar variables:
538551
</para>
539552
<programlisting>
540-
SELECT pgv_set_int('vars', 'int1', 101);
541-
SELECT pgv_set_int('vars', 'int2', 102);
553+
postgres=# SELECT pgv_set_int('vars', 'int1', 101);
554+
postgres=# SELECT pgv_set_int('vars', 'int2', 102);
542555

543-
SELECT pgv_get_int('vars', 'int1');
556+
postgres=# SELECT pgv_get_int('vars', 'int1');
544557
pgv_get_int
545558
-------------
546559
101
547560
(1 row)
548561

549-
SELECT pgv_get_int('vars', 'int2');
562+
postgres=# SELECT pgv_get_int('vars', 'int2');
550563
pgv_get_int
551564
-------------
552565
102
@@ -563,37 +576,37 @@ INSERT INTO tab VALUES (0, 'str00'), (1, 'str11');
563576
Then you can use functions to work with record variables:
564577
</para>
565578
<programlisting>
566-
SELECT pgv_insert('vars', 'r1', tab) FROM tab;
579+
postgres=# SELECT pgv_insert('vars', 'r1', tab) FROM tab;
567580

568-
SELECT pgv_select('vars', 'r1');
581+
postgres=# SELECT pgv_select('vars', 'r1');
569582
pgv_select
570583
------------
571584
(1,str11)
572585
(0,str00)
573586
(2 rows)
574587

575-
SELECT pgv_select('vars', 'r1', 1);
588+
postgres=# pgv_select('vars', 'r1', 1);
576589
pgv_select
577590
------------
578591
(1,str11)
579592
(1 row)
580593

581-
SELECT pgv_select('vars', 'r1', 0);
594+
postgres=# SELECT pgv_select('vars', 'r1', 0);
582595
pgv_select
583596
------------
584597
(0,str00)
585598
(1 row)
586599

587-
SELECT pgv_select('vars', 'r1', ARRAY[1, 0]);
600+
postgres=# SELECT pgv_select('vars', 'r1', ARRAY[1, 0]);
588601
pgv_select
589602
------------
590603
(1,str11)
591604
(0,str00)
592605
(2 rows)
593606

594-
SELECT pgv_delete('vars', 'r1', 1);
607+
postgres=# SELECT pgv_delete('vars', 'r1', 1);
595608

596-
SELECT pgv_select('vars', 'r1');
609+
postgres=# SELECT pgv_select('vars', 'r1');
597610
pgv_select
598611
------------
599612
(0,str00)
@@ -603,7 +616,7 @@ SELECT pgv_select('vars', 'r1');
603616
You can list packages and variables:
604617
</para>
605618
<programlisting>
606-
SELECT * FROM pgv_list() order by package, name;
619+
postgres=# SELECT * FROM pgv_list() ORDER BY package, name;
607620
package | name
608621
---------+------
609622
vars | int1
@@ -615,7 +628,7 @@ SELECT * FROM pgv_list() order by package, name;
615628
And get used memory in bytes:
616629
</para>
617630
<programlisting>
618-
SELECT * FROM pgv_stats() order by package;
631+
postgres=# SELECT * FROM pgv_stats() ORDER BY package;
619632
package | used_memory
620633
---------+-------------
621634
vars | 16736
@@ -625,14 +638,14 @@ SELECT * FROM pgv_stats() order by package;
625638
You can delete variables or whole packages:
626639
</para>
627640
<programlisting>
628-
SELECT pgv_remove('vars', 'int1');
629-
SELECT pgv_remove('vars');
641+
postgres=# SELECT pgv_remove('vars', 'int1');
642+
postgres=# SELECT pgv_remove('vars');
630643
</programlisting>
631644
<para>
632645
You can delete all packages and variables:
633646
</para>
634647
<programlisting>
635-
SELECT pgv_free();
648+
postgres=# SELECT pgv_free();
636649
</programlisting>
637650
</sect2>
638651
</sect1>

0 commit comments

Comments
 (0)