Docs
- Home
-
Quick Index
- Introduction
- ColdBox Overview
- Directory Layout & Conventions
- Request Life Cycles
- Application Bootstrapper
- Configuring
- Application Configuration
- Using configuration settings
- Fun Logging with LogBox
- Models
- ColdBox Models
- Dependency Injection via WireBox
- Active Entity
- Built-in ORM Services
- Hibernate Criteria Builder
- ORM Event Handling
- Views
- Layouts and Rendering in ColdBox
- Controllers
- Event Handlers
- ColdBox SES URL Mappings
- Object and Form Validation
- Request Context
- Request Context
- Extending the Request Context
- Tumble Down The Rabbit Hole...
- Flash RAM & Webflows
- Ajax Integration
- Powering Flex/Air/SOAP/REST Apps
- Caching with CacheBox
- Localization & i18n
- ColdBox Security
- Aspect Oriented Programming
- ColdBox Recipes
- Extending ColdBox
- ColdBox Modules & Architecture
- ColdBox Plugins
- Core Plugins Browser
- ColdBox Interceptors
- Core Interceptors Browser
- Testing
- Testing ColdBox Applications
- Mocking-Stubbing with MockBox
- Tools, IDE Extras
- ColdBox Platform Utilities
- IDE Syntax Dictionaries
- Standalone Projects
- ColdBox Cheatsheet
- API Docs
- Directory
SideBar
User Login 
Plugins:QueryHelper
last edited by
lmajano
on 11-Apr-2010
lmajano
on 11-Apr-2010
|
Exploring the QueryHelper Plugin
Overview
A query helper plugin.
getCountDistinct
Returns total/count disninct values
Returns
- This function returns numeric
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| qry | query | Yes | --- | cf query |
| ColumnName | string | Yes | --- | column/s name |
Examples
doQueryAppend
Append Query1 into Query2
Returns
- This function returns query
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| qryFrom | query | Yes | --- | Append Query1 into Query2 |
| qryTo | query | Yes | --- | Query2 will have all record from Query1 |
Examples
sortQueryNoCase
Sorts a query by the given field non-case
Returns
- This function returns query
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| qry | query | Yes | --- | Query to sort |
| sortBy | string | Yes | --- | Sort by column |
| sortOrder | string | No | ASC | ASC/DESC |
Examples
sortQuery
Sorts a query by the given field
Returns
- This function returns query
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| qry | query | Yes | --- | Query to sort |
| sortBy | string | Yes | --- | Sort by column(s) |
| sortOrder | string | No | ASC | ASC/DESC |
Examples
filterQuery
Filters a query by the given value
Returns
- This function returns query
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| qry | query | Yes | --- | Query to filter |
| field | string | Yes | --- | Field to filter on |
| value | string | Yes | --- | Value to filter on |
| cfsqltype | string | No | cf_sql_varchar | The cf sql type of the value. |
| list | boolean | No | false | Whether to do a where IN list. |
Examples
doInnerJoin
Return inner-joined Query
Returns
- This function returns query
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| qryLeft | query | Yes | --- | |
| qryRight | query | Yes | --- | |
| LeftJoinColumn | string | Yes | --- | the column name, not the value of column |
| RightJoinColumn | string | Yes | --- | the column name, not the value of column |
| OrderByElement | string | No | ||
| CaseSensitive | boolean | No | false |
Examples
querySim
First line are the query columns separated by commas. Then do a consecuent rows separated by line breaks separated by | to denote columns.
Returns
- This function returns query
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| queryData | string | Yes | --- | The data to create queries |
Examples
getColumnArray
Returns an array of the values
Returns
- This function returns any
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| qry | query | Yes | --- | cf query |
| ColumnName | string | Yes | --- | column name |
Examples
getCSV
returns query in delimited text file format
Returns
- This function returns string
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| qry | query | Yes | --- | query to return as a delimited text file |
| delimiter | string | No | , | delimiter |
Examples
filterNull
Filters a query by NULL
Returns
- This function returns query
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| qry | query | Yes | --- | Query to filter |
| field | string | Yes | --- | Field to filter on |
| null | string | No | NULL | NULL by default, also accepts NOT NULL |
Examples
doLeftOuterJoin
Return left outer-joined Query
Returns
- This function returns query
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| qryLeft | query | Yes | --- | |
| qryRight | query | Yes | --- | |
| LeftJoinColumn | string | Yes | --- | the column name, not the value of column |
| RightJoinColumn | string | Yes | --- | the column name, not the value of column |
| OrderByElement | string | No | ||
| CaseSensitive | boolean | No | false |
Examples
getRowNumber
Returns the row number of the first match
Returns
- This function returns numeric
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| qry | query | Yes | --- | cf query |
| ColumnValue | string | Yes | --- | column value |
| ColumnName | string | Yes | --- | column name |
Comments (