DatasheetElement.validateCustomQueryInfo (Method)
Throws an error if any of the information for the custom datasheet query is not valid.
Returns:
Void
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| datasourceName | PlainText_NonNull | Required | The name of a ColdFusion data source. |
| sqlQuery | ValidSQLSelectStatement | Required | The SQL query that CommonSpot will run when it generates a datasheet. |
| username | PlainText | Optional. Defaults to an empty string. | A database user name. |
| password | PlainText_Secure | Optional. Defaults to an empty string. | The password associated with the 'username' argument. |
| ignoreWhereClause | Boolean | Optional. Defaults to '0'. | When true, ignores the where part of the supplied sql. |
Context:
| License Requirements | Datasheet |
| Permission Requirements | Contributor |
| Deny Context | None |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | This method may be customized at the site level |
Error Codes:
| Code | Error Message |
|---|---|
| 78003 | '$1' is not permitted in the query statement. You can only use SELECT statements. |
| 78005 | CommonSpot could not execute the specified query. Please check your syntax and try again. $1. |
Notes:
None