User Guide Cancel

cfcollection

Last updated on May 30, 2024 | Also applies to ColdFusion

ColdFusion

Open app

CFML Reference User Guide
ColdFusion functions
ColdFusion Tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcol
    5. cfcontent
    6. cfdocument
    7. cfdocumentitem
    8. cfdocumentsection
    9. cfflush
    10. cfheader
    11. cflog
    12. cfoutput
    13. cfpresentation
    14. cfpresentationslide
    15. cfpresenter
    16. cfprocessingdirective
    17. cfprint
    18. cfreport
    19. cfreportparam
    20. cfsilent
    21. cftable
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
  1. cfcache
  2. cfcalendar
  3. cfcase
  4. cfcatch
  5. cfchart
  6. cfchartdata
  7. cfchartseries
  8. cfclient
  9. cfclientsettings
  10. cfcol
  11. cfcollection
  12. cfcomponent
  13. cfcontent
  14. cfcontinue
  15. cfcookie
  16. Tags d-e
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

Description

Creates and administers Solr search engine collections.

Syntax

cfcollection supports script style syntax: 

new collection().CREATE(collection="<collection_name>", engine="solr", path="<path to the solr directory>"); 


<cfcollection 
action = "action" 
categories = "yes|no" 
collection = "collection name" 
engine = "solr 
language = "language" 
name = "query name" 
path = "c">

Note: You can specify this tag's attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag's attribute names as structure keys.

History

ColdFusion (2016 release): The path attribute is ignored.

ColdFusion 9: Added the engine attribute (required for Solr support).ColdFusion MX 7:

Starting with ColdFusion MX 7, you cannot use the cfcollection tag to create alias names for existing collections. Because Verity maintains all the collection information, you cannot have two names point to the same collection.
Removed reference to external collections.
Deprecated the map and repair options of the action attribute. They might not work, and might cause an error, in later releases.
Added categories attribute and categorylist action.
Added CATEGORIES, SIZE, DOCCOUNT, and LASTMODIFIED to list of variables returned by the list action.
Marked as obsolete the MAPPED, ONLINE, and REGISTERED variables returned by the list action.
ColdFusion MX:
Changed the requirements for the action attribute: it is now required.
Added the action attribute list value. It is the default.
Changed the requirements for the action attribute value map: it is not necessary to specify the action attribute value map. (ColdFusion detects collections and creates maps collections as required.)
Changed acceptable collection naming: this tag accepts collection names that include spaces.
Changed Verity operations behavior: ColdFusion supports Verity operations on Acrobat PDF files.
Changed thrown exceptions: this tag can throw the SEARCHENGINE exception.

Attributes

Attribute	Req/Opt	Default	Description
action	Required; see Usage	list	categorylist: Retrieves categories from the collection and indicates how many documents are in each one. Returns a structure of structures in which the category representing each substructure is associated with a number of documents. For a category in a category tree, the number of documents is the number at or below that level in the tree. create: registers the collection with ColdFusion. If the collection is present, the tag creates a map to it. If the collection is not present, the tag creates it. delete: unregisters a collection and deletes its directories. list: returns a query result set, named from the name attribute value, of the attributes of the collections that are registered by ColdFusion. If you have Solr collections and omit the engine attribute, ColdFusion lists information for both types of collections. map: creates a map to a collection. If the action is create and the collection exists, ColdFusion also creates a map to the collection. optimize: optimizes the structure and contents of the collection for searching; recovers space. Causes collection to be taken offline, preventing searches and indexing. reload: The reload action allows you to reload a core or a collection in Solr. This action is useful for applying changes in configuration or settings without restarting the entire Solr server. repair: deprecated. Does nothing.
categories	See Usage	no	Used only for creating a collection: yes: this collection includes support for categories. no: this collection does not support categories.
collection	See Usage		A collection name. Collection names are case-sensitive.
engine	Optional	Solr	The search engine for the collection: solr: the Apache Lucene open source search engine For the create and map actions, the default is Solr. For the list action, the default is to list all collections, Solr. For all other actions ColdFusion determines the collection type.
language	See Usage	English	For a list of options, see Usage.
name	See Usage		Name for the query results returned by the list and categorylist actions.
path	Optional		Absolute path to a collection. To map an existing collection, specify a fully qualified path to the collection (not including the collection name); for example, "C:\MyCollections\". All collections are created in the location specified in Solr Home field on the ColdFusion administration page. Note: Starting with ColdFusion 2016, the *path* attribute will be ignored. All the collections will be created in the collections directory at the location specified in Solr_Home field in the ColdFusion administrator page.

With this tag you can

Create Solr collections.
Administer Solr collections created by this tag or the ColdFusion Administrator.
The following table shows the dependence relationships among this tag's attribute values:

This attribute is required, optional, or unnecessary (blank):	For this action attribute value:
	list	create	map	optimize	repair	delete	category list
collection		Required	Required	Required	Required	Required	Required
path (Deprecated)
language		Optional	Optional
name	Required						Required
categories

The following examples show the structures returned by the categorylist action:

CATEGORIES
blue	10
green	3
magenta	3
purple	2
CATEGORYTREES
a/	10
a/b	10
a/b/c	10
a/b/c/subdir	3

The list action returns the following information in a result set that contains one row per collection:

Column	Contents
CATEGORIES	yes: the collection has category support enabled. no: the collection does not have category support enabled.
CHARSET	The character set of the collection.
CREATED	The date and time that the collection was created.
DOCCOUNT	The number of documents in this collection.
EXTERNAL	yes: the collection is external. no: the collection is not external. not found: the collection is registered but is not available in the defined path.
LANGUAGE	The locale setting of the collection. This information is not available for K2Server collections.
LASTMODIFIED	The date and time that the collection was last changed.
MAPPED	Obsolete.
NAME	The name of the collection.
ONLINE	Obsolete.
PATH	Absolute path to the collection.
REGISTERED	Obsolete.
SIZE	The size of the collection, expressed in kilobytes.

You can also specify uni to enable support for multiple languages.
To determine whether a collection exists, use code, such as the following, to execute a query of queries:

<cfcollection action="list" name="myCollections" > 
<cfquery name="qoq" dbtype="query"> 
SELECT * from myCollections 
WHERE myCollections.name = 'myCollectionName' 
</cfquery> 
<cfif qoq.recordcount GT 0> 
<!--- Collection exists ---> 
<cfdump var = #qoq#> 
</cfif>

To determine whether a Solr collection exists, you must specifically add the attribute engine and provide the value as solr. For example,{{<cfcollection action="list" name="myCollections" engine="solr">}}To get a result set with values for all the collections that are registered with the search server, use code such as the following:

<cfcollection action="list" name="myCollections"> 
<cfoutput query="myCollections"> 
#name#<br> 
</cfoutput>

To add content to a collection, use cfindex. To search a collection, use cfsearch.Restart the ColdFusion Search Service for this change to take effect.
For Solr collections, the language attribute of this tag supports the following options:

Brazilian	cjk (Chinese, Japanese, Korean)	French	Russian
Czech	Dutch	German	Thai
Chinese	English	Greek

Get help faster and easier

New user?

cfcollection

Description

Category

Syntax

See also

History

Attributes

Get help faster and easier

Ask the Community

Contact Us