include/SugarSearchEngine/SugarSearchEngineIndexerBase.php

Show:

inherited

Classes
- \SugarSearchEngineIndexerBase

Table of Contents

\SugarSearchEngineIndexerBase
jump to top

Package: SugarCRM

Base class of full text search Indexer

Parent(s): \RunnableSchedulerJob
Children: \SugarSearchEngineSyncIndexer; \SugarSearchEngineFullIndexer
Api

Constants

 
                MAX_BULK_THRESHOLD
                = 5000

The max number of beans we process before starting to bulk insert so we dont hit memory issues.

 
                MAX_BULK_QUERY_THRESHOLD
                = 15000

The max number of beans we process before starting to bulk insert so we dont hit memory issues.

 
                MAX_BULK_DELETE_THRESHOLD
                = 3000

The max number of beans we delete at a time

 
                POSTPONE_JOB_TIME
                = 20

Number of time to postpone a job by so it's not executed twice during the same request.

 
                QUEUE_TABLE
                = 'fts_queue'

The name of the queue table

Properties

\SugarSearchEngineAbstractBase
                 $SSEngine= ''

Details

Type: \SugarSearchEngineAbstractBase

\DBManager
                 $db= ''

Details

Type: \DBManager

\SchedulersJob
                 $schedulerJob= ''

Details

Type: \SchedulersJob

\table_name
                 $table_name= ''

Details

Type: \table_name

Methods

__construct(
          \SugarSearchEngineAqbstractBase $engine
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$engine	\SugarSearchEngineAqbstractBase

__get(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

generateFTSQuery(
           $module,  $fieldDefinitions
          )
        
        :
          string

Generate the query necessary to retrieve FTS enabled fields for a bean.

Parameters

Name	Type	Description
$module
$fieldDefinitions

Returns

Type	Description
string

markBeansProcessed(
          \$beanIDs $beanIDs
          )
        
        :
          void

Given a set of bean ids processed from the queue table, mark them as being processed. We will throttle the update query as there is a limit on the size of records that can be passed to an in clause yet we don't want to update them individually for performance reasons.

Parameters

Name	Type	Description
$beanIDs	\$beanIDs	array of bean ids to delete

run(
           $data
          )
        
        :
          void

Main function that handles the indexing of a bean and is called by the job queue system.

Subclasses should implement their own logic.

Parameters

Name	Type	Description
$data

setBeanIDsProcessed(
           $deleteIDs
          )
        
        :
          void

Internal function to mark records within queue table as processed.

Parameters

Name	Type	Description
$deleteIDs

setJob(
          \SchedulersJob $job
          )
        
        :
          void

Set the scheduler job that initiated the run call.

Parameters

Name	Type	Description
$job	\SchedulersJob

include/SugarSearchEngine/SugarSearchEngineIndexerBase.php

\SugarSearchEngineIndexerBasejump to top

Constants

Properties

Methods

\SugarSearchEngineIndexerBase
jump to top