$darkmode
Qore SalesforceRestDataProvider Module Reference 1.0.1
SalesforceRestDataProviderDefs.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
28 public struct SoqlOperatorInfo {
29  string op;
30  auto arg;
31 };
32 
34 public struct SoqlColumnOperatorInfo {
35  string cop;
36  auto column;
37  auto arg;
38 };
39 
45 
47 const SOQL_COP_MIN = "min";
48 
50 
52 const SOQL_COP_MAX = "max";
53 
55 
57 const SOQL_COP_AVG = "avg";
58 
60 
62 const SOQL_COP_SUM = "sum";
63 
65 
67 const SOQL_COP_COUNT = "count";
68 
70 
72 const SOQL_COP_COUNT_DISTINCT = "count_distinct";
73 
75 
77 const SOQL_COP_FORMAT = "format";
78 
80 
82 const SOQL_COP_CONVERT_CURRENCY = "convert_currency";
83 
85 
87 const SOQL_COP_CALENDAR_MONTH = "calendar_month";
88 
90 
92 const SOQL_COP_CALENDAR_QUARTER = "calendar_quarter";
93 
95 
97 const SOQL_COP_CALENDAR_YEAR = "calendar_year";
98 
100 
102 const SOQL_COP_DAY_IN_MONTH = "day_in_month";
103 
105 
107 const SOQL_COP_DAY_IN_WEEK = "day_in_week";
108 
110 
112 const SOQL_COP_DAY_IN_YEAR = "day_in_year";
113 
115 
117 const SOQL_COP_DAY_ONLY = "day_only";
118 
120 
122 const SOQL_COP_FISCAL_MONTH = "fiscal_month";
123 
125 
127 const SOQL_COP_FISCAL_QUARTER = "fiscal_quarter";
128 
130 
132 const SOQL_COP_FISCAL_YEAR = "fiscal_year";
133 
135 
137 const SOQL_COP_HOUR_IN_DAY = "hour_in_day";
138 
140 
142 const SOQL_COP_WEEK_IN_MONTH = "week_in_month";
143 
145 
147 const SOQL_COP_WEEK_IN_YEAR = "week_in_year";
148 
151  SOQL_COP_MIN: (
152  "code": string sub (string cve, auto arg) {
153  return sprintf("min(%s)", cve);
154  },
155  "group": True,
156  ),
157  SOQL_COP_MAX: (
158  "code": string sub (string cve, auto arg) {
159  return sprintf("max(%s)", cve);
160  },
161  "group": True,
162  ),
163  SOQL_COP_AVG: (
164  "code": string sub (string cve, auto arg) {
165  return sprintf("avg(%s)", cve);
166  },
167  "group": True,
168  ),
169  SOQL_COP_SUM: (
170  "code": string sub (string cve, auto arg) {
171  return sprintf("sum(%s)", cve);
172  },
173  ),
174  SOQL_COP_COUNT: (
175  "nocolumn": True,
176  "code": string sub (*string cve, auto arg) {
177  return sprintf("count(%s)", cve);
178  },
179  ),
181  "code": string sub (string cve, auto arg) {
182  return sprintf("count_distinct %s", cve);
183  },
184  ),
185  SOQL_COP_FORMAT: {
186  "dostring": True,
187  "code": string sub (string cve, auto arg) {
188  return sprintf("format(%s)", cve);
189  },
190  },
192  "code": string sub (string cve, auto arg) {
193  return sprintf("convertCurrency(%s)", cve);
194  },
195  },
197  "code": string sub (string cve, auto arg) {
198  return sprintf("calendar_month(%s)", cve);
199  },
200  },
202  "code": string sub (string cve, auto arg) {
203  return sprintf("calendar_quarter(%s)", cve);
204  },
205  },
207  "code": string sub (string cve, auto arg) {
208  return sprintf("calendar_year(%s)", cve);
209  },
210  },
212  "code": string sub (string cve, auto arg) {
213  return sprintf("day_in_month(%s)", cve);
214  },
215  },
217  "code": string sub (string cve, auto arg) {
218  return sprintf("day_in_week(%s)", cve);
219  },
220  },
222  "code": string sub (string cve, auto arg) {
223  return sprintf("day_in_year(%s)", cve);
224  },
225  },
227  "code": string sub (string cve, auto arg) {
228  return sprintf("day_only(%s)", cve);
229  },
230  },
232  "code": string sub (string cve, auto arg) {
233  return sprintf("fiscal_month(%s)", cve);
234  },
235  },
237  "code": string sub (string cve, auto arg) {
238  return sprintf("fiscal_quarter(%s)", cve);
239  },
240  },
242  "code": string sub (string cve, auto arg) {
243  return sprintf("fiscal_year(%s)", cve);
244  },
245  },
247  "code": string sub (string cve, auto arg) {
248  return sprintf("hour_in_day(%s)", cve);
249  },
250  },
252  "code": string sub (string cve, auto arg) {
253  return sprintf("week_in_month(%s)", cve);
254  },
255  },
257  "code": string sub (string cve, auto arg) {
258  return sprintf("week_in_year(%s)", cve);
259  },
260  },
261 };
263 
269 const SOQL_OP_LIKE = "like";
270 
272 
274 const SOQL_OP_IN = "in";
275 
277 
279 const SOQL_OP_NOT_IN = "not in";
280 
282 
284 const SOQL_OP_LT = "<";
285 
287 
289 const SOQL_OP_LE = "<=";
290 
292 
294 const SOQL_OP_GT = ">";
295 
297 
299 const SOQL_OP_GE = ">=";
300 
302 
304 const SOQL_OP_NE = "!=";
305 
307 
309 const SOQL_OP_EQ = "=";
310 
312 
314 const SOQL_OP_NOT = "not";
315 
317 
319 const SOQL_OP_OR = "or";
321 
348 
357  hash<SoqlColumnOperatorInfo> soql_make_cop(string cop, auto column, auto arg);
358 
359 
361 
371  hash<SoqlColumnOperatorInfo> soql_cop_min(auto column);
372 
373 
375 
385  hash<SoqlColumnOperatorInfo> soql_cop_max(auto column);
386 
387 
389 
399  hash<SoqlColumnOperatorInfo> soql_cop_avg(auto column);
400 
401 
403 
413  hash<SoqlColumnOperatorInfo> soql_cop_sum(auto column);
414 
415 
417 
425  hash<SoqlColumnOperatorInfo> soql_cop_count(auto column = '');
426 
427 
429 
437  hash<SoqlColumnOperatorInfo> soql_cop_count_distinct(auto column = '');
438 
439 
441 
454  hash<SoqlColumnOperatorInfo> soql_cop_format(auto column);
455 
456 
458 
468  hash<SoqlColumnOperatorInfo> soql_cop_convert_currency(auto column);
469 
470 
472 
480  hash<SoqlColumnOperatorInfo> soql_cop_calendar_month(auto column);
481 
482 
484 
492  hash<SoqlColumnOperatorInfo> soql_cop_calendar_quarter(auto column);
493 
494 
496 
504  hash<SoqlColumnOperatorInfo> soql_cop_calendar_year(auto column);
505 
506 
508 
516  hash<SoqlColumnOperatorInfo> soql_cop_day_in_month(auto column);
517 
518 
520 
528  hash<SoqlColumnOperatorInfo> soql_cop_day_in_week(auto column);
529 
530 
532 
540  hash<SoqlColumnOperatorInfo> soql_cop_day_in_year(auto column);
541 
542 
544 
552  hash<SoqlColumnOperatorInfo> soql_cop_day_only(auto column);
553 
554 
556 
564  hash<SoqlColumnOperatorInfo> soql_cop_fiscal_month(auto column);
565 
566 
568 
576  hash<SoqlColumnOperatorInfo> soql_cop_fiscal_quarter(auto column);
577 
578 
580 
588  hash<SoqlColumnOperatorInfo> soql_cop_fiscal_year(auto column);
589 
590 
592 
600  hash<SoqlColumnOperatorInfo> soql_cop_hour_in_day(auto column);
601 
602 
604 
612  hash<SoqlColumnOperatorInfo> soql_cop_week_in_month(auto column);
613 
614 
616 
624  hash<SoqlColumnOperatorInfo> soql_cop_week_in_year(auto column);
625 
627 
644  hash<SoqlOperatorInfo> soql_make_op(string op, auto arg);
645 
646 
648 
657  hash<SoqlOperatorInfo> soql_op_like(string str);
658 
659 
661 
670  hash<SoqlOperatorInfo> soql_op_lt(auto arg);
671 
672 
674 
683  hash<SoqlOperatorInfo> soql_op_le(auto arg);
684 
685 
687 
696  hash<SoqlOperatorInfo> soql_op_gt(auto arg);
697 
698 
700 
709  hash<SoqlOperatorInfo> soql_op_ge(auto arg);
710 
711 
713 
720  hash<SoqlOperatorInfo> soql_op_ne(auto arg);
721 
722 
724 
733  hash<SoqlOperatorInfo> soql_op_eq(auto arg);
734 
735 
737 
746  hash<SoqlOperatorInfo> soql_op_in();
747 
748 
750 
761  hash<SoqlOperatorInfo> soql_op_in(list<auto> args);
762 
763 
765 
774  hash<SoqlOperatorInfo> soql_op_not_in();
775 
776 
778 
789  hash<SoqlOperatorInfo> soql_op_not_in(list<auto> args);
790 
791 
793 
800  hash<SoqlOperatorInfo> soql_op_not(hash arg);
801 
802 
804 
823  hash<string, hash<SoqlOperatorInfo>> soql_wop_or(hash<auto> h1, hash<auto> h2);
824 
826 
829  SOQL_OP_LIKE: (
830  "code": string sub (object i, string cn, auto arg) {
831  return sprintf("%s like %s", cn, arg);
832  },
833  ),
834  SOQL_OP_LT: (
835  "code": string sub (object i, string cn, auto arg) {
836  return sprintf("%s < %s", cn, arg);
837  },
838  ),
839  SOQL_OP_LE: (
840  "code": string sub (object i, string cn, auto arg) {
841  return sprintf("%s <= %s", cn, arg);
842  },
843  ),
844  SOQL_OP_GT: (
845  "code": string sub (object i, string cn, auto arg) {
846  return sprintf("%s > %s", cn, arg);
847  },
848  ),
849  SOQL_OP_GE: (
850  "code": string sub (object i, string cn, auto arg) {
851  return sprintf("%s >= %s", cn, arg);
852  },
853  ),
854  SOQL_OP_NE: (
855  "code": string sub (object i, string cn, auto arg) {
856  return sprintf("%s != %s", cn, arg);
857  },
858  ),
859  SOQL_OP_EQ: (
860  "code": string sub (object i, string cn, auto arg) {
861  return sprintf("%s = %s", cn, arg);
862  },
863  ),
864  SOQL_OP_IN: (
865  "no_process_arg": True,
866  "code": string sub (object i, string cn, auto arg) {
867  *string ins = (foldl $1 + "," + $2, (map i.getArgValue(cn, $1), arg));
868  return sprintf("%s in (%s)", cn, ins);
869  },
870  ),
871  SOQL_OP_NOT_IN: (
872  "no_process_arg": True,
873  "code": string sub (object i, string cn, auto arg) {
874  *string ins = (foldl $1 + "," + $2, (map i.getArgValue(cn, $1), arg));
875  return sprintf("%s not in (%s)", cn, ins);
876  },
877  ),
878  SOQL_OP_NOT: (
879  "recursive": True,
880  "code": string sub (object i, string cn, auto arg) {
881  return sprintf("not (%s)", cn);
882  },
883  ),
884  SOQL_OP_OR: (
885  "code": string sub (object i, string cn, list<auto> arg) {
886  return i.getOrClause(arg);
887  },
888  ),
889 };
891 };
const True
const SOQL_COP_FISCAL_QUARTER
to return the fiscal quarter of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:127
const SOQL_COP_AVG
to return the average value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:57
const SOQL_COP_FISCAL_MONTH
to return the fiscal month of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:122
const SOQL_COP_CALENDAR_YEAR
to return the calendar year of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:97
const SOQL_COP_DAY_IN_WEEK
to return the day in the week of a date or date/time value (1 = Sunday, 7 = Saturday)
Definition: SalesforceRestDataProviderDefs.qc.dox.h:107
const DefaultSoqlCopMap
a hash of default column operator descriptions
Definition: SalesforceRestDataProviderDefs.qc.dox.h:150
const SOQL_COP_CALENDAR_QUARTER
to return the calendar quarter of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:92
const SOQL_COP_FORMAT
to return the given column value in the default locale for number, date, time, and currency fields
Definition: SalesforceRestDataProviderDefs.qc.dox.h:77
const SOQL_COP_MIN
Definition: SalesforceRestDataProviderDefs.qc.dox.h:47
const SOQL_COP_DAY_IN_YEAR
to return the day in the year of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:112
const SOQL_COP_COUNT
to return the row count
Definition: SalesforceRestDataProviderDefs.qc.dox.h:67
const SOQL_COP_CONVERT_CURRENCY
to return the given column value in the default currency for the calling user
Definition: SalesforceRestDataProviderDefs.qc.dox.h:82
const SOQL_COP_FISCAL_YEAR
to return the fiscal year of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:132
const SOQL_COP_CALENDAR_MONTH
to return the calendar month of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:87
const SOQL_COP_MAX
to return the maximum value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:52
const SOQL_COP_COUNT_DISTINCT
to return a count of distinct values
Definition: SalesforceRestDataProviderDefs.qc.dox.h:72
const SOQL_COP_WEEK_IN_MONTH
to return the week in the month of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:142
const SOQL_COP_HOUR_IN_DAY
to return the hextern in the day of a date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:137
const SOQL_COP_WEEK_IN_YEAR
to return the week in the year of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:147
const SOQL_COP_SUM
to return the sum value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:62
const SOQL_COP_DAY_ONLY
to return the date from a date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:117
const SOQL_COP_DAY_IN_MONTH
to return the day in a month of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:102
hash< string, hash< SoqlOperatorInfo > > soql_wop_or(hash< auto > h1, hash< auto > h2)
returns an SoqlOperatorInfo hash with a fake "_OR_" column name; the list of arguments to the functio...
hash< SoqlOperatorInfo > soql_op_eq(auto arg)
returns an SoqlOperatorInfo hash for the "=" operator with the given argument for use in salesforce w...
hash< SoqlOperatorInfo > soql_op_not(hash arg)
returns an SoqlOperatorInfo hash for the "not" operator; for use in salesforce where clauses
hash< SoqlOperatorInfo > soql_op_lt(auto arg)
returns an SoqlOperatorInfo hash for the "<" operator with the given argument for use in salesforce w...
hash< SoqlOperatorInfo > soql_op_not_in()
returns an SoqlOperatorInfo hash for the "not in" operator with all arguments passed to the function;...
hash< SoqlOperatorInfo > soql_op_like(string str)
returns an SoqlOperatorInfo hash for the "like" operator with the given argument for use in salesforc...
hash< SoqlOperatorInfo > soql_op_in()
returns an SoqlOperatorInfo hash for the "in" operator with all arguments passed to the function; for...
hash< SoqlOperatorInfo > soql_op_gt(auto arg)
returns an SoqlOperatorInfo hash for the ">" operator with the given argument for use in salesforce w...
hash< SoqlOperatorInfo > soql_op_le(auto arg)
returns an SoqlOperatorInfo hash for the "<=" operator with the given argument for use in salesforce ...
hash< SoqlOperatorInfo > soql_op_ge(auto arg)
returns an SoqlOperatorInfo hash for the ">=" operator with the given argument for use in salesforce ...
hash< SoqlOperatorInfo > soql_make_op(string op, auto arg)
hash< SoqlOperatorInfo > soql_op_ne(auto arg)
returns an SoqlOperatorInfo hash for the "!=" or "<>" operator with the given argument for use in sal...
const SOQL_OP_GE
the SOQL greater than or equals operator (>=) for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:299
const SOQL_OP_NOT_IN
the SOQL in operator for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:279
const SOQL_OP_EQ
the SOQL equals operator (=) for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:309
const SOQL_OP_NE
the SOQL not equals operator (!= or <>) for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:304
const SOQL_OP_IN
the SOQL in operator for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:274
const SOQL_OP_NOT
the SOQL "not" operator for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:314
const SOQL_OP_LT
the SOQL less than (<) operator for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:284
const SOQL_OP_LIKE
Definition: SalesforceRestDataProviderDefs.qc.dox.h:269
const SOQL_OP_GT
the SOQL greater than operator (>) for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:294
const SOQL_OP_OR
to combine SOQL expressions with "or" for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:319
const SOQL_OP_LE
the SOQL less than or equals (<=) operator for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:289
hash< SoqlColumnOperatorInfo > soql_cop_day_in_year(auto column)
returns a SoqlColumnOperatorInfo hash for the "day_in_year" function; returns the day in the year for...
hash< SoqlColumnOperatorInfo > soql_cop_calendar_month(auto column)
returns a SoqlColumnOperatorInfo hash for the "calendar_month" function; returns the calendar month f...
hash< SoqlColumnOperatorInfo > soql_cop_convert_currency(auto column)
returns a SoqlColumnOperatorInfo hash for the "convertCurrency" operator; returns the given column va...
hash< SoqlColumnOperatorInfo > soql_cop_fiscal_month(auto column)
returns a SoqlColumnOperatorInfo hash for the "fiscal_month" function; returns the fiscal month for a...
hash< SoqlColumnOperatorInfo > soql_cop_fiscal_quarter(auto column)
returns a SoqlColumnOperatorInfo hash for the "fiscal_quarter" function; returns the fiscal quarter f...
hash< SoqlColumnOperatorInfo > soql_cop_min(auto column)
returns a SoqlColumnOperatorInfo hash for the "min" operator; returns minimum column values
hash< SoqlColumnOperatorInfo > soql_cop_calendar_quarter(auto column)
returns a SoqlColumnOperatorInfo hash for the "calendar_quarter" function; returns the calendar quart...
hash< SoqlColumnOperatorInfo > soql_cop_hour_in_day(auto column)
returns a SoqlColumnOperatorInfo hash for the "hour_in_day" function; returns the hextern in the day ...
hash< SoqlColumnOperatorInfo > soql_cop_max(auto column)
returns a SoqlColumnOperatorInfo hash for the "max" operator; returns maximum column values
hash< SoqlColumnOperatorInfo > soql_cop_fiscal_year(auto column)
returns a SoqlColumnOperatorInfo hash for the "fiscal_year" function; returns the fiscal year for a d...
hash< SoqlColumnOperatorInfo > soql_cop_day_only(auto column)
returns a SoqlColumnOperatorInfo hash for the "day_only" function; returns the date from a date/time ...
hash< SoqlColumnOperatorInfo > soql_cop_sum(auto column)
returns a SoqlColumnOperatorInfo hash for the "sum" operator; returns the total sum of a numeric colu...
hash< SoqlColumnOperatorInfo > soql_cop_day_in_week(auto column)
returns a SoqlColumnOperatorInfo hash for the "day_in_week" function; returns the day in the week for...
hash< SoqlColumnOperatorInfo > soql_cop_count(auto column='')
returns a SoqlColumnOperatorInfo hash for the "count" aggregate function; returns row counts
hash< SoqlColumnOperatorInfo > soql_cop_week_in_month(auto column)
returns a SoqlColumnOperatorInfo hash for the "week_in_month" function; returns the week in the month...
hash< SoqlColumnOperatorInfo > soql_cop_calendar_year(auto column)
returns a SoqlColumnOperatorInfo hash for the "calendar_year" function; returns the calendar year for...
hash< SoqlColumnOperatorInfo > soql_cop_format(auto column)
returns a SoqlColumnOperatorInfo hash for the "format" operator; returns the given column value in th...
hash< SoqlColumnOperatorInfo > soql_cop_count_distinct(auto column='')
returns a SoqlColumnOperatorInfo hash for the "count_distinct" aggregate function; returns row counts
hash< SoqlColumnOperatorInfo > soql_cop_week_in_year(auto column)
returns a SoqlColumnOperatorInfo hash for the "week_in_m=year" function; returns the week in the year...
hash< SoqlColumnOperatorInfo > soql_cop_day_in_month(auto column)
returns a SoqlColumnOperatorInfo hash for the "day_in_month" function; returns the day in the month f...
hash< SoqlColumnOperatorInfo > soql_make_cop(string cop, auto column, auto arg)
hash< SoqlColumnOperatorInfo > soql_cop_avg(auto column)
returns a SoqlColumnOperatorInfo hash for the "avg" operator; returns average column values
string sprintf(string fmt,...)
hash< auto > hash(object obj)
Qore SalesforceRestDataProvider module definition.
Definition: SalesforceRestDataProvider.qc.dox.h:26
const DefaultSoqlOpMap
a hash of valid operators for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:828
column operator info hash as returned by all column operator functions
Definition: SalesforceRestDataProviderDefs.qc.dox.h:34
auto arg
optional argument
Definition: SalesforceRestDataProviderDefs.qc.dox.h:37
auto column
column sopecifier, may be a string or a complex hash
Definition: SalesforceRestDataProviderDefs.qc.dox.h:36
string cop
the column operator string code
Definition: SalesforceRestDataProviderDefs.qc.dox.h:35
SOQL operator info hash as returned by all operator functions.
Definition: SalesforceRestDataProviderDefs.qc.dox.h:28
auto arg
optional argument
Definition: SalesforceRestDataProviderDefs.qc.dox.h:30
string op
the operator string code
Definition: SalesforceRestDataProviderDefs.qc.dox.h:29