%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% @author Angel Herranz <angel.herranz@coowry.com>
%%         Manuel Cherep <manuel.cherep@coowry.com>
%%
%% Copyright 2016, Coowry Ltd. - All rights reserved.
%%
%% See LICENSE.txt file in src directory for detailed information.
%%
%% This HRL contains records to represent PG SQL Abstract Syntax
%% Tree. Non-terminal symbols of the grammar are referenced according
%% to https://ronsavage.github.io/SQL/sql-2003-2.bnf.html
-record(
   select,
   {
     quantifier = all :: eesql:set_quant(), %% <set quantifier>
     columns = [] :: list(eesql:derived_column()), %% List of columns to retrieve, * as [] (<select list>)
     %% The rest of columns represents <table expression>
     from :: eesql:from_clause(), %% (FROM) Source of data, table names for the moment (<from clause>)
     where :: eesql:predicate() | undefined, %% (WHERE) search condition (<where clause>)
     group_by = [] :: list(eesql:column_reference()), %% TODO: Group by expression
     %% TODO (AH): <having clause> missing
     %% TODO (AH): <window clause> has ORDER BY, OFFSET, LIMIT, etc. We need to check it.
     order_by = [] :: list(eesql:sort_spec()), %% (ORDER BY) Sort specification (<sort specification list>)
     offset :: {non_neg_integer(), non_neg_integer()} | undefined, %% (OFFSET/FETCH)
     %% TODO (AH): maybe, this feature, is not in the SQL standard but it is supported by postgres, oracle, mysql
     for_update = false :: boolean() %% Decides if a select is done for update or not
   }
  ).

%% TODO (AH): to be deprecated, qualified_join to be used instead,
%% reuse the #join tag for #qualified_join after final remove
-record(
   join,
   {
     type :: eesql:join_type() | no_join, %% no_join represents the beggining of the join
     table :: eesql:table_primary(),
     joins :: [eesql:joined_table()] | undefined,
     spec :: eesql:predicate() | undefined
   }
  ).

-record(
   cross_join,
   {
     left :: eesql:table_ref(),
     right :: eesql:table_primary()
   }
  ).

-record(
   natural_join,
   {
     left :: eesql:table_ref(),
     right :: eesql:table_primary()
   }
  ).

-record(
   union_join,
   {
     left :: eesql:table_ref(),
     right :: eesql:table_primary()
   }
  ).

-record(
   qualified_join,
   {
     type = inner :: eesql:join_type(),
     left :: eesql:table_ref(),
     right :: eesql:table_ref(),
     on :: eesql:predicate()
   }
  ).

-record(
   union,
   {
     type = null :: all | null, %% UNION ALL | UNION
     queries :: [eesql:query_spec()],
     order_by = [] :: list(eesql:sort_spec()) %% (ORDER BY) Sort specification (<sort specification list>)
   }
  ).

-record(
   insert,
   {
     table :: eesql:table_name(),
     columns :: nonempty_list(eesql:column_name()), %% List of columns to set
     values :: nonempty_list(eesql:row_value_expr()), %% (VALUES) values to insert
     on_conflict_update_target :: undefined | [eesql:column_name()] %% UPDATE when the columns conflicts
   }
  ).

-record(
   update,
   {
     table :: eesql:table_name(), %% UPDATE target table
     set :: nonempty_list(eesql:set_clause()), %% (SET) columns to update
     where :: eesql:predicate() | undefined %% (WHERE) search condition
   }
  ).

-record(
   delete,
   {
     table :: eesql:table_name(), %% (DELETE FROM) target table
     where :: eesql:predicate() | undefined %% (WHERE) search_condition
   }
  ).

-record(
  truncate,
  {
    table :: eesql:table_name(), %% CLEARS TABLE
    cascade = false :: boolean() %% CASCADE CLEANS ALSO FOREIGN KEYS
  }).

-record(
  pg_refresh,
  {
    materialized_view :: eesql:table_name() %% REFRESH MATERIALIZED VIEW
  }).

-record(
   pg_with,
   {
     definitions :: [{eesql:id(), eesql:query_spec()}],
     select :: eesql:query_spec()
   }).

-record(
   pg_call,                                     % FUNCTION CALL in FROM CLAUSE
   {
     name :: eesql:id(),
     args :: list(eesql:value_expr())
   }).