Available Database Object Methods |
The table below describes the various methods that are available for this object.
 | ||
| To view an example that shows how to use these methods, see Using the Database Object Methods. | ||
 |
 | ||
|
To retrieve a database object, use one of the following methods defined for the environment variable:
When you use get_default_database() from within Iguana, the connection is inside a transaction envelope: any database actions performed by your Python scripts can be safely rolled back. | ||
 |
| Method | Description |
|---|---|
| escape_string(String) |
Will perform any character escaping that is required by your database. You would usually use this method to escape a string literal before using it in a query. For example, if you have the string, "Robert's", some databases might require this to be escaped so that it's "Robert''s" or "Robert\'s" since the ' character is often a special character reserved to denote the beginning and end of a string literal. If database support is turned off (in the DB tab of the Options window), no escaping will be performed on the String. |
| execute(SQLstring) | Executes the given SQL string against your database. Since no value is returned by this method, you'd use it to issue update, insert and delete type queries. |
| execute_select(SQLstring) | Executes the given SQL select statement against your database. Behaves exactly the same as the execute() method except that a result set object is returned containing the rows that result from the query. If database support is turned off, a 1 will be returned. |
| get_empty_default_result_set( ColumnsString ) |
Gets an empty result set data object with the columns specified in the ColumnsString parameter. The ColumnsString parameter is a string containing a comma-separated list of the column names that the result set should have. You can then add rows of data. The reason you might want to create a result set this way is so that you can use it as dummy data while testing your Python code with database support turned off. If database support is turned off (set in the DB tab of the Options Window), then the execute_select call (described above) will return a 1. So, your Python code can have a condition that allows it to work with the default result set in such cases instead of real data. |