cfindex

Overview ColdFusion Open BlueDragon Lucee

Populates a Solr search engine collection with an index of documents on a file system or of CFML query result sets. A collection must exist before it can be populated.

Attributes

Name Required Type Default Description
action Yes String abort : Valid if type is DIH.
delete: removes collection documents as specified by the key attribute.
deltaimport : Valid if type is DIH.
fullimport : Valid if type is DIH.
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.
status : Valid if type is DIH.
update: updates a collection and adds key to the index.
author No author for the document. If 'query' present this is a column name
10
autocommit No Boolean true Flag to indicate if to save indices automatically
body No 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 No 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.
categoryTree No String A string value that specifies a hierarchical category or category tree for searching. It is a series of categories separated by forward slashes ("/"). You can specify only one category tree.
collection No String Name of a collection that is registered by CFML; for example, "personnel" Name and absolute path of a collection that is not registered by CFML; for example: "e:\collections\personnel"
11
collectionnames No String No Help Available
11
criteria No String No Help Available
custom1 No String Custom field in which you can store data during an indexing operation. Specify a query column name for type, and a query name.
custom2 No String Custom field in which you can store data during an indexing operation. Specify a query column name for type, and a query name.
custom3 No String Custom field in which you can store data during an indexing operation. Specify a query column name for type, and a query name. (Added in ColdFusion 7)
custom4 No String Custom field in which you can store data during an indexing operation. Specify a query column name for type, and a query name. (Added in ColdFusion 7)
custommap No a structure of custom atttributes that will be added to the document and indexed. The key of the structure element will be the field name and the value will be indexed. You can specify as many custom attributes as required. Each one is stored in the index as well. If 'query' then this is used for column names
11
datasource No String No Help Available
11
dihconfigpath No String No Help Available
10
docboost No Numeric Relative ranking number for the document. Higher this number, the document appears with higher ranking in the search results
extensions No 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, "*."
external No Yes or No. Yes indicates that the collection specified in collection was created outside of ColdFusion using native Verity indexing tools.
10
fieldboost No String Comma-seperated values of fields and their boost factor e.g. field1:10,field2:5
key No 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.
language No String english For options, see cfcollection.
3
name No
8
prefix No String Specifies the location of files to index when the computer that contains the K2 Search Service is not the computer on which you installed ColdFusion, and when you index files with the type attribute set to path.
query No Query Query against which collection is generated
recurse No Boolean false Yes: if type = "path", directories below the path specified in key are included in indexing operation
status No String The name of the structure into which ColdFusion MX returns status information.
summary No summary for the document. If 'query' present this is a column name. This column is not indexed, merely stored as a reference
11
tables No String No Help Available
3
throwontimeout No YSpecifies how timeout conditions are handled. If the value is true, an exception is enerated to provide notification of the timeout. If the value is No, execution continues. Default is no.
3
timeout No the timeout in seconds for a single request of type url
title No String * Title for collection * Query column name for type and a valid query name Permits searching collections by title or displaying a separate title from the key
type No 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.
urlpath No URL If type="file" or "path", specifies the URL path. When the collection is searched with cfsearch, this pathname is prefixed to filenames and returned as the url attribute.