{"Entry":{"collection":"protocol","key":"describe-f","name":"Describe","aliases":["Describe","Byte1('D')"],"metadata":{"aliases":["Describe","Byte1('D')"],"category":"Frontend messages","content_hash":"c56e10d4a1bdb4d2accac37733ffaa5ea7cd9300a1e622d7bdd8786c1c94b729","imported_at":"2026-09-30T00:40:44.53916+08:00","name":"Describe","name_zh":"","slug":"describe-f","summary":"Describe is a frontend protocol message. Identifies the message as a Describe command."}},"Definition":{"Collection":"protocol","Key":"describe-f","SourceDatabase":"center","Version":"18","SourceTable":"protocol_message","SourceKey":"describe-f","SourceRevision":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","Facts":{"comparison_data":{"direction":"F","fields":[{"description":"Identifies the message as a Describe command.","format":"Byte1('D')"},{"description":"Length of message contents in bytes, including self.","format":"Int32"},{"description":"' S ' to describe a prepared statement; or ' P ' to describe a portal.","format":"Byte1"},{"description":"The name of the prepared statement or portal to describe (an empty string selects the unnamed prepared statement or portal).","format":"String"}]},"comparison_hash":"45b27fbfaae8aeadc619c80026805ce01b6d7d2a587deab9cdadb1a8f751f8fc","description":["Describe is a frontend protocol message. Identifies the message as a Describe command."],"direction":"F","facts":[{"label":"Direction","value":"Frontend → backend"},{"label":"First wire field","value":"Byte1('D')"},{"label":"Field entries","value":"4"},{"label":"Documented flow contexts","value":"Extended Query"}],"fields":[{"description":"Identifies the message as a Describe command.","format":"Byte1('D')"},{"description":"Length of message contents in bytes, including self.","format":"Int32"},{"description":"' S ' to describe a prepared statement; or ' P ' to describe a portal.","format":"Byte1"},{"description":"The name of the prepared statement or portal to describe (an empty string selects the unnamed prepared statement or portal).","format":"String"}],"manual_html":"\u003cdl\u003e\u003cdd\u003e\n\u003cdiv class=\"variablelist\"\u003e\n\u003cdl class=\"variablelist\"\u003e\n\u003cdt\u003e\u003cspan class=\"term\"\u003eByte1('D')\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003eIdentifies the message as a Describe command.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003cspan class=\"term\"\u003eInt32\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003eLength of message contents in bytes, including self.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003cspan class=\"term\"\u003eByte1\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003e'\u003ccode class=\"literal\"\u003eS\u003c/code\u003e' to describe a prepared statement; or '\u003ccode class=\"literal\"\u003eP\u003c/code\u003e' to describe a portal.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003cspan class=\"term\"\u003eString\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003eThe name of the prepared statement or portal to describe (an empty string selects the unnamed prepared statement or portal).\u003c/p\u003e\n\u003c/dd\u003e\n\u003c/dl\u003e\n\u003c/div\u003e\n\u003c/dd\u003e\u003c/dl\u003e","manual_path":"/docs/18/protocol-message-formats.html","related":[{"label":"Protocol flow and exchange examples","url":"/docs/18/protocol-flow.html"},{"label":"Protocol overview","url":"/docs/18/protocol-overview.html"},{"label":"Extended Query","url":"/docs/18/protocol-flow.html#PROTOCOL-FLOW-EXT-QUERY"}],"release":{"channel":"stable","label":"18.6","major":"18","ref":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2","revision":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"},"sections":[{"paragraphs":["The complete definition below retains repetition, counts and conditional fields. A numbered table row is a documented field definition, not a fixed byte offset. Integer encodings and flow rules follow the same-version protocol chapter."],"title":"Framing and repetition"}],"signature":"Describe (F)","sources":[{"label":"PostgreSQL 18 English manual","path":"protocol-message-formats.html","sha256":"53f37652ac2c089e30ada87d8aee7bdd0f26695b03f275302e526a807d2a1f23","url":"/docs/18/protocol-message-formats.html#PROTOCOL-MESSAGE-FORMATS-DESCRIBE"}],"tables":[{"columns":[{"key":"c0","label":"Position"},{"key":"c1","label":"Format"},{"key":"c2","label":"Meaning"}],"key":"fields","rows":[{"c0":"1","c1":"Byte1('D')","c2":"Identifies the message as a Describe command."},{"c0":"2","c1":"Int32","c2":"Length of message contents in bytes, including self."},{"c0":"3","c1":"Byte1","c2":"' S ' to describe a prepared statement; or ' P ' to describe a portal."},{"c0":"4","c1":"String","c2":"The name of the prepared statement or portal to describe (an empty string selects the unnamed prepared statement or portal)."}],"title":"Wire fields in documented order"}]},"ManualEvidence":{"manual_path":"/docs/18/protocol-message-formats.html","release":{"channel":"stable","label":"18.6","major":"18","ref":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2","revision":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"},"sources":[{"label":"PostgreSQL 18 English manual","path":"protocol-message-formats.html","sha256":"53f37652ac2c089e30ada87d8aee7bdd0f26695b03f275302e526a807d2a1f23","url":"/docs/18/protocol-message-formats.html#PROTOCOL-MESSAGE-FORMATS-DESCRIBE"}]},"MeasuredEvidence":{}},"Text":{"Collection":"protocol","Key":"describe-f","SourceDatabase":"center","Version":"18","Locale":"en","Title":"Describe","Summary":"Describe is a frontend protocol message. Identifies the message as a Describe command.","BodyHTML":"\u003cdl\u003e\u003cdd\u003e\n\u003cdiv\u003e\n\u003cdl\u003e\n\u003cdt\u003e\u003cspan\u003eByte1(\u0026#39;D\u0026#39;)\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003eIdentifies the message as a Describe command.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003cspan\u003eInt32\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003eLength of message contents in bytes, including self.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003cspan\u003eByte1\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003e\u0026#39;\u003ccode\u003eS\u003c/code\u003e\u0026#39; to describe a prepared statement; or \u0026#39;\u003ccode\u003eP\u003c/code\u003e\u0026#39; to describe a portal.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003cspan\u003eString\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003eThe name of the prepared statement or portal to describe (an empty string selects the unnamed prepared statement or portal).\u003c/p\u003e\n\u003c/dd\u003e\n\u003c/dl\u003e\n\u003c/div\u003e\n\u003c/dd\u003e\u003c/dl\u003e","SourceRevision":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","ContentHash":"2526a183a6da32bd54e394ef3bbc6d35820acbcb4dc10b12076c05d1a34b523a","Payload":{"description":["Describe is a frontend protocol message. Identifies the message as a Describe command."],"manual_html":"\u003cdl\u003e\u003cdd\u003e\n\u003cdiv class=\"variablelist\"\u003e\n\u003cdl class=\"variablelist\"\u003e\n\u003cdt\u003e\u003cspan class=\"term\"\u003eByte1('D')\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003eIdentifies the message as a Describe command.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003cspan class=\"term\"\u003eInt32\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003eLength of message contents in bytes, including self.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003cspan class=\"term\"\u003eByte1\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003e'\u003ccode class=\"literal\"\u003eS\u003c/code\u003e' to describe a prepared statement; or '\u003ccode class=\"literal\"\u003eP\u003c/code\u003e' to describe a portal.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003cspan class=\"term\"\u003eString\u003c/span\u003e\u003c/dt\u003e\n\u003cdd\u003e\n\u003cp\u003eThe name of the prepared statement or portal to describe (an empty string selects the unnamed prepared statement or portal).\u003c/p\u003e\n\u003c/dd\u003e\n\u003c/dl\u003e\n\u003c/div\u003e\n\u003c/dd\u003e\u003c/dl\u003e","related":[{"label":"Protocol flow and exchange examples","url":"/docs/18/protocol-flow.html"},{"label":"Protocol overview","url":"/docs/18/protocol-overview.html"},{"label":"Extended Query","url":"/docs/18/protocol-flow.html#PROTOCOL-FLOW-EXT-QUERY"}],"sections":[{"paragraphs":["The complete definition below retains repetition, counts and conditional fields. A numbered table row is a documented field definition, not a fixed byte offset. Integer encodings and flow rules follow the same-version protocol chapter."],"title":"Framing and repetition"}],"tables":[{"columns":[{"key":"c0","label":"Position"},{"key":"c1","label":"Format"},{"key":"c2","label":"Meaning"}],"key":"fields","rows":[{"c0":"1","c1":"Byte1('D')","c2":"Identifies the message as a Describe command."},{"c0":"2","c1":"Int32","c2":"Length of message contents in bytes, including self."},{"c0":"3","c1":"Byte1","c2":"' S ' to describe a prepared statement; or ' P ' to describe a portal."},{"c0":"4","c1":"String","c2":"The name of the prepared statement or portal to describe (an empty string selects the unnamed prepared statement or portal)."}],"title":"Wire fields in documented order"}]}},"RequestedLocale":"zh-Hans","Fallback":true,"Versions":["10","11","12","13","14","15","16","17","18","19","20"],"Locales":["en"],"Signatures":null,"Spellings":null,"SQLState":null,"Evidence":null}