framework reference

• global
• Application
• Request
• Response
• Session
• HopObject
• File
• FtpClient
• Image
• Mail
• Xml
• database connection
• database rowset
• mimepart
• skin

modules reference

• core.Array
• core.Date
• core.Number
• core.Object
• core.String


• helma.Aspects
• helma.Chart
• helma.Color
• helma.Database
• helma.File
• helma.Ftp
• helma.Html
• helma.Http
• helma.Mail
• helma.Search
• helma.Skin
• helma.Ssh
• helma.Url
• helma.Zip


• jala.AsyncRequest
• jala.BitTorrent
• jala.Captcha
• jala.Date
• jala.DnsClient
• jala.ErrorTracker
• jala.Form
• jala.History
• jala.HtmlDocument
• jala.I18n
• jala.ImageFilter
• jala.IndexManager
• jala.ListRenderer
• jala.Mp3Info
• jala.PodcastWriter
• jala.RemoteContent
• jala.Rss20Writer
• jala.Utilities
• jala.XmlRpcRequest
• jala.XmlWriter

dbConnection

Object
   |
   +--dbConnection

---

See:

- Packages.helma.scripting.rhino.extensions.DatabaseObject
- global.getDBConnection
- dbRowset

---

SUMMARY: Constructor | Properties | Methods

DETAIL: Constructor | Properties | Methods

---

Constructor Summary

dbConnection(Object)             A DatabaseObject represents a connection to a relational database and is created using the global getDBConnection function.

 

Methods Summary
Number	executeCommand(<String> sqlString)            Used to implement INSERT, UPDATE, ddl statements and other non value returning statements.
dbRowset	executeRetrieval(<String> sqlString)            Used to implement SELECT and other value returning statements.
Object	getLastError()            Return the last error which occured when connecting or executing a statement, undefined if none.
void	getMetaData()            Return the meta data attached to the connection.

Constructor Detail

dbConnection

dbConnection(Object)

A DatabaseObject represents a connection to a relational database and is created using the global getDBConnection function. There is no constructor to instantiate these objects.

The Direct DB interface allows the developer to directly access relational databases defined in the db.properties file without going through the Helma object model layer.

The string passed to the getDBConnection function must match one of the data sources being defined in [AppDir]/db.properties, or an error will be thrown.

Example:

 var dbConnection = getDBConnection("db_source_name");
  
 var dbRowset = dbConnection.executeRetrieval("select title from dummy");
 while (dbRowset.next())
   res.writeln(dbRowset.getColumnItem("title"));
 


 var deletedRows = dbConnection.executeCommand("delete from foobar");
 if(deletedRows){
   res.writeln(deletedRows + " rows successfully deleted");
 }



See also the documentation of the global getDBConnection() method.

See:
- Packages.helma.scripting.rhino.extensions.DatabaseObject
- global.getDBConnection
- dbRowset

---

Method Detail

executeCommand

Number executeCommand(<String> sqlString)

Used to implement INSERT, UPDATE, ddl statements and other non value returning statements.

Returns the number of rows impacted if the request is successful. Returns false otherwise. If false was returned, getLastError may be called on the database object to get the error information. Note that an error is generated (rather than returning a status) if the connection was not successful.

Parameters:
sqlString - as String

Returns:
Number of rows impacted if successful or false if error.

---

executeRetrieval

dbRowset executeRetrieval(<String> sqlString)

Used to implement SELECT and other value returning statements.

Return a RowSet object implementing the RowsetAccess protocol if the request is successful. Returns false otherwise. Additional arguments are ignored, and data is always returned as a RowsetAccess. The cursor is positioned before the fist row. If false was returned, getLastError may be called on the database object to get the error information. Note that an error is generated (rather than returning a status) if the connection was not successful.

Parameters:
sqlString - as String

Returns:
Object with the resulting rowset, or false in case of error

---

getLastError

Object getLastError()

Return the last error which occured when connecting or executing a statement, undefined if none.

Returns:
undefined if none

---

getMetaData

void getMetaData()

Return the meta data attached to the connection.

---

SUMMARY: Constructor | Properties | Methods

DETAIL: Constructor | Properties | Methods

---