• Publicity: Public Only All

search-procs.tcl

full-text search engine

Location:
packages/search/tcl/search-procs.tcl
Author:
Neophytos Demetriou <k2pts@yahoo.com>
CVS Identification:
$Id: search-procs.tcl,v 1.55.2.10 2023/03/09 13:39:17 antoniop Exp $

Procedures in this file

Detailed information

search::dequeue (public)

 search::dequeue [ -object_id object_id ] [ -event_date event_date ] \
    [ -event event ]

Remove an object from the search queue

Switches:
-object_id
(optional)
acs_objects object_id
-event_date
(optional)
the event date as retrieved from the DB (and which should not be changed)
-event
(optional)
INSERT or UPDATE or DELETE
Author:
Jeff Davis <davis@xarg.net>

Partial Call Graph (max 5 caller/called nodes):
%3 search::indexer search::indexer (private) search::dequeue search::dequeue search::indexer->search::dequeue ad_print_stack_trace ad_print_stack_trace (public) search::dequeue->ad_print_stack_trace package_exec_plsql package_exec_plsql (public) search::dequeue->package_exec_plsql

Testcases:
No testcase defined.

search::dotlrn::get_community_id (public)

 search::dotlrn::get_community_id -package_id package_id

If dotlrn is installed find the package's community_id

Switches:
-package_id
(required)
Package to find community
Returns:
dotLRN community_id. Empty string if package_id is not under a dotlrn package instance

Partial Call Graph (max 5 caller/called nodes):
%3 apm_package_installed_p apm_package_installed_p (public) db_string db_string (public) site_node::closest_ancestor_package site_node::closest_ancestor_package (public) site_node::get_node_id_from_object_id site_node::get_node_id_from_object_id (public) search::dotlrn::get_community_id search::dotlrn::get_community_id search::dotlrn::get_community_id->apm_package_installed_p search::dotlrn::get_community_id->db_string search::dotlrn::get_community_id->site_node::closest_ancestor_package search::dotlrn::get_community_id->site_node::get_node_id_from_object_id

Testcases:
No testcase defined.

search::driver_name (public)

 search::driver_name

Return the name of the current search driver.

Partial Call Graph (max 5 caller/called nodes):
%3 apm_package_id_from_key apm_package_id_from_key (public) parameter::get parameter::get (public) search::driver_name search::driver_name search::driver_name->apm_package_id_from_key search::driver_name->parameter::get

Testcases:
No testcase defined.

search::extra_args (public)

 search::extra_args

List of extra_args to pass to search::search callback

Partial Call Graph (max 5 caller/called nodes):
%3 search::extra_args_names search::extra_args_names (public) search::extra_args search::extra_args search::extra_args->search::extra_args_names

Testcases:
No testcase defined.

search::extra_args_names (public)

 search::extra_args_names

List of names of extra args implemented

Partial Call Graph (max 5 caller/called nodes):
%3 search::extra_args search::extra_args (public) search::extra_args_names search::extra_args_names search::extra_args->search::extra_args_names search::extra_args_page_contract search::extra_args_page_contract (public) search::extra_args_page_contract->search::extra_args_names

Testcases:
No testcase defined.

search::extra_args_page_contract (public)

 search::extra_args_page_contract

Generate ad_page_contract fragment for extra_args options Get all the callback impls for extra_args and add a page contract declaration

Returns:
string containing the ad_page_contract query declarations for the extra_args that are implemented

Partial Call Graph (max 5 caller/called nodes):
%3 search::extra_args_names search::extra_args_names (public) search::extra_args_page_contract search::extra_args_page_contract search::extra_args_page_contract->search::extra_args_names

Testcases:
No testcase defined.

search::is_guest_p (public, deprecated)

 search::is_guest_p
Deprecated. Invoking this procedure generates a warning.

Checks whether the logged-in user is a guest Deprecated: returning 0 since more than 10 years...

See Also:
  • acs::dc proc "call dotlrn_privacy guest_p"

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) search::is_guest_p search::is_guest_p search::is_guest_p->ad_log_deprecated

Testcases:
No testcase defined.

search::queue (public)

 search::queue [ -object_id object_id ] [ -event event ]

Add an object to the search_observer_queue table with an event. You should exercise care that the entry is not being created from a trigger (although search is robust for multiple entries so it will not insert or update the same object more than once per sweep).

Switches:
-object_id
(optional)
acs_objects object_id
-event
(optional)
INSERT or UPDATE or DELETE
Author:
Jeff Davis <davis@xarg.net>

Partial Call Graph (max 5 caller/called nodes):
%3 xowiki::Package instproc www-reindex xowiki::Package instproc www-reindex (public) search::queue search::queue xowiki::Package instproc www-reindex->search::queue ad_print_stack_trace ad_print_stack_trace (public) search::queue->ad_print_stack_trace package_exec_plsql package_exec_plsql (public) search::queue->package_exec_plsql

Testcases:
No testcase defined.
[ show source ]