User Guide

cfindex 237
Usage
The attributes settings that the cfindex tag requires depend on whether you set the query
attribute. If you set the query attribute to a valid query name, it specifies that
cfindex is to index
the data in the query rather than indexing documents on a disk. If you do not set the query
attribute,
cfindex assumes it is indexing a file (type = file), a set of files in a directory path
(
type = path), or text that you provide in the body attribute (type = custom).
If you set the
query attribute to a valid query name, the cfindex tag creates indexes as specified
by the following attributes and their values:
If you do not set the
query attribute, the cfindex tag creates indexes as specified by the following
attributes and their values:
If
type is not specified but query is set, ColdFusion sets the type to the default value of custom.
If neither
type nor query is set, ColdFusion sets type to the default value of file.
If
type equals custom, all attributes except for key and body can specify a literal value, not only a
column name. This allows you to change a field to empty in the collection.
Type Attribute values
File The
key attribute is the name of a column in the query that contains a full filename
(including path).
Path The
key attribute is the name of a column in the query that contains a directory
pathname.
The
extensions and recurse attributes, if specified, elaborate on which files are
included. If the action is
delete, cfindex deletes keys for the collection.
Custom The
key attribute specifies a column name that contains anything you want; for
example, the primary key value in the database. It must be unique because this is the
primary key in the collection. If the action is delete, the
key attribute is the name of a
column in the query that contains the keys to delete.
The
body attribute is required and is a comma-delimited list of the names of the columns
that contain the text data to be indexed.
Type Attribute values
File The
key attribute is required and is a full pathname to a file.
Path The key attribute is required and it is a directory pathname.
The
extensions and recurse attributes, if specified, designate which types of files are
included. If the action is
delete, both the keys and the document files are deleted.
Custom The
key attribute is an identifier that specifies the key. If the action is delete, the key
attribute is the document key to delete.
The
body attribute is required and is the text to be indexed.