Appendix B - Schema Reference

Database

Attribute Available Values Default Required
name n/a n/a Yes
defaultIdMethod "native", "none" "none" No
package n/a project name No
baseClass n/a propel.om.BaseObject  
basePeer n/a propel.util.BasePeer  
defaultPhpNamingMethod "nochange", "underscore", "phpname" "underscore" No
heavyIndexing "true", "false" "false" No

Nested Tags:

External Schema

Attribute Available Values Default Required
filename n/a n/a Yes

Table

Attribute Available Values Default Required
name n/a n/a Yes
idMethod "native", "none" "none" (or defaultIdMethod attrib of <database>) No
phpName n/a   No
skipSql "true", "false" "false" No
abstract "true", "false" "false" No
phpNamingMethod "nochange", "underscore", "phpname" "underscore" (or defaultPhpNamingMethod of <database>) No
baseClass n/a baseClass attribute of <database>  
basePeer n/a basePeer attribute of <database>  
description n/a n/a No
heavyIndexing "true", "false" heavyIndexing attribute of <database> No

Nested Tags:

Column

Attribute Available Values Default Required
name n/a n/a Yes
phpName n/a (transformed name) No
peerName n/a (uppercase name) No
primaryKey "true", "false" "false" No
required "true", "false" "false" No
type "BOOLEAN"
"TINYINT"
"SMALLINT"
"INTEGER"
"BIGINT"
"DOUBLE"
"FLOAT"
"REAL"
"DECIMAL"
"CHAR"
"VARCHAR"
"LONGVARCHAR"
"DATE"
"TIME"
"TIMESTAMP"
"BLOB"
"CLOB"
 "VARCHAR" No
size n/a n/a No
scale n/a n/a No
default n/a n/a No
autoIncrement "true", "false" "false"  
description n/a n/a No
phpNamingMethod "nochange", "underscore", "phpname" phpNamingMethod attribute of <table> No
inheritance "single", "false" "false" No
inputValidator n/a n/a No

Nested Tags:

Inheritance

Attribute Available Values Default Required
key n/a n/a Yes
class n/a n/a Yes
extends n/a n/a No

Foreign-Key

Attribute Available Values Default Required
foreignTable n/a n/a Yes
name n/a n/a No
onDelete "cascade","setnull", "restrict" "restrict" No

Nested Tags:

Reference

Attribute Available Values Default Required
local n/a n/a Yes
foreign n/a n/a Yes

Index

Attribute Available Values Default Required
name n/a n/a No

Nested Tags:

Index-Column

Attribute Available Values Default Required
name n/a n/a Yes
size n/a n/a No

Unique

Attribute Available Values Default Required
name n/a n/a No

Nested Tags:

Unique-Column

Attribute Available Values Default Required
name n/a n/a Yes