ormEvictCollection

This will remove all the entries with the specified relation/collection name in the specified component.

ormEvictCollection(entityName, collectionName [, primaryKey]) → returns void

  1. CFDocs
  2. Functions
  3. ORM Functions
  4. ormEvictCollection
  5. CF9+
  6. Lucee
  7. 0 Issue
  8. Edit
See Also:   ormEvictEntity   ormEvictQueries

Argument Reference

entityName string
Required

Entity name of the persistent CFC

collectionName string
Required

Name of the collection in the component

primaryKey string

Primary key of the collection or association data of the entity

Examples
Sample code invoking the ormEvictCollection function

To evict all the association or collection data of collection arts belonging to the component CArtists

<cfset ormEvictCollection("CArtists", "arts")>

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub