Class DescribeMessage (0.5.1)

publicclass DescribeMessageextendsAbstractQueryProtocolMessage

Calls describe on a portal or prepared statement.

Inherited Members

Static Fields

IDENTIFIER

protectedstaticfinalcharIDENTIFIER
Field Value
Type Description

Constructors

DescribeMessage(ConnectionHandler connection)

publicDescribeMessage(ConnectionHandlerconnection)
Parameter
Name Description
connection ConnectionHandler

DescribeMessage(ConnectionHandler connection, ControlMessage.ManuallyCreatedToken manuallyCreatedToken)

publicDescribeMessage(ConnectionHandlerconnection,ControlMessage.ManuallyCreatedTokenmanuallyCreatedToken)

Constructor for manually created Describe messages from the simple query protocol.

Parameters
Name Description
connection ConnectionHandler

Methods

flush()

publicvoidflush()
Overrides Exceptions
Type Description

getHeaderLength()

protectedintgetHeaderLength()

How many bytes is taken by the payload header. Header is defined here as protocol definition + length. Most common value here is four bytes, so we keep that as default. Effectively, this is how much of the message you "don't" want to read from the message's total length with readAll.

Returns
Type Description
int
Overrides

getIdentifier()

protectedStringgetIdentifier()

Used for logging.

Returns
Type Description
Overrides

getMessageName()

protectedStringgetMessageName()

Used for logging.

Returns
Type Description
Overrides

getName()

publicStringgetName()
Returns
Type Description

getPayloadString()

protectedStringgetPayloadString()

Used for logging.

Returns
Type Description
Overrides

getType()

publicControlMessage.PreparedTypegetType()
Returns
Type Description

handleDescribeStatement()

publicvoidhandleDescribeStatement()

Called when a describe message of type 'S' is received.

Exceptions
Type Description
Exception

if sending the message back to the client causes an error.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.