cfproperty

Specifies the name of the property.

Specifies the ColdFusion data type for the property.

Whether the parameter is required

This sets the default value on the property when the object is created. For ORM Entities, this only works for static values. Variable values like the current timestamp can be set by a function "preInsert" in the component.

A value to be displayed when using introspection to show information about the CFC. The value appears in parentheses following the property name.

Text to be displayed when using introspection to show information about the CFC. This attribute can be useful for describing the purpose of the parameter.

This attribute is used to specify the type of the property. Use this attribute to specify the following:* Primary key: Specify fieldtype = "id" to map a property to the primary key in the table. * Column: Specify the fieldtype = "column" to map a property to a column in the table.* Relationship: Specify the fieldtype = "relationship_type". The relationship_type can be one-to-one, one-to-many, many-to-one, or many-to-many.* Version: Specify the fieldtype="version” to indicate that the column contains versioned data.* Timestamp: Specify the fieldtype="timestamp" to indicate the column contains data with timestamp.* Collection: Specify the fieldtype="collection" to define the collection mapping.

Used to specify the data type of the primary key. If data type is not set and the ORM settinguseDBForMapping=true, then the ormtype is determined by inspecting the database.

Used to specify the primary key column name.

Algorithm used to generate unique identifiers for instances of the persistent CFC.

Sequence key name in the database.

The column name that is used to retrieve the primary key generated by a database trigger.

Additional parameters required by the various generators to generate the ID.The value for the params attribute should follow the CF Struct syntax. For example: params = {key1='value1', key2='value2'}

Use this attribute to specify the length of the column. This attribute is used for table creation only.

Specifies the precision value.

Specifies the name of an index that is created using the mapped column

Specifies whether to generate setter methods or not

Specifies whether to generate getter methods or not

Specifies the source from where the timestamp has to be retrieved

Column name in the table that is used as value in struct.

Data type of the value.

Specifies the data type of the key, when collectiontype=struct.

The column in the target table to use as key if the collection type is struct.

Specifies the foreign key column in the Join table that references the primary key column in the target table.

Schema for the link table

Catalog for the link table

Name of the link table

If the value is true, and the row that is referenced by the foreign key is missing, it is treated as a nullassociation. The default is false, in which case an exception occurs.

A Boolean value that specifies bidirectional association

Specifies the Order By string.

Specifies the foreign key column

Specifies if it is outer-join fetching or sequential select fetching

Specifies which operations should be cascaded from the parent object to the associated object

Whether a constraint is set on this table's Primary Key column to reference the Primary Key in the other table

Specifies if there should be a unique constraint on the column.

Groups columns in a single unique key constraint.

A Boolean value that specifies whether a notnull constraint should be added for this column.

Whether the column should be included in the SQL update statement.Set update=false and insert=false if the column needs to be read-only.

Whether the column should be included in SQL UPDATE and/or INSERT statements.Set update=false and insert=false if the column needs to be read-only.

Specifies that this property value is actually generated by the database {never|always|insert}* never: Specifies that the value for this property is never generated by database* always: Specifies that the value for this property is always generated by database* insert: Specifies that the value for this property is generated at the time of insert but is not regenerated at updates.

SQL expression that defines the value of the property. If you specify a formula, the column value is ignored.

Specifies if loading is to be done by parts:

Whether updates to this property require acquisition of the optimistic lock on the table row

Specifies the scale value

Property in the target CFC that is referenced by the foreign key in the Join table.

Name of referenced CFC

Use this attribute to define the join column for inheritance mapping.

Takes the validator to be used for validating data when implicit setter for this property is called.

Takes the parameters required by the validator specified in the validate attribute. This should be specified in the implicit struct notation eg. validateparams="{min=18,max=60}">.min: Minimum value if validate is integer/numeric/max: Maximum value if the validate is integer/numeric/minLength: Minimum length of the string if the validate is stringmaxLength: Maximum length of the string if the validate is stringpattern: regex expression if the validator specified in validate attribute is regex

Type of cache to use

Use this attribute to specify the DB-specific SQLType that should be used for the column. This attribute is used for table creation only.If this attribute is not specified, ColdFusion will automatically decide the SQLType based on the ormtype specified for this property.

This sets the default value of a column in the table when schema is exported.

Where condition

Specifies whether this property should be persisted. Ifpersistent="false‚ all the ORM related attributes are ignored.Set this attribute to false if you do not want this property to be persisted by ORM.

An identifier property value that indicates that an instance is newly instantiated and not saved/loaded in the database

Specifies whether this property can be serialized. If you set this value tofalse, the property cannot be serialized, so any changes made are not retained on session replication, and the property has its default value (if any) on the second server. Use this attribute to prevent serialization of properties in CFCs that are serializable.

Use this property to define the custom name for generated relationship methods. Applies to one-to-many and many-to-many

If remotingFetch is false, then the value of that attribute is not sent over flash remoting. remotingFetch is true by default was all properties. But in case of cfcs for which persistent = true, the value of the remotingFetch attribute is false by default for any property that shares one-to-one, one-to-many, many-to-one or many-to-many relationship.

Table name