Skip to content

Structure

MySQLProtocol.CapabilityFlags

The capability flags are used by the client and server to indicate which features they support and want to use.
struct CapabilityFlags

Overview

https://dev.mysql.com/doc/internals/en/capability-flags.html#packet-Protocol::CapabilityFlags

Topics

Initializers

  • init(rawValue:)
    Create a new MySQLCapabilityFlags from the upper and lower values.

Instance Properties

Type Properties

  • CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS
    Server: Announces support for expired password extension. Client: Can handle expired passwords. https://dev.mysql.com/doc/internals/en/cs-sect-expired-password.html
  • CLIENT_COMPRESS
    Compression protocol supported. Server: Supports compression. Client: Switches to 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. 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.
  • 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).
  • 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.
  • 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.
  • 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.
  • CLIENT_NO_SCHEMA
    Server: Do not permit database.table.column.
  • CLIENT_ODBC
    Special handling of ODBC behavior.
  • CLIENT_PLUGIN_AUTH
    Server: Sends extra data in Initial Handshake Packet and supports the pluggable authentication protocol. Client: Supports authentication plugins.
  • 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.
  • CLIENT_PROTOCOL_41
    Server: Supports the 4.1 protocol. Client: Uses the 4.1 protocol.
  • CLIENT_PS_MULTI_RESULTS
    Server: Can send multiple resultsets for COM_STMT_EXECUTE. Client: Can handle multiple resultsets for COM_STMT_EXECUTE.
  • CLIENT_RESERVED
    Unused.
  • 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.
  • MARIADB_CLIENT_COM_MULTI
    Permit COM_MULTI protocol.
  • MARIADB_CLIENT_PROGRESS
    Client support progress indicator (since 10.2).
  • MARIADB_CLIENT_STMT_BULK_OPERATIONS
    Permit bulk insert.
  • all
    All capabilities.
  • clientDefault
    Default capabilities.

Relationships

Conforms To

  • Swift.CustomStringConvertible
  • Swift.Equatable
  • Swift.ExpressibleByArrayLiteral
  • Swift.OptionSet
  • Swift.RawRepresentable
  • Swift.Sendable
  • Swift.SendableMetatype
  • Swift.SetAlgebra