(Tag: visualeditor-switched) |
|
| Line 1: |
Line 1: |
| − | {{CGscriptClass_Template
| + | [[Category:Archive]] |
| − | |Name=<nowiki>LuceneIndexCreator</nowiki>
| |
| − | |Description=<nowiki>Creates and updates lucene indexes to help find things</nowiki>
| |
| − | |Constructors=
| |
| − | {{CGscriptConstructors_Template|Parameters=
| |
| − | {{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>columns</nowiki>|Description=<nowiki>The column configuration. This MUST be the same every time every time for the same index, or a new index must be created</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>overwriteExisting</nowiki>|Description=<nowiki>If true, overwrite existing index, e.g. if changing column configuration</nowiki>}}
| |
| − | |Description=<nowiki>Instanciate index creator to create or update index</nowiki>}}
| |
| − | |Methods=
| |
| − | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>DeleteIds</nowiki>|Parameters=
| |
| − | {{CGscriptParameters_Template|Type=array|Name=<nowiki>documentsIds</nowiki>|Description=<nowiki>Documents to delete</nowiki>}}
| |
| − | |Description=<nowiki>Delete documents from index</nowiki>}}
| |
| − | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Destroy</nowiki>|Description=<nowiki>Delete all files associated with the index</nowiki>}}
| |
| − | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
| |
| − | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>UpdateOrAddDocuments</nowiki>|Parameters=
| |
| − | {{CGscriptParameters_Template|Type=array|Name=<nowiki>documents</nowiki>|Description=<nowiki>Documents to update/add</nowiki>}}
| |
| − | |Description=<nowiki>Update documents in index, or add if not already there. Note this may throw exceptions if called simultaneously on multiple server for the same index. It is therefore recommended it is called from cattask at specific times</nowiki>}}
| |
| − | |Properties=
| |
| − | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
| |
| − | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
| |
| − | }}
| |
