Status/Resolution/Reason: Closed/Fixed/Fixed
Reporter/Name(from Bugbase): Aaron Neff / ()
Created: 05/30/2018
Components: Documentation
Versions: 2018
Failure Type: Others
Found In Build/Fixed In Build: 2018.0.01.308605 (PreRelease) / docs
Priority/Frequency: Normal / Some users will encounter
Locale/System: / Platforms All
Vote Count: 0
Issue: cfindex action attribute description issues
Notes:
- The "Data Import Handler" actions should be grouped separately from the non-DIH actions.
- action="commit" needs documented (see below "Related URL" and its "Note")
- action="merge" needs documented (and its corresponding collectionNames attribute - see CF-4202659)
- The actions should be listed alphabetically
- "deltaimport:For" should be "deltaimport: For" (space missing after ":")
- "fullimport:To" should be "fullimport: To" (space missing after ":")
- The first letter of a sentence should be capitalized:
-- "delete: removes" => "delete: Removes"
-- "purge: deletes" => "purge: Deletes"
-- "refresh: deletes" => "refresh: Deletes"
-- "update: updates" => "update: Updates"
Related URL: https://www.jeffryhouser.com/index.cfm/2016/6/7/How-to-fix-Exceeded-limit-of-maxWarmingSearchers4-in-ColdFusion
- Note: This blog post explains the use-case for autocommit="false"+action="commit". Thus, I suggested the below description for action="commit".
Suggested wording for the action attribute's description:
-----------
- commit: (needs documented) (suggestion: Commits changes to the search server. For instance, you can use autocommit="false" while indexing many documents. Then, use action="commit" to commit all the changes at once.)
- delete: Removes collection documents as specified by the key attribute.
- merge: (needs documented)
- purge: Deletes all of the documents in a collection. Causes the collection to be taken offline, preventing searches.
- refresh: Deletes all of the documents in a collection, and then performs an update.
- update: Updates a collection and adds key to the index.
These actions are used when type="dih" for the Data Import Handler:
- abort: Aborts an ongoing indexing task.
- deltaimport: For partial indexing. For instance, for any updates in the database, instead of a full import, you can perform delta import to update your collection.
- fullimport: To index full database. For instance, when you index the database for the first time.
- status: Provides the status of indexing, such as the total number of documents processed and status such as idle or running.
-----------
Related URL: https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-tags/tags-i/cfindex.htmlAttachments:
Comments: