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 { ... }
- - (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) { ... }
- - (self) prepared_batch(sql = nil, batch = nil) { ... }
- - (self) prepared_query(sql = nil, arguments = nil) { ... }
- - (self) query(sql = nil) { ... }
- - (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`)

    24
    25
    26
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 24

    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`)

    86
    87
    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 86

    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

    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 self.j_api_type
      @@j_api_type
    end

### + (`Object`) j_class

    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_class
      Java::IoVertxMysqlclient::MySQLConnection.java_class
    end

### + (`Object`) unwrap(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.unwrap(obj)
      obj.j_del
    end

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

    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.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`)

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

    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, only username, password, database, collation and properties will be used.

Yields:

- the handler

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    212
    213
    214
    215
    216
    217
    218
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 212

    def change_user(options=nil)
      if options.class == Hash && block_given?
        @j_del.java_method(:changeUser, [Java::IoVertxMysqlclient::MySQLConnectOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxMysqlclient::MySQLConnectOptions.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`)

    59
    60
    61
    62
    63
    64
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 59

    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`)

    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 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

### - (`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`)

    201
    202
    203
    204
    205
    206
    207
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 201

    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`)

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

    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`)

    170
    171
    172
    173
    174
    175
    176
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 170

    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`)

    149
    150
    151
    152
    153
    154
    155
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 149

    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`)

    97
    98
    99
    100
    101
    102
    103
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 97

    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::PreparedQuery) : nil) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling prepare(#{sql})"
    end

### - (`self`) prepared_batch(sql = nil, batch = nil) { ... }

Parameters:

- sql (`String`) (defaults to: `nil`)
- batch (`Array<::VertxSqlClient::Tuple>`) (defaults to: `nil`)

Yields:

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    69
    70
    71
    72
    73
    74
    75
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 69

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

### - (`self`) prepared_query(sql = nil, arguments = nil) { ... }

Parameters:

- sql (`String`) (defaults to: `nil`)
- arguments (`::VertxSqlClient::Tuple`) (defaults to: `nil`)

Yields:

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 126

    def prepared_query(sql=nil,arguments=nil)
      if sql.class == String && block_given? && arguments == nil
        @j_del.java_method(:preparedQuery, [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::RowSet) : nil) }))
        return self
      elsif sql.class == String && arguments.class.method_defined?(:j_del) && block_given?
        @j_del.java_method(:preparedQuery, [Java::java.lang.String.java_class,Java::IoVertxSqlclient::Tuple.java_class,Java::IoVertxCore::Handler.java_class]).call(sql,arguments.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::VertxSqlClient::RowSet) : nil) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling prepared_query(#{sql},#{arguments})"
    end

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

Parameters:

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

Yields:

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    139
    140
    141
    142
    143
    144
    145
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 139

    def query(sql=nil)
      if sql.class == String && block_given?
        @j_del.java_method(:query, [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::RowSet) : nil) }))
        return self
      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`)

    191
    192
    193
    194
    195
    196
    197
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 191

    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`)

    181
    182
    183
    184
    185
    186
    187
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 181

    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`)

    160
    161
    162
    163
    164
    165
    166
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 160

    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`)

    51
    52
    53
    54
    55
    56
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mysql-client/my_sql_connection.rb', line 51

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