Difference between revisions of "LuceneIndexCreator class"
Nguyenduyan (talk | contribs) |
|||
| Line 2: | Line 2: | ||
|Name=<nowiki>LuceneIndexCreator</nowiki> | |Name=<nowiki>LuceneIndexCreator</nowiki> | ||
|Description=<nowiki>Creates and updates lucene indexes to help find things</nowiki> | |Description=<nowiki>Creates and updates lucene indexes to help find things</nowiki> | ||
| − | |Constructors= | + | |InheritsFrom=object|Constructors= |
{{CGscriptConstructors_Template|Description=<nowiki>Instanciate index creator to manipulate index</nowiki>}} | {{CGscriptConstructors_Template|Description=<nowiki>Instanciate index creator to manipulate index</nowiki>}} | ||
|Methods= | |Methods= | ||
| Line 11: | Line 11: | ||
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Resource to check permissions on</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>}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Resource to check permissions on</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>}} | ||
|Description=<nowiki>Delete all files associated with the index</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=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} |
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>UpdateOrAddDocuments</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>UpdateOrAddDocuments</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Resource to check permissions on</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>overwriteOldIndex</nowiki>|Description=<nowiki>Overwrite any existing index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>documents</nowiki>|Description=<nowiki>Documents to update/add</nowiki>}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Resource to check permissions on</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>overwriteOldIndex</nowiki>|Description=<nowiki>Overwrite any existing index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>documents</nowiki>|Description=<nowiki>Documents to update/add</nowiki>}} | ||
| Line 20: | Line 20: | ||
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | {{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>}} | + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} |
}} | }} | ||
Latest revision as of 06:45, 2 July 2020
LuceneIndexCreator
Creates and updates lucene indexes to help find things
Parent class
Inherits from object
Constructors
- () - Instanciate index creator to manipulate index
Methods
- Empty DeleteIds(string name "Name of the index", int parentResourceId "Resource to check permissions on", array columns "The column configuration. This MUST be the same every time every time for the same index, or a new index must be created", array documentsIds "Document ids to delete") - Delete documents from index
- Empty Destroy(string name "Name of the index", int parentResourceId "Resource to check permissions on", array columns "The column configuration. This MUST be the same every time every time for the same index, or a new index must be created") - Delete all files associated with the index
- (From object) string ToString() - The string representation of the object.
- Empty UpdateOrAddDocuments(string name "Name of the index", int parentResourceId "Resource to check permissions on", array columns "The column configuration. This MUST be the same every time every time for the same index, or a new index must be created", bool overwriteOldIndex "Overwrite any existing index", array documents "Documents to update/add") - Create, update or overwrite index
- Empty UpdateOrAddDocuments(string name "Name of the index", int parentResourceId "Resource to check permissions on", array columns "The column configuration. This MUST be the same every time every time for the same index, or a new index must be created", bool overwriteOldIndex "Overwrite any existing index", array sourceData "Array to iterate over and call the callback", Function callback "Callback that get each sourceData element as parameter, and must return either a LuceneDocument or Empty") - Create, update or overwrite index by stream updates or adding documents, which may vastly reduce memory usage, otherwise similar to overload
Properties
- string ObjectTypeName { get; } - The name of the type of object.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
