PostgreSQLLa base de données la plus sophistiquée au monde.

Version anglaise

9.4. Fonctions et opérateurs de chaînes

Cette section décrit les fonctions et opérateurs d'examen et de manipulation des valeurs de type chaîne de caractères. Dans ce contexte, les chaînes incluent les valeurs des types character, character varying et text. Sauf lorsque cela est précisé différemment, toutes les fonctions listées ci-dessous fonctionnent sur tous ces types, mais une attention particulière doit être portée aux effets potentiels du remplissage automatique lors de l'utilisation du type character. Quelques fonctions existent aussi nativement pour le type chaîne bit à bit.

SQL définit quelques fonctions de type chaîne qui utilisent des mots clés, à la place de la virgule, pour séparer les arguments. Des détails sont disponibles dans le Tableau 9.6, « Fonctions et opérateurs SQL pour le type chaîne ». PostgreSQL™ fournit aussi des versions de ces fonctions qui utilisent la syntaxe standard d'appel des fonctions (voir le Tableau 9.7, « Autres fonctions de chaîne »).

[Note]

Note

Avant PostgreSQL™ 8.3, ces fonctions acceptent silencieusement des valeurs de types de données différents de chaînes de caractères. Cela parce qu'existent des transtypages implicites de ces types en text. Ces forçages ont été supprimés parce que leur comportement est souvent surprenant. Néanmoins, l'opérateur de concaténation de chaîne (||) accepte toujours des éléments qui ne sont pas du type chaîne de caractères, dès lors qu'au moins un des éléments est de type chaîne, comme montré dans Tableau 9.6, « Fonctions et opérateurs SQL pour le type chaîne ». Dans tous les autres cas, il faut insérer un transtypage explicite en text pour mimer le comportement précédent.

Tableau 9.6. Fonctions et opérateurs SQL pour le type chaîne

Fonction Type renvoyé Description Exemple Résultat
chaîne || chaîne text Concaténation de chaînes 'Post' || 'greSQL' PostgreSQL
chaîne || autre-que-chaîne ou autre-que-chaîne || chaîne text Concaténation de chaînes avec un argument non-chaîne 'Value: ' || 42 Value: 42
bit_length(chaîne) int Nombre de bits de la chaîne bit_length('jose') 32
char_length(chaîne) ou character_length(chaîne) int Nombre de caractères de la chaîne char_length('jose') 4
lower(chaîne) text Convertit une chaîne en minuscule lower('TOM') tom
octet_length(chaîne) int Nombre d'octets de la chaîne octet_length('jose') 4
overlay(chaîne placing chaîne from int [for int]) text Remplace la sous-chaîne overlay('Txxxxas' placing 'hom' from 2 for 4) Thomas
position(sous-chaîne in chaîne) int Emplacement de la sous-chaîne indiquée position('om' in 'Thomas') 3
substring(chaîne [from int] [for int]) text Extrait une sous-chaîne substring('Thomas' from 2 for 3) hom
substring(chaîne from modele) text Extrait la sous-chaîne correspondant à l'expression rationnelle POSIX. Voir Section 9.7, « Correspondance de motif » pour plus d'informations sur la correspondance de modèles. substring('Thomas' from '...$') mas
substring(chaîne from modele for echappement) text Extrait la sous-chaîne correspondant à l'expression rationnelle SQL. Voir Section 9.7, « Correspondance de motif » pour plus d'informations sur la correspondance de modèles. substring('Thomas' from '%#"o_a#"_' for '#') oma
trim([leading | trailing | both] [caractères] from chaîne) text Supprime la plus grande chaîne qui ne contient que les caractères compris dans caractères (une espace par défaut) à partir du début, de la fin ou des deux extrémités (both par défaut) de la chaîne. trim(both 'xyz' from 'yxTomxx') Tom
upper(chaîne) text Convertit une chaîne en majuscule upper('tom') TOM

D'autres fonctions de manipulation de chaînes sont disponibles et listées dans le Tableau 9.7, « Autres fonctions de chaîne ». Certaines d'entre elles sont utilisées en interne pour implanter les fonctions de chaîne répondant au standard SQL listées dans le Tableau 9.6, « Fonctions et opérateurs SQL pour le type chaîne ».

Tableau 9.7. Autres fonctions de chaîne

Fonction Type renvoyé Description Exemple Résultat
ascii(chaîne) int Code ASCII du premier octet de l'argument. Pour UTF8, renvoie le code Unicode du caractère. Pour les autres codages multi-octets, l'argument doit impérativement être un caractère ASCII. ascii('x') 120
btrim(chaîne text [, caracteres text]) text Supprime la chaîne la plus longue constituée uniquement de caractères issus de caractères (une espace par défaut) à partir du début et de la fin de chaîne. btrim('xyxtrimyyx', 'xyz') trim
chr(int) text Caractère correspondant au code donné. Pour UTF8, l'argument est traité comme un code Unicode. Pour les autres codages multi-octets, l'argument doit impérativement désigner un caractère ASCII. Le caractère NULL (0) n'est pas autorisé car les types de données texte ne peuvent pas stocker ce type d'octets. chr(65) A
concat(chaîne "any" [, chaîne "any" [, ...] ]) text Concatène les représentations textuelles de tous les arguments. Les arguments NULL sont ignorés. concat('abcde', 2, NULL, 22) abcde222
concat_ws(séparateur text, chaîne "any" [, chaîne "any" [, ...] ]) text Concatène tous les arguments avec des séparateurs, sauf le premier utilisé comme séparateur. Les arguments NULL sont ignorés. concat_ws(',', 'abcde', 2, NULL, 22) abcde,2,22
convert(chaîne bytea, encodage_source name, encodage_destination name) bytea Convertit la chaîne en encodage encodage_destination. L'encodage d'origine est indiqué par encodage_source. La chaîne doit être valide pour cet encodage. Les conversions peuvent être définies avec CREATE CONVERSION. De plus, il existe quelques conversions pré-définies. Voir Tableau 9.8, « Conversions intégrées » pour les conversions disponibles. convert( 'texte_en_utf8', 'UTF8', 'LATIN1') texte_en_utf8 représenté dans le codage LATIN1
convert_from(chaîne bytea, encodage_source nom) text Convertit la chaîne dans l'encodage de la base. L'encodage original est indiqué par encodage_source. La chaîne doit être valide pour cet encodage. convert_from( 'texte_en_utf8', 'UTF8') texte_en_utf8 représenté dans le codage de la base en cours
convert_to(chaîne text, encodage_destination nom) bytea Convertit une chaîne en encodage encodage_destination. convert_to( 'un texte', 'UTF8') un texte représenté dans l'encodage UTF8
decode(chaîne text, format text) bytea Décode les données binaires à partir d'une répresentation textuelle disponible dans chaîne, codée préalablement avec encode. Les options disponibles pour le format sont les mêmes que pour la fonction encode. decode('MTIzAAE=', 'base64') \x3132330001
encode(données bytea, format text) text Code les données binaires en une représentation textuelle. Les formats supportés sont : base64, hex, escape. escape convertit les octets nuls et les octets dont le bit de poids fort est à 1, en séquence octal (\nnn) et des antislashs doubles. encode( E'123\\000\\001', 'base64') MTIzAAE=
format(chaine_formatage text [, argument_formatage "any" [, ...] ]) text Formate les arguments suivant une chaîne de formatage. Cette fonction est similaire à la fonction C sprintf. Voi Section 9.4.1, « format ». format('Bonjour %s, %1$s', 'monde') Bonjour monde, monde
initcap(chaîne) text Convertit la première lettre de chaque mot en majuscule et le reste en minuscule. Les mots sont des séquences de caractères alphanumériques séparés par des caractères non alphanumériques. initcap('bonjour THOMAS') Bonjour Thomas
left(chaîne text, n int) text Renvoie les n premiers caractères dans la chaîne. Quand n est négatif, renvoie tous sauf les n derniers caractères. left('abcde', 2) ab
length(chaîne) int Nombre de caractères de chaîne length('jose') 4
length(chaîne bytea, encodage nom ) int Nombre de caractères de chaîne dans l'encodage donné. La chaîne doit être valide dans cet encodage. length('jose', 'UTF8') 4
lpad(chaîne text, longueur int [, remplissage text]) text Complète chaîne à longueur en ajoutant les caractères remplissage en début de chaîne (une espace par défaut). Si chaîne a une taille supérieure à longueur, alors elle est tronquée (sur la droite). lpad('hi', 5, 'xy') xyxhi
ltrim(chaîne text [, caracteres text]) text Supprime la chaîne la plus longue constituée uniquement de caractères issus de caractères (une espace par défaut) à partir du début de la chaîne. ltrim('zzzytest', 'xyz') test
md5(chaîne) text Calcule la clé MD5 de chaîne et retourne le résultat en hexadécimal. md5('abc') 900150983cd24fb0 d6963f7d28e17f72
pg_client_encoding() name Nom de l'encodage client courant. pg_client_encoding() SQL_ASCII
quote_ident(chaîne text) text Renvoie la chaîne correctement placée entre guillemets pour utilisation comme identifiant dans une chaîne d'instruction SQL. Les guillemets ne sont ajoutés que s'ils sont nécessaires (c'est-à-dire si la chaîne contient des caractères autres que ceux de l'identifiant ou qu'il peut y avoir un problème de casse). Les guillemets compris dans la chaîne sont correctement doublés. Voir aussi Exemple 40.1, « Mettre entre guillemets des valeurs dans des requêtes dynamiques ». quote_ident('Foo bar') "Foo bar"
quote_literal(chaîne text) text Renvoie la chaîne correctement placée entre guillemets pour être utilisée comme libellé dans un chaîne d'instruction SQL. Les guillemets simples compris dans la chaîne et les antislash sont correctement doublés. Notez que quote_literal renvoie NULL si son argument est NULL ; si l'argument peut être NULL, la fonction quote_nullable convient mieux. Voir aussi Exemple 40.1, « Mettre entre guillemets des valeurs dans des requêtes dynamiques ». quote_literal( E'O\'Reilly') 'O''Reilly'
quote_literal(valeur anyelement) text Convertit la valeur donnée en texte, puis la place entre guillemets suivant la méthode appropriée pour une valeur littérale. Les guillemets simples et antislashs faisant partie de cette valeur sont doublés proprement. quote_literal(42.5) '42.5'
quote_nullable(chaîne text) text Renvoie la chaîne donnée convenablement mise entre guillemets pour être utilisée comme une chaîne littérale dans une instruction SQL ; or si l'argument est NULL, elle renvoie NULL. Les guillemets simples et antislashs dans la chaîne sont doublés correctement. Voir aussi Exemple 40.1, « Mettre entre guillemets des valeurs dans des requêtes dynamiques ». quote_nullable(NULL) NULL
quote_nullable(valeur anyelement) text Renvoie la valeur donnée en texte, puis la met entre guillemets comme un littéral ; or, si l'argument est NULL, elle renvoie NULL.Les guillemets simples et antislashs dans la chaîne sont doublés correctement. quote_nullable(42.5) '42.5'
regexp_matches(chaîne text, modèle text [, drapeaux text]) setof text[] Renvoie toutes les sous-chaînes capturées résultant d'une correspondance entre l'expression rationnelle POSIX et chaîne. Voir Section 9.7.3, « Expressions rationnelles POSIX » pour plus d'informations. regexp_matches('foobarbequebaz', '(bar)(beque)') {bar,beque}
regexp_replace(chaîne text, modèle text, remplacement text [, drapeaux text]) text Remplace la sous-chaîne correspondant à l'expression rationnelle POSIX. Voir Section 9.7.3, « Expressions rationnelles POSIX » pour plus d'informations. regexp_replace('Thomas', '.[mN]a.', 'M') ThM
regexp_split_to_array(chaîne text, modèle text [, drapeaux text ]) text[] Divise une chaîne en utilisant une expression rationnelle POSIX en tant que délimiteur. Voir Section 9.7.3, « Expressions rationnelles POSIX » pour plus d'informations. regexp_split_to_array('hello world', E'\\s+') {hello,world}
regexp_split_to_table(chaîne text, modèle text [, drapeaux text]) setof text Divise la chaîne en utilisant une expression rationnelle POSIX comme délimiteur. Voir Section 9.7.3, « Expressions rationnelles POSIX » pour plus d'informations. regexp_split_to_table('hello world', E'\\s+') hello

world

(2 rows)
repeat(chaîne text, nombre int) text Répète le texte chaîne nombre fois repeat('Pg', 4) PgPgPgPg
replace(chaîne text, àpartirde text, vers text) text Remplace dans chaîne toutes les occurrences de la sous-chaîne àpartirde par la sous-chaîne vers. replace( 'abcdefabcdef', 'cd', 'XX') abXXefabXXef
reverse(chaîne) text Renvoie une chaîne renversée. reverse('abcde') edcba
right(chaîne text, n int) text Renvoie les n derniers caractères dans la chaîne de caractères. Quand n est négatif, renvoie tout sauf les n derniers caractères. right('abcde', 2) de
rpad(chaîne text, longueur int [, remplissage text]) text Complète chaîne à longueur caractères en ajoutant les caractères remplissage à la fin (une espace par défaut). Si la chaîne a une taille supérieure à longueur, elle est tronquée. rpad('hi', 5, 'xy') hixyx
rtrim(chaîne text [, caracteres text]) text Supprime la chaîne la plus longue contenant uniquement les caractères provenant de caractères (une espace par défaut) depuis la fin de chaîne. rtrim('testxxzx', 'xyz') test
split_part(chaîne text, délimiteur text, champ int) text Divise chaîne par rapport au délimiteur et renvoie le champ donné (en comptant à partir de 1). split_part( 'abc~@~def~@~ghi', '~@~', 2) def
strpos(chaîne, sous-chaîne) int Emplacement de la sous-chaîne indiquée (identique à position(sous-chaîne in sous-chaîne), mais avec les arguments en ordre inverse). strpos('high', 'ig') 2
substr(chaîne, àpartirde [, nombre]) text Extrait la sous-chaîne (identique à substring(chaîne from àpartirde for nombre)) substr('alphabet', 3, 2) ph
to_ascii(chaîne text [, encodage text]) text Convertit la chaîne en ASCII à partir de n'importe quelle autre encodage (ne supporte que les conversions à partir de LATIN1, LATIN2, LATIN9 et WIN1250). to_ascii('Karel') Karel
to_hex(number int ou bigint) text Convertit nombre dans sa représentation hexadécimale équivalente. to_hex(2147483647) 7fffffff
translate(chaîne text, àpartirde text, vers text) text Tout caractère de chaîne qui correspond à un caractère de l'ensemble àpartirde est remplacé par le caractère correspondant de l'ensemble vers. Si àpartirde est plus long que vers, les occurrences des caractères supplémentaires dans àpartirde sont supprimées. translate('12345', '143', 'ax') a2x5

Les fonctions concat, concat_ws et format sont variadiques, donc il est possible de passer les valeurs à concaténer ou à formatter dans un tableau marqué du mot clé VARIADIC (voir Section 35.4.5, « Fonctions SQL avec un nombre variables d'arguments »). Les éléments du tableau sont traités comme des arguments ordinaires, mais séparés, de la fonction. Si le tableau est NULL, concat et concat_ws renvoient NULL. Par contre, format traite un NULL comme un tableau à zéro élément.

Voir aussi la fonction d'agrégat string_agg dans Section 9.20, « Fonctions d'agrégat ».

Tableau 9.8. Conversions intégrées

Nom de la conversion [a] Codage source Codage destination
ascii_to_mic SQL_ASCII MULE_INTERNAL
ascii_to_utf8 SQL_ASCII UTF8
big5_to_euc_tw BIG5 EUC_TW
big5_to_mic BIG5 MULE_INTERNAL
big5_to_utf8 BIG5 UTF8
euc_cn_to_mic EUC_CN MULE_INTERNAL
euc_cn_to_utf8 EUC_CN UTF8
euc_jp_to_mic EUC_JP MULE_INTERNAL
euc_jp_to_sjis EUC_JP SJIS
euc_jp_to_utf8 EUC_JP UTF8
euc_kr_to_mic EUC_KR MULE_INTERNAL
euc_kr_to_utf8 EUC_KR UTF8
euc_tw_to_big5 EUC_TW BIG5
euc_tw_to_mic EUC_TW MULE_INTERNAL
euc_tw_to_utf8 EUC_TW UTF8
gb18030_to_utf8 GB18030 UTF8
gbk_to_utf8 GBK UTF8
iso_8859_10_to_utf8 LATIN6 UTF8
iso_8859_13_to_utf8 LATIN7 UTF8
iso_8859_14_to_utf8 LATIN8 UTF8
iso_8859_15_to_utf8 LATIN9 UTF8
iso_8859_16_to_utf8 LATIN10 UTF8
iso_8859_1_to_mic LATIN1 MULE_INTERNAL
iso_8859_1_to_utf8 LATIN1 UTF8
iso_8859_2_to_mic LATIN2 MULE_INTERNAL
iso_8859_2_to_utf8 LATIN2 UTF8
iso_8859_2_to_windows_1250 LATIN2 WIN1250
iso_8859_3_to_mic LATIN3 MULE_INTERNAL
iso_8859_3_to_utf8 LATIN3 UTF8
iso_8859_4_to_mic LATIN4 MULE_INTERNAL
iso_8859_4_to_utf8 LATIN4 UTF8
iso_8859_5_to_koi8_r ISO_8859_5 KOI8R
iso_8859_5_to_mic ISO_8859_5 MULE_INTERNAL
iso_8859_5_to_utf8 ISO_8859_5 UTF8
iso_8859_5_to_windows_1251 ISO_8859_5 WIN1251
iso_8859_5_to_windows_866 ISO_8859_5 WIN866
iso_8859_6_to_utf8 ISO_8859_6 UTF8
iso_8859_7_to_utf8 ISO_8859_7 UTF8
iso_8859_8_to_utf8 ISO_8859_8 UTF8
iso_8859_9_to_utf8 LATIN5 UTF8
johab_to_utf8 JOHAB UTF8
koi8_r_to_iso_8859_5 KOI8R ISO_8859_5
koi8_r_to_mic KOI8R MULE_INTERNAL
koi8_r_to_utf8 KOI8R UTF8
koi8_r_to_windows_1251 KOI8R WIN1251
koi8_r_to_windows_866 KOI8R WIN866
koi8_u_to_utf8 KOI8U UTF8
mic_to_ascii MULE_INTERNAL SQL_ASCII
mic_to_big5 MULE_INTERNAL BIG5
mic_to_euc_cn MULE_INTERNAL EUC_CN
mic_to_euc_jp MULE_INTERNAL EUC_JP
mic_to_euc_kr MULE_INTERNAL EUC_KR
mic_to_euc_tw MULE_INTERNAL EUC_TW
mic_to_iso_8859_1 MULE_INTERNAL LATIN1
mic_to_iso_8859_2 MULE_INTERNAL LATIN2
mic_to_iso_8859_3 MULE_INTERNAL LATIN3
mic_to_iso_8859_4 MULE_INTERNAL LATIN4
mic_to_iso_8859_5 MULE_INTERNAL ISO_8859_5
mic_to_koi8_r MULE_INTERNAL KOI8R
mic_to_sjis MULE_INTERNAL SJIS
mic_to_windows_1250 MULE_INTERNAL WIN1250
mic_to_windows_1251 MULE_INTERNAL WIN1251
mic_to_windows_866 MULE_INTERNAL WIN866
sjis_to_euc_jp SJIS EUC_JP
sjis_to_mic SJIS MULE_INTERNAL
sjis_to_utf8 SJIS UTF8
tcvn_to_utf8 WIN1258 UTF8
uhc_to_utf8 UHC UTF8
utf8_to_ascii UTF8 SQL_ASCII
utf8_to_big5 UTF8 BIG5
utf8_to_euc_cn UTF8 EUC_CN
utf8_to_euc_jp UTF8 EUC_JP
utf8_to_euc_kr UTF8 EUC_KR
utf8_to_euc_tw UTF8 EUC_TW
utf8_to_gb18030 UTF8 GB18030
utf8_to_gbk UTF8 GBK
utf8_to_iso_8859_1 UTF8 LATIN1
utf8_to_iso_8859_10 UTF8 LATIN6
utf8_to_iso_8859_13 UTF8 LATIN7
utf8_to_iso_8859_14 UTF8 LATIN8
utf8_to_iso_8859_15 UTF8 LATIN9
utf8_to_iso_8859_16 UTF8 LATIN10
utf8_to_iso_8859_2 UTF8 LATIN2
utf8_to_iso_8859_3 UTF8 LATIN3
utf8_to_iso_8859_4 UTF8 LATIN4
utf8_to_iso_8859_5 UTF8 ISO_8859_5
utf8_to_iso_8859_6 UTF8 ISO_8859_6
utf8_to_iso_8859_7 UTF8 ISO_8859_7
utf8_to_iso_8859_8 UTF8 ISO_8859_8
utf8_to_iso_8859_9 UTF8 LATIN5
utf8_to_johab UTF8 JOHAB
utf8_to_koi8_r UTF8 KOI8R
utf8_to_koi8_u UTF8 KOI8U
utf8_to_sjis UTF8 SJIS
utf8_to_tcvn UTF8 WIN1258
utf8_to_uhc UTF8 UHC
utf8_to_windows_1250 UTF8 WIN1250
utf8_to_windows_1251 UTF8 WIN1251
utf8_to_windows_1252 UTF8 WIN1252
utf8_to_windows_1253 UTF8 WIN1253
utf8_to_windows_1254 UTF8 WIN1254
utf8_to_windows_1255 UTF8 WIN1255
utf8_to_windows_1256 UTF8 WIN1256
utf8_to_windows_1257 UTF8 WIN1257
utf8_to_windows_866 UTF8 WIN866
utf8_to_windows_874 UTF8 WIN874
windows_1250_to_iso_8859_2 WIN1250 LATIN2
windows_1250_to_mic WIN1250 MULE_INTERNAL
windows_1250_to_utf8 WIN1250 UTF8
windows_1251_to_iso_8859_5 WIN1251 ISO_8859_5
windows_1251_to_koi8_r WIN1251 KOI8R
windows_1251_to_mic WIN1251 MULE_INTERNAL
windows_1251_to_utf8 WIN1251 UTF8
windows_1251_to_windows_866 WIN1251 WIN866
windows_1252_to_utf8 WIN1252 UTF8
windows_1256_to_utf8 WIN1256 UTF8
windows_866_to_iso_8859_5 WIN866 ISO_8859_5
windows_866_to_koi8_r WIN866 KOI8R
windows_866_to_mic WIN866 MULE_INTERNAL
windows_866_to_utf8 WIN866 UTF8
windows_866_to_windows_1251 WIN866 WIN
windows_874_to_utf8 WIN874 UTF8
euc_jis_2004_to_utf8 EUC_JIS_2004 UTF8
utf8_to_euc_jis_2004 UTF8 EUC_JIS_2004
shift_jis_2004_to_utf8 SHIFT_JIS_2004 UTF8
utf8_to_shift_jis_2004 UTF8 SHIFT_JIS_2004
euc_jis_2004_to_shift_jis_2004 EUC_JIS_2004 SHIFT_JIS_2004
shift_jis_2004_to_euc_jis_2004 SHIFT_JIS_2004 EUC_JIS_2004

[a] Les noms des conversions suivent un schéma de nommage standard : le nom officiel de l'encodage source avec tous les caractères non alpha-numériques remplacés par des tirets bas suivi de _to_ suivi du nom de l'encodage cible ayant subit le même traitement que le nom de l'encodage source. Il est donc possible que les noms varient par rapport aux noms d'encodage personnalisés.


9.4.1. format

La fonction format produit une sortie formatée suivant une chaîne de formatage, dans un style similaire à celui de la fonction C sprintf.

format(chaine_format text [, arg_format "any" [, ...] ])

chaine_format est une chaîne de formatage qui indique comment le résultat doit être formatté. Le texte de la chaîne de formatage est copié directement dans le résultat, sauf quand des spécificateurs de formatage sont utilisés. Ces spécificateur agissent comme des pointeurs dans la chaîne, définissant comment les arguments suivants de la fonction doivent être formatés et insérés dans le résultat. Chaque argument arg_format est converti en texte suivant les règles de sortie habituelles pour son type de données, puis formaté et inséré dans la chaîne en résultat suivant les spécificateurs de format.

Les spécificateurs de format sont introduits par un symbole % et ont la forme suivante :

%[position][drapeaux][longueur]type

où les composants sont :

position (optionnel)

Une chaîne de la forme n$n est le numéro de l'argument à afficher. Le numéro 1 correspond au premier argument après chaine_format. Si position est omis, le comportement par défaut est d'utiliser le prochain argument dans la séquence.

drapeaux (optionnel)

Des options supplémentaires contrôlant la sortie du spécificateur est formatée. Actuellement, le seul drapeau supporté est le signe moins (-) qui fera en sorte que la sortie du spécificateur sera alignée à gauche. Cela n'a pas d'effet si le champ longueur n'est pas défini.

longueur (optionnel)

Indique le nombre minimum de caractères à utiliser pour afficher la sortie du spécificateur de format. Des espaces sont ajoutés à gauche ou à droite (suivant la présence du drapeau -) pour remplir la longueur demandée. Une longueur trop petite est tout simplement ignorée. La longueur peut être spécifiée en utilisant une des méthodes suivantes : un entier positif, une astérisque (*) pour utiliser le prochain argument de la fonction en tant que longueur, ou une chaîne de la forme *n$ pour utiliser l'argument n comme longueur.

Si la longueur vient d'un argument de la fonction, cet argument est consommé avant l'argument utilisé pour la valeur du spécificateur de format. Si l'argument longueur est négatif, le résultat est aligné à gauche (comme si le drapeau - a été spécifié) dans un champ de longueur abs (longueur).

type (requis)

Le type de conversion de format à utiliser pour produire la sortie du spécificateur de format. Les types suivants sont supportés :

  • s formate la valeur de l'argument comme une simple chaîne. Une valeur NULL est traitée comme une chaîne vide.

  • I traite la valeur de l'argument comme un identifiant SQL, en utilisant les guillemets doubles si nécessaire. Une valeur NULL est une erreur.

  • L met entre guillemets simple la valeur en argument pour un litéral SQL. Une valeur NULL est affichée sous la forme d'une chaîne NULL, sans guillemets.

En plus des spécificateurs de format décrit ci-dessus, la séquence spéciale %% peut être utilisée pour afficher un caractère litéral %.

Voici quelques exemples des conversions basiques de format :

SELECT format('Hello %s', 'World');
Résultat : Hello World

SELECT format('Testing %s, %s, %s, %%', 'one', 'two', 'three');
Résultat : Testing one, two, three, %

SELECT format('INSERT INTO %I VALUES(%L)', 'Foo bar', E'O\'Reilly');
Résultat : INSERT INTO "Foo bar" VALUES('O''Reilly')

SELECT format('INSERT INTO %I VALUES(%L)', 'locations', E'C:\\Program Files');
Résultat : INSERT INTO locations VALUES(E'C:\\Program Files')

Voici quelques exemples utilisant le champ longueur et le drapeau - :

SELECT format('|%10s|', 'foo');
Résultat : |       foo|

SELECT format('|%-10s|', 'foo');
Résultat : |foo       |

SELECT format('|%*s|', 10, 'foo');
Résultat : |       foo|

SELECT format('|%*s|', -10, 'foo');
Résultat : |foo       |

SELECT format('|%-*s|', 10, 'foo');
Résultat : |foo       |

SELECT format('|%-*s|', -10, 'foo');
Résultat : |foo       |

Ces exemples montrent l'utilisation des champs position :

SELECT format('Testing %3$s, %2$s, %1$s', 'one', 'two', 'three');
Résultat : Testing three, two, one

SELECT format('|%*2$s|', 'foo', 10, 'bar');
Résultat : |       bar|

SELECT format('|%1$*2$s|', 'foo', 10, 'bar');
Résultat : |       foo|

Contrairement à la fonction C standard sprintf, la fonction format de PostgreSQL™ permet que les spécificateurs de format avec ou sans le champ position soient mixés dans la même chaîne de formatage. Un spécificateur de format sans un champ position utilise toujours le prochain argument après que le dernier argument soit consommé. De plus, la fonction format ne requiert pas que tous les arguments de fonction soient utilisés dans la chaîne de formatage. Par exemple :

SELECT format('Testing %3$s, %2$s, %s', 'one', 'two', 'three');
Résultat : Testing three, two, three

Les spécificateurs de format %I et %L sont particulièrement utiles pour construire proprement des requêtes SQL dynamiques. Voir Exemple 40.1, « Mettre entre guillemets des valeurs dans des requêtes dynamiques ».