Class: VertxPgClient::PgConnection
- Inherits:
-
VertxSqlClient::SqlConnection
- Object
- VertxSqlClient::SqlClient
- VertxSqlClient::SqlConnection
- VertxPgClient::PgConnection
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_connection.rb
Overview
A connection to Postgres.
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.
-
- (::VertxPgClient::PgConnection) cancel_request { ... }
Send a request cancellation message to tell the server to cancel processing request in this connection.
-
- (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) exception_handler { ... }
-
- (self) notification_handler { ... }
Set an handler called when the connection receives notification on a channel.
- - (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.
-
- (Fixnum) process_id
The process ID of the target backend.
-
- (::VertxSqlClient::Query) query(sql = nil)
Create a query, the method must be called to execute the query.
-
- (Fixnum) secret_key
The secret key for the target backend.
-
- (true, false) ssl?
Whether the connection uses SSL.
Class Method Details
+ (Boolean) accept?(obj)
27 28 29 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_connection.rb', line 27 def @@j_api_type.accept?(obj) obj.class == PgConnection end |
+ (void) connect(vertx, handler) { ... } + (void) connect(vertx, options, handler) { ... } + (void) connect(vertx, connectionUri, handler) { ... }
This method returns an undefined value.
Like #connect with options build fromconnectionUri
.
107 108 109 110 111 112 113 114 115 116 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_connection.rb', line 107 def self.connect(param_1=nil,param_2=nil) if param_1.class.method_defined?(:j_del) && block_given? && param_2 == nil return Java::IoVertxPgclient::PgConnection.java_method(:connect, [Java::IoVertxCore::Vertx.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::VertxPgClient::PgConnection) : nil) })) elsif param_1.class.method_defined?(:j_del) && param_2.class == Hash && block_given? return Java::IoVertxPgclient::PgConnection.java_method(:connect, [Java::IoVertxCore::Vertx.java_class,Java::IoVertxPgclient::PgConnectOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1.j_del,Java::IoVertxPgclient::PgConnectOptions.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,::VertxPgClient::PgConnection) : nil) })) elsif param_1.class.method_defined?(:j_del) && param_2.class == String && block_given? return Java::IoVertxPgclient::PgConnection.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,::VertxPgClient::PgConnection) : 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-pg-client/pg_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-pg-client/pg_connection.rb', line 39 def self.j_class Java::IoVertxPgclient::PgConnection.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-pg-client/pg_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-pg-client/pg_connection.rb', line 30 def @@j_api_type.wrap(obj) PgConnection.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.
66 67 68 69 70 71 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_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 |
- (::VertxPgClient::PgConnection) cancel_request { ... }
Send a request cancellation message to tell the server to cancel processing request in this connection.
Note: Use this with caution because the cancellation signal may or may not have any effect.
Note: Use this with caution because the cancellation signal may or may not have any effect.
134 135 136 137 138 139 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_connection.rb', line 134 def cancel_request if block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:cancelRequest, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) })),::VertxPgClient::PgConnection) end raise ArgumentError, "Invalid arguments when calling cancel_request()" end |
- (void) close
This method returns an undefined value.
Close the current connection after all the pending commands have been processed.
81 82 83 84 85 86 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_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 { ... }
177 178 179 180 181 182 183 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_connection.rb', line 177 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
88 89 90 91 92 93 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_connection.rb', line 88 def 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) exception_handler { ... }
168 169 170 171 172 173 174 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_connection.rb', line 168 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) notification_handler { ... }
Set an handler called when the connection receives notification on a channel.
The handler is called with the Hash and has access to the channel name
and the notification payload.
123 124 125 126 127 128 129 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_connection.rb', line 123 def notification_handler if block_given? @j_del.java_method(:notificationHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(event != nil ? JSON.parse(event.toJson.encode) : nil) })) return self end raise ArgumentError, "Invalid arguments when calling notification_handler()" end |
- (self) prepare(sql = nil) { ... }
158 159 160 161 162 163 164 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_connection.rb', line 158 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.
55 56 57 58 59 60 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_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 |
- (Fixnum) process_id
Returns The process ID of the target backend
141 142 143 144 145 146 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_connection.rb', line 141 def process_id if !block_given? return @j_del.java_method(:processId, []).call() end raise ArgumentError, "Invalid arguments when calling process_id()" end |
- (::VertxSqlClient::Query) query(sql = nil)
Create a query, the method must be called to execute the query.
45 46 47 48 49 50 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_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 |
- (Fixnum) secret_key
Returns The secret key for the target backend
148 149 150 151 152 153 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_connection.rb', line 148 def secret_key if !block_given? return @j_del.java_method(:secretKey, []).call() end raise ArgumentError, "Invalid arguments when calling secret_key()" end |
- (true, false) ssl?
Returns whether the connection uses SSL
73 74 75 76 77 78 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-pg-client/pg_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 |