User Guide

106 CFML Language Reference
• File — Indexes files.
• Path — Indexes all files in specified path that pass EXTENSIONS filter.
• Custom — Indexes custom entities from a ColdFusion query.
TITLE
Required when TYPE="Custom". Specifies one of the following:
• A title for the collection
• A query column name for any TYPE and a valid query name
The TITLE attribute allows searching collections by title or displaying a separate
title from the actual key.
KEY
Optional. A unique identifier reference that specifies one of the following:
• Document filename when TYPE="File"
• Fully qualified path when TYPE="Path"
• A unique identifier when TYPE="Custom", such as the table column holding
the primary key
• A query column name for any other TYPE argument
BODY
Optional. ASCII text to index or a query column name. Required if
TYPE="Custom". Ignored for TYPE="File" and TYPE="Path". Invalid if
TYPE="Delete". Specifies one of the following:
• The ASCII text to be indexed
• A query column name when a valid query name is specified in QUERY
Multiple columns can be specified in a comma-separated list:
BODY="employee_name, dept_name, location"
CUSTOM1
Optional. A custom field you can use to store data during an indexing operation.
Specify a query column name for any TYPE and a valid query name.
CUSTOM2
Optional. A second custom field you can use to store data during an indexing
operation. Usage is the same as for CUSTOM1.
URLPATH
Optional. Specifies the URL path for files when TYPE="File" and TYPE="Path".
When the collection is searched with CFSEARCH, this path name will
automatically be prepended to all file names and returned as the URL attribute.