Open-ILS/examples/reporter-sql-builder-test.pl

   1 #!/usr/bin/perl
   2 #use diagnostics;
   3 use warnings;
   4 use strict;
   5 use OpenILS::Reporter::SQLBuilder;
   6 use OpenSRF::Utils::JSON;
   7
   8 # just to show a deep-ish join tree and several params
   9 my $report = <<REPORT;
  10 {
  11         select => [
  12                 {       relation=> 'circ',
  13                         column  => { transform => month_trunc => colname => 'checkin_time' },
  14                         alias   => '::PARAM4',
  15                 },
  16                 {       relation=> 'circ-checkin_lib-aou',
  17                         column  => { colname => 'shortname', transform => 'Bare'},
  18                         alias   => 'Library Short Name',
  19                 },
  20                 {       relation=> 'circ-circ_staff-au-card-ac',
  21                         column  => 'barcode',
  22                         alias   => 'User Barcode',
  23                 },
  24                 {       relation=> 'circ-id-mb',
  25                         column  => { transform => sum => colname => 'amount' },
  26                         alias   => '::PARAM3',
  27                 },
  28         ],
  29         from => {
  30                 table   => 'action.circulation',
  31                 alias   => 'circ',
  32                 join    => {
  33                         checkin_staff => {
  34                                 table   => 'actor.usr',
  35                                 alias   => 'circ-circ_staff-au',
  36                                 type    => 'inner',
  37                                 key     => 'id',
  38                                 join    => {
  39                                         card => {
  40                                                 table   => 'actor.card',
  41                                                 alias   => 'circ-circ_staff-au-card-ac',
  42                                                 type    => 'inner',
  43                                                 key     => 'id',
  44                                         },
  45                                 },
  46                         },
  47                         checkin_lib => {
  48                                 table   => 'actor.org_unit',
  49                                 alias   => 'circ-checkin_lib-aou',
  50                                 type    => 'inner',
  51                                 key     => 'id',
  52                         },
  53                         'id-billings' => {
  54                                 table   => 'money.billing',
  55                                 alias   => 'circ-id-mb',
  56                                 type    => 'left',
  57                                 key     => 'xact',
  58                         },
  59                 },
  60         },
  61         where => [
  62                 {       relation        => 'circ-checkin_lib-aou',
  63                         column          => 'id',
  64                         condition       => { 'in' => '::PARAM1' },
  65                 },
  66                 {       relation        => 'circ',
  67                         column          => { transform => month_trunc => colname => 'checkin_time' },
  68                         condition       => { 'in' => '::PARAM2' },
  69                 },
  70                 {       relation        => 'circ-id-mb',
  71                         column          => 'voided',
  72                         condition       => { '=' => '::PARAM7' },
  73                 },
  74         ],
  75         having => [],
  76         order_by => [
  77                 {       relation=> 'circ-checkin_lib-aou',
  78                         column  => { colname => 'shortname', transform => 'Bare' },
  79                 },
  80                 {       relation=> 'circ',
  81                         column  => { transform => month_trunc => colname => 'checkin_time' },
  82                         direction => 'descending'
  83                 },
  84                 {       relation=> 'circ-circ_staff-au-card-ac',
  85                         column  => 'barcode',
  86                 },
  87         ],
  88         pivot_default => 0,
  89         pivot_data => 4,
  90         pivot_label => 2,
  91 };
  92 REPORT
  93 my $params = <<PARAMS;
  94 {
  95         PARAM1 => [ 18, 19, 20, 21, 22, 23 ],
  96         PARAM2 => [{transform => 'relative_month', params => [-2]},{transform => 'relative_month', params => [-3]}],
  97         PARAM3 => 'Billed Amount',
  98         PARAM4 => 'Checkin Date',
  99         PARAM5 => [{ transform => 'Bare', params => [10] },{ transform => 'Bare', params => [100] }],
 100         PARAM6 => [ 1, 4 ],
 101         PARAM7 => 'f',
 102 }
 103 PARAMS
 104
 105
 106 # Survey response counts
 107 $report = '{"select":[{"relation":"b312819df8fe889b50f70ea9fa054e72","path":"au-home_ou-aou-shortname","alias":"ILS User:Home Library:Short (Policy) Name","column":{"transform":"Bare","colname":"shortname"}},{"relation":"80bfa74cd4909b585f6187fe8f8591c5","path":"au-survey_responses-asvr-survey-asv-name","alias":"ILS User:Survey Responses:survey:name","column":{"transform":"Bare","colname":"name"}},{"relation":"8a6cb366f41b2b8186df7c7749ff41ba","path":"au-survey_responses-asvr-answer-asva-answer","alias":"ILS User:Survey Responses:answer:Answer Text","column":{"transform":"Bare","colname":"answer"}},{"relation":"8bcc25c96aa5a71f7a76309077753e67","path":"au-id","alias":"count","column":{"transform":"count","colname":"id"}}],"from":{"table":"actor.usr","path":"au","alias":"8bcc25c96aa5a71f7a76309077753e67","join":{"id-survey_responses":{"key":"usr","type":"left","table":"action.survey_response","path":"au-survey_responses-asvr","alias":"cab1b47d26fa649f9a795d191bac0642","join":{"survey":{"key":"id","table":"action.survey","path":"au-survey_responses-asvr-survey-asv","alias":"80bfa74cd4909b585f6187fe8f8591c5"},"answer":{"key":"id","table":"action.survey_answer","path":"au-survey_responses-asvr-answer-asva","alias":"8a6cb366f41b2b8186df7c7749ff41ba"}}},"home_ou":{"key":"id","table":"actor.org_unit","path":"au-home_ou-aou","alias":"b312819df8fe889b50f70ea9fa054e72"}}},"where":[{"relation":"80bfa74cd4909b585f6187fe8f8591c5","path":"au-survey_responses-asvr-survey-asv-id","column":{"transform":"Bare","colname":"id"},"condition":{"in":"::P0"}},{"relation":"b312819df8fe889b50f70ea9fa054e72","path":"au-home_ou-aou-id","column":{"transform":"Bare","colname":"id"},"condition":{"in":"::P1"}}],"having":[],"order_by":[]}';
 108 $params = '{"P0":["1"],"P1":["1","17","18","20","19","22","24","25","27","21","29","26","28","23","30","226","227","229","230","228","221","222","130","131","132","231","232","233","234","235","223","224","225","135","137","136","138","139","140","141","277","280","279","283","281","282","284","278","133","134","262","263","265","266","264","268","267","43","44","45","46","47","48","285","286","287","296","288","289","299","290","291","292","293","294","295","298","297","300","301","302","31","32","33","34","41","42","121","122","123","125","129","126","124","127","128","168","169","170","171","172","173","194","195","151","154","155","152","153","164","165","167","166","236","237","238","240","239","269","270","271","272","273","274","275","276","118","119","120","243","251","256","244","245","246","247","248","249","250","252","253","255","257","254","258","259","260","261","10","12","11","13","15","14","16","108","109","110","111","112","113","241","242","156","157","158","160","162","163","159","161","303","304","307","306","305","308","310","309","311","207","211","208","209","210","88","89","91","90","212","213","218","215","214","217","216","219","220","70","72","71","74","73","75","76","77","114","115","116","117","196","197","201","199","200","204","202","203","206","198","205","100","101","102","103","104","105","106","107","68","69","98","99","35","38","37","36","39","40","142","143","144","145","146","147","148","149","150","92","93","94","95","96","97","188","189","190","191","192","193","61","62","67","63","64","65","66","78","79","80","81","82","85","84","86","83","87","58","59","60","49","56","50","51","52","54","53","55","57","174","182","175","177","179","180","183","181","184","185","186","187","176","178"]}';
 109
 110
 111 # template format v2, left join, having count = 0
 112 $report = '{"version":2,"core_class":"acp","select":[{"alias":"Short (Policy) Name","column":{"colname":"shortname","transform":"Bare","transform_label":"Raw Data"},"path":"acp-circ_lib-aou-shortname","relation":"ab9ff91ac334900edb50f0a5a8e3501f"},{"alias":"Barcode","column":{"colname":"barcode","transform":"Bare","transform_label":"Raw Data"},"path":"acp-barcode","relation":"7d74f3b92b19da5e606d737d339a9679"},{"alias":"Circ ID","column":{"colname":"id","transform":"count","transform_label":"Count"},"path":"acp-circulations-circ-id","relation":"ddeeaf1839fe1496b309babab563fea7"}],"from":{"path":"acp-circ_lib","table":"asset.copy","label":"Item","alias":"7d74f3b92b19da5e606d737d339a9679","idlclass":"acp","template_path":"acp","join":{"id-circ-target_copy-7d74f3b92b19da5e606d737d339a9679":{"path":"acp-circulations-circ","table":"action.circulation","key":"target_copy","type":"left","label":"Item :: Circulations","alias":"ddeeaf1839fe1496b309babab563fea7","idlclass":"circ","template_path":"acp-circulations"},"circ_lib-7d74f3b92b19da5e606d737d339a9679":{"path":"acp-circ_lib-aou","table":"actor.org_unit","key":"id","label":"Item :: Circulating Library","alias":"ab9ff91ac334900edb50f0a5a8e3501f","idlclass":"aou","template_path":"acp-circ_lib"}}},"where":[{"alias":"Circulating Library","column":{"colname":"circ_lib","transform":"Bare","transform_label":"Raw Data"},"path":"acp-circ_lib","relation":"7d74f3b92b19da5e606d737d339a9679","condition":{"in":"::P0"}},{"alias":"Check Out Date/Time","column":{"colname":"xact_start","transform":"Bare","transform_label":"Raw Data"},"path":"acp-circulations-circ-xact_start","relation":"ddeeaf1839fe1496b309babab563fea7","condition":{"between":"::P1"}}],"having":[{"alias":"Circ ID","column":{"colname":"id","transform":"count","transform_label":"Count"},"path":"acp-circulations-circ-id","relation":"ddeeaf1839fe1496b309babab563fea7","condition":{"=":"0"}}],"order_by":[],"rel_cache":{"7d74f3b92b19da5e606d737d339a9679":{"label":"Item","alias":"7d74f3b92b19da5e606d737d339a9679","path":"acp","reltype":"","idlclass":"acp","table":"asset.copy","fields":{"dis_tab":{"barcode":{"colname":"barcode","transform":"Bare","transform_label":"Raw Data","alias":"Barcode","datatype":"text","op":"=","op_label":"Equals","op_value":{}}},"filter_tab":{"circ_lib":{"colname":"circ_lib","transform":"Bare","transform_label":"Raw Data","alias":"Circulating Library","datatype":"org_unit","op":"in","op_label":"In list","op_value":{}}},"aggfilter_tab":{}}},"order_by":[{"relation":"ab9ff91ac334900edb50f0a5a8e3501f","field":"shortname"},{"relation":"7d74f3b92b19da5e606d737d339a9679","field":"barcode"},{"relation":"ddeeaf1839fe1496b309babab563fea7","field":"id"}],"ddeeaf1839fe1496b309babab563fea7":{"label":"Item :: Circulations","alias":"ddeeaf1839fe1496b309babab563fea7","path":"acp-circulations","reltype":"has_many","idlclass":"circ","table":"action.circulation","fields":{"dis_tab":{"id":{"colname":"id","transform":"count","aggregate":"true","params":"undefined","transform_label":"Count","alias":"Circ ID","datatype":"id","op":"=","op_label":"Equals","op_value":{}}},"filter_tab":{"xact_start":{"colname":"xact_start","transform":"Bare","aggregate":"undefined","params":"undefined","transform_label":"Raw Data","alias":"Check Out Date/Time","datatype":"timestamp","op":"between","op_label":"Between","op_value":{}}},"aggfilter_tab":{"id":{"colname":"id","transform":"count","aggregate":"true","params":"undefined","transform_label":"Count","alias":"Circ ID","datatype":"id","op":"=","op_label":"Equals","op_value":{"value":"0","label":"\"0\""}}}}},"ab9ff91ac334900edb50f0a5a8e3501f":{"label":"Item :: Circulating Library","alias":"ab9ff91ac334900edb50f0a5a8e3501f","path":"acp-circ_lib","reltype":"has_a","idlclass":"aou","table":"actor.org_unit","fields":{"dis_tab":{"shortname":{"colname":"shortname","transform":"Bare","transform_label":"Raw Data","alias":"Short (Policy) Name","datatype":"text","op":"=","op_label":"Equals","op_value":{}}},"filter_tab":{},"aggfilter_tab":{}}}}}';
 113 $params = '{"P0":["2"],"P1":["2008-06-01","now"],"__pivot_label":"","__pivot_data":"3"}';
 114
 115
 116 my $r = OpenILS::Reporter::SQLBuilder->new;
 117 $r->register_params( OpenSRF::Utils::JSON->JSON2perl($params) );
 118
 119 my $rs = $r->parse_report( OpenSRF::Utils::JSON->JSON2perl($report) );
 120 $rs->relative_time('2006-10-01T00:00:00-4');
 121
 122 print "Column Labels:\n---------------\n\t" . join("\n\t", $rs->column_label_list) . "\n\nSQL:\n--------\n";
 123 print $rs->toSQL;
 124
 125 print "--------\n\n";
 126
 127 print "SQL group by list: ".join(',',$rs->group_by_list)."\n";
 128 print "Perl group by list: ".join(',',$rs->group_by_list(0))."\n";
 129
 130 print "\n";
 131