Response filters - MySQL

Response filters are filters that are invoked whenever a response is received from the database server. Response filters can examine the response and do whatever they want to it before it gets forwarded to the database client.

Response filters need to be more careful about performance than request filter, because a single request packet can result in millions of response packets


All response filters define the following variables, which can be accessed from your JavaScript code:

  • log : A Logger object to output messages to the logging system

  • context : a container object with the following properties:

    • packet : the packet being processed - can be any response packet type

    • packetType : the type of the packet, equivalent to context.packet.getPacketType()

    • filterContext : variables available to all invocations of this filter

    • connectionContext : variables that persist through the life of this database connection

    • projectContext: variables available to all filters in the project

See the Contexts page for more information about the various context objects.

Response filters for MySQL

  • JavaScript filter : can be invoked for any response packets.

  • response logging filter: logs responses from the database server

  • result set filter: invoked when a result set is received from the server. Can be used to hide or modify rows or columns from result sets.

  • result set batch filter: invoked when a result set is received from the server, if the connection specifies a batch size. The filter receives a collection of rows instead of a single row.