CodeCharge Studio All ASP PHP Java C#.NET VB.NET Perl ColdFusion

Connection Reference

Design-Time Properties

Property Description
Name The name of the connection. Has to be unique.
Design Database Type The type of database being accessed during design time. If your database type is not listed, select the ANSI SQL-92 option.
Connection String Depending on the type of connection, this can be either an ODBC DSN or a connection string.
Connection Type The type of connection. ODBC or Connection String.
Login The user login name needed to access the database.
Password The user password needed to access the database.
Server Database Type The type of database being accessed during the server (live) execution. If your database type is not listed, select the ANSI SQL-92 option.
Date Format The format in which date values should be entered into the database.
Boolean Format The format in which Boolean values should be entered into the database.
Catalog Specify a database catalog from which to display objects during design time.
Schema Specify a database schema from which to display objects during design time.
Views [Yes/No] Select 'Yes' to enable the display of database views during design time.
Synonyms [Yes/No] Select 'Yes' to enable the display of database Synonyms during design time.
System Tables [Yes/No] Select 'Yes' to enable the display of database System Tables during design time.
System Views [Yes/No] Select 'Yes' to enable the display of database System Views during design time.
Aliases [Yes/No] Select 'Yes' to enable the display of database aliases during design time.
Use LIMIT/TOP [Yes/No] Select 'Yes' to enable the usage of LIMIT or TOP clause to limit the size of SQL result sets.
Server Same As Design [Yes/No] Select 'Yes' if the same connection will be used for design time as well as on the server.
Server Connection Type If the server connection is different from the design connection, specify whether the server connection will use an ODBC DSN or connection string.
Server Connection String If the server connection is different from the design connection, specify the ODBC DSN or connection string to be used.
Server Login If the server connection is different from the design connection, enter the user login name needed to access the server database.
Server Password If the server connection is different from the design connection, enter the user password needed to access the server database.

Run-Time Properties (ASP)

Property Description
Connection  Retrieves the Connection object used to access data for a given item. Since a project can have several connections, this property stores the connection used for a particular data bound object. The Connection object can be used to perform various basic operations such as execution of an SQL query against the database.
ConnectionString  This property contains the connection string used to establish the database connection. This string includes the connection type, user credentials, database name or path and some other parameters. The connection string is passed to an ADO connection object when a new connection is being made. 
Errors  This is a collection of errors pertaining to the object. Any errors which occur during the course of the objects execution are registered in this collection.
Password  This property contains the password used to establish a connection to the database. In some cases, the user name and password are included within ConnectionString property. 
User  This property contains the user name used to establish a connection to the database. In some cases, the user name and password are included within ConnectionString property. 

Run-Time Properties (PHP)

Property Description
Errors  This is a collection of errors pertaining to the object. Any errors which occur during the course of the objects execution are registered in this collection.

Run-Time Properties (.NET)

public sealed class ConnectionString
Property Description
Connection  The connection string that includes the database name, and other parameters needed to establish the initial connection. The default value is an empty string.
Type  The type of .NET Managed Provider which will be used for the connection
ConnectionCommands  The collection of commands which will be executed when the connection is opened. 
DateFormat  Mask for formatting and parsing DateTime values. 
BoolFormat  Mask for formatting and parsing Boolean values. 
DateLeftDelim  Left delimeter for date values in an SQL command (for example '#' for MS Access). 
DateRightDelim  Right delimeter for date values in an SQL command (for example '#' for MS Access). 

Methods (ASP)

Method Description
Close  Closes the database connection. 
Execute  Executes an SQL query against the database connection. This method returns a recordset object containing the query results. 
Open  Opens a database connection. 
ToSQL  Transforms values into SQL compatible format depending on the specified data type. 

Methods (PHP)

Method Description
connect Establishes a database connection.
f Retrieves the value of a field within a recordset.
next_record Moves the recordset pointer to the next row.
num_rows Retrieves the number of rows returned by the last executed query.
query  Executes an SQL query and returns a recordset if applicable. In the recordset, the row pointer is located before the first row so the next_record method has to be used to move the pointer to the first row before it can be read.
ToSQL  Transforms values into SQL compatible format depending on the specified data type. 

Methods (Servlets & JSP)

class JDBCConnectionFactory
MethodDescription
getJDBCConnection Create new JDBCConnection with the specified connection name.

class JDBCConnection
MethodDescription
getPoolName Get the name of the connection pool. This name corresponds to the Connection name configured within the CodeCharge Studio IDE.
setLocale Set the Locale. The locale is used to determine how to format data before it is inserted, updated and when it is selected.
hasErrors Indicates whether the connection has registered any errors or not.
getErrorsAsString Returns a single string with all the errors that have been registered.
getConnection This method is used to obtain a connection from the pool of connections. A new connection is created only if there are no other free connections, otherwise existing connections are reused. You should call the closeConnection method when done with a connection so as to return the connection to the pool.
closeConnection Returns a connection to the pool. This method doesn't really close the connection but returns it to the connection pool to be reused in the future.
createCallableStatement Create a CallableStatement by preparing a procedure call provided by the callString parameter.
createPreparedStatement Create a PreparedStatement from the sql indicated by the sql parameter. A PreparedStatement differs from an ordinary Statement in that you can use question marks in place of query parameters.
createStatement Create a Statement. The Statement object can then be used to query the database with SQL (executeQuery).
closeStatement Free a Statement object when it is no longer needed.
executeUpdate Execute an INSERT/UPDATE/DELETE SQL-query.
execute Execute a Stored Procedure.
toSql Transforms values into SQL compatible format depending on the specified data type.
getRows Returns an Enumeration of DbRows representing the records within a ResultSet.
getOneRow Get one row from a SQL query result.

See also:

Connection Overview


On-line, printable versions and updates