forked from gleu/pgdocs_fr
/
plpython.xml
1461 lines (1302 loc) · 53.2 KB
/
plpython.xml
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
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!-- Dernière modification
le $Date$
par $Author$
révision $Revision$ -->
<chapter id="plpython">
<title>PL/Python - Langage de procédures Python</title>
<indexterm zone="plpython"><primary>PL/Python</primary></indexterm>
<indexterm zone="plpython"><primary>Python</primary></indexterm>
<para>
Le langage de procédures <application>PL/Python</application> permet
l'écriture de fonctions <productname>PostgreSQL</productname> avec le
<ulink url="http://www.python.org">langage Python</ulink> (mais voir aussi
<xref linkend="plpython-python23"/>).
</para>
<para>
Pour installer PL/Python dans une base de données particulières, utilisez
<literal>CREATE EXTENSION plpythonu</literal>. À partir de la ligne de
commandes, utilisez <literal>createlang plpythonu
<replaceable>nom_base</replaceable></literal>.
</para>
<tip>
<para>
Si un langage est installé dans <literal>template1</literal>, toutes les bases
nouvellement créées se verront installées ce langage automatiquement.
</para>
</tip>
<para>
Depuis <productname>PostgreSQL</productname> 7.4, PL/Python est seulement
disponible en tant que langage <quote>sans confiance</quote> (ceci signifiant
qu'il n'offre aucun moyen de restreindre ce que les utilisateurs en font). Il
a donc été renommé en <literal>plpythonu</literal>. La variante de confiance
<literal>plpython</literal> pourrait être de nouveau disponible dans le futur, si un
nouveau mécanisme sécurisé d'exécution est développé dans Python. Le codeur
d'une fonction dans PL/Python sans confiance doit faire attention à ce que
cette fonction ne puisse pas être utilisée pour réaliser quelque chose qui
n'est pas prévue car il sera possible de faire tout ce que peut faire un
utilisateur connecté en tant qu'administrateur de la base de données. Seuls
les superutilisateurs peuvent créer des fonctions dans des langages sans
confiance comme <literal>plpythonu</literal>.
</para>
<note>
<para>
Les utilisateurs des paquets sources doivent activer spécifiquement la
construction de PL/Python lors des étapes d'installation (référez-vous aux
instructions d'installation pour plus d'informations). Les utilisateurs de
paquets binaires pourront trouver PL/Python dans un paquet séparé.
</para>
</note>
<sect1 id="plpython-python23">
<title>Python 2 et Python 3</title>
<para>
PL/Python accepte à la fois les versions 2 et 3 de Python. (Les instructions
d'installation de PostgreSQL peuvent contenir des informations plus précises
sur les versions mineures précisément supportées de Python.) Comme les
variantes Python 2 et Python 3 sont incompatibles pour certaines parties
très importantes, le schéma de nommage et de transition suivant est utilisé
par PL/Python pour éviter de les mixer :
<itemizedlist>
<listitem>
<para>
Le langage PostgreSQL nommé <literal>plpython2u</literal> implémente
PL/Python sur la variante Python 2 du langage.
</para>
</listitem>
<listitem>
<para>
Le langage PostgreSQL nommé <literal>plpython3u</literal> implémente
PL/Python sur la variante Python 3 du langage.
</para>
</listitem>
<listitem>
<para>
Le langage nommé <literal>plpythonu</literal> implémente PL/Python
suivant la variante par défaut du langage Python, qui est actuellement
Python 2. (Cette valeur par défaut est indépendante de ce que toute
installation locale de Python qui pourrait être considérée comme la valeur
par <quote>défaut</quote>, par exemple ce que pourrait être
<filename>/usr/bin/python</filename>.) La valeur par défaut sera
probablement changée avec Python 3 dans une prochaine version de
PostgreSQL, suivant les progrès de la migration à Python 3 dans la
communauté Python.
</para>
</listitem>
</itemizedlist>
Cela est analogue aux recommendations de <ulink
url="http://www.python.org/dev/peps/pep-0394/">PEP 394</ulink> au
regard des nommages et transitions des commandes <command>python</command>.
</para>
<para>
Cela dépend de la configuration lors de la compilation ou des paquets
installés si PL/Python pour Python 2 ou Python 3 ou les deux sont
disponibles.
</para>
<tip>
<para>
La variante construite dépend de la version de Python trouvée pendant
l'installation ou de la version sélectionnée explicitement en configurant
la variable d'environnement <envar>PYTHON</envar> ; voir <xref
linkend="install-procedure"/>. Pour que les deux variantes de PL/Python
soient disponibles sur une installation, le répertoire des sources doit
être configuré et construit deux fois.
</para>
</tip>
<para>
Ceci a pour résultat la stratégie suivante d'utilisation et de
migration :
<itemizedlist>
<listitem>
<para>
Les utilisateurs existants et ceux qui ne sont pas actuellement
intéressés par Python 3 utilisent le nom <literal>plpythonu</literal>
et n'ont rien à changer pour l'instant. Il est recommandé de
<quote>s'assurer</quote> graduellement de migrer le code vers
Python 2.6/2.7 pour simplifier une migration éventuelle vers Python 3.
</para>
<para>
En pratique, beaucoup de fonctions PL/Python seront migrées à Python 3
avec peu, voire par du tout, de modifications.
</para>
</listitem>
<listitem>
<para>
Les utilisateurs sachant d'avance qu'ils ont du code reposant massivement
sur Python 2 et ne planifient pas de changer peuvent utiliser le nom
<literal>plpython2u</literal>. Cela continuera de fonctionner, y compris
dans un futur lointain, jusqu'à ce que le support de Python 2 soit
complètement supprimée de PostgreSQL.
</para>
</listitem>
<listitem>
<para>
Les utilisateurs qui veulent utiliser Python 3 peuvent utiliser le nom
<literal>plpython3u</literal>, qui continuera à fonctionner en permanence
avec les standards actuels. Dans le futur, quand Python 3 deviendra la
version par défaut du langage, ils pourront supprimer le chiffre
<quote>3</quote>, principalement pour des raisons esthétiques.
</para>
</listitem>
<listitem>
<para>
Les intrépides qui veulent construire un système d'exploitation utilisant
seulement Python-3, peuvent modifier le contenu de
<link linkend="catalog-pg-pltemplate"><structname>pg_pltemplate</structname></link>
pour rendre <literal>plpythonu</literal> équivalent à
<literal>plpython3u</literal>, en gardant en tête que cela rend leur
installation incompatible avec la majorité de ce qui existe dans ce
monde.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Voir aussi le document <ulink
url="http://docs.python.org/py3k/whatsnew/3.0.html">What's New In Python
3.0</ulink> pour plus d'informations sur le portage vers Python 3.
</para>
<para>
Il n'est pas permis d'utiliser PL/Python basé sur Python 2 et PL/Python
basé sur Python 3 dans la même session car les symbôles dans les modules
dynamiques entreraient en conflit, ce qui pourrait résulter en des arrêts
brutaux du processus serveur PostgreSQL. Une vérification est ajoutée pour
empêcher ce mélange de versions majeures Python dans une même sessio. Cette
vérification aura pour effet d'annuler la session si une différence est
détectée. Néanmoins, il est possible d'utiliser les deux variantes de
PL/Python dans une même base de données à condition que ce soit dans des
sessions séparées.
</para>
</sect1>
<sect1 id="plpython-funcs">
<title>Fonctions PL/Python</title>
<para>
Les fonctions PL/Python sont déclarées via la syntaxe standard <xref
linkend="sql-createfunction"/> :
<programlisting>CREATE FUNCTION <replaceable>nom_fonction</replaceable> (<replaceable>liste-arguments</replaceable>)
RETURNS <replaceable>return-type</replaceable>
AS $$
# corps de la fonction PL/Python
$$ LANGUAGE plpythonu;
</programlisting>
</para>
<para>
Le corps d'une fonction est tout simplement un script Python. Quand la
fonction est appelée, ses arguments sont passés au script Python comme des
éléments de la liste <varname>args</varname> ; les arguments nommés
sont en plus passés comme des variables ordinaires. L'utilisation des
arguments nommés est beaucoup plus lisible. Le résultat est renvoyé
par le code Python de la façon habituelle, avec <literal>return</literal> ou
<literal>yield</literal> (dans le cas d'une instruction avec un ensemble
de résultats). Si vous ne fournissez pas une valeur de retour, Python
renvoie la valeur par défaut <symbol>None</symbol>.
<application>PL/Python</application> traduit la valeur <symbol>None</symbol>
de Python comme une valeur NULL SQL.
</para>
<para>
Par exemple, une fonction renvoyant le plus grand de deux entiers peut
être définie ainsi :
<programlisting>
CREATE FUNCTION pymax (a integer, b integer)
RETURNS integer
AS $$
if a > b:
return a
return b
$$ LANGUAGE plpythonu;
</programlisting>
Le code Python donné comme corps de la définition de fonction est transformé
en fonction Python. Par exemple, le code ci-dessus devient :
<programlisting>def __plpython_procedure_pymax_23456():
if a > b:
return a
return b</programlisting>
en supposant que 23456 est l'OID affecté à la fonction par
<productname>PostgreSQL</productname>.
</para>
<para>
Les arguments sont définis comme des variables globales. Conséquence subtile
des règles sur la portée de variables dans Python, il n'est pas possible de
réaffecter une variable à l'intérieur d'une fonction en conservant son nom,
sauf si elle est préalablement déclarée comme globale à l'intérieur du bloc.
Ainsi, l'exemple suivant ne fonctionnera pas :
<programlisting>
CREATE FUNCTION pystrip(x text)
RETURNS text
AS $$
x = x.strip() # error
return x
$$ LANGUAGE plpythonu;
</programlisting>
car affecter la variable <varname>x</varname> la transforme en variable
locale pour ce bloc et que, par conséquent, la variable <varname>x</varname>
de l'expression de droite fait référence à une variable locale
<varname>x</varname> non encore définie, et non pas au paramètre de la
fonction PL/Python. L'utilisation du mot-clé <literal>global</literal> permet
de résoudre le problème :
<programlisting>
CREATE FUNCTION pystrip(x text)
RETURNS text
AS $$
global x
x = x.strip() # ok now
return x
$$ LANGUAGE plpythonu;
</programlisting>
Cependant, il vaut mieux ne pas trop s'appuyer sur ce détail d'implémentation
de PL/Python. Il est préférable de traiter les paramètres de fonction
comme étant en lecture seule.
</para>
</sect1>
<sect1 id="plpython-data">
<title>Valeur des données avec PL/Python</title>
<para>De manière générale, le but de PL/Python est de fournir une relation
<quote>naturelle</quote> entre PostgreSQL et le monde Python. Ces règles
relationelles sont décrites ci-dessous.
</para>
<sect2>
<title>Type de données</title>
<para>
Les paramètres de fonctions sont convertis de leur type PostgreSQL vers un
type correspondant en Python :
<itemizedlist>
<listitem>
<para>
Le type <type>boolean</type> PostgreSQL est converti en
<type>bool</type> Python.
</para>
</listitem>
<listitem>
<para>
Les types <type>smallint</type> et <type>int</type> de PostgreSQL sont
convertis en <type>int</type> Python.
Les types <type>bigint</type> et <type>oid</type> PostgreSQL sont
convertis en <type>long</type> pour Python 2 et en <type>int</type> pour
Python 3.
</para>
</listitem>
<listitem>
<para>
Les <type>real</type>, <type>double</type> et <type>numeric</type> de
PostgreSQL sont convertis en <type>float</type> Python. Notez que pour
<type>numeric</type>, cela entraine une perte d'information et peut
aboutir à des résulats incorrects. Cela devrait être corrigé dans une
future version.
</para>
</listitem>
<listitem>
<para>
Le <type>bytea</type> PostgreSQL est converti en <type>str</type>
pour Python 2 et en <type>bytes</type> pour Python 3. Avec Python 2, la
chaîne devrait être traitée comme une séquence d'octets sans encodage.
</para>
</listitem>
<listitem>
<para>
Tous les autres types de données, y compris les chaînes de caractères
PostgreSQL, sont convertis en <type>str</type> Python. En Python 2, ces
chaînes auront le même encodage de caractères que le serveur. En
Python 3, ce seront des chaînes Unicode comme les autres.
</para>
</listitem>
<listitem>
<para>
Pour les données non scalaires, voir ci-dessous.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Les valeurs renvoyées par les fonctions sont converties en types de retour PostgreSQL comme suit:
<itemizedlist>
<listitem>
<para>
Quand le type de la valeur PostgreSQL renvoyée est <type>boolean</type>,
la valeur de retrour sera évaluée en fonction des règles
<emphasis>Python</emphasis>. Ainsi, les 0 et les chaines vides sont
fausses, mais la valeur <literal>'f'</literal> est vraie.
</para>
</listitem>
<listitem>
<para>
Quand le type de la valeur PostgreSQL renvoyée est <type>bytea</type>, la
valeur de retour sera convertie en chaine de caractères (Python 2) ou en
octets (Python 3) en utilisant les mécanismes Python correspondants, le
résultat étant ensuite converti en <type>bytea</type>.
</para>
</listitem>
<listitem>
<para>
Pour tous les autres types de retrour PostgreSQL, la valeur renvoyée par
Python est convertie en chaine de caractères en utilisant la méthode
Python <literal>str</literal>, et le résultat est transmis à la
fonction d'entrée du type de données PostgreSQL.
</para>
<para>
Les chaines de caractères en Python 2 doivent être transmises dans le
même encodage que celui du serveur PostgreSQL. Les chaines invalides dans
l'encodage du serveur entraineront la levée d'une erreur, mais toutes les
erreurs d'encodage ne sont pas detectées, ce qui peut aboutir à une
corruption des données lorsque ces règles ne sont pas respéctée. Les
chaines Unicode sont automatiquement converties dans le bon encodage,
il est donc plus prudent de les utiliser. Dans Python 3, toutes les
chaines sont en Unicode.
</para>
</listitem>
<listitem>
<para>
Pour les données non scalaires, voire ci dessous.
</para>
</listitem>
</itemizedlist>
Notez que les erreurs logiques entre le type de retour déclaré dans
PostgreSQL et le type de l'objet Python renvoyé ne sont pas détectées. La
valeur sera convertie dans tous les cas.
</para>
</sect2>
<sect2>
<title>Null, None</title>
<para>
Si une valeur SQL NULL<indexterm><primary>valeur NULL</primary><secondary
sortas="PL/Python">en PL/Python</secondary></indexterm> est passée à une fonction,
la valeur de l'argument apparaîtra comme <symbol>None</symbol> au niveau de
Python. Par exemple, la définition de la fonction <function>pymax</function>
indiquée dans <xref linkend="plpython-funcs"/> renverra la mauvaise réponse
pour des entrées NULL. Nous pouvons jouer <literal>STRICT</literal> à la
définition de la fonction pour faire en sorte que
<productname>PostgreSQL</productname> fasse quelque-chose de plus
raisonnable : si une valeur NULL est passée, la fonction ne sera pas
appelée du tout mais renverra juste un résultat NULL automatiquement.
Sinon, vous pouver vérifier les entrées NULL dans le corps de la
fonction :
<programlisting>CREATE FUNCTION pymax (a integer, b integer)
RETURNS integer
AS $$
if (a is None) or (b is None):
return None
if a > b:
return a
return b
$$ LANGUAGE plpythonu;
</programlisting>
Comme montré ci-dessus, pour renvoyer une valeur SQL NULL à partir d'une
fonction PL/Python, renvoyez la valeur <symbol>None</symbol>. Ceci peut
se faire que la fonction soit stricte ou non.
</para>
</sect2>
<sect2 id="plpython-arrays">
<title>Tableaux, Listes</title>
<para>
Les valeurs de type tableaux SQL sont passées via PL/Python comme des listes
Python. Pour renvoyer une valeur de type tableau SQL par une fonction
PL/Python, renvoyez une séquence Python, par exemple une liste ou un
tuple :
<programlisting>
CREATE FUNCTION return_arr()
RETURNS int[]
AS $$
return (1, 2, 3, 4, 5)
$$ LANGUAGE plpythonu;
SELECT return_arr();
return_arr
-------------
{1,2,3,4,5}
(1 row)
</programlisting>
Notez que, avec Python, les chaînes sont des séquences, ce qui peut avoir
des effets indésirables qui peuvent être familiers aux codeurs Python :
<programlisting>
CREATE FUNCTION return_str_arr()
RETURNS varchar[]
AS $$
return "hello"
$$ LANGUAGE plpythonu;
SELECT return_str_arr();
return_str_arr
----------------
{h,e,l,l,o}
(1 row)
</programlisting>
</para>
</sect2>
<sect2>
<title>Types composites</title>
<para>
Les arguments de type composite sont passés à la fonction via une
correspondance Python. Les noms d'élément de la correspondance sont les noms
d'attribut du type composite. Si un attribut a une valeur NULL dans la ligne
traitée; il a la valeur NULL dans sa correspondance. Voici un exemple :
<programlisting>CREATE TABLE employe (
nom text,
salaire integer,
age integer
);
CREATE FUNCTION trop_paye (e employe)
RETURNS boolean
AS $$
if e["salaire"] > 200000:
return True
if (e["age"] < 30) and (e["salaire"] > 100000):
return True
return False
$$ LANGUAGE plpythonu;
</programlisting>
</para>
<para>
Il existe plusieurs façon de renvoyer une ligne ou des types composites à
partir d'une fonction Python. Les exemples suivants supposent que nous
avons :
<programlisting>CREATE TABLE valeur_nommee (
nom text,
valeur integer
);
</programlisting>
ou
<programlisting>CREATE TYPE valeur_nommee AS (
nom text,
valeur integer
);
</programlisting>
Une valeur composite peut être renvoyé comme :
<variablelist>
<varlistentry>
<term>Un type séquence (ligne ou liste), mais pas
un ensemble parce que ce n'est pas indexable</term>
<listitem>
<para>
Les objets séquences renvoyés doivent avoir le même nombre d'éléments que
le type composite a de champs. L'élément d'index 0 est affecté au
premier champ du type composite, 1 au second et ainsi de suite. Par
exemple :
<programlisting>CREATE FUNCTION cree_paire (nom text, valeur integer)
RETURNS valeur_nommee
AS $$
return [ nom, valeur ]
# ou autrement, en tant que ligne : return ( nom, valeur )
$$ LANGUAGE plpythonu;
</programlisting>
Pour renvoyer NULL dans une colonne, insérez <symbol>None</symbol> à la
position correspondante.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Correspondance (dictionnaire)</term>
<listitem>
<para>
La valeur de chaque colonne du type résultat est récupérée à partir de la
correspondance avec le nom de colonne comme clé. Exemple :
<programlisting>CREATE FUNCTION cree_paire (nom text, valeur integer)
RETURNS valeur_nommee
AS $$
return { "nom": nom, "valeur": valeur }
$$ LANGUAGE plpythonu;
</programlisting>
Des paires clés/valeurs supplémentaires du dictionnaire sont ignorées.
Les clés manquantes sont traitées comme des erreurs.
Pour renvoyer NULL comme une colonne, insérez <symbol>None</symbol>
avec le nom de la colonne correspondante comme clé.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Objet (tout objet fournissant la méthode <literal>__getattr__</literal>)</term>
<listitem>
<para>
Ceci fonctionne de la même façon qu'une correspondance.
Exemple :
<programlisting>CREATE FUNCTION cree_paire (nom text, valeur integer)
RETURNS valeur_nommee
AS $$
class valeur_nommee:
def __init__ (self, n, v):
self.nom = n
self.valeur = v
return valeur_nommee(nom, valeur)
# ou simplement
class nv: pass
nv.nom = nom
nv.valeur = valeur
return nv
$$ LANGUAGE plpythonu;
</programlisting>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Les fonctions ayant des paramètres <literal>OUT</literal> sont
aussi supportées. Par exemple :
<programlisting>
CREATE FUNCTION multiout_simple(OUT i integer, OUT j integer) AS $$
return (1, 2)
$$ LANGUAGE plpythonu;
SELECT * FROM multiout_simple();
</programlisting>
</para>
</sect2>
<sect2>
<title>Fonctions renvoyant des ensembles</title>
<para>
Une fonction <application>PL/Python</application> peut aussi renvoyer des
ensembles scalaires ou des types composites. Il existe plusieurs façon de
faire ceci parce que l'objet renvoyé est transformé en interne en itérateur.
Les exemples suivants supposent que nous avons le type composite :
<programlisting>CREATE TYPE greeting AS (
how text,
who text
);
</programlisting>
Un résultat ensemble peut être renvoyé à partir de :
<variablelist>
<varlistentry>
<term>Un type séquence (ligne, liste, ensemble)</term>
<listitem>
<para>
<programlisting>CREATE FUNCTION greet (how text)
RETURNS SETOF greeting
AS $$
# renvoie la ligne contenant les listes en tant que types composites
# toutes les autres combinaisons fonctionnent aussi
return ( [ how, "World" ], [ how, "PostgreSQL" ], [ how, "PL/Python" ] )
$$ LANGUAGE plpythonu;
</programlisting>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>L'itérateur (tout objet fournissant les méthodes <symbol>__iter__</symbol>
et <symbol>next</symbol>)</term>
<listitem>
<para>
<programlisting>CREATE FUNCTION greet (how text)
RETURNS SETOF greeting
AS $$
class producer:
def __init__ (self, how, who):
self.how = how
self.who = who
self.ndx = -1
def __iter__ (self):
return self
def next (self):
self.ndx += 1
if self.ndx == len(self.who):
raise StopIteration
return ( self.how, self.who[self.ndx] )
return producer(how, [ "World", "PostgreSQL", "PL/Python" ])
$$ LANGUAGE plpythonu;
</programlisting>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Le générateur (<literal>yield</literal>)</term>
<listitem>
<para>
<programlisting>CREATE FUNCTION greet (how text)
RETURNS SETOF greeting
AS $$
for who in [ "World", "PostgreSQL", "PL/Python" ]:
yield ( how, who )
$$ LANGUAGE plpythonu;
</programlisting>
<warning>
<para>
À cause du
<ulink url="http://bugs.python.org/issue1483133">bogue #1483133</ulink> de Python,
certaines versions de débogage de Python 2.4
(configuré et compilé avec l'option <literal>--with-pydebug</literal>)
sont connues pour arrêter brutalement le serveur
<productname>PostgreSQL</productname> lors de l'utilisation d'un
itérateur pour renvoyer un résultat ensemble. Les versions non corrigées de
Fedora 4 contiennent ce bogue. Cela n'arrive pas dans les versions de
production de Python et sur les versions corrigées de Fedora 4.
</para>
</warning>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Les fonctions renvoyant des ensembles et ayant des paramètres
<literal>OUT</literal> (en utilisant <literal>RETURNS SETOF
record</literal>) sont aussi supportées. Par exemple :
<programlisting>
CREATE FUNCTION multiout_simple_setof(n integer, OUT integer, OUT integer) RETURNS SETOF record AS $$
return [(1, 2)] * n
$$ LANGUAGE plpythonu;
SELECT * FROM multiout_simple_setof(3);
</programlisting>
</para>
</sect2>
</sect1>
<sect1 id="plpython-sharing">
<title>Sharing Data</title>
<para>
Le dictionnaire global <varname>SD</varname> est disponible pour stocker des
données entres les appels de fonctions. Cette variable est une donnée
statique privée. Le dictionnaire global <varname>GD</varname> est une donnée
publique disponible pour toutes les fonctions Python à l'intérieur d'une
session. À utiliser avec précaution.<indexterm><primary>données
globales</primary><secondary>en PL/Python</secondary></indexterm>
</para>
<para>
Chaque fonction obtient son propre environnement d'exécution dans
l'interpréteur Python, de façon à ce que les données globales et les
arguments de fonction provenant de <function>ma_fonction</function> ne soient
pas disponibles depuis <function>ma_fonction2</function>. L'exception
concerne les données du dictionnaire <varname>GD</varname> comme indiqué
ci-dessus.
</para>
</sect1>
<sect1 id="plpython-do">
<title>Blocs de code anonymes</title>
<para>
PL/Python accepte aussi les blocs de code anonymes appelés avec
l'instruction <xref linkend="sql-do"/> :
<programlisting>
DO $$
# Code PL/Python
$$ LANGUAGE plpythonu;
</programlisting>
Un bloc de code anonyme ne reçoit aucun argument et, quelque soit la valeur
renvoyée, elle est ignorée. Sinon, ce bloc se comporte exactement comme
n'importe quelle fonction.
</para>
</sect1>
<sect1 id="plpython-trigger">
<title>Fonctions de déclencheurs</title>
<indexterm zone="plpython-trigger">
<primary>déclencheur</primary>
<secondary>en PL/Python</secondary>
</indexterm>
<para>
Quand une fonction est utilisée par un trigger, le dictionnaire
<literal>TD</literal> contient les valeurs relatives au trigger :
<variablelist>
<varlistentry>
<term><literal>TD["event"]</literal></term>
<listitem>
<para>
contient l'événement sous la forme d'une chaîne :
<literal>INSERT</literal>, <literal>UPDATE</literal>,
<literal>DELETE</literal>, <literal>TRUNCATE</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>TD["when"]</literal></term>
<listitem>
<para>
contient une chaîne valant soit <literal>BEFORE</literal>, soit
<literal>AFTER</literal> soit <literal>INSTEAD OF</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>TD["level"]</literal></term>
<listitem>
<para>
contient une chaîne valant soit <literal>ROW</literal> soit
<literal>STATEMENT</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>TD["new"]</literal></term>
<term><literal>TD["old"]</literal></term>
<listitem>
<para>
pour un trigger au niveau ligne, ces champs contiennent les lignes
du trigger, l'ancienne version et la nouvelle version ; les deux
champs ne sont pas forcément disponibles, ceci dépendant de l'événement
qui a déclenché le trigger
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>TD["name"]</literal></term>
<listitem>
<para>
contient le nom du trigger.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>TD["table_name"]</literal></term>
<listitem>
<para>
contient le nom de la table sur laquelle le trigger a été déclenché
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>TD["table_schema"]</literal></term>
<listitem>
<para>
contient le schéma de la table sur laquelle le trigger a été déclenché
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>TD["relid"]</literal></term>
<listitem>
<para>
contient l'OID de la table sur laquelle le trigger a été déclenché
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>TD["args"]</literal></term>
<listitem>
<para>
si la commande <command>CREATE TRIGGER</command> comprend des arguments,
ils sont disponibles dans les variables allant de
<literal>TD["args"][0]</literal> à
<literal>TD["args"][<replaceable>n</replaceable>-1]</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Si <literal>TD["when"]</literal> vaut <literal>BEFORE</literal> ou
<literal>INSTEAD OF</literal> et si
<literal>TD["level"]</literal> vaut <literal>ROW</literal>, vous pourriez
renvoyer <literal>None</literal> ou <literal>"OK"</literal> à partir de la
fonction Python pour indiquer que la ligne n'est pas modifiée,
<literal>"SKIP"</literal> pour annuler l'événement ou si <literal>TD["event"]</literal>
vaut <command>INSERT</command> ou <command>UPDATE</command>, vous
pouvez renvoyer <literal>"MODIFY"</literal> pour indiquer que vous
avez modifié la ligne. Sinon la valeur de retour est ignorée.
</para>
</sect1>
<sect1 id="plpython-database">
<title>Accès à la base de données</title>
<para>
Le module du langage PL/Python importe automatiquement un module Python
appelé <literal>plpy</literal>. Les fonctions et constantes de ce module
vous sont accessibles dans le code Python via
<literal>plpy.<replaceable>foo</replaceable></literal>.
</para>
<sect2>
<title>Fonctions d'accès à la base de données</title>
<para>
Le module <literal>plpy</literal> fournit plusieurs fonctions pour exécuter
des commandes sur la base de données :
</para>
<variablelist>
<varlistentry>
<term><literal>plpy.<function>execute</function>(<replaceable>query</replaceable> [, <replaceable>max-rows</replaceable>])</literal></term>
<listitem>
<para>
L'appel à <function>plpy.execute</function> avec une chaîne pour la requête
et une limite de ligne optionnelle permet d'exécuter la requête et de
retourner le résultat dans un objet résultant.
</para>
<para>
L'objet resultant émule une liste ou un objet dictionnaire. L'objet
résultant peut être accédé par le numéro de ligne et le nom de colonne.
Par exemple :
<programlisting>
rv = plpy.execute("SELECT * FROM my_table", 5)
</programlisting>
retourne jusqu'à 5 lignes de <literal>my_table</literal>.
Si <literal>my_table</literal> possède une colonne <literal>my_column</literal>,
elle pourra être accédée ainsi :
<programlisting>
foo = rv[i]["my_column"]
</programlisting>
Le nombre de lignes retournées peut être obtenu en utilisant la
fonction intégrée <function>len</function>.
</para>
<para>
L'objet résultant contient ces méthodes additionnelles :
<variablelist>
<varlistentry>
<term><literal><function>nrows</function>()</literal></term>
<listitem>
<para>
Retourne le nombre de lignes traitées par cette commande. Notez que
cela n'est pas nécessairement identique au nombre de lignes retournées.
Par exemple, une commande <command>UPDATE</command> fixera cette valeur
mais ne retournera aucune ligne (sauf si <literal>RETURNING</literal>
est utilisé).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal><function>status</function>()</literal></term>
<listitem>
<para>
La valeur retournée par <function>SPI_execute()</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal><function>colnames</function>()</literal></term>
<term><literal><function>coltypes</function>()</literal></term>
<term><literal><function>coltypmods</function>()</literal></term>
<listitem>
<para>
Retourne respectivement une liste de noms de colonne, une liste de type OID
de colonne et une liste de type de modifieurs spécifiques à un type
pour les colonnes.
</para>
<para>
Ces méthodes lèvent une exception quand elles sont appelées sur un
objet résultant d'une commande n'ayant pas produit d'ensemble de
résultat, par ex,
<command>UPDATE</command> sans <literal>RETURNING</literal>, ou
<command>DROP TABLE</command>. Il est cependant normal d'utiliser
ces méthodes sur un ensemble de résultat ne contenant aucune ligne.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal><function>__str__</function>()</literal></term>
<listitem>
<para>
The standard <literal>__str__</literal> method is defined so that it
is possible for example to debug query execution results
using <literal>plpy.debug(rv)</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
L'objet résultant peut être modifié.
</para>
<para>
Notez que l'appel à <literal>plpy.execute</literal> provoquera la lecture
de tout l'ensemble de résultat en mémoire. N'utilisez cette fonction que
lorsque vous êtes surs que l'ensemble de résultat sera relativement petit.
Si vous ne voulez pas risquer une utilisation excessive de mémoire pour
récupérer de gros ensembles, préférez <literal>plpy.cursor</literal> à
<literal>plpy.execute</literal>.
</para>
</listitem>
</varlistentry>