Rem
Rem Copyright (c) 1998, 2011, Oracle and/or its affiliates. 
Rem All rights reserved. 
Rem  NAME
Rem    drvparx.pkh - DR cartridge PARallel indeX services
Rem  DESCRIPTION
rem
Rem  RETURNS
Rem
Rem    NOTES
Rem
Rem    MODIFIED   (MM/DD/YY)
REm     rpalakod   05/24/10  - Bug 9354204
REm     rkadwe     04/15/10  - XbranchMerge rkadwe_bug-9561799 from
REm                            st_ctx_11.1.2.2
REm     rkadwe     04/13/10  - IndexMapLanguages as index owner
REm     rpalakod   03/02/10  - bug 9439697
REm     surman     01/03/07  - 5738539: Change to index owner for parallel sync
REm     ehuang     10/24/03  - tracing 
REm     gkaminag   03/06/03  - switch user on opt if needed
REm     smuralid   12/20/02  - PX support
REm     smuralid   12/03/02  - add drvparx package
REm     gkaminag   07/02/02  - gkaminag_misc_020702
REm     gkaminag   06/01/02 -  migrate from driddlp
Rem     yucheng    10/12/01 -  parallel sync
Rem     yucheng    09/26/01 -  parallel support
Rem     yucheng    08/23/01 -  creation

-- public types for mapping documents
drop type dr$mapdoc_t force;
create or replace type dr$mapdoc_t as object(
  map_docid number, 
  map_data  varchar2(4000)
);
/

drop type dr$mapdoc_set_t force;
create or replace type dr$mapdoc_set_t as table of dr$mapdoc_t;
/

create or replace package drvparx authid current_user is
   FUNCTION ParallelPopuIndex(
     cur        SYS_REFCURSOR, 
     idxownid   number,
     idxid      number,
     idxo       varchar2, 
     idxn       varchar2,
     idxp       varchar2,
     idxpopstate dr$popindex_state_t) 
       return sys.odcivarchar2list
      parallel_enable(partition cur by any) pipelined;

   FUNCTION IndexOptimizeParFn(
     crsr        in drvddl.popcurtyp,
     idxownid    in number,
     idxowner    in varchar2,
     idxname     in varchar2,
     ixpname     in varchar2,
     shadow_itab in varchar2,
     shadow_stab in varchar2,
     nextid     in number,
     optstate    in dr$optim_state_t
   ) return sys.odcivarchar2list
     pipelined parallel_enable (partition crsr BY HASH(num));

   FUNCTION TraceGetTrace return dr$trc_tab;
   FUNCTION FilterCacheGetStats(
     idx_id    number,
     idx_ownid number,
     idx_owner varchar2,
     idx_name  varchar2,
     ixp_name  varchar2
    ) return number;

  function GetFilterCacheSize     return number;
  function GetFilterCacheEntries  return number;
  function GetFilterCacheRequests return number;
  function GetFilterCacheHits     return number;

  procedure SetFilterCacheSize(stat in number);
  procedure SetFilterCacheEntries(stat in number);
  procedure SetFilterCacheRequests(stat in number);
  procedure SetFilterCacheHits(stat in number);

/*------------- Mapping Attributes into Existing Documents -----------------*/

type map_rec_t is record(map_docid number, map_data  varchar2(4000));
type map_typ_cur is ref cursor return map_rec_t;

-- process input documents as mdata
MAP_DOC_MODE_MDATA constant number := 0;

/* Main Mapping function */
function IndexMapDocuments(
    crsr     in drvparx.map_typ_cur,
    ownid    in number,
    owner    in varchar2,
    idxname  in varchar2,
    partname in varchar2,
    flags    in binary_integer,
    sectyp   in binary_integer
) return dr$mapdoc_set_t
  pipelined 
  order crsr by (map_docid)
  parallel_enable (partition crsr by range(map_docid));

/* Create sublex tokens given language column */
function CreateSublexTokens(
  crsr   in drvparx.map_typ_cur
) return dr$mapdoc_set_t
  pipelined
  parallel_enable (partition crsr by any);

end drvparx;
/