action
string
- update: updates a collection and adds key to the index.
- delete: removes collection documents as specified by
the key attribute.
- 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.
Values:
update
delete
purge
refresh
type
string
file: using the key attribute value of the query result as
input, applies action value to filenames or filepaths.
path: using the key attribute value of the query result as
input, applies action to filenames or filepaths that
pass the extensions filter
custom: If action = "update" or "delete": applies action to
custom entities in query results.
key
string
* Absolute path and filename, if type = "file"
* Absolute path, if type = "path"
* A query column name (typically, the primary key column
name), if type = "custom"
* A query column name, if type = any other value
This attribute is required for the actions listed, unless
you intend for its value to be an
empty string.
body
string
* ASCII text to index
* Query column name(s), if name is specified in query
You can specify columns in a delimited list. For example:
"emp_name, dept_name, location"
category
string
A string value that specifies one or more search categories
for which to index the data. You can define multiple
categories, separated by commas, for a single index.
extensions
string
Delimited list of file extensions that CFML uses to
index files, if type = "Path".
"*." returns files with no extension.
For example: the following code returns files with a
listed extension or no extension:
extensions = ".htm, .html, .cfm, .cfml, "*."