Queries
Returns a list of queries.
Table Specific Information
Select
The driver will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver.
- Name supports the 'LIKE' operator.
- TypeId supports the '=' operator.
- CategoryId supports the '=' operator.
- Product supports the '=' operator.
- Module supports the '=' operator.
- Format supports the '=' operator.
- DateAdded supports the '=' operator.
- MergedQueriesOnly supports the '=' operator.
- MyQueriesOnly supports the '=' operator.
- MyFavQueriesOnly supports the '=' operator.
SELECT * FROM Queries Where TypeId = '12345'
Columns
| Name | Type | References | Description |
| Id [KEY] | Integer | The immutable system record ID of the query. | |
| Name | String | The name of the query. | |
| Product | String | The Blackbaud product for which to retrieve queries.
The allowed values are RE. | |
| Module | String | The module within the product for which to retrieve queries.
The allowed values are None. | |
| Description | String | The description of the query. | |
| Type | String | The type of the query (e.g., Constituent). | |
| TypeId | Integer |
QueryTypes.Id | The ID of the query type. |
| Category | String | The name of the category the query belongs to. | |
| CategoryId | Integer | The ID of the category the query belongs to. | |
| AddedBy | String | The user who created the query. | |
| DateAdded | Datetime | The date the query was created. | |
| LastChangedBy | String | The user who last modified the query. | |
| DateChanged | Datetime | The date the query was last modified. | |
| DateLastRun | Datetime | The date the query was last run. | |
| NumRecords | Integer | The number of records returned by the most recent execution of the query. | |
| ElapsedMs | Integer | The time in milliseconds taken for the most recent execution of the query. | |
| Format | String | The format of the query results (e.g., Static, Dynamic).
The allowed values are Static, Dynamic. | |
| ResultLayout | String | The layout of the query results (e.g., MultiRow). | |
| SupportedExecutionModes | String | The execution modes supported by the query (e.g., Both). | |
| CanModify | Boolean | Indicates whether the current user can modify the query. | |
| CanExecute | Boolean | Indicates whether the current user can execute the query. | |
| OthersCanExecute | Boolean | Indicates whether other users can execute the query. | |
| OthersCanModify | Boolean | Indicates whether other users can modify the query. | |
| ViewSupported | Boolean | Indicates whether the query results can be viewed inline. | |
| EditSupported | Boolean | Indicates whether the query supports inline editing. | |
| Favorite | Boolean | Indicates whether the query is marked as a favorite. | |
| QueryList | Boolean | Indicates whether the query is a query list. | |
| SuppressDuplicates | Boolean | Indicates whether duplicate records are suppressed in query results. | |
| HasAskFields | Boolean | Indicates whether the query contains fields that prompt the user for input. | |
| CreatedByQuery | Boolean | Indicates whether the query was created using the query builder. | |
| SelectFromQueryId | Integer |
Queries.Id | The ID of the query from which this query selects records. |
| SelectFromQueryName | String | The name of the query from which this query selects records. | |
| OutputLimitType | String | The type of output limit applied to query results (e.g., TopNumberRows). | |
| OutputLimitCount | Integer | The maximum number of records to return based on the output limit setting. | |
| IncludeInactive | Boolean | Indicates whether inactive constituents are included in the query results. | |
| IncludeDeceased | Boolean | Indicates whether deceased constituents are included in the query results. | |
| IncludeNoValidAddresses | Boolean | Indicates whether constituents with no valid addresses are included in the query results. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| MergedQueriesOnly | Boolean | If true, returns only merged queries. | |
| MyQueriesOnly | Boolean | If true, returns only queries created by the current user. | |
| MyFavQueriesOnly | Boolean | If true, returns only queries marked as favorites by the current user. |