CFML Functions

search Category functions

Function Name Description
CollectionCreate Creates a brand new collection. If it already exists then this function will throw an exception
CollectionDelete Deletes the collection. All files will be removed and the collection will no longer be available for use
CollectionIndexcustom Inserts/Updates a document into the collection. The key is the unique identifier for each document. Each field in the document can be searched against. If a query is presented then the fields represent columns into the query. If the column does not exist then an exception is thrown. The index can still be searched while an update is happening, however the new documents will not be available in the search until this operation has completed. Note that all fields are treated as strings and will be indexed accordingly.
CollectionIndexdelete Deletes the given key from the collection. If a query is specified then the key parameter is the column where the unique identifier is. The query is then looped over and all the values deleted from the index
CollectionIndexfile Inserts/Updates a file into the collection. The key is the unique file for each document. Each field in the document can be searched against. If a query is presented then the fields represent columns into the query. If the column does not exist then an exception is thrown. The index can still be searched while an update is happening, however the new documents will not be available in the search until this operation has completed. Note that all fields are treated as strings and will be indexed accordingly.
CollectionIndexpath Inserts/Updates a path into the collection. The key is the unique path for each directory that all files inside will be handled. Each field in the document can be searched against. If a query is presented then the fields represent columns into the query. If the column does not exist then an exception is thrown. The index can still be searched while an update is happening, however the new documents will not be available in the search until this operation has completed. Note that all fields are treated as strings and will be indexed accordingly.
CollectionIndexpurge Removes all the documents in this collection. This does not delete the collection, merely empties the collection ready for further updates
CollectionIndexweb Inserts/Updates a webpage into the collection. The URL is the unique key for each document. Each field in the document can be searched against. The index can still be searched while an update is happening, however the new documents will not be available in the search until this operation has completed. Note that all fields are treated as strings and will be indexed accordingly. The webpage will be automatically crawled for links and only internal links will be followed. A maximum of 100 URLs will be indexed at once. Each URL indexed will be logged to the main application log file.
CollectionList Lists all the collections registered. A query is returned detailing information about each collection
CollectionListcategory Lists all the categories this collection uses and the counts for each one. A struct with all the counts are returned
CollectionSearch Performs searches against the registered collection using the Apache Lucene internal engine
CollectionStatus Returns back all the information for a given collection