EgretDoc
Back to Home
Location:system/protocol.mysql

Module

Module documentation.

moduleprotocol.mysql

Classes

Classes and inheritance.

classprotocol.mysql::Packet
@brief`Packet` type.
@details`Packet` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class Packet {
    /*
    @brief `seq` field.
classprotocol.mysql::Reader
@brief`Reader` type.
@details`Reader` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class Reader {
    /*
    @brief `data` field.
classprotocol.mysql::Handshake
@brief`Handshake` type.
@details`Handshake` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class Handshake {
    /*
    @brief `protocol_version` field.
classprotocol.mysql::OkPacket
@brief`OkPacket` type.
@details`OkPacket` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class OkPacket {
    /*
    @brief `affected_rows` field.
classprotocol.mysql::ErrPacket
@brief`ErrPacket` type.
@details`ErrPacket` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class ErrPacket {
    /*
    @brief `code` field.
classprotocol.mysql::EofPacket
@brief`EofPacket` type.
@details`EofPacket` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class EofPacket {
    /*
    @brief `warnings` field.
classprotocol.mysql::ColumnDefinition
@brief`ColumnDefinition` type.
@details`ColumnDefinition` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class ColumnDefinition {
    /*
    @brief `catalog` field.
classprotocol.mysql::DecimalValue
@brief`DecimalValue` type.
@details`DecimalValue` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class DecimalValue {
    /*
    @brief `text` field.
classprotocol.mysql::ResultCell
@brief`ResultCell` type.
@details`ResultCell` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class ResultCell {
    /*
    @brief `text` field.
classprotocol.mysql::Row
@brief`Row` type.
@details`Row` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class Row {
    /*
    @brief `values` field.
classprotocol.mysql::ResultSet
@brief`ResultSet` type.
@details`ResultSet` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class ResultSet {
    /*
    @brief `columns` field.
classprotocol.mysql::StmtPrepareOk
@brief`StmtPrepareOk` type.
@details`StmtPrepareOk` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class StmtPrepareOk {
    /*
    @brief `statement_id` field.
classprotocol.mysql::AuthSwitchRequest
@brief`AuthSwitchRequest` type.
@details`AuthSwitchRequest` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class AuthSwitchRequest {
    /*
    @brief `plugin_name` field.
classprotocol.mysql::AuthMoreData
@brief`AuthMoreData` type.
@details`AuthMoreData` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class AuthMoreData {
    /*
    @brief `code` field.
classprotocol.mysql::StmtParam
@brief`StmtParam` type.
@details`StmtParam` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class StmtParam {
    /*
    @brief `type_code` field.
classprotocol.mysql::HandshakeResponse
@brief`HandshakeResponse` type.
@details`HandshakeResponse` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class HandshakeResponse {
    /*
    @brief `user` field.
classprotocol.mysql::Config
@brief`Config` type.
@details`Config` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class Config {
    /*
    @brief `host` field.

Functions

Free functions and class methods.

functionprotocol.mysql::__mysql_f32_text
Signatureextern func __mysql_f32_text(raw: String) -> String;
extern func __mysql_f32_text(raw: String) -> String;
/*
@brief Binds the low-level runtime symbol `__mysql_f64_text`.
@briefBinds the low-level runtime symbol `__mysql_f32_text`.
@detailsThis function is an external entry point used by system modules to access native runtime capabilities such as filesystem, networking, threading, GC, cryptography, or platform operations. Prefer the safe wrapper functions in the same file when available. When calling this entry directly, pass validated arguments that match the signature and handle failures according to the return-value convention.
@param
  • rawRaw encoded input string before validation, parsing, or normalization.
@returnReturns the operation result as `String`.
functionprotocol.mysql::__mysql_f64_text
Signatureextern func __mysql_f64_text(raw: String) -> String;
extern func __mysql_f64_text(raw: String) -> String;

/*
@briefBinds the low-level runtime symbol `__mysql_f64_text`.
@detailsThis function is an external entry point used by system modules to access native runtime capabilities such as filesystem, networking, threading, GC, cryptography, or platform operations. Prefer the safe wrapper functions in the same file when available. When calling this entry directly, pass validated arguments that match the signature and handle failures according to the return-value convention.
@param
  • rawRaw encoded input string before validation, parsing, or normalization.
@returnReturns the operation result as `String`.
functionprotocol.mysql::max_payload_len
Signaturefunc max_payload_len() -> Int
func max_payload_len() -> Int {
    return 16777215;
}
@briefProvides the system library operation `max_payload_len`.
@detailsExecutes the `max_payload_len` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::default_port
Signaturefunc default_port() -> Int
func default_port() -> Int {
    return 3306;
}
@briefProvides the system library operation `default_port`.
@detailsExecutes the `default_port` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::charset_utf8mb4
Signaturefunc charset_utf8mb4() -> Int
func charset_utf8mb4() -> Int {
    return 45;
}
@briefProvides the system library operation `charset_utf8mb4`.
@detailsExecutes the `charset_utf8mb4` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::charset_utf8mb3
Signaturefunc charset_utf8mb3() -> Int
func charset_utf8mb3() -> Int {
    return 33;
}
@briefProvides the system library operation `charset_utf8mb3`.
@detailsExecutes the `charset_utf8mb3` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::charset_latin1
Signaturefunc charset_latin1() -> Int
func charset_latin1() -> Int {
    return 8;
}
@briefProvides the system library operation `charset_latin1`.
@detailsExecutes the `charset_latin1` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::charset_binary
Signaturefunc charset_binary() -> Int
func charset_binary() -> Int {
    return 63;
}
@briefProvides the system library operation `charset_binary`.
@detailsExecutes the `charset_binary` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::charset_id
Signaturefunc charset_id(name: String) -> Int
func charset_id(name: String) -> Int {
    let lc: String = strings.to_lower_ascii(name);
    if lc == "utf8mb4" {
@briefProvides the system library operation `charset_id`.
@detailsExecutes the `charset_id` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • nameName.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::plugin_mysql_native_password
Signaturefunc plugin_mysql_native_password() -> String
func plugin_mysql_native_password() -> String {
    return "mysql_native_password";
}
@briefProvides the system library operation `plugin_mysql_native_password`.
@detailsExecutes the `plugin_mysql_native_password` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `String`.
functionprotocol.mysql::plugin_caching_sha2_password
Signaturefunc plugin_caching_sha2_password() -> String
func plugin_caching_sha2_password() -> String {
    return "caching_sha2_password";
}
@briefProvides the system library operation `plugin_caching_sha2_password`.
@detailsExecutes the `plugin_caching_sha2_password` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `String`.
functionprotocol.mysql::plugin_sha256_password
Signaturefunc plugin_sha256_password() -> String
func plugin_sha256_password() -> String {
    return "sha256_password";
}
@briefProvides the system library operation `plugin_sha256_password`.
@detailsExecutes the `plugin_sha256_password` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `String`.
functionprotocol.mysql::plugin_mysql_clear_password
Signaturefunc plugin_mysql_clear_password() -> String
func plugin_mysql_clear_password() -> String {
    return "mysql_clear_password";
}
@briefProvides the system library operation `plugin_mysql_clear_password`.
@detailsExecutes the `plugin_mysql_clear_password` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `String`.
functionprotocol.mysql::client_long_password
Signaturefunc client_long_password() -> Int
func client_long_password() -> Int {
    return 1;
}
@briefProvides the system library operation `client_long_password`.
@detailsExecutes the `client_long_password` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_found_rows
Signaturefunc client_found_rows() -> Int
func client_found_rows() -> Int {
    return 2;
}
@briefProvides the system library operation `client_found_rows`.
@detailsExecutes the `client_found_rows` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_long_flag
Signaturefunc client_long_flag() -> Int
func client_long_flag() -> Int {
    return 4;
}
@briefProvides the system library operation `client_long_flag`.
@detailsExecutes the `client_long_flag` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_connect_with_db
Signaturefunc client_connect_with_db() -> Int
func client_connect_with_db() -> Int {
    return 8;
}
@briefProvides the system library operation `client_connect_with_db`.
@detailsExecutes the `client_connect_with_db` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_no_schema
Signaturefunc client_no_schema() -> Int
func client_no_schema() -> Int {
    return 16;
}
@briefProvides the system library operation `client_no_schema`.
@detailsExecutes the `client_no_schema` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_compress
Signaturefunc client_compress() -> Int
func client_compress() -> Int {
    return 32;
}
@briefProvides the system library operation `client_compress`.
@detailsExecutes the `client_compress` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_odbc
Signaturefunc client_odbc() -> Int
func client_odbc() -> Int {
    return 64;
}
@briefProvides the system library operation `client_odbc`.
@detailsExecutes the `client_odbc` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_local_files
Signaturefunc client_local_files() -> Int
func client_local_files() -> Int {
    return 128;
}
@briefProvides the system library operation `client_local_files`.
@detailsExecutes the `client_local_files` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_ignore_space
Signaturefunc client_ignore_space() -> Int
func client_ignore_space() -> Int {
    return 256;
}
@briefProvides the system library operation `client_ignore_space`.
@detailsExecutes the `client_ignore_space` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_protocol_41
Signaturefunc client_protocol_41() -> Int
func client_protocol_41() -> Int {
    return 512;
}
@briefProvides the system library operation `client_protocol_41`.
@detailsExecutes the `client_protocol_41` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_interactive
Signaturefunc client_interactive() -> Int
func client_interactive() -> Int {
    return 1024;
}
@briefProvides the system library operation `client_interactive`.
@detailsExecutes the `client_interactive` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_ssl
Signaturefunc client_ssl() -> Int
func client_ssl() -> Int {
    return 2048;
}
@briefProvides the system library operation `client_ssl`.
@detailsExecutes the `client_ssl` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_ignore_sigpipe
Signaturefunc client_ignore_sigpipe() -> Int
func client_ignore_sigpipe() -> Int {
    return 4096;
}
@briefProvides the system library operation `client_ignore_sigpipe`.
@detailsExecutes the `client_ignore_sigpipe` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_transactions
Signaturefunc client_transactions() -> Int
func client_transactions() -> Int {
    return 8192;
}
@briefProvides the system library operation `client_transactions`.
@detailsExecutes the `client_transactions` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_reserved
Signaturefunc client_reserved() -> Int
func client_reserved() -> Int {
    return 16384;
}
@briefProvides the system library operation `client_reserved`.
@detailsExecutes the `client_reserved` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_secure_connection
Signaturefunc client_secure_connection() -> Int
func client_secure_connection() -> Int {
    return 32768;
}
@briefProvides the system library operation `client_secure_connection`.
@detailsExecutes the `client_secure_connection` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_multi_statements
Signaturefunc client_multi_statements() -> Int
func client_multi_statements() -> Int {
    return 65536;
}
@briefProvides the system library operation `client_multi_statements`.
@detailsExecutes the `client_multi_statements` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_multi_results
Signaturefunc client_multi_results() -> Int
func client_multi_results() -> Int {
    return 131072;
}
@briefProvides the system library operation `client_multi_results`.
@detailsExecutes the `client_multi_results` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_ps_multi_results
Signaturefunc client_ps_multi_results() -> Int
func client_ps_multi_results() -> Int {
    return 262144;
}
@briefProvides the system library operation `client_ps_multi_results`.
@detailsExecutes the `client_ps_multi_results` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_plugin_auth
Signaturefunc client_plugin_auth() -> Int
func client_plugin_auth() -> Int {
    return 524288;
}
@briefProvides the system library operation `client_plugin_auth`.
@detailsExecutes the `client_plugin_auth` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_connect_attrs
Signaturefunc client_connect_attrs() -> Int
func client_connect_attrs() -> Int {
    return 1048576;
}
@briefProvides the system library operation `client_connect_attrs`.
@detailsExecutes the `client_connect_attrs` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_plugin_auth_lenenc_client_data
Signaturefunc client_plugin_auth_lenenc_client_data() -> Int
func client_plugin_auth_lenenc_client_data() -> Int {
    return 2097152;
}
@briefProvides the system library operation `client_plugin_auth_lenenc_client_data`.
@detailsExecutes the `client_plugin_auth_lenenc_client_data` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_can_handle_expired_passwords
Signaturefunc client_can_handle_expired_passwords() -> Int
func client_can_handle_expired_passwords() -> Int {
    return 4194304;
}
@briefProvides the system library operation `client_can_handle_expired_passwords`.
@detailsExecutes the `client_can_handle_expired_passwords` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_session_track
Signaturefunc client_session_track() -> Int
func client_session_track() -> Int {
    return 8388608;
}
@briefProvides the system library operation `client_session_track`.
@detailsExecutes the `client_session_track` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_deprecate_eof
Signaturefunc client_deprecate_eof() -> Int
func client_deprecate_eof() -> Int {
    return 16777216;
}
@briefProvides the system library operation `client_deprecate_eof`.
@detailsExecutes the `client_deprecate_eof` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_ssl_verify_server_cert
Signaturefunc client_ssl_verify_server_cert() -> Int
func client_ssl_verify_server_cert() -> Int {
    return 1073741824;
}
@briefProvides the system library operation `client_ssl_verify_server_cert`.
@detailsExecutes the `client_ssl_verify_server_cert` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::client_remember_options
Signaturefunc client_remember_options() -> Int
func client_remember_options() -> Int {
    return 2147483648;
}
@briefProvides the system library operation `client_remember_options`.
@detailsExecutes the `client_remember_options` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::default_capabilities
Signaturefunc default_capabilities() -> Int
func default_capabilities() -> Int {
    return client_long_password()
    | client_long_flag()
@briefProvides the system library operation `default_capabilities`.
@detailsExecutes the `default_capabilities` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_quit
Signaturefunc com_quit() -> Int
func com_quit() -> Int {
    return 1;
}
@briefProvides the system library operation `com_quit`.
@detailsExecutes the `com_quit` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_init_db
Signaturefunc com_init_db() -> Int
func com_init_db() -> Int {
    return 2;
}
@briefProvides the system library operation `com_init_db`.
@detailsExecutes the `com_init_db` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_query
Signaturefunc com_query() -> Int
func com_query() -> Int {
    return 3;
}
@briefProvides the system library operation `com_query`.
@detailsExecutes the `com_query` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_field_list
Signaturefunc com_field_list() -> Int
func com_field_list() -> Int {
    return 4;
}
@briefProvides the system library operation `com_field_list`.
@detailsExecutes the `com_field_list` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_ping
Signaturefunc com_ping() -> Int
func com_ping() -> Int {
    return 14;
}
@briefProvides the system library operation `com_ping`.
@detailsExecutes the `com_ping` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_change_user
Signaturefunc com_change_user() -> Int
func com_change_user() -> Int {
    return 17;
}
@briefProvides the system library operation `com_change_user`.
@detailsExecutes the `com_change_user` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_stmt_prepare
Signaturefunc com_stmt_prepare() -> Int
func com_stmt_prepare() -> Int {
    return 22;
}
@briefProvides the system library operation `com_stmt_prepare`.
@detailsExecutes the `com_stmt_prepare` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_stmt_execute
Signaturefunc com_stmt_execute() -> Int
func com_stmt_execute() -> Int {
    return 23;
}
@briefProvides the system library operation `com_stmt_execute`.
@detailsExecutes the `com_stmt_execute` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_stmt_send_long_data
Signaturefunc com_stmt_send_long_data() -> Int
func com_stmt_send_long_data() -> Int {
    return 24;
}
@briefProvides the system library operation `com_stmt_send_long_data`.
@detailsExecutes the `com_stmt_send_long_data` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_stmt_close
Signaturefunc com_stmt_close() -> Int
func com_stmt_close() -> Int {
    return 25;
}
@briefProvides the system library operation `com_stmt_close`.
@detailsExecutes the `com_stmt_close` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_stmt_reset
Signaturefunc com_stmt_reset() -> Int
func com_stmt_reset() -> Int {
    return 26;
}
@briefProvides the system library operation `com_stmt_reset`.
@detailsExecutes the `com_stmt_reset` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_set_option
Signaturefunc com_set_option() -> Int
func com_set_option() -> Int {
    return 27;
}
@briefProvides the system library operation `com_set_option`.
@detailsExecutes the `com_set_option` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_stmt_fetch
Signaturefunc com_stmt_fetch() -> Int
func com_stmt_fetch() -> Int {
    return 28;
}
@briefProvides the system library operation `com_stmt_fetch`.
@detailsExecutes the `com_stmt_fetch` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::com_reset_connection
Signaturefunc com_reset_connection() -> Int
func com_reset_connection() -> Int {
    return 31;
}
@briefProvides the system library operation `com_reset_connection`.
@detailsExecutes the `com_reset_connection` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::auth_more_data_header
Signaturefunc auth_more_data_header() -> Int
func auth_more_data_header() -> Int {
    return 1;
}
@briefProvides the system library operation `auth_more_data_header`.
@detailsExecutes the `auth_more_data_header` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::auth_switch_request_header
Signaturefunc auth_switch_request_header() -> Int
func auth_switch_request_header() -> Int {
    return 254;
}
@briefProvides the system library operation `auth_switch_request_header`.
@detailsExecutes the `auth_switch_request_header` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::caching_sha2_fast_auth_success
Signaturefunc caching_sha2_fast_auth_success() -> Int
func caching_sha2_fast_auth_success() -> Int {
    return 3;
}
@briefProvides the system library operation `caching_sha2_fast_auth_success`.
@detailsExecutes the `caching_sha2_fast_auth_success` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::caching_sha2_perform_full_auth
Signaturefunc caching_sha2_perform_full_auth() -> Int
func caching_sha2_perform_full_auth() -> Int {
    return 4;
}
@briefProvides the system library operation `caching_sha2_perform_full_auth`.
@detailsExecutes the `caching_sha2_perform_full_auth` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::caching_sha2_request_public_key
Signaturefunc caching_sha2_request_public_key() -> String
func caching_sha2_request_public_key() -> String {
    return byte(2);
}
@briefProvides the system library operation `caching_sha2_request_public_key`.
@detailsExecutes the `caching_sha2_request_public_key` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `String`.
functionprotocol.mysql::cursor_type_no_cursor
Signaturefunc cursor_type_no_cursor() -> Int
func cursor_type_no_cursor() -> Int {
    return 0;
}
@briefProvides the system library operation `cursor_type_no_cursor`.
@detailsExecutes the `cursor_type_no_cursor` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::cursor_type_read_only
Signaturefunc cursor_type_read_only() -> Int
func cursor_type_read_only() -> Int {
    return 1;
}
@briefProvides the system library operation `cursor_type_read_only`.
@detailsExecutes the `cursor_type_read_only` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_in_trans
Signaturefunc status_in_trans() -> Int
func status_in_trans() -> Int {
    return 1;
}
@briefProvides the system library operation `status_in_trans`.
@detailsExecutes the `status_in_trans` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_autocommit
Signaturefunc status_autocommit() -> Int
func status_autocommit() -> Int {
    return 2;
}
@briefProvides the system library operation `status_autocommit`.
@detailsExecutes the `status_autocommit` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_more_results_exists
Signaturefunc status_more_results_exists() -> Int
func status_more_results_exists() -> Int {
    return 8;
}
@briefProvides the system library operation `status_more_results_exists`.
@detailsExecutes the `status_more_results_exists` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_no_good_index_used
Signaturefunc status_no_good_index_used() -> Int
func status_no_good_index_used() -> Int {
    return 16;
}
@briefProvides the system library operation `status_no_good_index_used`.
@detailsExecutes the `status_no_good_index_used` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_no_index_used
Signaturefunc status_no_index_used() -> Int
func status_no_index_used() -> Int {
    return 32;
}
@briefProvides the system library operation `status_no_index_used`.
@detailsExecutes the `status_no_index_used` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_cursor_exists
Signaturefunc status_cursor_exists() -> Int
func status_cursor_exists() -> Int {
    return 64;
}
@briefProvides the system library operation `status_cursor_exists`.
@detailsExecutes the `status_cursor_exists` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_last_row_sent
Signaturefunc status_last_row_sent() -> Int
func status_last_row_sent() -> Int {
    return 128;
}
@briefProvides the system library operation `status_last_row_sent`.
@detailsExecutes the `status_last_row_sent` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_db_dropped
Signaturefunc status_db_dropped() -> Int
func status_db_dropped() -> Int {
    return 256;
}
@briefProvides the system library operation `status_db_dropped`.
@detailsExecutes the `status_db_dropped` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_no_backslash_escapes
Signaturefunc status_no_backslash_escapes() -> Int
func status_no_backslash_escapes() -> Int {
    return 512;
}
@briefProvides the system library operation `status_no_backslash_escapes`.
@detailsExecutes the `status_no_backslash_escapes` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_metadata_changed
Signaturefunc status_metadata_changed() -> Int
func status_metadata_changed() -> Int {
    return 1024;
}
@briefProvides the system library operation `status_metadata_changed`.
@detailsExecutes the `status_metadata_changed` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_query_was_slow
Signaturefunc status_query_was_slow() -> Int
func status_query_was_slow() -> Int {
    return 2048;
}
@briefProvides the system library operation `status_query_was_slow`.
@detailsExecutes the `status_query_was_slow` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_ps_out_params
Signaturefunc status_ps_out_params() -> Int
func status_ps_out_params() -> Int {
    return 4096;
}
@briefProvides the system library operation `status_ps_out_params`.
@detailsExecutes the `status_ps_out_params` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_in_trans_readonly
Signaturefunc status_in_trans_readonly() -> Int
func status_in_trans_readonly() -> Int {
    return 8192;
}
@briefProvides the system library operation `status_in_trans_readonly`.
@detailsExecutes the `status_in_trans_readonly` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::status_session_state_changed
Signaturefunc status_session_state_changed() -> Int
func status_session_state_changed() -> Int {
    return 16384;
}
@briefProvides the system library operation `status_session_state_changed`.
@detailsExecutes the `status_session_state_changed` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_decimal
Signaturefunc type_decimal() -> Int
func type_decimal() -> Int {
    return 0;
}
@briefProvides the system library operation `type_decimal`.
@detailsExecutes the `type_decimal` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_tiny
Signaturefunc type_tiny() -> Int
func type_tiny() -> Int {
    return 1;
}
@briefProvides the system library operation `type_tiny`.
@detailsExecutes the `type_tiny` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_short
Signaturefunc type_short() -> Int
func type_short() -> Int {
    return 2;
}
@briefProvides the system library operation `type_short`.
@detailsExecutes the `type_short` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_long
Signaturefunc type_long() -> Int
func type_long() -> Int {
    return 3;
}
@briefProvides the system library operation `type_long`.
@detailsExecutes the `type_long` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_float
Signaturefunc type_float() -> Int
func type_float() -> Int {
    return 4;
}
@briefProvides the system library operation `type_float`.
@detailsExecutes the `type_float` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_double
Signaturefunc type_double() -> Int
func type_double() -> Int {
    return 5;
}
@briefProvides the system library operation `type_double`.
@detailsExecutes the `type_double` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_null
Signaturefunc type_null() -> Int
func type_null() -> Int {
    return 6;
}
@briefProvides the system library operation `type_null`.
@detailsExecutes the `type_null` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_timestamp
Signaturefunc type_timestamp() -> Int
func type_timestamp() -> Int {
    return 7;
}
@briefProvides the system library operation `type_timestamp`.
@detailsExecutes the `type_timestamp` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_longlong
Signaturefunc type_longlong() -> Int
func type_longlong() -> Int {
    return 8;
}
@briefProvides the system library operation `type_longlong`.
@detailsExecutes the `type_longlong` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_int24
Signaturefunc type_int24() -> Int
func type_int24() -> Int {
    return 9;
}
@briefProvides the system library operation `type_int24`.
@detailsExecutes the `type_int24` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_date
Signaturefunc type_date() -> Int
func type_date() -> Int {
    return 10;
}
@briefProvides the system library operation `type_date`.
@detailsExecutes the `type_date` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_time
Signaturefunc type_time() -> Int
func type_time() -> Int {
    return 11;
}
@briefProvides the system library operation `type_time`.
@detailsExecutes the `type_time` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_datetime
Signaturefunc type_datetime() -> Int
func type_datetime() -> Int {
    return 12;
}
@briefProvides the system library operation `type_datetime`.
@detailsExecutes the `type_datetime` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_year
Signaturefunc type_year() -> Int
func type_year() -> Int {
    return 13;
}
@briefProvides the system library operation `type_year`.
@detailsExecutes the `type_year` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_varchar
Signaturefunc type_varchar() -> Int
func type_varchar() -> Int {
    return 15;
}
@briefProvides the system library operation `type_varchar`.
@detailsExecutes the `type_varchar` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_bit
Signaturefunc type_bit() -> Int
func type_bit() -> Int {
    return 16;
}
@briefProvides the system library operation `type_bit`.
@detailsExecutes the `type_bit` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_json
Signaturefunc type_json() -> Int
func type_json() -> Int {
    return 245;
}
@briefProvides the system library operation `type_json`.
@detailsExecutes the `type_json` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_newdecimal
Signaturefunc type_newdecimal() -> Int
func type_newdecimal() -> Int {
    return 246;
}
@briefProvides the system library operation `type_newdecimal`.
@detailsExecutes the `type_newdecimal` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_enum
Signaturefunc type_enum() -> Int
func type_enum() -> Int {
    return 247;
}
@briefProvides the system library operation `type_enum`.
@detailsExecutes the `type_enum` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_set
Signaturefunc type_set() -> Int
func type_set() -> Int {
    return 248;
}
@briefProvides the system library operation `type_set`.
@detailsExecutes the `type_set` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_tiny_blob
Signaturefunc type_tiny_blob() -> Int
func type_tiny_blob() -> Int {
    return 249;
}
@briefProvides the system library operation `type_tiny_blob`.
@detailsExecutes the `type_tiny_blob` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_medium_blob
Signaturefunc type_medium_blob() -> Int
func type_medium_blob() -> Int {
    return 250;
}
@briefProvides the system library operation `type_medium_blob`.
@detailsExecutes the `type_medium_blob` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_long_blob
Signaturefunc type_long_blob() -> Int
func type_long_blob() -> Int {
    return 251;
}
@briefProvides the system library operation `type_long_blob`.
@detailsExecutes the `type_long_blob` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_blob
Signaturefunc type_blob() -> Int
func type_blob() -> Int {
    return 252;
}
@briefProvides the system library operation `type_blob`.
@detailsExecutes the `type_blob` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_var_string
Signaturefunc type_var_string() -> Int
func type_var_string() -> Int {
    return 253;
}
@briefProvides the system library operation `type_var_string`.
@detailsExecutes the `type_var_string` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_string
Signaturefunc type_string() -> Int
func type_string() -> Int {
    return 254;
}
@briefProvides the system library operation `type_string`.
@detailsExecutes the `type_string` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::type_geometry
Signaturefunc type_geometry() -> Int
func type_geometry() -> Int {
    return 255;
}
@briefProvides the system library operation `type_geometry`.
@detailsExecutes the `type_geometry` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::byte
Signaturefunc byte(n: Int) -> String
func byte(n: Int) -> String {
    return encoding.byte_from_code(n & 255);
}
@briefProvides the system library operation `byte`.
@detailsExecutes the `byte` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • nCount, size, or limit value.
@returnReturns the operation result as `String`.
functionprotocol.mysql::byte_at
Signaturefunc byte_at(s: String, idx: Int) -> Int
func byte_at(s: String, idx: Int) -> Int {
    return std.byte_at(s, idx) & 255;
}
@briefProvides the system library operation `byte_at`.
@detailsExecutes the `byte_at` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sInput string.
  • idxZero-based index.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::u16_le
Signaturefunc u16_le(n: Int) -> String
func u16_le(n: Int) -> String {
    return byte(n) + byte(n >> 8);
}
@briefProvides the system library operation `u16_le`.
@detailsExecutes the `u16_le` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • nCount, size, or limit value.
@returnReturns the operation result as `String`.
functionprotocol.mysql::u24_le
Signaturefunc u24_le(n: Int) -> String
func u24_le(n: Int) -> String {
    return byte(n) + byte(n >> 8) + byte(n >> 16);
}
@briefProvides the system library operation `u24_le`.
@detailsExecutes the `u24_le` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • nCount, size, or limit value.
@returnReturns the operation result as `String`.
functionprotocol.mysql::u32_le
Signaturefunc u32_le(n: Int) -> String
func u32_le(n: Int) -> String {
    return byte(n) + byte(n >> 8) + byte(n >> 16) + byte(n >> 24);
}
@briefProvides the system library operation `u32_le`.
@detailsExecutes the `u32_le` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • nCount, size, or limit value.
@returnReturns the operation result as `String`.
functionprotocol.mysql::u32_be
Signaturefunc u32_be(n: Int) -> String
func u32_be(n: Int) -> String {
    return byte(n >> 24) + byte(n >> 16) + byte(n >> 8) + byte(n);
}
@briefProvides the system library operation `u32_be`.
@detailsExecutes the `u32_be` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • nCount, size, or limit value.
@returnReturns the operation result as `String`.
functionprotocol.mysql::u64_le
Signaturefunc u64_le(n: Int) -> String
func u64_le(n: Int) -> String {
    return byte(n)
    + byte(n >> 8)
@briefProvides the system library operation `u64_le`.
@detailsExecutes the `u64_le` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • nCount, size, or limit value.
@returnReturns the operation result as `String`.
functionprotocol.mysql::read_u16_le
Signaturefunc read_u16_le(s: String, off: Int) -> Int
func read_u16_le(s: String, off: Int) -> Int {
    return byte_at(s, off) | (byte_at(s, off + 1) << 8);
}
@briefReads data with `read_u16_le`.
@detailsExecutes the `read_u16_le` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sInput string.
  • offZero-based byte offset or element offset at which the operation starts.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::read_u24_le
Signaturefunc read_u24_le(s: String, off: Int) -> Int
func read_u24_le(s: String, off: Int) -> Int {
    return byte_at(s, off) | (byte_at(s, off + 1) << 8) | (byte_at(s, off + 2) << 16);
}
@briefReads data with `read_u24_le`.
@detailsExecutes the `read_u24_le` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sInput string.
  • offZero-based byte offset or element offset at which the operation starts.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::read_u32_le
Signaturefunc read_u32_le(s: String, off: Int) -> Int
func read_u32_le(s: String, off: Int) -> Int {
    return byte_at(s, off) | (byte_at(s, off + 1) << 8) | (byte_at(s, off + 2) << 16) | (byte_at(s, off + 3) << 24);
}
@briefReads data with `read_u32_le`.
@detailsExecutes the `read_u32_le` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sInput string.
  • offZero-based byte offset or element offset at which the operation starts.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::read_u64_le
Signaturefunc read_u64_le(s: String, off: Int) -> Int
func read_u64_le(s: String, off: Int) -> Int {
    return byte_at(s, off)
    | (byte_at(s, off + 1) << 8)
@briefReads data with `read_u64_le`.
@detailsExecutes the `read_u64_le` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sInput string.
  • offZero-based byte offset or element offset at which the operation starts.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::nul
Signaturefunc nul() -> String
func nul() -> String {
    return byte(0);
}
@briefProvides the system library operation `nul`.
@detailsExecutes the `nul` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `String`.
functionprotocol.mysql::find_nul
Signaturefunc find_nul(s: String, start: Int) -> Int
func find_nul(s: String, start: Int) -> Int {
    let i: Int = start;
    let n: Int = std.len(s);
@briefFinds a matching position or element with `find_nul`.
@detailsExecutes the `find_nul` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sInput string.
  • startZero-based starting index, byte offset, or range boundary for the operation.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::Packet.init
Signaturefunc init(self: protocol.mysql.Packet, seq: Int = 0, payload: String = "") -> Void
    func init(self: protocol.mysql.Packet, seq: Int = 0, payload: String = "") -> Void {
        self.seq = seq;
        self.payload = payload;
@briefInitializes a `Packet` instance.
@detailsEstablishes the initial field state for `Packet` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • seqSequence number used to order or correlate protocol messages.
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnVoid
functionprotocol.mysql::Packet.deinit
Signaturefunc deinit(self: protocol.mysql.Packet) -> Void
    func deinit(self: protocol.mysql.Packet) -> Void {
    }
}
@briefReleases fallback resources at the end of the `Packet` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::Reader.init
Signaturefunc init(self: protocol.mysql.Reader, data: String) -> Void
    func init(self: protocol.mysql.Reader, data: String) -> Void {
        self.data = data;
        self.pos = 0;
@briefInitializes a `Reader` instance.
@detailsEstablishes the initial field state for `Reader` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • dataInput or output data buffer.
@returnVoid
functionprotocol.mysql::Reader.remaining
Signaturefunc remaining(self: protocol.mysql.Reader) -> Int
    func remaining(self: protocol.mysql.Reader) -> Int {
        return std.len(self.data) - self.pos;
    }
@briefProvides the system library operation `Reader.remaining`.
@detailsExecutes the `remaining` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::Reader.eof
Signaturefunc eof(self: protocol.mysql.Reader) -> Bool
    func eof(self: protocol.mysql.Reader) -> Bool {
        return self.pos >= std.len(self.data);
    }
@briefProvides the system library operation `Reader.eof`.
@detailsExecutes the `eof` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::Reader.take
Signaturefunc take(self: protocol.mysql.Reader, n: Int) -> String, ErrCode
    func take(self: protocol.mysql.Reader, n: Int) -> String, ErrCode {
        if n < 0 {
            return "", std.ERR_INVALID;
@briefProvides the system library operation `Reader.take`.
@detailsExecutes the `take` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • nCount, size, or limit value.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::Reader.u8
Signaturefunc u8(self: protocol.mysql.Reader) -> Int, ErrCode
    func u8(self: protocol.mysql.Reader) -> Int, ErrCode {
        if self.remaining() < 1 {
            return 0, std.ERR_EOF;
@briefProvides the system library operation `Reader.u8`.
@detailsExecutes the `u8` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::Reader.u16
Signaturefunc u16(self: protocol.mysql.Reader) -> Int, ErrCode
    func u16(self: protocol.mysql.Reader) -> Int, ErrCode {
        let raw: String = self.take(2)?;
        return read_u16_le(raw, 0), std.OK;
@briefProvides the system library operation `Reader.u16`.
@detailsExecutes the `u16` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::Reader.u24
Signaturefunc u24(self: protocol.mysql.Reader) -> Int, ErrCode
    func u24(self: protocol.mysql.Reader) -> Int, ErrCode {
        let raw: String = self.take(3)?;
        return read_u24_le(raw, 0), std.OK;
@briefProvides the system library operation `Reader.u24`.
@detailsExecutes the `u24` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::Reader.u32
Signaturefunc u32(self: protocol.mysql.Reader) -> Int, ErrCode
    func u32(self: protocol.mysql.Reader) -> Int, ErrCode {
        let raw: String = self.take(4)?;
        return read_u32_le(raw, 0), std.OK;
@briefProvides the system library operation `Reader.u32`.
@detailsExecutes the `u32` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::Reader.u64
Signaturefunc u64(self: protocol.mysql.Reader) -> Int, ErrCode
    func u64(self: protocol.mysql.Reader) -> Int, ErrCode {
        let raw: String = self.take(8)?;
        return read_u64_le(raw, 0), std.OK;
@briefProvides the system library operation `Reader.u64`.
@detailsExecutes the `u64` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::Reader.nul_string
Signaturefunc nul_string(self: protocol.mysql.Reader) -> String, ErrCode
    func nul_string(self: protocol.mysql.Reader) -> String, ErrCode {
        let p: Int = find_nul(self.data, self.pos);
        if p < 0 {
@briefProvides the system library operation `Reader.nul_string`.
@detailsExecutes the `nul_string` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::Reader.eof_string
Signaturefunc eof_string(self: protocol.mysql.Reader) -> String, ErrCode
    func eof_string(self: protocol.mysql.Reader) -> String, ErrCode {
        let out: String = std.substr(self.data, self.pos, self.remaining());
        self.pos = std.len(self.data);
@briefProvides the system library operation `Reader.eof_string`.
@detailsExecutes the `eof_string` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::Reader.lenenc_int
Signaturefunc lenenc_int(self: protocol.mysql.Reader) -> Int, ErrCode
    func lenenc_int(self: protocol.mysql.Reader) -> Int, ErrCode {
        let first: Int = self.u8()?;
        if first < 251 {
@briefProvides the system library operation `Reader.lenenc_int`.
@detailsExecutes the `lenenc_int` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::Reader.lenenc_string
Signaturefunc lenenc_string(self: protocol.mysql.Reader) -> String, ErrCode
    func lenenc_string(self: protocol.mysql.Reader) -> String, ErrCode {
        let n: Int = self.lenenc_int()?;
        if n < 0 {
@briefProvides the system library operation `Reader.lenenc_string`.
@detailsExecutes the `lenenc_string` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::Reader.deinit
Signaturefunc deinit(self: protocol.mysql.Reader) -> Void
    func deinit(self: protocol.mysql.Reader) -> Void {
    }
}
@briefReleases fallback resources at the end of the `Reader` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::lenenc_int
Signaturefunc lenenc_int(n: Int) -> String, ErrCode
func lenenc_int(n: Int) -> String, ErrCode {
    if n < 0 {
        return "", std.ERR_INVALID;
@briefProvides the system library operation `lenenc_int`.
@detailsExecutes the `lenenc_int` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • nCount, size, or limit value.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::lenenc_string
Signaturefunc lenenc_string(s: String) -> String, ErrCode
func lenenc_string(s: String) -> String, ErrCode {
    let p: String = lenenc_int(std.len(s))?;
    return p + s, std.OK;
@briefProvides the system library operation `lenenc_string`.
@detailsExecutes the `lenenc_string` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sInput string.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::encode_packet_header
Signaturefunc encode_packet_header(seq: Int, payload_len: Int) -> String, ErrCode
func encode_packet_header(seq: Int, payload_len: Int) -> String, ErrCode {
    if seq < 0 || seq > 255 || payload_len < 0 || payload_len > max_payload_len() {
        return "", std.ERR_INVALID;
@briefEncodes input data with `encode_packet_header`.
@detailsExecutes the `encode_packet_header` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • seqSequence number used to order or correlate protocol messages.
  • payload_lenSize or length value that limits how much data the operation processes.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::encode_packet
Signaturefunc encode_packet(seq: Int, payload: String) -> String, ErrCode
func encode_packet(seq: Int, payload: String) -> String, ErrCode {
    let n: Int = std.len(payload);
    if n > max_payload_len() {
@briefEncodes input data with `encode_packet`.
@detailsExecutes the `encode_packet` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • seqSequence number used to order or correlate protocol messages.
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::encode_fragmented_packets
Signaturefunc encode_fragmented_packets(start_seq: Int, payload: String) -> String, ErrCode
func encode_fragmented_packets(start_seq: Int, payload: String) -> String, ErrCode {
    let out: String = "";
    let off: Int = 0;
@briefEncodes input data with `encode_fragmented_packets`.
@detailsExecutes the `encode_fragmented_packets` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • start_seqInitial sequence number used by the protocol operation.
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::encode_compressed_packet_header
Signaturefunc encode_compressed_packet_header(seq: Int, compressed_len: Int, uncompressed_len: Int) -> String, ErrCode
func encode_compressed_packet_header(seq: Int, compressed_len: Int, uncompressed_len: Int) -> String, ErrCode {
    if seq < 0 || seq > 255 || compressed_len < 0 || compressed_len > max_payload_len() || uncompressed_len < 0 || uncompressed_len > max_payload_len() {
        return "", std.ERR_INVALID;
@briefEncodes input data with `encode_compressed_packet_header`.
@detailsExecutes the `encode_compressed_packet_header` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • seqSequence number used to order or correlate protocol messages.
  • compressed_lenSize or length value that limits how much data the operation processes.
  • uncompressed_lenSize or length value that limits how much data the operation processes.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::encode_uncompressed_compression_frame
Signaturefunc encode_uncompressed_compression_frame(seq: Int, wire_packet: String) -> String, ErrCode
func encode_uncompressed_compression_frame(seq: Int, wire_packet: String) -> String, ErrCode {
    let n: Int = std.len(wire_packet);
    let hdr: String = encode_compressed_packet_header(seq, n, 0)?;
@briefEncodes input data with `encode_uncompressed_compression_frame`.
@detailsExecutes the `encode_uncompressed_compression_frame` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • seqSequence number used to order or correlate protocol messages.
  • wire_packetComplete wire-format packet bytes processed by the protocol codec.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::encode_compressed_frame
Signaturefunc encode_compressed_frame(seq: Int, compressed_payload: String, uncompressed_len: Int) -> String, ErrCode
func encode_compressed_frame(seq: Int, compressed_payload: String, uncompressed_len: Int) -> String, ErrCode {
    let hdr: String = encode_compressed_packet_header(seq, std.len(compressed_payload), uncompressed_len)?;
    return hdr + compressed_payload, std.OK;
@briefEncodes input data with `encode_compressed_frame`.
@detailsExecutes the `encode_compressed_frame` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • seqSequence number used to order or correlate protocol messages.
  • compressed_payloadCompressed payload bytes passed to decompression or framing logic.
  • uncompressed_lenSize or length value that limits how much data the operation processes.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::is_ok_payload
Signaturefunc is_ok_payload(payload: String) -> Bool
func is_ok_payload(payload: String) -> Bool {
    return std.len(payload) > 0 && byte_at(payload, 0) == 0;
}
@briefTests whether the state satisfies the condition represented by `is_ok_payload`.
@detailsExecutes the `is_ok_payload` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::is_err_payload
Signaturefunc is_err_payload(payload: String) -> Bool
func is_err_payload(payload: String) -> Bool {
    return std.len(payload) > 0 && byte_at(payload, 0) == 255;
}
@briefTests whether the state satisfies the condition represented by `is_err_payload`.
@detailsExecutes the `is_err_payload` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::is_eof_payload
Signaturefunc is_eof_payload(payload: String) -> Bool
func is_eof_payload(payload: String) -> Bool {
    return std.len(payload) > 0 && byte_at(payload, 0) == 254 && std.len(payload) < 9;
}
@briefTests whether the state satisfies the condition represented by `is_eof_payload`.
@detailsExecutes the `is_eof_payload` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::is_local_infile_request
Signaturefunc is_local_infile_request(payload: String) -> Bool
func is_local_infile_request(payload: String) -> Bool {
    return std.len(payload) > 0 && byte_at(payload, 0) == 251;
}
@briefTests whether the state satisfies the condition represented by `is_local_infile_request`.
@detailsExecutes the `is_local_infile_request` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::parse_local_infile_filename
Signaturefunc parse_local_infile_filename(payload: String) -> String, ErrCode
func parse_local_infile_filename(payload: String) -> String, ErrCode {
    if !is_local_infile_request(payload) {
        return "", std.ERR_INVALID;
@briefParses input data with `parse_local_infile_filename`.
@detailsExecutes the `parse_local_infile_filename` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::has_cap
Signaturefunc has_cap(caps: Int, flag: Int) -> Bool
func has_cap(caps: Int, flag: Int) -> Bool {
    return (caps & flag) != 0;
}
@briefTests whether the object contains the specified state or data with `has_cap`.
@detailsExecutes the `has_cap` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • capsCapability bitmask or capability list advertised by the peer.
  • flagSingle option flag or protocol flag value used by the operation.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::Handshake.init
Signaturefunc init(self: protocol.mysql.Handshake) -> Void
    func init(self: protocol.mysql.Handshake) -> Void {
        self.protocol_version = 0;
        self.server_version = "";
@briefInitializes a `Handshake` instance.
@detailsEstablishes the initial field state for `Handshake` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::Handshake.deinit
Signaturefunc deinit(self: protocol.mysql.Handshake) -> Void
    func deinit(self: protocol.mysql.Handshake) -> Void {
    }
}
@briefReleases fallback resources at the end of the `Handshake` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::OkPacket.init
Signaturefunc init(self: protocol.mysql.OkPacket) -> Void
    func init(self: protocol.mysql.OkPacket) -> Void {
        self.affected_rows = 0;
        self.last_insert_id = 0;
@briefInitializes a `OkPacket` instance.
@detailsEstablishes the initial field state for `OkPacket` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::OkPacket.deinit
Signaturefunc deinit(self: protocol.mysql.OkPacket) -> Void
    func deinit(self: protocol.mysql.OkPacket) -> Void {
    }
}
@briefReleases fallback resources at the end of the `OkPacket` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::ErrPacket.init
Signaturefunc init(self: protocol.mysql.ErrPacket) -> Void
    func init(self: protocol.mysql.ErrPacket) -> Void {
        self.code = 0;
        self.sql_state = "HY000";
@briefInitializes a `ErrPacket` instance.
@detailsEstablishes the initial field state for `ErrPacket` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::ErrPacket.deinit
Signaturefunc deinit(self: protocol.mysql.ErrPacket) -> Void
    func deinit(self: protocol.mysql.ErrPacket) -> Void {
    }
}
@briefReleases fallback resources at the end of the `ErrPacket` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::EofPacket.init
Signaturefunc init(self: protocol.mysql.EofPacket) -> Void
    func init(self: protocol.mysql.EofPacket) -> Void {
        self.warnings = 0;
        self.status_flags = 0;
@briefInitializes a `EofPacket` instance.
@detailsEstablishes the initial field state for `EofPacket` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::EofPacket.deinit
Signaturefunc deinit(self: protocol.mysql.EofPacket) -> Void
    func deinit(self: protocol.mysql.EofPacket) -> Void {
    }
}
@briefReleases fallback resources at the end of the `EofPacket` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::ColumnDefinition.init
Signaturefunc init(self: protocol.mysql.ColumnDefinition) -> Void
    func init(self: protocol.mysql.ColumnDefinition) -> Void {
        self.catalog = "";
        self.schema = "";
@briefInitializes a `ColumnDefinition` instance.
@detailsEstablishes the initial field state for `ColumnDefinition` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::ColumnDefinition.deinit
Signaturefunc deinit(self: protocol.mysql.ColumnDefinition) -> Void
    func deinit(self: protocol.mysql.ColumnDefinition) -> Void {
    }
}
@briefReleases fallback resources at the end of the `ColumnDefinition` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::DecimalValue.init
Signaturefunc init(self: protocol.mysql.DecimalValue) -> Void
    func init(self: protocol.mysql.DecimalValue) -> Void {
        self.text = "";
        self.negative = false;
@briefInitializes a `DecimalValue` instance.
@detailsEstablishes the initial field state for `DecimalValue` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::DecimalValue.deinit
Signaturefunc deinit(self: protocol.mysql.DecimalValue) -> Void
    func deinit(self: protocol.mysql.DecimalValue) -> Void {
    }
}
@briefReleases fallback resources at the end of the `DecimalValue` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::parse_decimal_value
Signaturefunc parse_decimal_value(text: String) -> protocol.mysql.DecimalValue
func parse_decimal_value(text: String) -> protocol.mysql.DecimalValue {
    let out: protocol.mysql.DecimalValue = new protocol.mysql.DecimalValue();
    out.text = text;
@briefParses input data with `parse_decimal_value`.
@detailsExecutes the `parse_decimal_value` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • textText input to parse, encode, format, search, or transmit.
@returnReturns the operation result as `protocol.mysql.DecimalValue`.
functionprotocol.mysql::ResultCell.init
Signaturefunc init(self: protocol.mysql.ResultCell, text: String = "", raw: String = "", type_code: Int = 0, is_null: Bool = false, unsigned_flag: Bool = false) -> Void
    func init(self: protocol.mysql.ResultCell, text: String = "", raw: String = "", type_code: Int = 0, is_null: Bool = false, unsigned_flag: Bool = false) -> Void {
        self.text = text;
        self.raw = raw;
@briefInitializes a `ResultCell` instance.
@detailsEstablishes the initial field state for `ResultCell` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • textText input to parse, encode, format, search, or transmit.
  • rawRaw encoded input string before validation, parsing, or normalization.
  • type_codeNumeric type code used to decode or encode a protocol value.
  • is_nullWhether the value is encoded or treated as a null value.
  • unsigned_flagWhether the numeric field should be treated as unsigned.
@returnVoid
functionprotocol.mysql::ResultCell.get_int
Signaturefunc get_int(self: protocol.mysql.ResultCell, def: Int = 0) -> Int
    func get_int(self: protocol.mysql.ResultCell, def: Int = 0) -> Int {
        if self.is_null {
            return def;
@briefReads the state or data for `ResultCell.get_int`.
@detailsExecutes the `get_int` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • defDefault value returned or used when the requested value is absent, invalid, or cannot be decoded.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::ResultCell.get_uint
Signaturefunc get_uint(self: protocol.mysql.ResultCell, def: Int = 0) -> Int
    func get_uint(self: protocol.mysql.ResultCell, def: Int = 0) -> Int {
        let v: Int = self.get_int(def);
        if v < 0 {
@briefReads the state or data for `ResultCell.get_uint`.
@detailsExecutes the `get_uint` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • defDefault value returned or used when the requested value is absent, invalid, or cannot be decoded.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::ResultCell.get_float
Signaturefunc get_float(self: protocol.mysql.ResultCell, def: Float = 0.0) -> Float
    func get_float(self: protocol.mysql.ResultCell, def: Float = 0.0) -> Float {
        if self.is_null {
            return def;
@briefReads the state or data for `ResultCell.get_float`.
@detailsExecutes the `get_float` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • defDefault value returned or used when the requested value is absent, invalid, or cannot be decoded.
@returnReturns the operation result as `Float`.
functionprotocol.mysql::ResultCell.get_bool
Signaturefunc get_bool(self: protocol.mysql.ResultCell, def: Bool = false) -> Bool
    func get_bool(self: protocol.mysql.ResultCell, def: Bool = false) -> Bool {
        if self.is_null {
            return def;
@briefReads the state or data for `ResultCell.get_bool`.
@detailsExecutes the `get_bool` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • defDefault value returned or used when the requested value is absent, invalid, or cannot be decoded.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::ResultCell.get_date
Signaturefunc get_date(self: protocol.mysql.ResultCell) -> String
    func get_date(self: protocol.mysql.ResultCell) -> String {
        return self.text;
    }
@briefReads the state or data for `ResultCell.get_date`.
@detailsExecutes the `get_date` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `String`.
functionprotocol.mysql::ResultCell.get_time
Signaturefunc get_time(self: protocol.mysql.ResultCell) -> String
    func get_time(self: protocol.mysql.ResultCell) -> String {
        return self.text;
    }
@briefReads the state or data for `ResultCell.get_time`.
@detailsExecutes the `get_time` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `String`.
functionprotocol.mysql::ResultCell.get_decimal
Signaturefunc get_decimal(self: protocol.mysql.ResultCell) -> protocol.mysql.DecimalValue
    func get_decimal(self: protocol.mysql.ResultCell) -> protocol.mysql.DecimalValue {
        return self.decimal;
    }
@briefReads the state or data for `ResultCell.get_decimal`.
@detailsExecutes the `get_decimal` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `protocol.mysql.DecimalValue`.
functionprotocol.mysql::ResultCell.get_json
Signaturefunc get_json(self: protocol.mysql.ResultCell) -> String
    func get_json(self: protocol.mysql.ResultCell) -> String {
        return self.text;
    }
@briefReads the state or data for `ResultCell.get_json`.
@detailsExecutes the `get_json` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `String`.
functionprotocol.mysql::ResultCell.get_blob
Signaturefunc get_blob(self: protocol.mysql.ResultCell) -> String
    func get_blob(self: protocol.mysql.ResultCell) -> String {
        return self.raw;
    }
@briefReads the state or data for `ResultCell.get_blob`.
@detailsExecutes the `get_blob` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `String`.
functionprotocol.mysql::ResultCell.get_bit
Signaturefunc get_bit(self: protocol.mysql.ResultCell) -> Int
    func get_bit(self: protocol.mysql.ResultCell) -> Int {
        return binary_unsigned_int(self.raw);
    }
@briefReads the state or data for `ResultCell.get_bit`.
@detailsExecutes the `get_bit` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::ResultCell.get_geometry
Signaturefunc get_geometry(self: protocol.mysql.ResultCell) -> String
    func get_geometry(self: protocol.mysql.ResultCell) -> String {
        return self.raw;
    }
@briefReads the state or data for `ResultCell.get_geometry`.
@detailsExecutes the `get_geometry` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `String`.
functionprotocol.mysql::ResultCell.deinit
Signaturefunc deinit(self: protocol.mysql.ResultCell) -> Void
    func deinit(self: protocol.mysql.ResultCell) -> Void {
    }
}
@briefReleases fallback resources at the end of the `ResultCell` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::Row.init
Signaturefunc init(self: protocol.mysql.Row) -> Void
    func init(self: protocol.mysql.Row) -> Void {
        self.values = new collections.Vector<String>();
        self.nulls = new collections.Vector<Bool>();
@briefInitializes a `Row` instance.
@detailsEstablishes the initial field state for `Row` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::Row.push
Signaturefunc push(self: protocol.mysql.Row, value: String, is_null: Bool) -> Void
    func push(self: protocol.mysql.Row, value: String, is_null: Bool) -> Void {
        _ = self.values.push(value);
        _ = self.nulls.push(is_null);
@briefAppends an element with `Row.push`.
@detailsExecutes the `push` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • valueValue to write or store.
  • is_nullWhether the value is encoded or treated as a null value.
@returnVoid
functionprotocol.mysql::Row.push_typed
Signaturefunc push_typed(self: protocol.mysql.Row, cell: protocol.mysql.ResultCell) -> Void
    func push_typed(self: protocol.mysql.Row, cell: protocol.mysql.ResultCell) -> Void {
        _ = self.values.push(cell.text);
        _ = self.nulls.push(cell.is_null);
@briefProvides the system library operation `Row.push_typed`.
@detailsExecutes the `push_typed` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • cellCell value or table cell processed by the formatter or encoder.
@returnVoid
functionprotocol.mysql::Row.len
Signaturefunc len(self: protocol.mysql.Row) -> Int
    func len(self: protocol.mysql.Row) -> Int {
        return self.values.len();
    }
@briefReturns the element count or byte length with `Row.len`.
@detailsExecutes the `len` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::Row.cell
Signaturefunc cell(self: protocol.mysql.Row, idx: Int) -> protocol.mysql.ResultCell
    func cell(self: protocol.mysql.Row, idx: Int) -> protocol.mysql.ResultCell {
        return self.cells.get_unchecked(idx);
    }
@briefProvides the system library operation `Row.cell`.
@detailsExecutes the `cell` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
@returnReturns the operation result as `protocol.mysql.ResultCell`.
functionprotocol.mysql::Row.get_int
Signaturefunc get_int(self: protocol.mysql.Row, idx: Int, def: Int = 0) -> Int
    func get_int(self: protocol.mysql.Row, idx: Int, def: Int = 0) -> Int {
        if idx < 0 || idx >= self.cells.len() {
            return def;
@briefReads the state or data for `Row.get_int`.
@detailsExecutes the `get_int` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
  • defDefault value returned or used when the requested value is absent, invalid, or cannot be decoded.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::Row.get_uint
Signaturefunc get_uint(self: protocol.mysql.Row, idx: Int, def: Int = 0) -> Int
    func get_uint(self: protocol.mysql.Row, idx: Int, def: Int = 0) -> Int {
        if idx < 0 || idx >= self.cells.len() {
            return def;
@briefReads the state or data for `Row.get_uint`.
@detailsExecutes the `get_uint` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
  • defDefault value returned or used when the requested value is absent, invalid, or cannot be decoded.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::Row.get_float
Signaturefunc get_float(self: protocol.mysql.Row, idx: Int, def: Float = 0.0) -> Float
    func get_float(self: protocol.mysql.Row, idx: Int, def: Float = 0.0) -> Float {
        if idx < 0 || idx >= self.cells.len() {
            return def;
@briefReads the state or data for `Row.get_float`.
@detailsExecutes the `get_float` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
  • defDefault value returned or used when the requested value is absent, invalid, or cannot be decoded.
@returnReturns the operation result as `Float`.
functionprotocol.mysql::Row.get_bool
Signaturefunc get_bool(self: protocol.mysql.Row, idx: Int, def: Bool = false) -> Bool
    func get_bool(self: protocol.mysql.Row, idx: Int, def: Bool = false) -> Bool {
        if idx < 0 || idx >= self.cells.len() {
            return def;
@briefReads the state or data for `Row.get_bool`.
@detailsExecutes the `get_bool` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
  • defDefault value returned or used when the requested value is absent, invalid, or cannot be decoded.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::Row.get_time
Signaturefunc get_time(self: protocol.mysql.Row, idx: Int) -> String
    func get_time(self: protocol.mysql.Row, idx: Int) -> String {
        if idx < 0 || idx >= self.cells.len() {
            return "";
@briefReads the state or data for `Row.get_time`.
@detailsExecutes the `get_time` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
@returnReturns the operation result as `String`.
functionprotocol.mysql::Row.get_date
Signaturefunc get_date(self: protocol.mysql.Row, idx: Int) -> String
    func get_date(self: protocol.mysql.Row, idx: Int) -> String {
        if idx < 0 || idx >= self.cells.len() {
            return "";
@briefReads the state or data for `Row.get_date`.
@detailsExecutes the `get_date` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
@returnReturns the operation result as `String`.
functionprotocol.mysql::Row.get_decimal
Signaturefunc get_decimal(self: protocol.mysql.Row, idx: Int) -> protocol.mysql.DecimalValue
    func get_decimal(self: protocol.mysql.Row, idx: Int) -> protocol.mysql.DecimalValue {
        if idx < 0 || idx >= self.cells.len() {
            return new protocol.mysql.DecimalValue();
@briefReads the state or data for `Row.get_decimal`.
@detailsExecutes the `get_decimal` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
@returnReturns the operation result as `protocol.mysql.DecimalValue`.
functionprotocol.mysql::Row.get_json
Signaturefunc get_json(self: protocol.mysql.Row, idx: Int) -> String
    func get_json(self: protocol.mysql.Row, idx: Int) -> String {
        if idx < 0 || idx >= self.cells.len() {
            return "";
@briefReads the state or data for `Row.get_json`.
@detailsExecutes the `get_json` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
@returnReturns the operation result as `String`.
functionprotocol.mysql::Row.get_blob
Signaturefunc get_blob(self: protocol.mysql.Row, idx: Int) -> String
    func get_blob(self: protocol.mysql.Row, idx: Int) -> String {
        if idx < 0 || idx >= self.cells.len() {
            return "";
@briefReads the state or data for `Row.get_blob`.
@detailsExecutes the `get_blob` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
@returnReturns the operation result as `String`.
functionprotocol.mysql::Row.get_bit
Signaturefunc get_bit(self: protocol.mysql.Row, idx: Int) -> Int
    func get_bit(self: protocol.mysql.Row, idx: Int) -> Int {
        if idx < 0 || idx >= self.cells.len() {
            return 0;
@briefReads the state or data for `Row.get_bit`.
@detailsExecutes the `get_bit` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::Row.get_geometry
Signaturefunc get_geometry(self: protocol.mysql.Row, idx: Int) -> String
    func get_geometry(self: protocol.mysql.Row, idx: Int) -> String {
        if idx < 0 || idx >= self.cells.len() {
            return "";
@briefReads the state or data for `Row.get_geometry`.
@detailsExecutes the `get_geometry` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • idxZero-based index.
@returnReturns the operation result as `String`.
functionprotocol.mysql::Row.deinit
Signaturefunc deinit(self: protocol.mysql.Row) -> Void
    func deinit(self: protocol.mysql.Row) -> Void {
    }
}
@briefReleases fallback resources at the end of the `Row` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::ResultSet.init
Signaturefunc init(self: protocol.mysql.ResultSet) -> Void
    func init(self: protocol.mysql.ResultSet) -> Void {
        self.columns = new collections.Vector<protocol.mysql.ColumnDefinition>();
        self.rows = new collections.Vector<protocol.mysql.Row>();
@briefInitializes a `ResultSet` instance.
@detailsEstablishes the initial field state for `ResultSet` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::ResultSet.deinit
Signaturefunc deinit(self: protocol.mysql.ResultSet) -> Void
    func deinit(self: protocol.mysql.ResultSet) -> Void {
    }
}
@briefReleases fallback resources at the end of the `ResultSet` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::StmtPrepareOk.init
Signaturefunc init(self: protocol.mysql.StmtPrepareOk) -> Void
    func init(self: protocol.mysql.StmtPrepareOk) -> Void {
        self.statement_id = 0;
        self.column_count = 0;
@briefInitializes a `StmtPrepareOk` instance.
@detailsEstablishes the initial field state for `StmtPrepareOk` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::StmtPrepareOk.deinit
Signaturefunc deinit(self: protocol.mysql.StmtPrepareOk) -> Void
    func deinit(self: protocol.mysql.StmtPrepareOk) -> Void {
    }
}
@briefReleases fallback resources at the end of the `StmtPrepareOk` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::AuthSwitchRequest.init
Signaturefunc init(self: protocol.mysql.AuthSwitchRequest) -> Void
    func init(self: protocol.mysql.AuthSwitchRequest) -> Void {
        self.plugin_name = "";
        self.plugin_data = "";
@briefInitializes a `AuthSwitchRequest` instance.
@detailsEstablishes the initial field state for `AuthSwitchRequest` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::AuthSwitchRequest.deinit
Signaturefunc deinit(self: protocol.mysql.AuthSwitchRequest) -> Void
    func deinit(self: protocol.mysql.AuthSwitchRequest) -> Void {
    }
}
@briefReleases fallback resources at the end of the `AuthSwitchRequest` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::AuthMoreData.init
Signaturefunc init(self: protocol.mysql.AuthMoreData) -> Void
    func init(self: protocol.mysql.AuthMoreData) -> Void {
        self.code = 0;
        self.data = "";
@briefInitializes a `AuthMoreData` instance.
@detailsEstablishes the initial field state for `AuthMoreData` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::AuthMoreData.deinit
Signaturefunc deinit(self: protocol.mysql.AuthMoreData) -> Void
    func deinit(self: protocol.mysql.AuthMoreData) -> Void {
    }
}
@briefReleases fallback resources at the end of the `AuthMoreData` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::StmtParam.init
Signaturefunc init(self: protocol.mysql.StmtParam, type_code: Int = 0, value: String = "", is_null: Bool = false, unsigned_flag: Bool = false) -> Void
    func init(self: protocol.mysql.StmtParam, type_code: Int = 0, value: String = "", is_null: Bool = false, unsigned_flag: Bool = false) -> Void {
        self.type_code = type_code;
        self.unsigned_flag = unsigned_flag;
@briefInitializes a `StmtParam` instance.
@detailsEstablishes the initial field state for `StmtParam` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • type_codeNumeric type code used to decode or encode a protocol value.
  • valueValue to write or store.
  • is_nullWhether the value is encoded or treated as a null value.
  • unsigned_flagWhether the numeric field should be treated as unsigned.
@returnVoid
functionprotocol.mysql::StmtParam.deinit
Signaturefunc deinit(self: protocol.mysql.StmtParam) -> Void
    func deinit(self: protocol.mysql.StmtParam) -> Void {
    }
}
@briefReleases fallback resources at the end of the `StmtParam` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::param_null
Signaturefunc param_null() -> protocol.mysql.StmtParam
func param_null() -> protocol.mysql.StmtParam {
    return new protocol.mysql.StmtParam(type_null(), "", true, false);
}
@briefProvides the system library operation `param_null`.
@detailsExecutes the `param_null` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `protocol.mysql.StmtParam`.
functionprotocol.mysql::param_i64
Signaturefunc param_i64(v: Int) -> protocol.mysql.StmtParam
func param_i64(v: Int) -> protocol.mysql.StmtParam {
    return new protocol.mysql.StmtParam(type_longlong(), u64_le(v), false, false);
}
@briefProvides the system library operation `param_i64`.
@detailsExecutes the `param_i64` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • vValue argument consumed, stored, encoded, compared, or forwarded by this API.
@returnReturns the operation result as `protocol.mysql.StmtParam`.
functionprotocol.mysql::param_u64
Signaturefunc param_u64(v: Int) -> protocol.mysql.StmtParam
func param_u64(v: Int) -> protocol.mysql.StmtParam {
    return new protocol.mysql.StmtParam(type_longlong(), u64_le(v), false, true);
}
@briefProvides the system library operation `param_u64`.
@detailsExecutes the `param_u64` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • vValue argument consumed, stored, encoded, compared, or forwarded by this API.
@returnReturns the operation result as `protocol.mysql.StmtParam`.
functionprotocol.mysql::param_i32
Signaturefunc param_i32(v: Int) -> protocol.mysql.StmtParam
func param_i32(v: Int) -> protocol.mysql.StmtParam {
    return new protocol.mysql.StmtParam(type_long(), u32_le(v), false, false);
}
@briefProvides the system library operation `param_i32`.
@detailsExecutes the `param_i32` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • vValue argument consumed, stored, encoded, compared, or forwarded by this API.
@returnReturns the operation result as `protocol.mysql.StmtParam`.
functionprotocol.mysql::param_u32
Signaturefunc param_u32(v: Int) -> protocol.mysql.StmtParam
func param_u32(v: Int) -> protocol.mysql.StmtParam {
    return new protocol.mysql.StmtParam(type_long(), u32_le(v), false, true);
}
@briefProvides the system library operation `param_u32`.
@detailsExecutes the `param_u32` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • vValue argument consumed, stored, encoded, compared, or forwarded by this API.
@returnReturns the operation result as `protocol.mysql.StmtParam`.
functionprotocol.mysql::param_string
Signaturefunc param_string(v: String) -> protocol.mysql.StmtParam
func param_string(v: String) -> protocol.mysql.StmtParam {
    return new protocol.mysql.StmtParam(type_var_string(), v, false, false);
}
@briefProvides the system library operation `param_string`.
@detailsExecutes the `param_string` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • vValue argument consumed, stored, encoded, compared, or forwarded by this API.
@returnReturns the operation result as `protocol.mysql.StmtParam`.
functionprotocol.mysql::param_blob
Signaturefunc param_blob(v: String) -> protocol.mysql.StmtParam
func param_blob(v: String) -> protocol.mysql.StmtParam {
    return new protocol.mysql.StmtParam(type_blob(), v, false, false);
}
@briefProvides the system library operation `param_blob`.
@detailsExecutes the `param_blob` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • vValue argument consumed, stored, encoded, compared, or forwarded by this API.
@returnReturns the operation result as `protocol.mysql.StmtParam`.
functionprotocol.mysql::parse_handshake
Signaturefunc parse_handshake(payload: String) -> protocol.mysql.Handshake, ErrCode
func parse_handshake(payload: String) -> protocol.mysql.Handshake, ErrCode {
    let r: protocol.mysql.Reader = new protocol.mysql.Reader(payload);
    let h: protocol.mysql.Handshake = new protocol.mysql.Handshake();
@briefParses input data with `parse_handshake`.
@detailsExecutes the `parse_handshake` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns `protocol.mysql.Handshake, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::parse_ok
Signaturefunc parse_ok(payload: String, caps: Int) -> protocol.mysql.OkPacket, ErrCode
func parse_ok(payload: String, caps: Int) -> protocol.mysql.OkPacket, ErrCode {
    let r: protocol.mysql.Reader = new protocol.mysql.Reader(payload);
    let ok: protocol.mysql.OkPacket = new protocol.mysql.OkPacket();
@briefParses input data with `parse_ok`.
@detailsExecutes the `parse_ok` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
  • capsCapability bitmask or capability list advertised by the peer.
@returnReturns `protocol.mysql.OkPacket, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::parse_err
Signaturefunc parse_err(payload: String) -> protocol.mysql.ErrPacket, ErrCode
func parse_err(payload: String) -> protocol.mysql.ErrPacket, ErrCode {
    let r: protocol.mysql.Reader = new protocol.mysql.Reader(payload);
    let e: protocol.mysql.ErrPacket = new protocol.mysql.ErrPacket();
@briefParses input data with `parse_err`.
@detailsExecutes the `parse_err` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns `protocol.mysql.ErrPacket, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::parse_eof
Signaturefunc parse_eof(payload: String) -> protocol.mysql.EofPacket, ErrCode
func parse_eof(payload: String) -> protocol.mysql.EofPacket, ErrCode {
    let r: protocol.mysql.Reader = new protocol.mysql.Reader(payload);
    let eof: protocol.mysql.EofPacket = new protocol.mysql.EofPacket();
@briefParses input data with `parse_eof`.
@detailsExecutes the `parse_eof` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns `protocol.mysql.EofPacket, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::parse_column_definition
Signaturefunc parse_column_definition(payload: String) -> protocol.mysql.ColumnDefinition, ErrCode
func parse_column_definition(payload: String) -> protocol.mysql.ColumnDefinition, ErrCode {
    let r: protocol.mysql.Reader = new protocol.mysql.Reader(payload);
    let c: protocol.mysql.ColumnDefinition = new protocol.mysql.ColumnDefinition();
@briefParses input data with `parse_column_definition`.
@detailsExecutes the `parse_column_definition` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns `protocol.mysql.ColumnDefinition, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::parse_text_row
Signaturefunc parse_text_row(payload: String, column_count: Int) -> protocol.mysql.Row, ErrCode
func parse_text_row(payload: String, column_count: Int) -> protocol.mysql.Row, ErrCode {
    let r: protocol.mysql.Reader = new protocol.mysql.Reader(payload);
    let row: protocol.mysql.Row = new protocol.mysql.Row();
@briefParses input data with `parse_text_row`.
@detailsExecutes the `parse_text_row` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
  • column_countNumber of columns represented in the row or result metadata.
@returnReturns `protocol.mysql.Row, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::null_bitmap_is_null
Signaturefunc null_bitmap_is_null(bitmap: String, index: Int, offset: Int) -> Bool
func null_bitmap_is_null(bitmap: String, index: Int, offset: Int) -> Bool {
    let bit: Int = index + offset;
    let byte_idx: Int = bit / 8;
@briefProvides the system library operation `null_bitmap_is_null`.
@detailsExecutes the `null_bitmap_is_null` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • bitmapBitmap value used to mark null fields, flags, or selected items.
  • indexZero-based index.
  • offsetByte offset measured from the start position.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::unsigned_flag
Signaturefunc unsigned_flag(flags: Int) -> Bool
func unsigned_flag(flags: Int) -> Bool {
    return (flags & 32) != 0;
}
@briefProvides the system library operation `unsigned_flag`.
@detailsExecutes the `unsigned_flag` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • flagsBitmask of option flags that controls how the operation is performed.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::sign_extend
Signaturefunc sign_extend(v: Int, bits: Int) -> Int
func sign_extend(v: Int, bits: Int) -> Int {
    let sign: Int = 1 << (bits - 1);
    let mask: Int = 1 << bits;
@briefProvides the system library operation `sign_extend`.
@detailsExecutes the `sign_extend` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • vValue argument consumed, stored, encoded, compared, or forwarded by this API.
  • bitsBit count, bit mask, or encoded bits consumed by the operation.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::pad2
Signaturefunc pad2(v: Int) -> String
func pad2(v: Int) -> String {
    if v < 10 {
        return "0" + strconv.itoa(v);
@briefProvides the system library operation `pad2`.
@detailsExecutes the `pad2` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • vValue argument consumed, stored, encoded, compared, or forwarded by this API.
@returnReturns the operation result as `String`.
functionprotocol.mysql::pad6
Signaturefunc pad6(v: Int) -> String
func pad6(v: Int) -> String {
    let s: String = strconv.itoa(v);
    let out: String = s;
@briefProvides the system library operation `pad6`.
@detailsExecutes the `pad6` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • vValue argument consumed, stored, encoded, compared, or forwarded by this API.
@returnReturns the operation result as `String`.
functionprotocol.mysql::binary_date_text
Signaturefunc binary_date_text(raw: String) -> String, ErrCode
func binary_date_text(raw: String) -> String, ErrCode {
    let n: Int = std.len(raw);
    if n == 0 {
@briefProvides the system library operation `binary_date_text`.
@detailsExecutes the `binary_date_text` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • rawRaw encoded input string before validation, parsing, or normalization.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::binary_time_text
Signaturefunc binary_time_text(raw: String) -> String, ErrCode
func binary_time_text(raw: String) -> String, ErrCode {
    let n: Int = std.len(raw);
    if n == 0 {
@briefProvides the system library operation `binary_time_text`.
@detailsExecutes the `binary_time_text` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • rawRaw encoded input string before validation, parsing, or normalization.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::binary_int_text
Signaturefunc binary_int_text(raw: String, bits: Int, unsigned_value: Bool) -> String
func binary_int_text(raw: String, bits: Int, unsigned_value: Bool) -> String {
    let v: Int = 0;
    loop (let i: Int = 0; i < std.len(raw); i += 1) {
@briefProvides the system library operation `binary_int_text`.
@detailsExecutes the `binary_int_text` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • rawRaw encoded input string before validation, parsing, or normalization.
  • bitsBit count, bit mask, or encoded bits consumed by the operation.
  • unsigned_valueValue supplied by the caller for storage, comparison, or encoding.
@returnReturns the operation result as `String`.
functionprotocol.mysql::binary_unsigned_int
Signaturefunc binary_unsigned_int(raw: String) -> Int
func binary_unsigned_int(raw: String) -> Int {
    let v: Int = 0;
    loop (let i: Int = 0; i < std.len(raw); i += 1) {
@briefProvides the system library operation `binary_unsigned_int`.
@detailsExecutes the `binary_unsigned_int` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • rawRaw encoded input string before validation, parsing, or normalization.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::binary_value_text
Signaturefunc binary_value_text(raw: String, column_type: Int, unsigned_value: Bool) -> String, ErrCode
func binary_value_text(raw: String, column_type: Int, unsigned_value: Bool) -> String, ErrCode {
    if column_type == type_tiny() {
        return binary_int_text(raw, 8, unsigned_value), std.OK;
@briefProvides the system library operation `binary_value_text`.
@detailsExecutes the `binary_value_text` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • rawRaw encoded input string before validation, parsing, or normalization.
  • column_typeColumn type identifier decoded from database metadata.
  • unsigned_valueValue supplied by the caller for storage, comparison, or encoding.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::read_binary_cell
Signaturefunc read_binary_cell(r: protocol.mysql.Reader, col: protocol.mysql.ColumnDefinition) -> protocol.mysql.ResultCell, ErrCode
func read_binary_cell(r: protocol.mysql.Reader, col: protocol.mysql.ColumnDefinition) -> protocol.mysql.ResultCell, ErrCode {
    let cell: protocol.mysql.ResultCell = new protocol.mysql.ResultCell();
    cell.type_code = col.column_type;
@briefReads data with `read_binary_cell`.
@detailsExecutes the `read_binary_cell` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • rResult object, reader object, or range value consumed by the operation.
  • colColumn index, name, or metadata entry processed by the operation.
@returnReturns `protocol.mysql.ResultCell, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::parse_binary_row
Signaturefunc parse_binary_row(payload: String, columns: collections.Vector<protocol.mysql.ColumnDefinition>) -> protocol.mysql.Row, ErrCode
func parse_binary_row(payload: String, columns: collections.Vector<protocol.mysql.ColumnDefinition>) -> protocol.mysql.Row, ErrCode {
    let r: protocol.mysql.Reader = new protocol.mysql.Reader(payload);
    let row: protocol.mysql.Row = new protocol.mysql.Row();
@briefParses input data with `parse_binary_row`.
@detailsExecutes the `parse_binary_row` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
  • columnsColumn definitions or selected column names used by the database operation.
@returnReturns `protocol.mysql.Row, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::encode_command
Signaturefunc encode_command(cmd: Int, arg: String) -> String
func encode_command(cmd: Int, arg: String) -> String {
    return byte(cmd) + arg;
}
@briefEncodes input data with `encode_command`.
@detailsExecutes the `encode_command` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • cmdCommand string or command code sent to a process, protocol, or runtime binding.
  • argOpaque argument value passed through to a callback, thread entry point, or runtime helper.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_query
Signaturefunc encode_query(sql: String) -> String
func encode_query(sql: String) -> String {
    return encode_command(com_query(), sql);
}
@briefEncodes input data with `encode_query`.
@detailsExecutes the `encode_query` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sqlSQL statement text sent to the database server.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_init_db
Signaturefunc encode_init_db(db: String) -> String
func encode_init_db(db: String) -> String {
    return encode_command(com_init_db(), db);
}
@briefEncodes input data with `encode_init_db`.
@detailsExecutes the `encode_init_db` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • dbDatabase object, database name, or database index used by the operation.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_ping
Signaturefunc encode_ping() -> String
func encode_ping() -> String {
    return byte(com_ping());
}
@briefEncodes input data with `encode_ping`.
@detailsExecutes the `encode_ping` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_quit
Signaturefunc encode_quit() -> String
func encode_quit() -> String {
    return byte(com_quit());
}
@briefEncodes input data with `encode_quit`.
@detailsExecutes the `encode_quit` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_stmt_prepare
Signaturefunc encode_stmt_prepare(sql: String) -> String
func encode_stmt_prepare(sql: String) -> String {
    return encode_command(com_stmt_prepare(), sql);
}
@briefEncodes input data with `encode_stmt_prepare`.
@detailsExecutes the `encode_stmt_prepare` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sqlSQL statement text sent to the database server.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_stmt_close
Signaturefunc encode_stmt_close(statement_id: Int) -> String
func encode_stmt_close(statement_id: Int) -> String {
    return byte(com_stmt_close()) + u32_le(statement_id);
}
@briefEncodes input data with `encode_stmt_close`.
@detailsExecutes the `encode_stmt_close` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • statement_idPrepared statement identifier assigned by the database server.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_stmt_reset
Signaturefunc encode_stmt_reset(statement_id: Int) -> String
func encode_stmt_reset(statement_id: Int) -> String {
    return byte(com_stmt_reset()) + u32_le(statement_id);
}
@briefEncodes input data with `encode_stmt_reset`.
@detailsExecutes the `encode_stmt_reset` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • statement_idPrepared statement identifier assigned by the database server.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_stmt_fetch
Signaturefunc encode_stmt_fetch(statement_id: Int, rows: Int) -> String
func encode_stmt_fetch(statement_id: Int, rows: Int) -> String {
    return byte(com_stmt_fetch()) + u32_le(statement_id) + u32_le(rows);
}
@briefEncodes input data with `encode_stmt_fetch`.
@detailsExecutes the `encode_stmt_fetch` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • statement_idPrepared statement identifier assigned by the database server.
  • rowsRow data returned by, encoded for, or supplied to the database operation.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_stmt_send_long_data
Signaturefunc encode_stmt_send_long_data(statement_id: Int, param_id: Int, data: String) -> String
func encode_stmt_send_long_data(statement_id: Int, param_id: Int, data: String) -> String {
    return byte(com_stmt_send_long_data()) + u32_le(statement_id) + u16_le(param_id) + data;
}
@briefEncodes input data with `encode_stmt_send_long_data`.
@detailsExecutes the `encode_stmt_send_long_data` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • statement_idPrepared statement identifier assigned by the database server.
  • param_idParameter identifier used to select a prepared-statement parameter.
  • dataInput or output data buffer.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_reset_connection
Signaturefunc encode_reset_connection() -> String
func encode_reset_connection() -> String {
    return byte(com_reset_connection());
}
@briefEncodes input data with `encode_reset_connection`.
@detailsExecutes the `encode_reset_connection` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_stmt_execute_header
Signaturefunc encode_stmt_execute_header(statement_id: Int, flags: Int, iteration_count: Int) -> String
func encode_stmt_execute_header(statement_id: Int, flags: Int, iteration_count: Int) -> String {
    return byte(com_stmt_execute()) + u32_le(statement_id) + byte(flags) + u32_le(iteration_count);
}
@briefEncodes input data with `encode_stmt_execute_header`.
@detailsExecutes the `encode_stmt_execute_header` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • statement_idPrepared statement identifier assigned by the database server.
  • flagsBitmask of option flags that controls how the operation is performed.
  • iteration_countNumber of iterations, retries, or hash rounds to perform.
@returnReturns the operation result as `String`.
functionprotocol.mysql::stmt_param_type_word
Signaturefunc stmt_param_type_word(param: protocol.mysql.StmtParam) -> String
func stmt_param_type_word(param: protocol.mysql.StmtParam) -> String {
    let high: Int = 0;
    if param.unsigned_flag {
@briefProvides the system library operation `stmt_param_type_word`.
@detailsExecutes the `stmt_param_type_word` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • paramParameter value encoded, decoded, or forwarded by the operation.
@returnReturns the operation result as `String`.
functionprotocol.mysql::stmt_param_value
Signaturefunc stmt_param_value(param: protocol.mysql.StmtParam) -> String, ErrCode
func stmt_param_value(param: protocol.mysql.StmtParam) -> String, ErrCode {
    if param.is_null || param.type_code == type_null() {
        return "", std.OK;
@briefProvides the system library operation `stmt_param_value`.
@detailsExecutes the `stmt_param_value` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • paramParameter value encoded, decoded, or forwarded by the operation.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::encode_null_bitmap
Signaturefunc encode_null_bitmap(params: collections.Vector<protocol.mysql.StmtParam>, offset: Int) -> String
func encode_null_bitmap(params: collections.Vector<protocol.mysql.StmtParam>, offset: Int) -> String {
    let n: Int = (params.len() + offset + 7) / 8;
    let out: String = "";
@briefEncodes input data with `encode_null_bitmap`.
@detailsExecutes the `encode_null_bitmap` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • paramsName/value parameter map encoded into the request or protocol message.
  • offsetByte offset measured from the start position.
@returnReturns the operation result as `String`.
functionprotocol.mysql::encode_stmt_execute
Signaturefunc encode_stmt_execute(statement_id: Int, params: collections.Vector<protocol.mysql.StmtParam>, flags: Int = 0) -> String, ErrCode
func encode_stmt_execute(statement_id: Int, params: collections.Vector<protocol.mysql.StmtParam>, flags: Int = 0) -> String, ErrCode {
    let out: String = encode_stmt_execute_header(statement_id, flags, 1);
    if params.len() == 0 {
@briefEncodes input data with `encode_stmt_execute`.
@detailsExecutes the `encode_stmt_execute` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • statement_idPrepared statement identifier assigned by the database server.
  • paramsName/value parameter map encoded into the request or protocol message.
  • flagsBitmask of option flags that controls how the operation is performed.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::parse_stmt_prepare_ok
Signaturefunc parse_stmt_prepare_ok(payload: String) -> protocol.mysql.StmtPrepareOk, ErrCode
func parse_stmt_prepare_ok(payload: String) -> protocol.mysql.StmtPrepareOk, ErrCode {
    let r: protocol.mysql.Reader = new protocol.mysql.Reader(payload);
    let ok: protocol.mysql.StmtPrepareOk = new protocol.mysql.StmtPrepareOk();
@briefParses input data with `parse_stmt_prepare_ok`.
@detailsExecutes the `parse_stmt_prepare_ok` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns `protocol.mysql.StmtPrepareOk, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::is_auth_switch_request
Signaturefunc is_auth_switch_request(payload: String) -> Bool
func is_auth_switch_request(payload: String) -> Bool {
    return std.len(payload) > 0 && byte_at(payload, 0) == auth_switch_request_header() && std.len(payload) >= 2;
}
@briefTests whether the state satisfies the condition represented by `is_auth_switch_request`.
@detailsExecutes the `is_auth_switch_request` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::is_auth_more_data
Signaturefunc is_auth_more_data(payload: String) -> Bool
func is_auth_more_data(payload: String) -> Bool {
    return std.len(payload) > 0 && byte_at(payload, 0) == auth_more_data_header();
}
@briefTests whether the state satisfies the condition represented by `is_auth_more_data`.
@detailsExecutes the `is_auth_more_data` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::parse_auth_switch_request
Signaturefunc parse_auth_switch_request(payload: String) -> protocol.mysql.AuthSwitchRequest, ErrCode
func parse_auth_switch_request(payload: String) -> protocol.mysql.AuthSwitchRequest, ErrCode {
    let r: protocol.mysql.Reader = new protocol.mysql.Reader(payload);
    let out: protocol.mysql.AuthSwitchRequest = new protocol.mysql.AuthSwitchRequest();
@briefParses input data with `parse_auth_switch_request`.
@detailsExecutes the `parse_auth_switch_request` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns `protocol.mysql.AuthSwitchRequest, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::parse_auth_more_data
Signaturefunc parse_auth_more_data(payload: String) -> protocol.mysql.AuthMoreData, ErrCode
func parse_auth_more_data(payload: String) -> protocol.mysql.AuthMoreData, ErrCode {
    let r: protocol.mysql.Reader = new protocol.mysql.Reader(payload);
    let out: protocol.mysql.AuthMoreData = new protocol.mysql.AuthMoreData();
@briefParses input data with `parse_auth_more_data`.
@detailsExecutes the `parse_auth_more_data` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns `protocol.mysql.AuthMoreData, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::parse_auth_public_key
Signaturefunc parse_auth_public_key(payload: String) -> String, ErrCode
func parse_auth_public_key(payload: String) -> String, ErrCode {
    if std.len(payload) <= 1 || byte_at(payload, 0) != auth_more_data_header() {
        return "", std.ERR_INVALID;
@briefParses input data with `parse_auth_public_key`.
@detailsExecutes the `parse_auth_public_key` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • payloadPayload bytes or text carried by the protocol frame, request, or response.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::HandshakeResponse.init
Signaturefunc init(self: protocol.mysql.HandshakeResponse) -> Void
    func init(self: protocol.mysql.HandshakeResponse) -> Void {
        self.user = "";
        self.database = "";
@briefInitializes a `HandshakeResponse` instance.
@detailsEstablishes the initial field state for `HandshakeResponse` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::HandshakeResponse.deinit
Signaturefunc deinit(self: protocol.mysql.HandshakeResponse) -> Void
    func deinit(self: protocol.mysql.HandshakeResponse) -> Void {
    }
}
@briefReleases fallback resources at the end of the `HandshakeResponse` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::encode_connect_attrs
Signaturefunc encode_connect_attrs(attrs: collections.Map<String, String>) -> String, ErrCode
func encode_connect_attrs(attrs: collections.Map<String, String>) -> String, ErrCode {
    let payload: String = "";
    let keys: collections.Vector<String> = attrs.keys();
@briefEncodes input data with `encode_connect_attrs`.
@detailsExecutes the `encode_connect_attrs` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • attrsAttribute map or attribute collection encoded into the protocol message.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::encode_handshake_response
Signaturefunc encode_handshake_response(resp: protocol.mysql.HandshakeResponse) -> String, ErrCode
func encode_handshake_response(resp: protocol.mysql.HandshakeResponse) -> String, ErrCode {
    let caps: Int = resp.capability_flags;
    let out: String = u32_le(caps) + u32_le(resp.max_packet_size) + byte(resp.character_set);
@briefEncodes input data with `encode_handshake_response`.
@detailsExecutes the `encode_handshake_response` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • respResponse object or encoded response payload processed by the operation.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::hex_val
Signaturefunc hex_val(ch: String) -> Int
func hex_val(ch: String) -> Int {
    let c: Int = byte_at(ch, 0);
    if c >= 48 && c <= 57 {
@briefProvides the system library operation `hex_val`.
@detailsExecutes the `hex_val` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • chCharacter code or channel handle processed by the operation.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::hex_to_bytes
Signaturefunc hex_to_bytes(hex: String) -> String, ErrCode
func hex_to_bytes(hex: String) -> String, ErrCode {
    if std.len(hex) % 2 != 0 {
        return "", std.ERR_INVALID;
@briefProvides the system library operation `hex_to_bytes`.
@detailsExecutes the `hex_to_bytes` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • hexHex-encoded text converted to or from binary data.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::sha256_raw
Signaturefunc sha256_raw(data: String) -> String, ErrCode
func sha256_raw(data: String) -> String, ErrCode {
    return hex_to_bytes(crypto.sha256.sum_hex(data));
}
@briefProvides the system library operation `sha256_raw`.
@detailsExecutes the `sha256_raw` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • dataInput or output data buffer.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::xor_bytes
Signaturefunc xor_bytes(a: String, b: String) -> String, ErrCode
func xor_bytes(a: String, b: String) -> String, ErrCode {
    if std.len(a) != std.len(b) {
        return "", std.ERR_INVALID;
@briefProvides the system library operation `xor_bytes`.
@detailsExecutes the `xor_bytes` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • aInput value used for comparison, computation, or conversion.
  • bInput value used for comparison, computation, or conversion.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::mask32
Signaturefunc mask32(n: Int) -> Int
func mask32(n: Int) -> Int {
    return n & 4294967295;
}
@briefProvides the system library operation `mask32`.
@detailsExecutes the `mask32` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • nCount, size, or limit value.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::rol32
Signaturefunc rol32(n: Int, bits: Int) -> Int
func rol32(n: Int, bits: Int) -> Int {
    let x: Int = mask32(n);
    return mask32((x << bits) | (x >> (32 - bits)));
@briefProvides the system library operation `rol32`.
@detailsExecutes the `rol32` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • nCount, size, or limit value.
  • bitsBit count, bit mask, or encoded bits consumed by the operation.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::sha1_pad
Signaturefunc sha1_pad(data: String) -> String
func sha1_pad(data: String) -> String {
    let bit_len: Int = std.len(data) * 8;
    let out: String = data + byte(128);
@briefProvides the system library operation `sha1_pad`.
@detailsExecutes the `sha1_pad` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • dataInput or output data buffer.
@returnReturns the operation result as `String`.
functionprotocol.mysql::sha1_word
Signaturefunc sha1_word(block: String, off: Int) -> Int
func sha1_word(block: String, off: Int) -> Int {
    return (byte_at(block, off) << 24)
    | (byte_at(block, off + 1) << 16)
@briefProvides the system library operation `sha1_word`.
@detailsExecutes the `sha1_word` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • blockBlock size, callback block, or blocking-mode flag used by the operation.
  • offZero-based byte offset or element offset at which the operation starts.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::sha1_raw
Signaturefunc sha1_raw(data: String) -> String
func sha1_raw(data: String) -> String {
    let msg: String = sha1_pad(data);
    let state_a: Int = 1732584193;
@briefProvides the system library operation `sha1_raw`.
@detailsExecutes the `sha1_raw` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • dataInput or output data buffer.
@returnReturns the operation result as `String`.
functionprotocol.mysql::mysql_native_password_auth
Signaturefunc mysql_native_password_auth(password: String, seed: String) -> String, ErrCode
func mysql_native_password_auth(password: String, seed: String) -> String, ErrCode {
    if std.len(password) == 0 {
        return "", std.OK;
@briefProvides the system library operation `mysql_native_password_auth`.
@detailsExecutes the `mysql_native_password_auth` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • passwordPassword or authentication secret supplied to the protocol login flow.
  • seedSeed value used to initialize deterministic hashing or pseudo-random behavior.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::caching_sha2_password_fast_auth
Signaturefunc caching_sha2_password_fast_auth(password: String, seed: String) -> String, ErrCode
func caching_sha2_password_fast_auth(password: String, seed: String) -> String, ErrCode {
    if std.len(password) == 0 {
        return "", std.OK;
@briefProvides the system library operation `caching_sha2_password_fast_auth`.
@detailsExecutes the `caching_sha2_password_fast_auth` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • passwordPassword or authentication secret supplied to the protocol login flow.
  • seedSeed value used to initialize deterministic hashing or pseudo-random behavior.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::rsa_password_plain
Signaturefunc rsa_password_plain(password: String, seed: String) -> String, ErrCode
func rsa_password_plain(password: String, seed: String) -> String, ErrCode {
    let plain: String = password + nul();
    let out: String = "";
@briefProvides the system library operation `rsa_password_plain`.
@detailsExecutes the `rsa_password_plain` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • passwordPassword or authentication secret supplied to the protocol login flow.
  • seedSeed value used to initialize deterministic hashing or pseudo-random behavior.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::rsa_password_auth
Signaturefunc rsa_password_auth(password: String, seed: String, public_key_pem: String) -> String, ErrCode
func rsa_password_auth(password: String, seed: String, public_key_pem: String) -> String, ErrCode {
    if std.len(password) == 0 {
        return "", std.OK;
@briefProvides the system library operation `rsa_password_auth`.
@detailsExecutes the `rsa_password_auth` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • passwordPassword or authentication secret supplied to the protocol login flow.
  • seedSeed value used to initialize deterministic hashing or pseudo-random behavior.
  • public_key_pemPEM-encoded public key used for encryption or verification.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::clear_password_auth
Signaturefunc clear_password_auth(password: String, tls_enabled: Bool) -> String, ErrCode
func clear_password_auth(password: String, tls_enabled: Bool) -> String, ErrCode {
    if !tls_enabled {
        return "", std.ERR_PERMISSION;
@briefProvides the system library operation `clear_password_auth`.
@detailsExecutes the `clear_password_auth` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • passwordPassword or authentication secret supplied to the protocol login flow.
  • tls_enabledWhether TLS transport is enabled for the connection or protocol session.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::full_auth_response
Signaturefunc full_auth_response(plugin: String, password: String, tls_enabled: Bool, allow_cleartext_password: Bool) -> String, ErrCode
func full_auth_response(plugin: String, password: String, tls_enabled: Bool, allow_cleartext_password: Bool) -> String, ErrCode {
    if std.len(password) == 0 {
        return "", std.OK;
@briefProvides the system library operation `full_auth_response`.
@detailsExecutes the `full_auth_response` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • pluginPlugin object or plugin name used by authentication or extension handling.
  • passwordPassword or authentication secret supplied to the protocol login flow.
  • tls_enabledWhether TLS transport is enabled for the connection or protocol session.
  • allow_cleartext_passwordWhether cleartext password authentication is permitted for the database connection.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::auth_response
Signaturefunc auth_response(plugin: String, password: String, seed: String, tls_enabled: Bool) -> String, ErrCode
func auth_response(plugin: String, password: String, seed: String, tls_enabled: Bool) -> String, ErrCode {
    if std.len(password) == 0 {
        return "", std.OK;
@briefProvides the system library operation `auth_response`.
@detailsExecutes the `auth_response` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • pluginPlugin object or plugin name used by authentication or extension handling.
  • passwordPassword or authentication secret supplied to the protocol login flow.
  • seedSeed value used to initialize deterministic hashing or pseudo-random behavior.
  • tls_enabledWhether TLS transport is enabled for the connection or protocol session.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::Config.init
Signaturefunc init(self: protocol.mysql.Config) -> Void
    func init(self: protocol.mysql.Config) -> Void {
        self.host = "127.0.0.1";
        self.port = default_port();
@briefInitializes a `Config` instance.
@detailsEstablishes the initial field state for `Config` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::Config.deinit
Signaturefunc deinit(self: protocol.mysql.Config) -> Void
    func deinit(self: protocol.mysql.Config) -> Void {
    }
}
@briefReleases fallback resources at the end of the `Config` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionprotocol.mysql::is_dsn_ident_char
Signaturefunc is_dsn_ident_char(ch: String) -> Bool
func is_dsn_ident_char(ch: String) -> Bool {
    let c: Int = byte_at(ch, 0);
    if c >= 48 && c <= 57 || c >= 65 && c <= 90 || c >= 97 && c <= 122 || ch == "_" {
@briefTests whether the state satisfies the condition represented by `is_dsn_ident_char`.
@detailsExecutes the `is_dsn_ident_char` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • chCharacter code or channel handle processed by the operation.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::valid_mysql_identifier
Signaturefunc valid_mysql_identifier(s: String) -> Bool
func valid_mysql_identifier(s: String) -> Bool {
    if std.len(s) == 0 {
        return false;
@briefProvides the system library operation `valid_mysql_identifier`.
@detailsExecutes the `valid_mysql_identifier` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sInput string.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::quote_sql_literal
Signaturefunc quote_sql_literal(s: String) -> String
func quote_sql_literal(s: String) -> String {
    let out: String = "'";
    loop (let i: Int = 0; i < std.len(s); i += 1) {
@briefProvides the system library operation `quote_sql_literal`.
@detailsExecutes the `quote_sql_literal` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sInput string.
@returnReturns the operation result as `String`.
functionprotocol.mysql::session_sql_count
Signaturefunc session_sql_count(cfg: protocol.mysql.Config) -> Int
func session_sql_count(cfg: protocol.mysql.Config) -> Int {
    let n: Int = 0;
    if std.len(cfg.charset_name) > 0 {
@briefProvides the system library operation `session_sql_count`.
@detailsExecutes the `session_sql_count` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • cfgConfiguration value or pointer used to initialize or control the operation.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::session_sql_at
Signaturefunc session_sql_at(cfg: protocol.mysql.Config, idx: Int) -> String, ErrCode
func session_sql_at(cfg: protocol.mysql.Config, idx: Int) -> String, ErrCode {
    let n: Int = 0;
    if std.len(cfg.charset_name) > 0 {
@briefProvides the system library operation `session_sql_at`.
@detailsExecutes the `session_sql_at` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • cfgConfiguration value or pointer used to initialize or control the operation.
  • idxZero-based index.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::from_hex_digit
Signaturefunc from_hex_digit(ch: String) -> Int
func from_hex_digit(ch: String) -> Int {
    let c: Int = byte_at(ch, 0);
    if c >= 48 && c <= 57 {
@briefConstructs the target representation from input with `from_hex_digit`.
@detailsExecutes the `from_hex_digit` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • chCharacter code or channel handle processed by the operation.
@returnReturns the operation result as `Int`.
functionprotocol.mysql::percent_decode
Signaturefunc percent_decode(s: String, plus_as_space: Bool = false) -> String, ErrCode
func percent_decode(s: String, plus_as_space: Bool = false) -> String, ErrCode {
    let out: String = "";
    let i: Int = 0;
@briefProvides the system library operation `percent_decode`.
@detailsExecutes the `percent_decode` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sInput string.
  • plus_as_spaceWhether plus signs are decoded as spaces in URL-style text.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::dsn_bool
Signaturefunc dsn_bool(v: String) -> Bool
func dsn_bool(v: String) -> Bool {
    let lc: String = strings.to_lower_ascii(v);
    return lc == "1" || lc == "true" || lc == "yes" || lc == "on";
@briefProvides the system library operation `dsn_bool`.
@detailsExecutes the `dsn_bool` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • vValue argument consumed, stored, encoded, compared, or forwarded by this API.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionprotocol.mysql::apply_dsn_option
Signaturefunc apply_dsn_option(cfg: protocol.mysql.Config, key: String, value: String) -> ErrCode
func apply_dsn_option(cfg: protocol.mysql.Config, key: String, value: String) -> ErrCode {
    let k: String = strings.to_lower_ascii(key);
    if k == "charset" {
@briefProvides the system library operation `apply_dsn_option`.
@detailsExecutes the `apply_dsn_option` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • cfgConfiguration value or pointer used to initialize or control the operation.
  • keyKey name.
  • valueValue to write or store.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::apply_dsn_query
Signaturefunc apply_dsn_query(cfg: protocol.mysql.Config, query: String) -> ErrCode
func apply_dsn_query(cfg: protocol.mysql.Config, query: String) -> ErrCode {
    if std.len(query) == 0 {
        return std.OK;
@briefProvides the system library operation `apply_dsn_query`.
@detailsExecutes the `apply_dsn_query` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • cfgConfiguration value or pointer used to initialize or control the operation.
  • queryQuery text, query object, or query parameters processed by the operation.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::parse_host_port
Signaturefunc parse_host_port(cfg: protocol.mysql.Config, host_port: String) -> ErrCode
func parse_host_port(cfg: protocol.mysql.Config, host_port: String) -> ErrCode {
    if std.len(host_port) == 0 {
        return std.OK;
@briefParses input data with `parse_host_port`.
@detailsExecutes the `parse_host_port` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • cfgConfiguration value or pointer used to initialize or control the operation.
  • host_portHost name or address used for the network operation.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionprotocol.mysql::parse_dsn
Signaturefunc parse_dsn(raw: String) -> protocol.mysql.Config, ErrCode
func parse_dsn(raw: String) -> protocol.mysql.Config, ErrCode {
    let cfg: protocol.mysql.Config = new protocol.mysql.Config();
    let rest: String = raw;
@briefParses input data with `parse_dsn`.
@detailsExecutes the `parse_dsn` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • rawRaw encoded input string before validation, parsing, or normalization.
@returnReturns `protocol.mysql.Config, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.

Variables

Class fields (var).

varprotocol.mysql::Packet.seq
TypeInt
@brief`seq` field.
@detailsHolds the `seq` value for each `Packet` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var seq: Int;
    /*
    @brief `payload` field.
varprotocol.mysql::Packet.payload
TypeString
@brief`payload` field.
@detailsHolds the `payload` value for each `Packet` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var payload: String;

    /*
varprotocol.mysql::Reader.data
TypeString
@brief`data` field.
@detailsStores the underlying data. The field type is `String`, and it is maintained by the constructors and methods of `Reader`.
    var data: String;
    /*
    @brief `pos` field.
varprotocol.mysql::Reader.pos
TypeInt
@brief`pos` field.
@detailsHolds the `pos` value for each `Reader` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var pos: Int;

    /*
varprotocol.mysql::Handshake.protocol_version
TypeInt
@brief`protocol_version` field.
@detailsHolds the `protocol_version` value for each `Handshake` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var protocol_version: Int;
    /*
    @brief `server_version` field.
varprotocol.mysql::Handshake.server_version
TypeString
@brief`server_version` field.
@detailsHolds the `server_version` value for each `Handshake` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var server_version: String;
    /*
    @brief `connection_id` field.
varprotocol.mysql::Handshake.connection_id
TypeInt
@brief`connection_id` field.
@detailsHolds the `connection_id` value for each `Handshake` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var connection_id: Int;
    /*
    @brief `auth_plugin_data` field.
varprotocol.mysql::Handshake.auth_plugin_data
TypeString
@brief`auth_plugin_data` field.
@detailsHolds the `auth_plugin_data` value for each `Handshake` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var auth_plugin_data: String;
    /*
    @brief `capability_flags` field.
varprotocol.mysql::Handshake.capability_flags
TypeInt
@brief`capability_flags` field.
@detailsHolds the `capability_flags` value for each `Handshake` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var capability_flags: Int;
    /*
    @brief `character_set` field.
varprotocol.mysql::Handshake.character_set
TypeInt
@brief`character_set` field.
@detailsHolds the `character_set` value for each `Handshake` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var character_set: Int;
    /*
    @brief `status_flags` field.
varprotocol.mysql::Handshake.status_flags
TypeInt
@brief`status_flags` field.
@detailsHolds the `status_flags` value for each `Handshake` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var status_flags: Int;
    /*
    @brief `auth_plugin_name` field.
varprotocol.mysql::Handshake.auth_plugin_name
TypeString
@brief`auth_plugin_name` field.
@detailsHolds the `auth_plugin_name` value for each `Handshake` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var auth_plugin_name: String;

    /*
varprotocol.mysql::OkPacket.affected_rows
TypeInt
@brief`affected_rows` field.
@detailsHolds the `affected_rows` value for each `OkPacket` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var affected_rows: Int;
    /*
    @brief `last_insert_id` field.
varprotocol.mysql::OkPacket.last_insert_id
TypeInt
@brief`last_insert_id` field.
@detailsHolds the `last_insert_id` value for each `OkPacket` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var last_insert_id: Int;
    /*
    @brief `status_flags` field.
varprotocol.mysql::OkPacket.status_flags
TypeInt
@brief`status_flags` field.
@detailsHolds the `status_flags` value for each `OkPacket` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var status_flags: Int;
    /*
    @brief `auth_plugin_name` field.
varprotocol.mysql::OkPacket.warnings
TypeInt
@brief`warnings` field.
@detailsHolds the `warnings` value for each `OkPacket` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var warnings: Int;
    /*
    @brief `info` field.
varprotocol.mysql::OkPacket.info
TypeString
@brief`info` field.
@detailsHolds the `info` value for each `OkPacket` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var info: String;

    /*
varprotocol.mysql::ErrPacket.code
TypeInt
@brief`code` field.
@detailsHolds the `code` value for each `ErrPacket` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var code: Int;
    /*
    @brief `sql_state` field.
varprotocol.mysql::ErrPacket.sql_state
TypeString
@brief`sql_state` field.
@detailsHolds the `sql_state` value for each `ErrPacket` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var sql_state: String;
    /*
    @brief `message` field.
varprotocol.mysql::ErrPacket.message
TypeString
@brief`message` field.
@detailsHolds the `message` value for each `ErrPacket` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var message: String;

    /*
varprotocol.mysql::EofPacket.warnings
TypeInt
@brief`warnings` field.
@detailsHolds the `warnings` value for each `EofPacket` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var warnings: Int;
    /*
    @brief `info` field.
varprotocol.mysql::EofPacket.status_flags
TypeInt
@brief`status_flags` field.
@detailsHolds the `status_flags` value for each `EofPacket` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var status_flags: Int;
    /*
    @brief `auth_plugin_name` field.
varprotocol.mysql::ColumnDefinition.catalog
TypeString
@brief`catalog` field.
@detailsHolds the `catalog` value for each `ColumnDefinition` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var catalog: String;
    /*
    @brief `schema` field.
varprotocol.mysql::ColumnDefinition.schema
TypeString
@brief`schema` field.
@detailsHolds the `schema` value for each `ColumnDefinition` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var schema: String;
    /*
    @brief `table` field.
varprotocol.mysql::ColumnDefinition.table
TypeString
@brief`table` field.
@detailsHolds the `table` value for each `ColumnDefinition` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var table: String;
    /*
    @brief `org_table` field.
varprotocol.mysql::ColumnDefinition.org_table
TypeString
@brief`org_table` field.
@detailsHolds the `org_table` value for each `ColumnDefinition` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var org_table: String;
    /*
    @brief `name` field.
varprotocol.mysql::ColumnDefinition.name
TypeString
@brief`name` field.
@detailsHolds the `name` value for each `ColumnDefinition` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var name: String;
    /*
    @brief `org_name` field.
varprotocol.mysql::ColumnDefinition.org_name
TypeString
@brief`org_name` field.
@detailsHolds the `org_name` value for each `ColumnDefinition` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var org_name: String;
    /*
    @brief `character_set` field.
varprotocol.mysql::ColumnDefinition.character_set
TypeInt
@brief`character_set` field.
@detailsHolds the `character_set` value for each `ColumnDefinition` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var character_set: Int;
    /*
    @brief `status_flags` field.
varprotocol.mysql::ColumnDefinition.column_length
TypeInt
@brief`column_length` field.
@detailsHolds the `column_length` value for each `ColumnDefinition` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var column_length: Int;
    /*
    @brief `column_type` field.
varprotocol.mysql::ColumnDefinition.column_type
TypeInt
@brief`column_type` field.
@detailsHolds the `column_type` value for each `ColumnDefinition` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var column_type: Int;
    /*
    @brief `flags` field.
varprotocol.mysql::ColumnDefinition.flags
TypeInt
@brief`flags` field.
@detailsHolds the `flags` value for each `ColumnDefinition` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var flags: Int;
    /*
    @brief `decimals` field.
varprotocol.mysql::ColumnDefinition.decimals
TypeInt
@brief`decimals` field.
@detailsHolds the `decimals` value for each `ColumnDefinition` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var decimals: Int;

    /*
varprotocol.mysql::DecimalValue.text
TypeString
@brief`text` field.
@detailsHolds the `text` value for each `DecimalValue` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var text: String;
    /*
    @brief `negative` field.
varprotocol.mysql::DecimalValue.negative
TypeBool
@brief`negative` field.
@detailsHolds the `negative` value for each `DecimalValue` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var negative: Bool;
    /*
    @brief `digits` field.
varprotocol.mysql::DecimalValue.digits
TypeString
@brief`digits` field.
@detailsHolds the `digits` value for each `DecimalValue` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var digits: String;
    /*
    @brief `scale` field.
varprotocol.mysql::DecimalValue.scale
TypeInt
@brief`scale` field.
@detailsHolds the `scale` value for each `DecimalValue` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var scale: Int;
    /*
    @brief `valid` field.
varprotocol.mysql::DecimalValue.valid
TypeBool
@brief`valid` field.
@detailsHolds the `valid` value for each `DecimalValue` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var valid: Bool;

    /*
varprotocol.mysql::ResultCell.text
TypeString
@brief`text` field.
@detailsHolds the `text` value for each `ResultCell` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var text: String;
    /*
    @brief `negative` field.
varprotocol.mysql::ResultCell.raw
TypeString
@brief`raw` field.
@detailsHolds the `raw` value for each `ResultCell` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var raw: String;
    /*
    @brief `type_code` field.
varprotocol.mysql::ResultCell.type_code
TypeInt
@brief`type_code` field.
@detailsHolds the `type_code` value for each `ResultCell` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var type_code: Int;
    /*
    @brief `is_null` field.
varprotocol.mysql::ResultCell.is_null
TypeBool
@brief`is_null` field.
@detailsHolds the `is_null` value for each `ResultCell` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var is_null: Bool;
    /*
    @brief `unsigned_flag` field.
varprotocol.mysql::ResultCell.unsigned_flag
TypeBool
@brief`unsigned_flag` field.
@detailsHolds the `unsigned_flag` value for each `ResultCell` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var unsigned_flag: Bool;
    /*
    @brief `decimal` field.
varprotocol.mysql::ResultCell.decimal
Typeprotocol.mysql.DecimalValue
@brief`decimal` field.
@detailsHolds the `decimal` value for each `ResultCell` instance. The field type is `protocol.mysql.DecimalValue`, and constructors and methods keep it synchronized with the object's runtime state.
    var decimals: Int;

    /*
varprotocol.mysql::Row.values
Typecollections.Vector<String>
@brief`values` field.
@detailsHolds the `values` value for each `Row` instance. The field type is `collections.Vector<String>`, and constructors and methods keep it synchronized with the object's runtime state.
    var values: collections.Vector<String>;
    /*
    @brief `nulls` field.
varprotocol.mysql::Row.nulls
Typecollections.Vector<Bool>
@brief`nulls` field.
@detailsHolds the `nulls` value for each `Row` instance. The field type is `collections.Vector<Bool>`, and constructors and methods keep it synchronized with the object's runtime state.
    var nulls: collections.Vector<Bool>;
    /*
    @brief `cells` field.
varprotocol.mysql::Row.cells
Typecollections.Vector<protocol.mysql.ResultCell>
@brief`cells` field.
@detailsHolds the `cells` value for each `Row` instance. The field type is `collections.Vector<protocol.mysql.ResultCell>`, and constructors and methods keep it synchronized with the object's runtime state.
    var cells: collections.Vector<protocol.mysql.ResultCell>;

    /*
varprotocol.mysql::ResultSet.columns
Typecollections.Vector<protocol.mysql.ColumnDefinition>
@brief`columns` field.
@detailsHolds the `columns` value for each `ResultSet` instance. The field type is `collections.Vector<protocol.mysql.ColumnDefinition>`, and constructors and methods keep it synchronized with the object's runtime state.
    var columns: collections.Vector<protocol.mysql.ColumnDefinition>;
    /*
    @brief `rows` field.
varprotocol.mysql::ResultSet.rows
Typecollections.Vector<protocol.mysql.Row>
@brief`rows` field.
@detailsHolds the `rows` value for each `ResultSet` instance. The field type is `collections.Vector<protocol.mysql.Row>`, and constructors and methods keep it synchronized with the object's runtime state.
    var rows: collections.Vector<protocol.mysql.Row>;
    /*
    @brief `status_flags` field.
varprotocol.mysql::ResultSet.status_flags
TypeInt
@brief`status_flags` field.
@detailsHolds the `status_flags` value for each `ResultSet` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var status_flags: Int;
    /*
    @brief `auth_plugin_name` field.
varprotocol.mysql::ResultSet.warnings
TypeInt
@brief`warnings` field.
@detailsHolds the `warnings` value for each `ResultSet` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var warnings: Int;
    /*
    @brief `info` field.
varprotocol.mysql::StmtPrepareOk.statement_id
TypeInt
@brief`statement_id` field.
@detailsHolds the `statement_id` value for each `StmtPrepareOk` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var statement_id: Int;
    /*
    @brief `column_count` field.
varprotocol.mysql::StmtPrepareOk.column_count
TypeInt
@brief`column_count` field.
@detailsHolds the `column_count` value for each `StmtPrepareOk` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var column_count: Int;
    /*
    @brief `param_count` field.
varprotocol.mysql::StmtPrepareOk.param_count
TypeInt
@brief`param_count` field.
@detailsHolds the `param_count` value for each `StmtPrepareOk` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var param_count: Int;
    /*
    @brief `warning_count` field.
varprotocol.mysql::StmtPrepareOk.warning_count
TypeInt
@brief`warning_count` field.
@detailsHolds the `warning_count` value for each `StmtPrepareOk` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var warning_count: Int;
    /*
    @brief `params` field.
varprotocol.mysql::StmtPrepareOk.params
Typecollections.Vector<protocol.mysql.ColumnDefinition>
@brief`params` field.
@detailsHolds the `params` value for each `StmtPrepareOk` instance. The field type is `collections.Vector<protocol.mysql.ColumnDefinition>`, and constructors and methods keep it synchronized with the object's runtime state.
    var params: collections.Vector<protocol.mysql.ColumnDefinition>;
    /*
    @brief `columns` field.
varprotocol.mysql::StmtPrepareOk.columns
Typecollections.Vector<protocol.mysql.ColumnDefinition>
@brief`columns` field.
@detailsHolds the `columns` value for each `StmtPrepareOk` instance. The field type is `collections.Vector<protocol.mysql.ColumnDefinition>`, and constructors and methods keep it synchronized with the object's runtime state.
    var columns: collections.Vector<protocol.mysql.ColumnDefinition>;
    /*
    @brief `rows` field.
varprotocol.mysql::AuthSwitchRequest.plugin_name
TypeString
@brief`plugin_name` field.
@detailsHolds the `plugin_name` value for each `AuthSwitchRequest` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var plugin_name: String;
    /*
    @brief `plugin_data` field.
varprotocol.mysql::AuthSwitchRequest.plugin_data
TypeString
@brief`plugin_data` field.
@detailsHolds the `plugin_data` value for each `AuthSwitchRequest` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var plugin_data: String;

    /*
varprotocol.mysql::AuthMoreData.code
TypeInt
@brief`code` field.
@detailsHolds the `code` value for each `AuthMoreData` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var code: Int;
    /*
    @brief `sql_state` field.
varprotocol.mysql::AuthMoreData.data
TypeString
@brief`data` field.
@detailsStores the underlying data. The field type is `String`, and it is maintained by the constructors and methods of `AuthMoreData`.
    var data: String;
    /*
    @brief `pos` field.
varprotocol.mysql::StmtParam.type_code
TypeInt
@brief`type_code` field.
@detailsHolds the `type_code` value for each `StmtParam` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var type_code: Int;
    /*
    @brief `is_null` field.
varprotocol.mysql::StmtParam.unsigned_flag
TypeBool
@brief`unsigned_flag` field.
@detailsHolds the `unsigned_flag` value for each `StmtParam` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var unsigned_flag: Bool;
    /*
    @brief `decimal` field.
varprotocol.mysql::StmtParam.is_null
TypeBool
@brief`is_null` field.
@detailsHolds the `is_null` value for each `StmtParam` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var is_null: Bool;
    /*
    @brief `unsigned_flag` field.
varprotocol.mysql::StmtParam.value
TypeString
@brief`value` field.
@detailsHolds the `value` value for each `StmtParam` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var values: collections.Vector<String>;
    /*
    @brief `nulls` field.
varprotocol.mysql::HandshakeResponse.user
TypeString
@brief`user` field.
@detailsHolds the `user` value for each `HandshakeResponse` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var user: String;
    /*
    @brief `database` field.
varprotocol.mysql::HandshakeResponse.database
TypeString
@brief`database` field.
@detailsHolds the `database` value for each `HandshakeResponse` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var database: String;
    /*
    @brief `auth_response` field.
varprotocol.mysql::HandshakeResponse.auth_response
TypeString
@brief`auth_response` field.
@detailsHolds the `auth_response` value for each `HandshakeResponse` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var auth_response: String;
    /*
    @brief `auth_plugin_name` field.
varprotocol.mysql::HandshakeResponse.auth_plugin_name
TypeString
@brief`auth_plugin_name` field.
@detailsHolds the `auth_plugin_name` value for each `HandshakeResponse` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var auth_plugin_name: String;

    /*
varprotocol.mysql::HandshakeResponse.capability_flags
TypeInt
@brief`capability_flags` field.
@detailsHolds the `capability_flags` value for each `HandshakeResponse` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var capability_flags: Int;
    /*
    @brief `character_set` field.
varprotocol.mysql::HandshakeResponse.max_packet_size
TypeInt
@brief`max_packet_size` field.
@detailsHolds the `max_packet_size` value for each `HandshakeResponse` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var max_packet_size: Int;
    /*
    @brief `character_set` field.
varprotocol.mysql::HandshakeResponse.character_set
TypeInt
@brief`character_set` field.
@detailsHolds the `character_set` value for each `HandshakeResponse` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var character_set: Int;
    /*
    @brief `status_flags` field.
varprotocol.mysql::HandshakeResponse.attrs
Typecollections.Map<String, String>
@brief`attrs` field.
@detailsHolds the `attrs` value for each `HandshakeResponse` instance. The field type is `collections.Map<String, String>`, and constructors and methods keep it synchronized with the object's runtime state.
    var attrs: collections.Map<String, String>;

    /*
varprotocol.mysql::Config.host
TypeString
@brief`host` field.
@detailsStores a host name or network address. The field type is `String`, and it is maintained by the constructors and methods of `Config`.
    var host: String;
    /*
    @brief `port` field.
varprotocol.mysql::Config.port
TypeInt
@brief`port` field.
@detailsStores a port number. The field type is `Int`, and it is maintained by the constructors and methods of `Config`.
    var port: Int;
    /*
    @brief `user` field.
varprotocol.mysql::Config.user
TypeString
@brief`user` field.
@detailsHolds the `user` value for each `Config` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var user: String;
    /*
    @brief `database` field.
varprotocol.mysql::Config.password
TypeString
@brief`password` field.
@detailsHolds the `password` value for each `Config` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var password: String;
    /*
    @brief `database` field.
varprotocol.mysql::Config.database
TypeString
@brief`database` field.
@detailsHolds the `database` value for each `Config` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var database: String;
    /*
    @brief `auth_response` field.
varprotocol.mysql::Config.charset_name
TypeString
@brief`charset_name` field.
@detailsHolds the `charset_name` value for each `Config` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var charset_name: String;
    /*
    @brief `collation` field.
varprotocol.mysql::Config.collation
TypeString
@brief`collation` field.
@detailsHolds the `collation` value for each `Config` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var collation: String;
    /*
    @brief `time_zone` field.
varprotocol.mysql::Config.time_zone
TypeString
@brief`time_zone` field.
@detailsHolds the `time_zone` value for each `Config` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var time_zone: String;
    /*
    @brief `sql_mode` field.
varprotocol.mysql::Config.sql_mode
TypeString
@brief`sql_mode` field.
@detailsHolds the `sql_mode` value for each `Config` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var sql_mode: String;
    /*
    @brief `init_command` field.
varprotocol.mysql::Config.init_command
TypeString
@brief`init_command` field.
@detailsHolds the `init_command` value for each `Config` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var init_command: String;
    /*
    @brief `tls` field.
varprotocol.mysql::Config.tls
TypeBool
@brief`tls` field.
@detailsHolds the `tls` value for each `Config` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var tls: Bool;
    /*
    @brief `tls_verify` field.
varprotocol.mysql::Config.tls_verify
TypeBool
@brief`tls_verify` field.
@detailsHolds the `tls_verify` value for each `Config` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var tls_verify: Bool;
    /*
    @brief `tls_ca_file` field.
varprotocol.mysql::Config.tls_ca_file
TypeString
@brief`tls_ca_file` field.
@detailsHolds the `tls_ca_file` value for each `Config` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var tls_ca_file: String;
    /*
    @brief `tls_server_name` field.
varprotocol.mysql::Config.tls_server_name
TypeString
@brief`tls_server_name` field.
@detailsHolds the `tls_server_name` value for each `Config` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var tls_server_name: String;
    /*
    @brief `allow_cleartext_password` field.
varprotocol.mysql::Config.allow_cleartext_password
TypeBool
@brief`allow_cleartext_password` field.
@detailsHolds the `allow_cleartext_password` value for each `Config` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var allow_cleartext_password: Bool;
    /*
    @brief `allow_local_infile` field.
varprotocol.mysql::Config.allow_local_infile
TypeBool
@brief`allow_local_infile` field.
@detailsHolds the `allow_local_infile` value for each `Config` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var allow_local_infile: Bool;
    /*
    @brief `allow_public_key_retrieval` field.
varprotocol.mysql::Config.allow_public_key_retrieval
TypeBool
@brief`allow_public_key_retrieval` field.
@detailsHolds the `allow_public_key_retrieval` value for each `Config` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var allow_public_key_retrieval: Bool;
    /*
    @brief `local_infile_root` field.
varprotocol.mysql::Config.local_infile_root
TypeString
@brief`local_infile_root` field.
@detailsHolds the `local_infile_root` value for each `Config` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var local_infile_root: String;
    /*
    @brief `max_local_infile_bytes` field.
varprotocol.mysql::Config.max_local_infile_bytes
TypeInt
@brief`max_local_infile_bytes` field.
@detailsHolds the `max_local_infile_bytes` value for each `Config` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var max_local_infile_bytes: Int;
    /*
    @brief `compression` field.
varprotocol.mysql::Config.compression
TypeBool
@brief`compression` field.
@detailsHolds the `compression` value for each `Config` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var compression: Bool;
    /*
    @brief `compression_min_bytes` field.
varprotocol.mysql::Config.compression_min_bytes
TypeInt
@brief`compression_min_bytes` field.
@detailsHolds the `compression_min_bytes` value for each `Config` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var compression_min_bytes: Int;
    /*
    @brief `max_uncompressed_packet_bytes` field.
varprotocol.mysql::Config.max_uncompressed_packet_bytes
TypeInt
@brief`max_uncompressed_packet_bytes` field.
@detailsHolds the `max_uncompressed_packet_bytes` value for each `Config` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var max_uncompressed_packet_bytes: Int;
    /*
    @brief `multi_statements` field.
varprotocol.mysql::Config.multi_statements
TypeBool
@brief`multi_statements` field.
@detailsHolds the `multi_statements` value for each `Config` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var multi_statements: Bool;
    /*
    @brief `timeout_ms` field.
varprotocol.mysql::Config.timeout_ms
TypeInt
@brief`timeout_ms` field.
@detailsStores the default timeout in milliseconds. The field type is `Int`, and it is maintained by the constructors and methods of `Config`.
    var timeout_ms: Int;
    /*
    @brief `charset` field.
varprotocol.mysql::Config.charset
TypeInt
@brief`charset` field.
@detailsHolds the `charset` value for each `Config` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var charset_name: String;
    /*
    @brief `collation` field.