Appearance

API: database ​

Source: db/database.ts

API Database

Usage ​

javascript
import { database } from "sdk/db";
import { response } from "sdk/http";

let connection = database.getConnection("SystemDB");
try {
    let statement = connection.prepareStatement("select * from DIRIGIBLE_EXTENSIONS");
    let resultSet = statement.executeQuery();
    while (resultSet.next()) {
        response.println("[path]: " + resultSet.getString("ARTEFACT_LOCATION"));
    }
    resultSet.close();
    statement.close();
} catch (e) {
    if (e instanceof Error) {
        console.error(e);
        response.println(e.message);
    } else {
        console.error("Something went wrong", e);
    }
} finally {
    connection.close();
}

response.flush();
response.close();

Classes ​

PreparedStatement ​

Statement object

Methods ​

close ​

  • close ():void

    Statement object

getResultSet ​

  • getResultSet ():ResultSet

execute ​

  • execute ():boolean

executeQuery ​

  • executeQuery ():ResultSet

executeUpdate ​

  • executeUpdate ():number

setNull ​

  • setNull (index:number, sqlType:number):void

setBinaryStream ​

  • setBinaryStream (parameterIndex:number, inputStream:InputStream, length?:number):void

setBoolean ​

  • setBoolean (index:number, value?:boolean):void

setByte ​

  • setByte (index:number, value?:any):void

setBlob ​

  • setBlob (index:number, value?:any):void

setClob ​

  • setClob (index:number, value?:any):void

setNClob ​

  • setNClob (index:number, value?:any):void

setBytesNative ​

  • setBytesNative (index:number, value?:any[]):void

setBytes ​

  • setBytes (index:number, value?:any[]):void

setDate ​

  • setDate (index:number, value?:string|Date):void

setDouble ​

  • setDouble (index:number, value?:number):void

setFloat ​

  • setFloat (index:number, value?:number):void

setInt ​

  • setInt (index:number, value?:number):void

setLong ​

  • setLong (index:number, value?:number):void

setShort ​

  • setShort (index:number, value?:number):void

setString ​

  • setString (index:number, value?:string):void

setTime ​

  • setTime (index:number, value?:string|Date):void

setTimestamp ​

  • setTimestamp (index:number, value?:string|Date):void

setBigDecimal ​

  • setBigDecimal (index:number, value?:number):void

setNString ​

  • setNString (index:number, value?:string):void

addBatch ​

  • addBatch ():void

executeBatch ​

  • executeBatch ():number[]

getMetaData ​

  • getMetaData ():any

getMoreResults ​

  • getMoreResults ():boolean

getParameterMetaData ​

  • getParameterMetaData ():any

getSQLWarning ​

  • getSQLWarning ():any

isClosed ​

  • isClosed ():boolean

CallableStatement ​

Methods ​

getResultSet ​

  • getResultSet ():ResultSet

executeQuery ​

  • executeQuery ():ResultSet

executeUpdate ​

  • executeUpdate ():number

registerOutParameter ​

  • registerOutParameter (parameterIndex:number, sqlType:keyoftypeofSQLTypes|number):void

registerOutParameterByScale ​

  • registerOutParameterByScale (parameterIndex:number, sqlType:keyoftypeofSQLTypes|number, scale:number):void

registerOutParameterByTypeName ​

  • registerOutParameterByTypeName (parameterIndex:number, sqlType:keyoftypeofSQLTypes|number, typeName:string):void

wasNull ​

  • wasNull ():boolean

getString ​

  • getString (parameterIndex:number):string

getBoolean ​

  • getBoolean (parameterIndex:number):boolean

getByte ​

  • getByte (parameterIndex:number):any

getShort ​

  • getShort (parameterIndex:number):number

    : byte

getInt ​

  • getInt (parameterIndex:number):number

getLong ​

  • getLong (parameterIndex:number):number

getFloat ​

  • getFloat (parameterIndex:number):number

getDouble ​

  • getDouble (parameterIndex:number):number

getDate ​

  • getDate (parameterIndex:number):Date

getTime ​

  • getTime (parameterIndex:number):Date

getTimestamp ​

  • getTimestamp (parameterIndex:number):Date

getObject ​

  • getObject (parameterIndex:number):any

getBigDecimal ​

  • getBigDecimal (parameterIndex:number):number

getRef ​

  • getRef (parameterIndex:number):any

    : sql.BigDecimal

getBytes ​

  • getBytes (parameterIndex:number):any[]

    : sql.Ref

getBytesNative ​

  • getBytesNative (parameterIndex:number):any[]

    : byte[]

getBlob ​

  • getBlob (parameterIndex:number):any

    : byte[]

getBlobNative ​

  • getBlobNative (parameterIndex:number):any

    : sql.Blob

getClob ​

  • getClob (parameterIndex:number):any

    : sql.Blob

getNClob ​

  • getNClob (parameterIndex:string|number):any

    : sql.Clob

getNString ​

  • getNString (parameterIndex:string|number):string

    : sql.NClob

getArray ​

  • getArray (parameterIndex:string|number):any[]

getURL ​

  • getURL (parameterIndex:string|number):any

    : sql.Array

getRowId ​

  • getRowId (parameterIndex:string|number):any

getSQLXML ​

  • getSQLXML (parameterIndex:string|number):any

    : sql.RowId

setURL ​

  • setURL (parameterIndex:number, value:any):void

    : sql.SQLXML

setNull ​

  • setNull (parameterIndex:number, sqlTypeStr:keyoftypeofSQLTypes|number, typeName?:string):void

setBoolean ​

  • setBoolean (parameterIndex:number, value?:boolean):void

setByte ​

  • setByte (parameterIndex:number, value?:any):void

setShort ​

  • setShort (parameterIndex:number, value?:number):void

setInt ​

  • setInt (parameterIndex:number, value?:number):void

setLong ​

  • setLong (parameterIndex:number, value?:number):void

setFloat ​

  • setFloat (parameterIndex:number, value?:number):void

setDouble ​

  • setDouble (parameterIndex:number, value?:number):void

setBigDecimal ​

  • setBigDecimal (parameterIndex:number, value?:number):void

setString ​

  • setString (parameterIndex:number, value?:string):void

setBytes ​

  • setBytes (parameterIndex:number, value?:any[]):void

setDate ​

  • setDate (parameterIndex:number, value?:string|Date):void

setTime ​

  • setTime (parameterIndex:number, value?:string|Date):void

setTimestamp ​

  • setTimestamp (parameterIndex:number, value?:string|Date):void

setAsciiStream ​

  • setAsciiStream (parameterIndex:number, inputStream:InputStream, length?:number):void

setBinaryStream ​

  • setBinaryStream (parameterIndex:number, inputStream:InputStream, length?:number):void

setObject ​

  • setObject (parameterIndex:number, value:any, targetSqlType?:number, scale?:number):void

setRowId ​

  • setRowId (parameterIndex:number, value:number):void

setNString ​

  • setNString (parameterIndex:number, value:string):void

    : RowId

setSQLXML ​

  • setSQLXML (parameterIndex:number, value:any):void

setBlob ​

  • setBlob (parameterIndex:number, value:any):void

setClob ​

  • setClob (parameterIndex:number, value:any):void

setNClob ​

  • setNClob (parameterIndex:number, value:any):void

execute ​

  • execute ():boolean

getMoreResults ​

  • getMoreResults ():boolean

getParameterMetaData ​

  • getParameterMetaData ():any

isClosed ​

  • isClosed ():boolean

    : ParameterMetaData

close ​

  • close ():void

    : ParameterMetaData

ResultSet ​

ResultSet object

Methods ​

toJson ​

  • toJson (limited=false, stringify=false):any[]

    Converts the ResultSet into a JSON array of objects.
    @param limited Whether to use limited JSON conversion (optimized).
    @param stringify Whether to return the JSON as a string or a parsed array.
    @returns A JavaScript array of objects representing the result set, or a string if stringify is true.

close ​

  • close ():void

getBigDecimal ​

  • getBigDecimal (identifier:number|string):any

getBoolean ​

  • getBoolean (identifier:number|string):boolean

    : BigDecimal

getByte ​

  • getByte (identifier:number|string):any

getBytes ​

  • getBytes (identifier:number|string):any[]

    : byte

getBytesNative ​

  • getBytesNative (identifier:number|string):any[]

    : byte[]

getBlob ​

  • getBlob (identifier:number|string):any

    : byte[]

getBlobNative ​

  • getBlobNative (identifier:number|string):any

    : sql.Blob

getClob ​

  • getClob (identifier:number|string):any

    : sql.Blob

getNClob ​

  • getNClob (identifier:number|string):any

    : sql.Clob

getDate ​

  • getDate (identifier:number|string):Date|undefined

    : sql.NClob

getDouble ​

  • getDouble (identifier:number|string):number

getFloat ​

  • getFloat (identifier:number|string):number

getInt ​

  • getInt (identifier:number|string):number

getLong ​

  • getLong (identifier:number|string):number

getShort ​

  • getShort (identifier:number|string):number

getString ​

  • getString (identifier:number|string):string

getTime ​

  • getTime (identifier:number|string):Date|undefined

getTimestamp ​

  • getTimestamp (identifier:number|string):Date|undefined

isAfterLast ​

  • isAfterLast ():boolean

isBeforeFirst ​

  • isBeforeFirst ():boolean

isClosed ​

  • isClosed ():boolean

isFirst ​

  • isFirst ():boolean

isLast ​

  • isLast ():boolean

next ​

  • next ():boolean

getMetaData ​

  • getMetaData ():any

getNString ​

  • getNString (columnIndex:number):string

    : ResultSetMetaData

Connection ​

Connection object wrapper around a native Java Connection.

Methods ​

isOfType ​

  • isOfType (databaseSystem:DatabaseSystem):boolean

    Checks if the connection is for a specific database system.

getDatabaseSystem ​

  • getDatabaseSystem ():DatabaseSystem

    Returns the type of the underlying database system as a {@link DatabaseSystem} enum.

prepareStatement ​

  • prepareStatement (sql:string):PreparedStatement

    Creates a new {@link PreparedStatement} object for sending parameterized SQL statements to the database.

prepareCall ​

  • prepareCall (sql:string):CallableStatement

    Creates a {@link CallableStatement} object for calling database stored procedures or functions.

close ​

  • close ():void

    Creates a {@link CallableStatement} object for calling database stored procedures or functions.

commit ​

  • commit ():void

getAutoCommit ​

  • getAutoCommit ():boolean

getCatalog ​

  • getCatalog ():string

getSchema ​

  • getSchema ():string

getTransactionIsolation ​

  • getTransactionIsolation ():number

isClosed ​

  • isClosed ():boolean

isReadOnly ​

  • isReadOnly ():boolean

isValid ​

  • isValid ():boolean

rollback ​

  • rollback ():void

setAutoCommit ​

  • setAutoCommit (autoCommit:boolean):void

setCatalog ​

  • setCatalog (catalog:string):void

setReadOnly ​

  • setReadOnly (readOnly:boolean):void

setSchema ​

  • setSchema (schema:string):void

setTransactionIsolation ​

  • setTransactionIsolation (transactionIsolation:number):void

getMetaData ​

  • getMetaData ():any

Database ​

: DatabaseMetaData

Methods ​

getDataSources ​

  • getDataSources ():string[]

    Returns a list of available data source names.

getMetadata ​

  • getMetadata (datasourceName?:string):DatabaseMetadata|undefined

    Returns database metadata for the specified data source.

getProductName ​

  • getProductName (datasourceName?:string):string

    Returns the product name of the underlying database system.

getConnection ​

  • getConnection (datasourceName?:string):Connection

    Gets a new database connection object.