The DataEngine object provides the data-handling component for Stonefield Query. It contains a data dictionary, exposed to the rest of the application as collections of AppView, Database, Field, Join, and Table objects.
Properties
All properties are read-only except IncludeJoinsInWhere and PerformJoins.
| Name | Data Type | Description |
|---|---|---|
| AppViews | Object | A reference to the AppViews collection. |
| Databases | Object | A reference to the Databases collection. |
| ErrorMessage | String | The text of any error that occurs. |
| ExcludeConditions | Object | A reference to the FilterConditions collection containing exclusion conditions. |
| Fields | Object | A reference to the Fields collection. |
| FilterConditions | Object | A reference to the FilterConditions collection containing filter conditions. |
| IncludeJoinsInWhere | Boolean | Indicates whether joins are included in the WHERE clause. This corresponds to the Include Joins in the WHERE Clause configuration setting but allows it to be changed programmatically. |
| Joins | Object | A reference to the Joins collection. |
| PerformJoins | Boolean | Indicates whether Stonefield Query performs joins. This corresponds to the Stonefield Query Performs Joins configuration setting but allows it to be changed programmatically. |
| QuerySplit | Boolean | True if the query is being split into separate tables; Stonefield Query sometimes needs to do that, such as when the query references a virtual table. |
| Tables | Object | A reference to the Tables collection. |
| UserCancelled | Boolean | True if the user clicked Cancel when prompted for a parameter value. |
Methods
| Name | Description |
|---|---|
| AddToFavorites | Adds a table or field to the Favorites table. |
| AddToFields | Adds fields to the SELECT clause of a SQL statement. |
| AddToWhere | Adds a condition to the WHERE clause of a SQL statement. |
| CancelReport | Stops the run of a report. |
| GetFieldsFromSQLStatement | Returns a collection of field names used in a SQL statement. |
| GetTablesFromSQLStatement | Returns a collection of table names used in a SQL statement. |
| GetValuesForField | Prompts the user for the value of a field. |
| GetValuesForParameter | Prompts the user for the value of a stored procedure parameter. |
| GetWhereFromSQLStatement | Returns the WHERE clause of a SQL statement. |
| ODBCFilterToLocalFilter | Converts ODBC filter conditions to local conditions in the specified SQL statement. |
See also
Application Object | Databases Collection | Fields Collection | FilterConditions Collection | Joins Collection | Tables Collection© Stonefield Software Inc., 2025 • Updated: 04/14/21
Comment or report problem with topic
DataEngine Object