callback::search::search::contract (private)

 callback::search::search::contract -query query [ -user_id user_id ] \
    [ -offset offset ] [ -limit limit ] [ -df df ] [ -dt dt ] \
    [ -package_ids package_ids ] [ -object_type object_type ] \
    [ -extra_args extra_args ]

Defined in packages/search/tcl/search-procs.tcl

This callback is invoked when a search is to be performed. Query will be a list of lists. The first list is required and will be a list of search terms to send to the full text search engine. Additional optional lists will be a two element list. The first element will be the name of an advanced search operator. The second element will be a list of data to restrict search results based on that operator.

Switches:

-query (required)

-user_id (optional)

-offset (optional, defaults to "0")

-limit (optional, defaults to "10")

-df (optional)

-dt (optional)

-package_ids (optional)

-object_type (optional)

-extra_args (optional)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Source code:

            # this is a callback contract which only invokes its arg parser for input validation

XQL Not present:

PostgreSQL

Generic XQL file:

packages/search/tcl/search-procs.xql

Oracle XQL file:

packages/search/tcl/search-procs-oracle.xql