Class List Method List File List

# Class: VertxMysqlClient::MySQLConnection

Inherits:
  VertxSqlClient::SqlConnection
  - Object
  - VertxSqlClient::SqlClient
  - VertxSqlClient::SqlConnection
  - VertxMysqlClient::MySQLConnection
  show all
Defined in:
  /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb

## Overview

A connection to MySQL server.

## Constant Summary

@@j_api_type =

      Object.new

## Class Method Summary (collapse)

- + (Boolean) accept?(obj)
- + (void) connect(param_1 = nil, param_2 = nil)
  Like #connect with options build from connectionUri.
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)

## Instance Method Summary (collapse)

- - (::VertxSqlClient::Transaction) begin
  Begin a transaction and returns a for controlling and tracking this transaction.
- - (self) change_user(options = nil) { ... }
  Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
- - (void) close
  Close the current connection after all the pending commands have been processed.
- - (self) close_handler { ... }
- - (::VertxSqlClient::DatabaseMetadata) database_metadata
  The static metadata about the backend database server for this connection.
- - (self) debug { ... }
  Send a DEBUG command to dump debug information to the server's stdout.
- - (self) exception_handler { ... }
- - (self) get_internal_statistics { ... }
  Send a STATISTICS command to get a human readable string of the server internal status.
- - (self) ping { ... }
  Send a PING command to check if the server is alive.
- - (self) prepare(sql = nil) { ... }
- - (::VertxSqlClient::PreparedQuery) prepared_query(sql = nil)
  Create a prepared query, one of the or methods must be called to execute the query.
- - (::VertxSqlClient::Query) query(sql = nil)
  Create a query, the method must be called to execute the query.
- - (self) reset_connection { ... }
  Send a RESET_CONNECTION command to reset the session state.
- - (self) set_option(option = nil) { ... }
  Send a SET_OPTION command to set options for the current connection.
- - (self) specify_schema(schemaName = nil) { ... }
  Send a INIT_DB command to change the default schema of the connection.
- - (true, false) ssl?
  Whether the connection uses SSL.

## Class Method Details

### + (`Boolean`) accept?(obj)

Returns:

- (`Boolean`)

    27
    28
    29
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 27

    def @@j_api_type.accept?(obj)
      obj.class == MySQLConnection
    end

### + (`void`) connect(vertx, connectOptions, handler) { ... } + (`void`) connect(vertx, connectionUri, handler) { ... }

This method returns an undefined value.

Like #connect with options build from `connectionUri`.

Overloads:

- + (`void`) connect(vertx, connectOptions, handler) { ... }

  Parameters:

  - vertx (`::Vertx::Vertx`) —
    the vertx instance
  - connectOptions (`Hash`) —
    the options for the connection

  Yields:

  - the handler called with the connection or the failure
- + (`void`) connect(vertx, connectionUri, handler) { ... }

  Parameters:

  - vertx (`::Vertx::Vertx`)
  - connectionUri (`String`)

  Yields:

Raises:

- (`ArgumentError`)

    104
    105
    106
    107
    108
    109
    110
    111
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 104

    def self.connect(param_1=nil,param_2=nil)
      if param_1.class.method_defined?(:j_del) && param_2.class == Hash && block_given?
        return Java::IoVertxMysqlclient::MySQLConnection.java_method(:connect, [Java::IoVertxCore::Vertx.java_class,Java::IoVertxMysqlclient::MySQLConnectOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1.j_del,Java::IoVertxMysqlclient::MySQLConnectOptions.new(::Vertx::Util::Utils.to_json_object(param_2)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::VertxMysqlClient::MySQLConnection) : nil) }))
      elsif param_1.class.method_defined?(:j_del) && param_2.class == String && block_given?
        return Java::IoVertxMysqlclient::MySQLConnection.java_method(:connect, [Java::IoVertxCore::Vertx.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1.j_del,param_2,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::VertxMysqlClient::MySQLConnection) : nil) }))
      end
      raise ArgumentError, "Invalid arguments when calling connect(#{param_1},#{param_2})"
    end

### + (`Object`) j_api_type

    36
    37
    38
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 36

    def self.j_api_type
      @@j_api_type
    end

### + (`Object`) j_class

    39
    40
    41
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 39

    def self.j_class
      Java::IoVertxMysqlclient::MySQLConnection.java_class
    end

### + (`Object`) unwrap(obj)

    33
    34
    35
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 33

    def @@j_api_type.unwrap(obj)
      obj.j_del
    end

### + (`Object`) wrap(obj)

    30
    31
    32
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 30

    def @@j_api_type.wrap(obj)
      MySQLConnection.new(obj)
    end

## Instance Method Details

### - (`::VertxSqlClient::Transaction`) begin

Begin a transaction and returns a for controlling and tracking this transaction.

When the connection is explicitely closed, any inflight transaction is rollbacked.

Returns:

- (`::VertxSqlClient::Transaction`) —
  the transaction instance

Raises:

- (`ArgumentError`)

    66
    67
    68
    69
    70
    71
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 66

    def begin
      if !block_given?
        return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:begin, []).call(),::VertxSqlClient::Transaction)
      end
      raise ArgumentError, "Invalid arguments when calling begin()"
    end

### - (`self`) change_user(options = nil) { ... }

Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.

Parameters:

- options (`Hash`) (defaults to: `nil`) —
  authentication options

Yields:

- the handler

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    206
    207
    208
    209
    210
    211
    212
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 206

    def change_user(options=nil)
      if options.class == Hash && block_given?
        @j_del.java_method(:changeUser, [Java::IoVertxMysqlclient::MySQLAuthOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxMysqlclient::MySQLAuthOptions.new(::Vertx::Util::Utils.to_json_object(options)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling change_user(#{options})"
    end

### - (`void`) close

This method returns an undefined value.

Close the current connection after all the pending commands have been processed.

Raises:

- (`ArgumentError`)

    81
    82
    83
    84
    85
    86
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 81

    def close
      if !block_given?
        return @j_del.java_method(:close, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling close()"
    end

### - (`self`) close_handler { ... }

Yields:

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    133
    134
    135
    136
    137
    138
    139
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 133

    def close_handler
      if block_given?
        @j_del.java_method(:closeHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield })
        return self
      end
      raise ArgumentError, "Invalid arguments when calling close_handler()"
    end

### - (`::VertxSqlClient::DatabaseMetadata`) database_metadata

Returns The static metadata about the backend database server for this connection

Returns:

- (`::VertxSqlClient::DatabaseMetadata`) —
  The static metadata about the backend database server for this connection

Raises:

- (`ArgumentError`)

    88
    89
    90
    91
    92
    93
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 88

    def database_metadata
      if !block_given?
        return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:databaseMetadata, []).call(),::VertxSqlClient::DatabaseMetadata)
      end
      raise ArgumentError, "Invalid arguments when calling database_metadata()"
    end

### - (`self`) debug { ... }

Send a DEBUG command to dump debug information to the server's stdout.

Yields:

- the handler notified with the execution result

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    195
    196
    197
    198
    199
    200
    201
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 195

    def debug
      if block_given?
        @j_del.java_method(:debug, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling debug()"
    end

### - (`self`) exception_handler { ... }

Yields:

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    124
    125
    126
    127
    128
    129
    130
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 124

    def exception_handler
      if block_given?
        @j_del.java_method(:exceptionHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling exception_handler()"
    end

### - (`self`) get_internal_statistics { ... }

Send a STATISTICS command to get a human readable string of the server internal status.

Yields:

- the handler notified with the execution result

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    164
    165
    166
    167
    168
    169
    170
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 164

    def get_internal_statistics
      if block_given?
        @j_del.java_method(:getInternalStatistics, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling get_internal_statistics()"
    end

### - (`self`) ping { ... }

Send a PING command to check if the server is alive.

Yields:

- the handler notified when the server responses to client

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    143
    144
    145
    146
    147
    148
    149
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 143

    def ping
      if block_given?
        @j_del.java_method(:ping, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling ping()"
    end

### - (`self`) prepare(sql = nil) { ... }

Parameters:

- sql (`String`) (defaults to: `nil`)

Yields:

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    115
    116
    117
    118
    119
    120
    121
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 115

    def prepare(sql=nil)
      if sql.class == String && block_given?
        @j_del.java_method(:prepare, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(sql,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::VertxSqlClient::PreparedStatement) : nil) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling prepare(#{sql})"
    end

### - (`::VertxSqlClient::PreparedQuery`) prepared_query(sql = nil)

Create a prepared query, one of the or methods must be called to execute the query.

Parameters:

- sql (`String`) (defaults to: `nil`)

Returns:

- (`::VertxSqlClient::PreparedQuery`) —
  the prepared query

Raises:

- (`ArgumentError`)

    55
    56
    57
    58
    59
    60
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 55

    def prepared_query(sql=nil)
      if sql.class == String && !block_given?
        return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:preparedQuery, [Java::java.lang.String.java_class]).call(sql),::VertxSqlClient::PreparedQuery,::VertxSqlClient::RowSet.j_api_type)
      end
      raise ArgumentError, "Invalid arguments when calling prepared_query(#{sql})"
    end

### - (`::VertxSqlClient::Query`) query(sql = nil)

Create a query, the method must be called to execute the query.

Parameters:

- sql (`String`) (defaults to: `nil`)

Returns:

- (`::VertxSqlClient::Query`) —
  the query

Raises:

- (`ArgumentError`)

    45
    46
    47
    48
    49
    50
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 45

    def query(sql=nil)
      if sql.class == String && !block_given?
        return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:query, [Java::java.lang.String.java_class]).call(sql),::VertxSqlClient::Query,::VertxSqlClient::RowSet.j_api_type)
      end
      raise ArgumentError, "Invalid arguments when calling query(#{sql})"
    end

### - (`self`) reset_connection { ... }

Send a RESET_CONNECTION command to reset the session state.

Yields:

- the handler notified with the execution result

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    185
    186
    187
    188
    189
    190
    191
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 185

    def reset_connection
      if block_given?
        @j_del.java_method(:resetConnection, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling reset_connection()"
    end

### - (`self`) set_option(option = nil) { ... }

Send a SET_OPTION command to set options for the current connection.

Parameters:

- option (`:MYSQL_OPTION_MULTI_STATEMENTS_ON`, `:MYSQL_OPTION_MULTI_STATEMENTS_OFF`) (defaults to: `nil`) —
  the options to set

Yields:

- the handler notified with the execution result

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    175
    176
    177
    178
    179
    180
    181
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 175

    def set_option(option=nil)
      if option.class == Symbol && block_given?
        @j_del.java_method(:setOption, [Java::IoVertxMysqlclient::MySQLSetOption.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxMysqlclient::MySQLSetOption.valueOf(option.to_s),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling set_option(#{option})"
    end

### - (`self`) specify_schema(schemaName = nil) { ... }

Send a INIT_DB command to change the default schema of the connection.

Parameters:

- schemaName (`String`) (defaults to: `nil`) —
  name of the schema to change to

Yields:

- the handler notified with the execution result

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    154
    155
    156
    157
    158
    159
    160
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 154

    def specify_schema(schemaName=nil)
      if schemaName.class == String && block_given?
        @j_del.java_method(:specifySchema, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(schemaName,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling specify_schema(#{schemaName})"
    end

### - (`true`, `false`) ssl?

Returns whether the connection uses SSL

Returns:

- (`true`, `false`) —
  whether the connection uses SSL

Raises:

- (`ArgumentError`)

    73
    74
    75
    76
    77
    78
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 73

    def ssl?
      if !block_given?
        return @j_del.java_method(:isSSL, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling ssl?()"
    end