LuceneIndexCreator class - Revision history

Administrator at 04:45, 2 July 2020

2020-07-02T04:45:54Z

← Older revision		Revision as of 04:45, 2 July 2020
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>}}
	}}		}}

Nguyenduyan at 07:19, 21 June 2017

2017-06-21T07:19:46Z

← Older revision		Revision as of 07:19, 21 June 2017
Line 3:		Line 3:
	\|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=		\|Constructors=
	{{CGscriptConstructors_Template~~\|Parameters=~~		{{CGscriptConstructors_Template\|Description=<nowiki>Instanciate index creator to manipulate index</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>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=		\|Methods=
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>DeleteIds</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>DeleteIds</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>documentsIds</nowiki>\|Description=<nowiki>~~Documents~~ to delete</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=array\|Name=<nowiki>documentsIds</nowiki>\|Description=<nowiki>Document ids to delete</nowiki>}}
	\|Description=<nowiki>Delete documents from index~~. Atleast 1 update is required to make the deletes actually occur~~</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=Empty\|Name=<nowiki>Destroy</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>}}
			\|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>\|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=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>}}
	\|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>}}		\|Description=<nowiki>Create, update or overwrite index</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>UpdateOrAddDocuments</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>UpdateOrAddDocuments</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>sourceData</nowiki>\|Description=<nowiki>Array to iterate over and call the callback</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Function\|Name=<nowiki>callback</nowiki>\|Description=<nowiki>Callback that get each sourceData element as parameter, and must return either a ~~Document~~ or Empty</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>sourceData</nowiki>\|Description=<nowiki>Array to iterate over and call the callback</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Function\|Name=<nowiki>callback</nowiki>\|Description=<nowiki>Callback that get each sourceData element as parameter, and must return either a LuceneDocument or Empty</nowiki>}}
	\|Description=<nowiki>~~Stream~~ updates or adding documents ~~in index~~, which may vastly reduce memory usage, otherwise similar to overload</nowiki>}}		\|Description=<nowiki>Create, update or overwrite index by stream updates or adding documents, which may vastly reduce memory usage, otherwise similar to overload</nowiki>}}
	\|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\|Description=<nowiki>Get information about this class.</nowiki>}}
	}}		}}

Nguyenduyan: Created page with "{{CGscriptClass_Template |Name=LuceneIndexCreator |Description=Creates and updates lucene indexes to help find things |Constructors= {{CGscri..."

2017-06-01T09:54:36Z

Created page with "{{CGscriptClass_Template |Name=<nowiki>LuceneIndexCreator</nowiki> |Description=<nowiki>Creates and updates lucene indexes to help find things</nowiki> |Constructors= {{CGscri..."

New page

{{CGscriptClass_Template
|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=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>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. Atleast 1 update is required to make the deletes actually occur</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>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>UpdateOrAddDocuments</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>sourceData</nowiki>|Description=<nowiki>Array to iterate over and call the callback</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Function|Name=<nowiki>callback</nowiki>|Description=<nowiki>Callback that get each sourceData element as parameter, and must return either a Document or Empty</nowiki>}}
|Description=<nowiki>Stream updates or adding documents in index, which may vastly reduce memory usage, otherwise similar to overload</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>}}
}}