SICIGroupConcat Protocol Reference
Conforms to | NSObject |
---|---|
Declared in | SICIGroupConcat.h |
Overview
Exposes API’s to get group concat that returns a string which is the concatenation of all non-NULL values of X. If parameter Y is present then it is used as the separator between instances of X. A comma (“,”) is used as the separator if Y is omitted. The order of the concatenated elements is arbitrary.
– delimiter:
required method
Used to specify separator if Y is omitted.
- (id<SICIGroupConcat>)delimiter:(NSString *)delimiter
Parameters
delimiter |
Delimiter. |
---|
Return Value
SICIGroupConcat Interface.
Discussion
Used to specify separator if Y is omitted.
Declared In
SICIGroupConcat.h
– where:
required method
Column name of which condition will be specified.
- (id<SICIGroupConcatClause>)where:(NSString *)column
Parameters
column |
Name of column. |
---|
Return Value
SICIGroupConcatClause Interface.
Discussion
Column name of which condition will be specified.
Declared In
SICIGroupConcat.h
– whereClause:
required method
Used to provide manually created Where clause, instead of using API’s.
- (id<SICIGroupConcat>)whereClause:(NSString *)whereClause
Parameters
whereClause |
Manually created where clause. |
---|
Return Value
SICIGroupConcat Interface.
Discussion
Used to provide manually created Where clause, instead of using API’s.
Declared In
SICIGroupConcat.h
– and:
required method
Used to specify AND condition between where clause.
- (id<SICIGroupConcatClause>)and:(NSString *)column
Parameters
column |
Name of column on which condition need to be specified. |
---|
Return Value
SICIGroupConcatClause Interface.
Discussion
Used to specify AND condition between where clause.
Declared In
SICIGroupConcat.h
– or:
required method
Used to specify OR condition between where clause.
- (id<SICIGroupConcatClause>)or:(NSString *)column
Parameters
column |
Name of column on which condition need to be specified. |
---|
Return Value
SICIGroupConcatClause Interface.
Discussion
Used to specify OR condition between where clause.
Declared In
SICIGroupConcat.h
– groupBy:
required method
Used to specify GROUP BY statement in conjunction with the aggregate functions to group the result-set by one or more columns.
- (id<SICIGroupConcat>)groupBy:(NSArray *)columns
Parameters
columns |
Name of columns. |
---|
Return Value
SICIGroupConcat Interface.
Discussion
Used to specify GROUP BY statement in conjunction with the aggregate functions to group the result-set by one or more columns.
Declared In
SICIGroupConcat.h
– having:
required method
Used to specify HAVING clause to SQL because the WHERE keyword could not be used with aggregate functions.
- (id<SICIGroupConcatClause>)having:(NSString *)column
Parameters
column |
Name of column on which condition need to be applied. |
---|
Return Value
SICIGroupConcatClause Interface.
Discussion
Used to specify HAVING clause to SQL because the WHERE keyword could not be used with aggregate functions.
Declared In
SICIGroupConcat.h
– havingClause:
required method
Used to provide manually created Where clause, instead of using API’s.
- (id<SICIGroupConcat>)havingClause:(NSString *)havingClause
Parameters
havingClause |
Where clause. |
---|
Return Value
SICIGroupConcat Interface.
Discussion
Used to provide manually created Where clause, instead of using API’s.
Declared In
SICIGroupConcat.h
– column:
required method
Used to provide name of column for which average will be calculated.
- (id<SICIGroupConcat>)column:(NSString *)column
Parameters
column |
Name of column. |
---|
Return Value
SICIGroupConcat Interface.
Discussion
Used to provide name of column for which average will be calculated.
Declared In
SICIGroupConcat.h
– execute
required method
Used to get average, this method should be called in last to calculate group concat.
- (id)execute
Return Value
Return group concat.
Discussion
Used to get average, this method should be called in last to calculate group concat.
Exceptions
SICDatabaseException |
Throws exception if any error occur while calculating group concat. |
---|
Declared In
SICIGroupConcat.h