Enum MysqlCapabilityFlag

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS
      Server: Announces support for expired password extension.
      Client: Can handle expired passwords.
      CLIENT_COMPRESS
      Compression protocol supported.
      Server: Supports compression.
      Client: Switches to Compression compressed protocol after successful authentication.
      CLIENT_CONNECT_ATTRS
      Server: Permits connection attributes in Protocol::HandshakeResponse41.
      Client: Sends connection attributes in Protocol::HandshakeResponse41.
      CLIENT_CONNECT_WITH_DB
      Database (schema) name can be specified on connect in Handshake Response Packet.
      Server: Supports schema-name in Handshake Response Packet.
      Client: Handshake Response Packet contains a schema-name.
      CLIENT_DEPRECATE_EOF
      Server: Can send OK after a Text Resultset.
      Client: Expects an OK (instead of EOF) after the resultset rows of a Text Resultset.
      Background: To support CLIENT_SESSION_TRACK, additional information must be sent after all successful commands.
      CLIENT_FOUND_ROWS
      Send found rows instead of affected rows in EOF_Packet.
      CLIENT_IGNORE_SIGPIPE
      Client: Do not issue SIGPIPE if network failures occur (libmysqlclient only).
      See: mysql_real_connect()
      CLIENT_IGNORE_SPACE
      Server: Parser can ignore spaces before '('.
      Client: Let the parser ignore spaces before '('.
      CLIENT_INTERACTIVE
      wait_timeout versus wait_interactive_timeout.
      Server: Supports interactive and noninteractive clients.
      Client: Client is interactive.
      See: mysql_real_connect()
      CLIENT_LOCAL_FILES
      Can use LOAD DATA LOCAL.
      Server: Enables the LOCAL INFILE request of LOAD DATA|XML.
      Client: Will handle LOCAL INFILE request.
      CLIENT_LONG_FLAG
      Longer flags in Protocol::ColumnDefinition320.
      Server: Supports longer flags., Client: Expects longer flags.
      CLIENT_LONG_PASSWORD
      Use the improved version of Old Password Authentication.
      CLIENT_MULTI_RESULTS
      Server: Can send multiple resultsets for COM_QUERY.
      Client: Can handle multiple resultsets for COM_QUERY.
      Requires: CLIENT_PROTOCOL_41
      CLIENT_MULTI_STATEMENTS
      Server: Can handle multiple statements per COM_QUERY and COM_STMT_PREPARE.
      Client: May send multiple statements per COM_QUERY and COM_STMT_PREPARE.
      Note: Was named CLIENT_MULTI_QUERIES in 4.1.0, renamed later.
      Requires: CLIENT_PROTOCOL_41
      CLIENT_NO_SCHEMA
      Server: Do not permit database.table.column.
      CLIENT_ODBC
      Special handling of ODBC behavior.
      Note : No special behavior since 3.22.
      CLIENT_PLUGIN_AUTH
      Server: Sends extra data in Initial Handshake Packet and supports the pluggable authentication protocol.
      Client: Supports authentication plugins.
      Requires: CLIENT_PROTOCOL_41
      CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA
      Server: Understands length-encoded integer for auth response data in Protocol::HandshakeResponse41.
      Client: Length of auth response data in Protocol::HandshakeResponse41 is a length-encoded integer.
      Note: The flag was introduced in 5.6.6, but had the wrong value.
      CLIENT_PROTOCOL_41
      Server: Supports the 4.1 protocol.
      Client: Uses the 4.1 protocol.
      Note: this value was CLIENT_CHANGE_USER in 3.22, unused in 4.0
      CLIENT_PS_MULTI_RESULTS
      Server: Can send multiple resultsets for COM_STMT_EXECUTE.
      Client: Can handle multiple resultsets for COM_STMT_EXECUTE.
      Requires: CLIENT_PROTOCOL_41
      CLIENT_RESERVED
      Unused.
      Note: Was named CLIENT_PROTOCOL_41 in 4.1.0.
      CLIENT_SECURE_CONNECTION
      Server: Supports Authentication::Native41.
      Client: Supports Authentication::Native41.
      CLIENT_SESSION_TRACK
      Server: Can set SERVER_SESSION_STATE_CHANGED in the Status Flags and send session-state change data after a OK packet.
      Client: Expects the server to send sesson-state changes after a OK packet.
      CLIENT_SSL
      Server: Supports SSL
      Client: Switch to SSL after sending the capability-flags.
      CLIENT_TRANSACTIONS
      Server: Can send status flags in EOF_Packet.
      Client: Expects status flags in EOF_Packet.
      Note: This flag is optional in 3.23, but always set by the server since 4.0.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getValue()  
      boolean support​(int capabilities)  
      static MysqlCapabilityFlag valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static MysqlCapabilityFlag[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • CLIENT_LONG_PASSWORD

        public static final MysqlCapabilityFlag CLIENT_LONG_PASSWORD
        Use the improved version of Old Password Authentication.
      • CLIENT_FOUND_ROWS

        public static final MysqlCapabilityFlag CLIENT_FOUND_ROWS
        Send found rows instead of affected rows in EOF_Packet.
      • CLIENT_LONG_FLAG

        public static final MysqlCapabilityFlag CLIENT_LONG_FLAG
        Longer flags in Protocol::ColumnDefinition320.
        Server: Supports longer flags., Client: Expects longer flags.
      • CLIENT_CONNECT_WITH_DB

        public static final MysqlCapabilityFlag CLIENT_CONNECT_WITH_DB
        Database (schema) name can be specified on connect in Handshake Response Packet.
        Server: Supports schema-name in Handshake Response Packet.
        Client: Handshake Response Packet contains a schema-name.
      • CLIENT_NO_SCHEMA

        public static final MysqlCapabilityFlag CLIENT_NO_SCHEMA
        Server: Do not permit database.table.column.
      • CLIENT_COMPRESS

        public static final MysqlCapabilityFlag CLIENT_COMPRESS
        Compression protocol supported.
        Server: Supports compression.
        Client: Switches to Compression compressed protocol after successful authentication.
      • CLIENT_ODBC

        public static final MysqlCapabilityFlag CLIENT_ODBC
        Special handling of ODBC behavior.
        Note : No special behavior since 3.22.
      • CLIENT_LOCAL_FILES

        public static final MysqlCapabilityFlag CLIENT_LOCAL_FILES
        Can use LOAD DATA LOCAL.
        Server: Enables the LOCAL INFILE request of LOAD DATA|XML.
        Client: Will handle LOCAL INFILE request.
      • CLIENT_IGNORE_SPACE

        public static final MysqlCapabilityFlag CLIENT_IGNORE_SPACE
        Server: Parser can ignore spaces before '('.
        Client: Let the parser ignore spaces before '('.
      • CLIENT_PROTOCOL_41

        public static final MysqlCapabilityFlag CLIENT_PROTOCOL_41
        Server: Supports the 4.1 protocol.
        Client: Uses the 4.1 protocol.
        Note: this value was CLIENT_CHANGE_USER in 3.22, unused in 4.0
      • CLIENT_INTERACTIVE

        public static final MysqlCapabilityFlag CLIENT_INTERACTIVE
        wait_timeout versus wait_interactive_timeout.
        Server: Supports interactive and noninteractive clients.
        Client: Client is interactive.
        See: mysql_real_connect()
      • CLIENT_SSL

        public static final MysqlCapabilityFlag CLIENT_SSL
        Server: Supports SSL
        Client: Switch to SSL after sending the capability-flags.
      • CLIENT_IGNORE_SIGPIPE

        public static final MysqlCapabilityFlag CLIENT_IGNORE_SIGPIPE
        Client: Do not issue SIGPIPE if network failures occur (libmysqlclient only).
        See: mysql_real_connect()
      • CLIENT_TRANSACTIONS

        public static final MysqlCapabilityFlag CLIENT_TRANSACTIONS
        Server: Can send status flags in EOF_Packet.
        Client: Expects status flags in EOF_Packet.
        Note: This flag is optional in 3.23, but always set by the server since 4.0.
      • CLIENT_SECURE_CONNECTION

        public static final MysqlCapabilityFlag CLIENT_SECURE_CONNECTION
        Server: Supports Authentication::Native41.
        Client: Supports Authentication::Native41.
      • CLIENT_MULTI_STATEMENTS

        public static final MysqlCapabilityFlag CLIENT_MULTI_STATEMENTS
        Server: Can handle multiple statements per COM_QUERY and COM_STMT_PREPARE.
        Client: May send multiple statements per COM_QUERY and COM_STMT_PREPARE.
        Note: Was named CLIENT_MULTI_QUERIES in 4.1.0, renamed later.
        Requires: CLIENT_PROTOCOL_41
      • CLIENT_MULTI_RESULTS

        public static final MysqlCapabilityFlag CLIENT_MULTI_RESULTS
        Server: Can send multiple resultsets for COM_QUERY.
        Client: Can handle multiple resultsets for COM_QUERY.
        Requires: CLIENT_PROTOCOL_41
      • CLIENT_PS_MULTI_RESULTS

        public static final MysqlCapabilityFlag CLIENT_PS_MULTI_RESULTS
        Server: Can send multiple resultsets for COM_STMT_EXECUTE.
        Client: Can handle multiple resultsets for COM_STMT_EXECUTE.
        Requires: CLIENT_PROTOCOL_41
      • CLIENT_PLUGIN_AUTH

        public static final MysqlCapabilityFlag CLIENT_PLUGIN_AUTH
        Server: Sends extra data in Initial Handshake Packet and supports the pluggable authentication protocol.
        Client: Supports authentication plugins.
        Requires: CLIENT_PROTOCOL_41
      • CLIENT_CONNECT_ATTRS

        public static final MysqlCapabilityFlag CLIENT_CONNECT_ATTRS
        Server: Permits connection attributes in Protocol::HandshakeResponse41.
        Client: Sends connection attributes in Protocol::HandshakeResponse41.
      • CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA

        public static final MysqlCapabilityFlag CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA
        Server: Understands length-encoded integer for auth response data in Protocol::HandshakeResponse41.
        Client: Length of auth response data in Protocol::HandshakeResponse41 is a length-encoded integer.
        Note: The flag was introduced in 5.6.6, but had the wrong value.
      • CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS

        public static final MysqlCapabilityFlag CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS
        Server: Announces support for expired password extension.
        Client: Can handle expired passwords.
      • CLIENT_SESSION_TRACK

        public static final MysqlCapabilityFlag CLIENT_SESSION_TRACK
        Server: Can set SERVER_SESSION_STATE_CHANGED in the Status Flags and send session-state change data after a OK packet.
        Client: Expects the server to send sesson-state changes after a OK packet.
      • CLIENT_DEPRECATE_EOF

        public static final MysqlCapabilityFlag CLIENT_DEPRECATE_EOF
        Server: Can send OK after a Text Resultset.
        Client: Expects an OK (instead of EOF) after the resultset rows of a Text Resultset.
        Background: To support CLIENT_SESSION_TRACK, additional information must be sent after all successful commands. Although the OK packet is extensible, the EOF packet is not due to the overlap of its bytes with the content of the Text Resultset Row.
        Therefore, the EOF packet in the Text Resultset is replaced with an OK packet. EOF packets are deprecated as of MySQL 5.7.5.
    • Method Detail

      • values

        public static MysqlCapabilityFlag[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (MysqlCapabilityFlag c : MysqlCapabilityFlag.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static MysqlCapabilityFlag valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • support

        public boolean support​(int capabilities)
      • getValue

        public int getValue()