|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.FrameworkSupertype
coldbox.system.Plugin
coldbox.system.plugins.QueryHelper
public class QueryHelper
A query helper plugin.
Constructor Summary | |
---|---|
init(any controller)
|
Method Summary | |
---|---|
any |
arrayOfStructuresToQuery(array theArray)
Converts an array of structures to a CF Query Object |
query |
doInnerJoin(query qryLeft, query qryRight, string LeftJoinColumn, string RightJoinColumn, [string OrderByElement=''], [boolean CaseSensitive='false'])
Return inner-joined Query |
query |
doLeftOuterJoin(query qryLeft, query qryRight, string LeftJoinColumn, string RightJoinColumn, [string OrderByElement=''], [boolean CaseSensitive='false'])
Return left outer-joined Query |
query |
doQueryAppend(query qryFrom, query qryTo)
Append Query1 into Query2 |
query |
filterNull(query qry, string field, [string null='NULL'])
Filters a query by NULL |
query |
filterQuery(query qry, string field, string value, [string cfsqltype='cf_sql_varchar'], [boolean list='false'])
Filters a query by the given value |
string |
getCSV(query qry, [string delimiter=','])
returns query in delimited text file format |
any |
getColumnArray(query qry, string ColumnName)
Returns an array of the values |
numeric |
getCountDistinct(query qry, string ColumnName)
Returns total/count disninct values |
numeric |
getRowNumber(query qry, string ColumnValue, string ColumnName)
Returns the row number of the first match |
private string |
getUnMatchedElements(string FirstList, string secondList)
Returns element which are only present in second-list |
private any |
getUniqueElements(string FirstList, string secondList)
Returns unique elements from two list |
private query |
qrySetCell(query qryFrom, query qryTo, array ArrayCols, numeric FromRowNumber, numeric ToRowNumber)
Insert value into query |
query |
querySim(string queryData)
First line are the query columns separated by commas |
array |
queryToArrayOfStructures(query theQuery)
Converts a query to an array of structures |
Query |
rotateQuery(query originalQuery)
Rotates query swapping rows for cols and cols for rows, first col becomes new col names |
string |
slugifyCol(string str, [numeric maxLength='0'], [string allow=''])
Create a query column name safe slug from a string |
query |
sortQuery(query qry, string sortBy, [string sortOrder='ASC'])
Sorts a query by the given field |
query |
sortQueryNoCase(query qry, string sortBy, [string sortOrder='ASC'])
Sorts a query by the given field non-case |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init(any controller)
controller
Method Detail |
---|
public any arrayOfStructuresToQuery(array theArray)
theArray
- The array of structures to convert to a querypublic query doInnerJoin(query qryLeft, query qryRight, string LeftJoinColumn, string RightJoinColumn, [string OrderByElement=''], [boolean CaseSensitive='false'])
qryLeft
qryRight
LeftJoinColumn
- the column name, not the value of columnRightJoinColumn
- the column name, not the value of columnOrderByElement
CaseSensitive
public query doLeftOuterJoin(query qryLeft, query qryRight, string LeftJoinColumn, string RightJoinColumn, [string OrderByElement=''], [boolean CaseSensitive='false'])
qryLeft
qryRight
LeftJoinColumn
- the column name, not the value of columnRightJoinColumn
- the column name, not the value of columnOrderByElement
CaseSensitive
public query doQueryAppend(query qryFrom, query qryTo)
qryFrom
- Append Query1 into Query2qryTo
- Query2 will have all record from Query1public query filterNull(query qry, string field, [string null='NULL'])
qry
- Query to filterfield
- Field to filter onnull
- NULL by default, also accepts NOT NULLpublic query filterQuery(query qry, string field, string value, [string cfsqltype='cf_sql_varchar'], [boolean list='false'])
qry
- Query to filterfield
- Field to filter onvalue
- Value to filter oncfsqltype
- The cf sql type of the value.list
- Whether to do a where IN list.public string getCSV(query qry, [string delimiter=','])
qry
- query to return as a delimited text filedelimiter
- delimiterpublic any getColumnArray(query qry, string ColumnName)
qry
- cf queryColumnName
- column namepublic numeric getCountDistinct(query qry, string ColumnName)
qry
- cf queryColumnName
- column/s namepublic numeric getRowNumber(query qry, string ColumnValue, string ColumnName)
qry
- cf queryColumnValue
- column valueColumnName
- column nameprivate string getUnMatchedElements(string FirstList, string secondList)
FirstList
- first list which be compared to second listsecondList
- second list which be compared from first listprivate any getUniqueElements(string FirstList, string secondList)
FirstList
- first list which be compared to second listsecondList
- second list which be compared from first listprivate query qrySetCell(query qryFrom, query qryTo, array ArrayCols, numeric FromRowNumber, numeric ToRowNumber)
qryFrom
qryTo
ArrayCols
FromRowNumber
ToRowNumber
public query querySim(string queryData)
queryData
- The data to create queriespublic array queryToArrayOfStructures(query theQuery)
theQuery
- The query to convertpublic Query rotateQuery(query originalQuery)
originalQuery
- The query to rotatepublic string slugifyCol(string str, [numeric maxLength='0'], [string allow=''])
str
- The string to slugifymaxLength
- The maximum number of characters for the slugallow
- a regex safe list of additional characters to allowpublic query sortQuery(query qry, string sortBy, [string sortOrder='ASC'])
qry
- Query to sortsortBy
- Sort by column(s)sortOrder
- ASC/DESCpublic query sortQueryNoCase(query qry, string sortBy, [string sortOrder='ASC'])
qry
- Query to sortsortBy
- Sort by columnsortOrder
- ASC/DESC
|
ColdBox Platform v3.8.0 | ||||
FRAMES |