| Documentation PostgreSQL 8.0.25 | ||||
|---|---|---|---|---|
| Précédent | Arrière rapide | Chapitre 42. Protocole client/serveur | Avance rapide | Suivant |
Cette section décrit le format détaillé de chaque message. Chaque message est marqué pour indiquer s'il peut être envoyé par un client (F pour Frontend), un serveur (B pour Backend) ou les deux (F & B). Bien que chaque message commence par son nombre d'octets, le format du message est défini de telle sorte que la fin du message puisse être trouvée sans ce nombre. Cela contribue à la vérification de la validité. Le message CopyData est une exception car il constitue une partie du flux de données ; le contenu d'un message CopyData individuel n'est, en soi, pas interprétable.
Marqueur de demande d'authentification.
Taille du message en octets, y compris la taille elle-même.
L'authentification a réussi.
Marqueur de demande d'authentification.
Taille du message en octets, y compris la taille elle-même.
Une authentification Kerberos V4 est requise.
Marqueur de demande d'authentification.
Taille du message en octets, y compris la taille elle-même.
Une authentification Kerberos V5 est requise.
Marqueur de demande d'authentification.
Taille du message en octets, y compris la taille elle-même.
Un mot de passe en clair est requis.
Marqueur de demande d'authentification.
Taille du message en octets, y compris la taille elle-même.
Un mot de passe chiffré à l'aide de crypt() est requis.
Composant (salt) à utiliser lors du chiffrement du mot de passe.
Marqueur de demande d'authentification.
Taille du message en octets, y compris la taille elle-même.
Un mot de passe chiffré par MD5 est requis.
Composant (salt) à utiliser lors du chiffrement du mot de passe.
Marqueur de demande d'authentification.
Taille du message en octets, y compris la taille elle-même.
Un message d'accréditation SCM est requis.
Marqueur de clé d'annulation. Le client doit sauvegarder ces valeurs s'il souhaite initier des messages CancelRequest par la suite.
Taille du message en octets, y compris la taille elle-même.
ID du processus du serveur concerné.
Clé secrète du serveur concerné.
Marqueur de commande Bind.
Taille du message en octets, y compris la taille elle-même.
Nom du portail de destination (une chaîne vide sélectionne le portail non-nommé).
Nom de l'instruction source préparée (une chaîne vide sélectionne l'instruction préparée non-nommée).
Nombre de codes de format de paramètres qui suivent (notés C ci-dessous). Peut valoir zéro pour indiquer qu'il n'y a aucun paramètre ou que tous les paramètres utilisent le format par défaut (texte) ; ou un, auquel cas le code de format spécifié est appliqué à tous les paramètres ; il peut aussi être égal au nombre courant de paramètres.
Codes de format des paramètres. Tous doivent valoir zéro (texte) ou un (binaire).
Nombre de valeurs de paramètres qui suivent (peut valoir zéro). Cela doit correspondre au nombre de paramètres nécessaires à la requête.
Puis, le couple de champs suivant apparaît pour chaque paramètre :
Taille de la valeur du paramètre, en octets (ce nombre n'inclut pas la longueur elle-même). Peut valoir zéro. Traité comme un cas spécial, -1 indique une valeur de paramètre NULL. Aucun octet de valeur ne suit le cas NULL.
Valeur du paramètre, dans le format indiqué par le code de format associé. n est la longueur ci-dessus.
Après le dernier paramètre, les champs suivants apparaissent :
Nombre de codes de format des colonnes de résultat qui suivent (noté R ci-dessous). Peut valoir zéro pour indiquer qu'il n'y a pas de colonnes de résultat ou que les colonnes de résultat utilisent le format par défaut (texte) ; ou une, auquel cas le code de format spécifié est appliqué à toutes les colonnes de résultat (s'il y en a) ; il peut aussi être égal au nombre de colonnes de résultat de la requête.
Codes de format des colonnes de résultat. Tous doivent valoir zéro (texte) ou un (binaire).
Indicateur de Bind complet.
Taille du message en octets, y compris la taille elle-même.
Taille du message en octets, y compris la taille elle-même.
Code d'annulation de la requête. La valeur est choisie pour contenir 1234 dans les 16 bits les plus significatifs et 5678 dans les 16 bits les moins significatifs. (Pour éviter toute confusion, ce code ne doit pas être le même qu'un numéro de version de protocole.)
ID du processus du serveur cible.
Clé secrète du serveur cible.
Marqueur de commande Close.
Taille du message en octets, y compris la taille elle-même.
'S' pour fermer une instruction préparée ; ou 'P' pour fermer un portail.
Nom de l'instruction préparée ou du portail à fermer (une chaîne vide sélectionne l'instruction préparée ou le portail non-nommé(e)).
Indicateur de complétude de Close.
Taille du message en octets, y compris la taille elle-même.
Marqueur de réponse de complétude de commande.
Taille du message en octets, y compris la taille elle-même.
Balise de la commande. Mot simple identifiant la commande SQL terminée.
Pour une commande INSERT, la balise est INSERT oid lignes où lignes est le nombre de lignes insérées. oid est l'ID de l'objet de la ligne insérée si lignes vaut 1 et que la table cible a des OID ; sinon oid vaut 0.
Pour une commande DELETE, la balise est DELETE lignes où lignes est le nombre de lignes supprimées.
Pour une commande UPDATE, la balise est UPDATE lignes où lignes est le nombre de lignes mises à jour.
Pour une commande MOVE, la balise est MOVE lignes où lignes est le nombre de lignes de déplacement du curseur.
Pour une commande FETCH, la balise est FETCH lignes où lignes est le nombre de lignes récupérées à partir du curseur.
Marqueur de données de COPY.
Taille du message en octets, y compris la taille elle-même.
Données formant une partie d'un flux de données COPY. Les messages envoyés depuis le serveur correspondront toujours à des lignes uniques de données, mais les messages envoyés par les clients peuvent diviser le flux de données de façon arbitraire.
Indicateur de fin de COPY.
Taille du message en octets, y compris la taille elle-même.
Indicateur d'échec de COPY.
Taille du message en octets, y compris la taille elle-même.
Message d'erreur rapportant la cause d'un échec.
Marqueur de réponse de Start Copy In. Le client doit alors envoyer des données de copie (s'il n'est pas à cela, il enverra un message CopyFail).
Taille du message en octets, y compris la taille elle-même.
0 indique que le format de copie complet est textuel (lignes séparées par des retours chariot, colonnes séparées par des caractères de séparation, etc). 1 indique que le format de copie complet est binaire (similaire au format DataRow). Voir COPY pour plus d'informations.
Nombre de colonnes dans les données à copier (noté N ci-dessous).
Codes de format à utiliser pour chaque colonne. Chacun doit valoir zéro (texte) ou un (binaire). Tous doivent valoir zéro si le format de copie complet est de type texte.
Marqueur de réponse Start Copy Out. Ce message sera suivi de données copy-out.
Taille du message en octets, y compris la taille elle-même.
0 indique que le format de copie complet est textuel (lignes séparées par des retours chariots, colonnes séparées par des caractères séparateur, etc). 1 indique que le format de copie complet est binaire (similaire au format DataRow). Voir COPY pour plus d'informations.
Nombre de colonnes de données à copier (noté N ci-dessous).
Codes de format à utiliser pour chaque colonne. Chaque code doit valoir zéro (texte) ou un (binaire). Tous doivent valoir zéro si le format de copie complet est de type texte.
Marqueur de ligne de données.
Taille du message en octets, y compris la taille elle-même.
Nombre de valeurs de colonnes qui suivent (peut valoir zéro).
Apparaît ensuite le couple de champs suivant, pour chaque colonne :
Longueur de la valeur de la colonne, en octets (ce nombre n'inclut pas la longueur elle-même). Peut valoir zéro. Traité comme un cas spécial, -1 indique une valeur NULL de colonne. Aucun octet de valeur ne suit le cas NULL.
Valeur de la colonne dans le format indiqué par le code de format associé. n est la longueur ci-dessus.
Marqueur de commande Describe.
Taille du message en octets, y compris la taille elle-même.
'S' pour décrire une instruction préparée ; ou 'P' pour décrire un portail.
Nom de l'instruction préparée ou du portail à décrire (une chaîne vide sélectionne l'instruction préparée ou le portail non-nommé(e)).
Marqueur de réponse à une chaîne de requête vide. (C'est un substitut de CommandComplete.)
Taille du message en octets, y compris la taille elle-même.
Marqueur d'erreur.
Taille du message en octets, y compris la taille elle-même.
Le corps du message est constitué d'un ou plusieurs champs identifié(s), suivi(s) d'un octet nul comme terminateur. L'ordre des champs n'est pas fixé. Pour chaque champ, on trouve les informations suivantes :
Code identifiant le type de champ ; s'il vaut zéro, c'est la fin du message et aucune chaîne ne suit. Les types de champs définis sont listés dans Section 42.5. De nouveaux types de champs pourraient être ajoutés dans le futur, les clients doivent donc ignorer silencieusement les types non reconnus.
Valeur du champ.
Marqueur de commande Execute.
Taille du message en octets, y compris la taille elle-même.
Nom du portail à exécuter (une chaîne vide sélectionne le portail non-nommé).
Nombre maximum de lignes à retourner si le portail contient une requête retournant des lignes (ignoré sinon). Zéro signifie << aucune limite >>.
Marqueur de commande Flush.
Taille du message en octets, y compris la taille elle-même.
Marqueur d'appel de fonction.
Taille du message en octets, y compris la taille elle-même.
Spécifie l'ID de l'objet représentant la fonction à appeler.
Nombre de codes de format de l'argument qui suivent (noté C ci-dessous). Cela peut être zéro pour indiquer qu'il n'y a pas d'arguments ou que tous les arguments utilisent le format par défaut (texte) ; un, auquel cas le code de format est appliqué à tous les arguments ; il peut aussi être égal au nombre réel d'arguments.
Les codes de format d'argument. Chacun doit valoir zéro (texte) ou un (binaire).
Nombre d'arguments fournis à la fonction.
Apparaît ensuite, pour chaque argument, le couple de champs suivant :
Longueur de la valeur de l'argument, en octets (ce nombre n'inclut pas la longueur elle-même). Peut valoir zéro. Traité comme un cas spécial, -1 indique une valeur NULL de l'argument. Aucun octet de valeur ne suit le cas NULL.
Valeur de l'argument dans le format indiqué par le code de format associé. n est la longueur ci-dessus.
Après le dernier argument, le champ suivant apparaît :
Code du format du résultat de la fonction. Doit valoir zéro (texte) ou un (binaire).
Marqueur de résultat d'un appel de fonction.
Taille du message en octets, y compris la taille elle-même.
Longueur de la valeur du résultat de la fonction, en octets (ce nombre n'inclut pas la longueur elle-même). Peut valoir zéro. Traité comme un cas spécial, -1 indique un résultat de fonction NULL. Aucun octet de valeur ne suit le cas NULL.
Valeur du résultat de la fonction, dans le format indiqué par le code de format associé. n est la longueur ci-dessus.
Indicateur d'absence de données.
Taille du message en octets, y compris la taille elle-même.
Marqueur d'avertissement.
Taille du message en octets, y compris la taille elle-même.
Le corps du message est constitué d'un ou plusieurs champs identifié(s), suivi(s) d'un octet zéro comme terminateur. L'ordre des champs n'est pas fixé. Pour chaque champ, on trouve les informations suivantes :
Code identifiant le type de champ ; s'il vaut zéro, c'est la fin du message et aucune chaîne ne suit. Les types de champs déjà définis sont listés dans Section 42.5. De nouveaux types de champs pourraient être ajoutés dans le futur, les clients doivent donc ignorer silencieusement les champs de type non reconnu.
Valeur du champ.
Marqueur de réponse de notification.
Taille du message en octets, y compris la taille elle-même.
ID du processus serveur ayant procédé à la notification.
Nom de la condition à l'origine de la notification.
Information supplémentaire provenant du processus à l'origine de la notification. (Cette fonctionnalité n'est , à ce jour, pas implantée, le champ est donc toujours constitué d'une chaîne vide.)
Marqueur de description de paramètre.
Taille du message en octets, y compris la taille elle-même.
Nombre de paramètres utilisé par l'instruction (peut valoir zéro).
Pour chaque paramètre, suivent :
ID de l'objet du type de données du paramètre.
Marqueur de rapport d'état de paramètre d'exécution.
Taille du message en octets, y compris la taille elle-même.
Nom du paramètre d'exécution dont le rapport est en cours.
Valeur actuelle du paramètre.
Marqueur de commande Parse.
Taille du message en octets, y compris la taille elle-même.
Nom de l'instruction préparée de destination (une chaîne vide sélectionne l'instruction préparée non-nommée).
Chaîne de requête à analyser.
Nombre de types de données de paramètre spécifiés (peut valoir zéro). Ce n'est pas une indication du nombre de paramètres pouvant apparaître dans la chaîne de requête, mais simplement le nombre de paramètres pour lesquels le client veut pré-spécifier les types.
Pour chaque paramètre, on trouve ensuite :
ID de l'objet du type de données du paramètre. la valeur zéro équivaut à ne pas spécifier le type.
Indicateur de fin de Parse.
Taille du message en octets, y compris la taille elle-même.
Marqueur de réponse de mot de passe.
Taille du message en octets, y compris la taille elle-même.
Mot de passe (chiffré à la demande).
Indicateur de suspension du portail. Apparaît seulement si la limite du nombre de lignes d'un message Execute a été atteint.
Taille du message en octets, y compris la taille elle-même.
Marqueur de requête simple.
Taille du message en octets, y compris la taille elle-même.
La chaîne de requête elle-même.
Identifie le type du message. ReadyForQuery est envoyé à chaque fois que le serveur est prêt pour un nouveau cycle de requêtes.
Taille du message en octets, y compris la taille elle-même.
Indicateur de l'état transactionnel du serveur. Les valeurs possibles sont 'I' s'il est en pause (en dehors d'un bloc de transaction) ; 'T' s'il est dans un bloc de transaction ; ou 'E' s'il est dans un bloc de transaction échouée (les requêtes seront réjetées jusqu'à la fin du bloc).
Marqueur de description de ligne.
Taille du message en octets, y compris la taille elle-même.
Nombre de champs dans une ligne (peut valoir zéro).
On trouve, ensuite, pour chaque champ :
Nom du champ.
Si le champ peut être identifié comme colonne d'une table spécifique, l'ID de l'objet de la table ; sinon zéro.
Si le champ peut être identifié comme colonne d'une table spécifique, le numéro d'attribut de la colonne ; sinon zéro.
ID de l'objet du type de données du champ.
Taille du type de données (voir pg_type.typlen). Les valeurs négatives indiquent des types de largeur variable.
Modificateur de type (voir pg_attribute.atttypmod). La signification du modificateur est spécifique au type.
Code de format utilisé pour le champ. Zéro (texte) ou un (binaire), à l'heure actuelle. Dans un RowDescription retourné par la variante de l'instruction de Describe, le code du format n'est pas encore connu et vaudra toujours zéro.
Taille du message en octets, y compris la taille elle-même.
Code de requête SSL. La valeur est choisie pour contenir 1234 dans les 16 bits les plus significatifs, et 5679 dans les 16 bits les moins significatifs (pour éviter toute confusion, ce code ne doit pas être le même que celui d'un numéro de version de protocole).
Taille du message en octets, y compris la taille elle-même.
Numéro de version du protocole. Les 16 bits les plus significatifs représentent le numéro de version majeure (3 pour le protocole décrit ici). Les 16 bits les moins significatifs représentent le numéro de version mineure (0 pour le protocole décrit ici).
Le numéro de version du protocole est suivi par un ou plusieurs couple(s) nom de paramètre et chaîne de valeur. Un octet zéro est requis comme terminateur après le dernier couple nom/valeur. L'ordre des paramètres n'est pas fixé. Le paramètre user est requis, les autres sont optionnels. Chaque paramètre est spécifié de la façon suivante :
Nom du paramètre. Les noms actuellement reconnus sont :
Nom de l'utilisateur de base de données sous lequel se connecter. Requis ; il n'y a pas de valeur par défaut.
Base de données à laquelle se connecter. Par défaut le nom de l'utilisateur.
Arguments en ligne de commande pour le serveur. (Rendu obsolète par l'utilisation de paramètres individuels d'exécution.)
En plus de ce qui précède, tout paramètre d'exécution pouvant être initialisé au démarrage du serveur peut être listé. Ces paramètres seront appliqués au démarrage du serveur (après analyse des options en ligne de commande, s'il y en a). Leurs valeurs agiront comme valeurs de session par défaut.
Valeur du paramètre.
Marqueur de commande Sync.
Taille du message en octets, y compris la taille elle-même.
Marqueur de fin.
Taille du message en octets, y compris la taille elle-même.
| Précédent | Sommaire | Suivant |
| Types de données des message | Niveau supérieur | Champs des messages d'erreur et d'avertissement |