@vertx/sql-client
Advanced tools
Comparing version 3.9.4 to 4.0.0-CR1
261
index.d.ts
@@ -33,2 +33,4 @@ /* | ||
import { Future } from '@vertx/core'; | ||
/** | ||
@@ -50,9 +52,2 @@ * A cursor that reads progressively rows from the database, it is useful for reading very large result sets. | ||
/** | ||
* Release the cursor. | ||
* <p/> | ||
* It should be called for prepared queries executed with a fetch size. | ||
*/ | ||
close() : void; | ||
/** | ||
* Like {@link Cursor#close} but with a <code>completionHandler</code> called when the cursor has been released. | ||
@@ -68,3 +63,3 @@ */ | ||
/** | ||
* Contains static metadata about the backend database server | ||
* Contains static metadata about the backend database server | ||
*/ | ||
@@ -94,3 +89,3 @@ export abstract class DatabaseMetadata { | ||
/** | ||
* A pool of SQL connections. | ||
* A connection pool which reuses a number of SQL connections. | ||
*/ | ||
@@ -135,11 +130,30 @@ export abstract class Pool extends SqlClient { | ||
/** | ||
* Borrow a connection from the pool and begin a transaction, the underlying connection will be returned | ||
* to the pool when the transaction ends. | ||
* Execute the given <code>function</code> within a transaction. | ||
* | ||
* <p>The <code>function</code> is passed a client executing all operations within a transaction. | ||
* When the future returned by the function | ||
* <ul> | ||
* <li>succeeds the transaction commits</li> | ||
* <li>fails the transaction rollbacks</li> | ||
* </ul> | ||
* | ||
* <p>The <code>handler</code> is given a success result when the function returns a succeeded futures and the transaction commits. | ||
* Otherwise it is given a failure result. | ||
*/ | ||
begin(handler: ((res: AsyncResult<Transaction>) => void) | Handler<AsyncResult<Transaction>>) : void; | ||
withTransaction<T>(__function: (arg: SqlConnection) => Future<T>, handler: ((res: AsyncResult<T>) => void) | Handler<AsyncResult<T>>) : void; | ||
/** | ||
* Get a connection from the pool and execute the given <code>function</code>. | ||
* | ||
* <p> When the future returned by the <code>function</code> completes, the connection is returned to the pool. | ||
* | ||
* <p>The <code>handler</code> is given a success result when the function returns a succeeded futures. | ||
* Otherwise it is given a failure result. | ||
*/ | ||
withConnection<T>(__function: (arg: SqlConnection) => Future<T>, handler: ((res: AsyncResult<T>) => void) | Handler<AsyncResult<T>>) : void; | ||
/** | ||
* Close the pool and release the associated resources. | ||
*/ | ||
close() : void; | ||
close(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>) : void; | ||
} | ||
@@ -215,7 +229,2 @@ | ||
/** | ||
* Close the prepared query and release its resources. | ||
*/ | ||
close() : void; | ||
/** | ||
* Like {@link PreparedStatement#close} but notifies the <code>completionHandler</code> when it's closed. | ||
@@ -227,3 +236,3 @@ */ | ||
/** | ||
* Represents which kind the property is. | ||
* The kind of the property, this can be used to fetch some specific property of the [execution result] {@link SqlResult}. | ||
*/ | ||
@@ -258,3 +267,3 @@ export abstract class PropertyKind<T> { | ||
/** | ||
* Represents single row of the result set. | ||
* A single row of the [execution result rowset] {@link RowSet}. | ||
*/ | ||
@@ -271,3 +280,3 @@ export abstract class Row extends Tuple { | ||
/** | ||
* Get a column name for the given <code>column</code>. | ||
* Get a column name at <code>pos</code>. | ||
*/ | ||
@@ -277,8 +286,8 @@ getColumnName(pos: number) : string; | ||
/** | ||
* Get a column position for the given column <code>name</code>. | ||
* Get a column position for the given @code column}. | ||
*/ | ||
getColumnIndex(name: string) : number; | ||
getColumnIndex(column: string) : number; | ||
/** | ||
* Get an object value for the given <code>column</code>. | ||
* Get a value for the given <code>column</code>. | ||
*/ | ||
@@ -323,2 +332,12 @@ getValue(name: string | number) : any; | ||
/** | ||
* Get a value for the given <code>column</code>. | ||
*/ | ||
getJsonObject(column: string) : { [key: string]: any }; | ||
/** | ||
* Get a value for the given <code>column</code>. | ||
*/ | ||
getJsonArray(column: string) : any[]; | ||
/** | ||
* Get a buffer value for the given <code>column</code>. | ||
@@ -329,4 +348,27 @@ */ | ||
/** | ||
* Get a numeric value for the given <code>column</code>. | ||
* Like {@link Tuple#get} but specifying the <code>column</code> instead of the position. | ||
*/ | ||
get<T>(type: any /* TODO: class */, column: string) : T; | ||
/** | ||
* Return a JSON object representation of the row. | ||
* | ||
* <p>Column names are mapped to JSON keys. | ||
* | ||
* <p>The following rules are applied for the column values: | ||
* | ||
* <ul> | ||
* <li>number, boolean and string are preserved</li> | ||
* <li>the <code>null</code> value is preserved</li> | ||
* <li>JSON elements are preserved</li> | ||
* <li><code>Buffer</code> are converted to base64 encoded strings</li> | ||
* <li>array is mapped <code>JsonArray</code></li> | ||
* <li>otherwise the type converted to a string</li> | ||
* </ul> | ||
*/ | ||
toJson() : { [key: string]: any }; | ||
/** | ||
* Get value for the given <code>column</code>. | ||
*/ | ||
getNumeric(name: string | number) : any /* io.vertx.sqlclient.data.Numeric */; | ||
@@ -417,2 +459,12 @@ | ||
*/ | ||
getJsonObjectArray(column: string) : any /* io.vertx.core.json.JsonObject[] */; | ||
/** | ||
* Get an array of value for the given <code>column</code>. | ||
*/ | ||
getJsonArrayArray(column: string) : any /* io.vertx.core.json.JsonArray[] */; | ||
/** | ||
* Get an array of value for the given <code>column</code>. | ||
*/ | ||
getTemporalArray(name: string | number) : any /* java.time.temporal.Temporal[] */; | ||
@@ -466,7 +518,8 @@ | ||
/** | ||
* A set of rows. | ||
* The execution result of the row set of a query provided as <code><R></code>, commonly used as a <code>RowSet<Row></code>. | ||
* Using a collector query might provide a different result. | ||
*/ | ||
export abstract class RowSet<R> extends SqlResult<RowSet<R>> { | ||
/** | ||
* Get the result value. | ||
* Get the execution result value, the execution result type may vary such as a [rowSet] {@link RowSet} or even a string. | ||
*/ | ||
@@ -488,8 +541,4 @@ value() : RowSet<R>; | ||
export abstract class RowStream<T> implements ReadStream<T> { | ||
fetch(arg0: number) : ReadStream<T>; | ||
pipe() : Pipe<T>; | ||
pipeTo(dst: WriteStream<T>) : void; | ||
pipeTo(dst: WriteStream<T>, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>) : void; | ||
@@ -507,6 +556,3 @@ | ||
/** | ||
* Close the stream and release the resources. | ||
*/ | ||
close() : void; | ||
fetch(l: number) : RowStream<T>; | ||
@@ -520,3 +566,3 @@ /** | ||
/** | ||
* Defines the client operations with a database server. | ||
* Defines common SQL client operations with a database server. | ||
*/ | ||
@@ -538,11 +584,11 @@ export abstract class SqlClient { | ||
*/ | ||
close() : void; | ||
close(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>) : void; | ||
} | ||
/** | ||
* A connection to database server. | ||
* A connection to the database server. | ||
*/ | ||
export abstract class SqlConnection extends SqlClient { | ||
/** | ||
* Create a prepared query. | ||
* Create a prepared statement using the given <code>sql</code> string. | ||
*/ | ||
@@ -567,3 +613,3 @@ prepare(sql: string, handler: ((res: AsyncResult<PreparedStatement>) => void) | Handler<AsyncResult<PreparedStatement>>) : SqlConnection; | ||
*/ | ||
begin() : Transaction; | ||
begin(handler: ((res: AsyncResult<Transaction>) => void) | Handler<AsyncResult<Transaction>>) : void; | ||
@@ -577,3 +623,3 @@ /** | ||
*/ | ||
close() : void; | ||
close(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>) : void; | ||
@@ -586,3 +632,3 @@ /** | ||
/** | ||
* Represents the result of an operation on database. | ||
* An interface that represents the execution result of an operation on the database server. | ||
*/ | ||
@@ -611,3 +657,3 @@ export abstract class SqlResult<T> { | ||
/** | ||
* Get the property with the specified {@link PropertyKind}. | ||
* Get the specific property with the specified {@link PropertyKind}. | ||
*/ | ||
@@ -617,3 +663,3 @@ property<V>(propertyKind: PropertyKind<V>) : V; | ||
/** | ||
* Get the result value. | ||
* Get the execution result value, the execution result type may vary such as a [rowSet] {@link RowSet} or even a string. | ||
*/ | ||
@@ -630,16 +676,6 @@ value() : T; | ||
/** | ||
* A transaction that allows to control the transaction and receive events. | ||
* A transaction. | ||
*/ | ||
export abstract class Transaction extends SqlClient { | ||
export abstract class Transaction { | ||
/** | ||
* Create a prepared query. | ||
*/ | ||
prepare(sql: string, handler: ((res: AsyncResult<PreparedStatement>) => void) | Handler<AsyncResult<PreparedStatement>>) : Transaction; | ||
/** | ||
* Commit the current transaction. | ||
*/ | ||
commit() : void; | ||
/** | ||
* Like {@link Transaction#commit} with an handler to be notified when the transaction commit has completed | ||
@@ -650,7 +686,2 @@ */ | ||
/** | ||
* Rollback the current transaction. | ||
*/ | ||
rollback() : void; | ||
/** | ||
* Like {@link Transaction#rollback} with an handler to be notified when the transaction rollback has completed | ||
@@ -661,10 +692,10 @@ */ | ||
/** | ||
* Set an handler to be called when the transaction is aborted. | ||
* Return the transaction completion <code>Future</code> that | ||
* | ||
* <ul> | ||
* <li>succeeds when the transaction commits</li> | ||
* <li>fails with {@link TransactionRollbackException} when the transaction rollbacks</li> | ||
* </ul> | ||
*/ | ||
abortHandler(handler: ((res: void) => void) | Handler<void>) : Transaction; | ||
/** | ||
* Rollback the transaction and release the associated resources. | ||
*/ | ||
close() : void; | ||
completion() : Future<void>; | ||
} | ||
@@ -773,2 +804,14 @@ | ||
/** | ||
* Get a value at <code>pos</code>. | ||
*/ | ||
getJsonObject(pos: number) : { [key: string]: any }; | ||
/** | ||
* Get a value at <code>pos</code>. | ||
*/ | ||
getJsonArray(pos: number) : any[]; | ||
getJsonElement(pos: number) : any; | ||
/** | ||
* Get a buffer value at <code>pos</code>. | ||
@@ -819,2 +862,12 @@ */ | ||
/** | ||
* Add a value at the end of the tuple. | ||
*/ | ||
addJsonObject(value: { [key: string]: any }) : Tuple; | ||
/** | ||
* Add a value at the end of the tuple. | ||
*/ | ||
addJsonArray(value: any[]) : Tuple; | ||
/** | ||
* Add a buffer value at the end of the tuple. | ||
@@ -824,3 +877,9 @@ */ | ||
get<T>(type: any /* TODO: class */, pos: number) : T; | ||
/** | ||
* Get the the at the specified <code>position</code> and the specified <code>type</code>. | ||
* | ||
* <p>The type can be one of the types returned by the row (e.g <code>String.class</code>) or an array | ||
* of the type (e.g <code>String[].class</code>)). | ||
*/ | ||
get<T>(type: any /* TODO: class */, position: number) : T; | ||
@@ -856,2 +915,5 @@ /** | ||
* Get LocalDate value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>LocalDateTime</code> will be | ||
* coerced to <code>LocalDate</code>. | ||
*/ | ||
@@ -862,2 +924,5 @@ getLocalDate(pos: number) : Date; | ||
* Get LocalTime value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>LocalDateTime</code> will be | ||
* coerced to <code>LocalTime</code>. | ||
*/ | ||
@@ -873,2 +938,5 @@ getLocalTime(pos: number) : any /* java.time.LocalTime */; | ||
* Get OffsetTime value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>OffsetDateTime</code> will be | ||
* coerced to <code>OffsetTime</code>. | ||
*/ | ||
@@ -894,2 +962,5 @@ getOffsetTime(pos: number) : any /* java.time.OffsetTime */; | ||
* Get an array of Boolean value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>Object[]</code> will be | ||
* coerced to <code>Boolean[]</code>. | ||
*/ | ||
@@ -900,2 +971,5 @@ getBooleanArray(pos: number) : boolean[]; | ||
* Get an array of Short value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>Number[]</code> or <code>Object[]</code> will be | ||
* coerced to <code>Short[]</code>. | ||
*/ | ||
@@ -906,2 +980,5 @@ getShortArray(pos: number) : number[]; | ||
* Get an array of Integer value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>Number[]</code> or <code>Object[]</code> will be | ||
* coerced to <code>Integer[]</code>. | ||
*/ | ||
@@ -912,2 +989,5 @@ getIntegerArray(pos: number) : number[]; | ||
* Get an array of Long value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>Number[]</code> or <code>Object[]</code> will be | ||
* coerced to <code>Long[]</code>. | ||
*/ | ||
@@ -918,2 +998,5 @@ getLongArray(pos: number) : number[]; | ||
* Get an array of Float value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>Number[]</code> or <code>Object[]</code> will be | ||
* coerced to <code>Float[]</code>. | ||
*/ | ||
@@ -924,2 +1007,5 @@ getFloatArray(pos: number) : number[]; | ||
* Get an array of Double value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>Number[]</code> or <code>Object[]</code> will be | ||
* coerced to <code>Double[]</code>. | ||
*/ | ||
@@ -935,2 +1021,5 @@ getDoubleArray(pos: number) : number[]; | ||
* Get an array of String value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>Object[]</code> will be | ||
* coerced to <code>String[]</code>. | ||
*/ | ||
@@ -942,2 +1031,14 @@ getStringArray(pos: number) : string[]; | ||
*/ | ||
getJsonObjectArray(pos: number) : any /* io.vertx.core.json.JsonObject[] */; | ||
/** | ||
* Get an array of value at <code>pos</code>. | ||
*/ | ||
getJsonArrayArray(pos: number) : any /* io.vertx.core.json.JsonArray[] */; | ||
getJsonElementArray(pos: number) : any[]; | ||
/** | ||
* Get an array of value at <code>pos</code>. | ||
*/ | ||
getTemporalArray(pos: number) : any /* java.time.temporal.Temporal[] */; | ||
@@ -947,2 +1048,5 @@ | ||
* Get an array of value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>LocalDateTime[]</code> will be | ||
* coerced to <code>LocalDate[]</code>. | ||
*/ | ||
@@ -953,2 +1057,5 @@ getLocalDateArray(pos: number) : any /* java.time.LocalDate[] */; | ||
* Get an array of value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>LocalDateTime[]</code> will be | ||
* coerced to <code>LocalTime[]</code>. | ||
*/ | ||
@@ -964,2 +1071,5 @@ getLocalTimeArray(pos: number) : any /* java.time.LocalTime[] */; | ||
* Get an array of value at <code>pos</code>. | ||
* | ||
* <p>Target element instance of <code>OffsetDateTime[]</code> will be | ||
* coerced to <code>OffsetTime[]</code>. | ||
*/ | ||
@@ -1035,2 +1145,5 @@ getOffsetTimeArray(pos: number) : any /* java.time.OffsetTime[] */; | ||
* Add an array of <code>Integer</code> value at the end of the tuple. | ||
* | ||
* <p>Target element instance of <code>Number[]</code> will be | ||
* coerced to <code>Integer[]</code>. | ||
*/ | ||
@@ -1062,2 +1175,12 @@ addIntegerArray(value: number[]) : Tuple; | ||
*/ | ||
addJsonObjectArray(value: any /* io.vertx.core.json.JsonObject[] */) : Tuple; | ||
/** | ||
* Add an array of value at the end of the tuple. | ||
*/ | ||
addJsonArrayArray(value: any /* io.vertx.core.json.JsonArray[] */) : Tuple; | ||
/** | ||
* Add an array of value at the end of the tuple. | ||
*/ | ||
addTemporalArray(value: any /* java.time.temporal.Temporal[] */) : Tuple; | ||
@@ -1064,0 +1187,0 @@ |
@@ -20,3 +20,3 @@ /* | ||
/** | ||
* @typedef { import("es4x") } Java | ||
* @typedef { import("@vertx/core") } Java | ||
*/ | ||
@@ -23,0 +23,0 @@ module.exports = { |
@@ -50,10 +50,11 @@ /* | ||
import { ProxyOptions } from '@vertx/core/options'; | ||
import { JksOptions } from '@vertx/core/options'; | ||
import { PfxOptions } from '@vertx/core/options'; | ||
import { OpenSSLEngineOptions } from '@vertx/core/options'; | ||
import { ProxyOptions } from '@vertx/core/options'; | ||
import { Buffer } from '@vertx/core'; | ||
import { PemKeyCertOptions } from '@vertx/core/options'; | ||
import { JksOptions } from '@vertx/core/options'; | ||
import { PemTrustOptions } from '@vertx/core/options'; | ||
import { TracingPolicy } from '@vertx/core/enums'; | ||
import { JdkSSLEngineOptions } from '@vertx/core/options'; | ||
import { PfxOptions } from '@vertx/core/options'; | ||
@@ -137,2 +138,4 @@ /** | ||
setKeyCertOptions(keyCertOptions: any /* io.vertx.core.net.KeyCertOptions */): SqlConnectOptions; | ||
getKeyStoreOptions(): JksOptions; | ||
@@ -257,2 +260,6 @@ | ||
getSslEngineOptions(): any /* io.vertx.core.net.SSLEngineOptions */; | ||
setSslEngineOptions(sslEngineOptions: any /* io.vertx.core.net.SSLEngineOptions */): SqlConnectOptions; | ||
getSslHandshakeTimeout(): number; | ||
@@ -286,2 +293,12 @@ | ||
/** | ||
* Set the tracing policy for the client behavior when Vert.x has tracing enabled. | ||
*/ | ||
getTracingPolicy(): TracingPolicy; | ||
/** | ||
* Set the tracing policy for the client behavior when Vert.x has tracing enabled. | ||
*/ | ||
setTracingPolicy(tracingPolicy: TracingPolicy): SqlConnectOptions; | ||
getTrafficClass(): number; | ||
@@ -295,2 +312,6 @@ | ||
getTrustOptions(): any /* io.vertx.core.net.TrustOptions */; | ||
setTrustOptions(trustOptions: any /* io.vertx.core.net.TrustOptions */): SqlConnectOptions; | ||
getTrustStoreOptions(): JksOptions; | ||
@@ -304,6 +325,2 @@ | ||
isUsePooledBuffers(): boolean; | ||
setUsePooledBuffers(usePooledBuffers: boolean): SqlConnectOptions; | ||
/** | ||
@@ -310,0 +327,0 @@ * Specify the user account to be used for the authentication. |
@@ -20,3 +20,3 @@ /* | ||
/** | ||
* @typedef { import("es4x") } Java | ||
* @typedef { import("@vertx/core") } Java | ||
*/ | ||
@@ -23,0 +23,0 @@ module.exports = { |
{ | ||
"name" : "@vertx/sql-client", | ||
"description" : "Generated Eclipse Vert.x bindings for 'vertx-sql-client'", | ||
"version" : "3.9.4", | ||
"version" : "4.0.0-CR1", | ||
"license" : "Apache-2.0", | ||
@@ -10,6 +10,6 @@ "public" : true, | ||
"artifactId" : "vertx-sql-client", | ||
"version" : "3.9.4" | ||
"version" : "4.0.0.CR1" | ||
}, | ||
"dependencies" : { | ||
"@vertx/core" : "3.9.4" | ||
"@vertx/core" : "4.0.0-CR1" | ||
}, | ||
@@ -19,2 +19,7 @@ "main" : "index.js", | ||
"types" : "index.d.ts", | ||
"exports" : { | ||
"." : "./index.mjs", | ||
"./index" : "./index.mjs", | ||
"./options" : "./options.mjs" | ||
}, | ||
"sideEffects" : false, | ||
@@ -21,0 +26,0 @@ "repository" : { |
 | ||
 | ||
 | ||
 | ||
@@ -5,0 +5,0 @@ Generated JavaScript bindings for Eclipse Vert.x. |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
48917
1321
2
+ Added@vertx/core@4.0.0-CR1(transitive)
- Removed@vertx/core@3.9.4(transitive)
Updated@vertx/core@4.0.0-CR1