Columns
| Column | Type | Size | Nulls | Auto | Default | Children | Parents | Comments | ||
|---|---|---|---|---|---|---|---|---|---|---|
| id | INT UNSIGNED | 10 | √ | null |
|
|
Unique Custom Field ID |
|||
| custom_group_id | INT UNSIGNED | 10 | null |
|
|
FK to civicrm_custom_group. |
||||
| name | VARCHAR | 64 | √ | null |
|
|
Variable name/programmatic handle for this group. |
|||
| data_type | VARCHAR | 16 | null |
|
|
Controls location of data storage in extended_data table. |
||||
| html_type | VARCHAR | 32 | null |
|
|
HTML types plus several built-in extended types. |
||||
| default_value | VARCHAR | 255 | √ | null |
|
|
Use form_options.is_default for field_types which use options. |
|||
| is_required | TINYINT | 3 | √ | 0 |
|
|
Is a value required for this property. |
|||
| is_searchable | TINYINT | 3 | √ | 0 |
|
|
Is this property searchable. |
|||
| is_search_range | TINYINT | 3 | √ | 0 |
|
|
Is this property range searchable. |
|||
| weight | INT | 10 | 1 |
|
|
Controls field display order within an extended property group. |
||||
| mask | VARCHAR | 64 | √ | null |
|
|
Optional format instructions for specific field types, like date types. |
|||
| attributes | VARCHAR | 255 | √ | null |
|
|
Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes |
|||
| javascript | VARCHAR | 255 | √ | null |
|
|
Optional scripting attributes for field. |
|||
| is_active | TINYINT | 3 | √ | 1 |
|
|
Is this property active? |
|||
| is_view | TINYINT | 3 | √ | 0 |
|
|
Is this property set by PHP Code? A code field is viewable but not editable |
|||
| options_per_line | INT UNSIGNED | 10 | √ | null |
|
|
number of options per line for checkbox and radio |
|||
| text_length | INT UNSIGNED | 10 | √ | null |
|
|
field length if alphanumeric |
|||
| start_date_years | INT | 10 | √ | null |
|
|
Date may be up to start_date_years years prior to the current date. |
|||
| end_date_years | INT | 10 | √ | null |
|
|
Date may be up to end_date_years years after the current date. |
|||
| date_format | VARCHAR | 64 | √ | null |
|
|
date format for custom date |
|||
| time_format | INT UNSIGNED | 10 | √ | null |
|
|
time format for custom date |
|||
| note_columns | INT UNSIGNED | 10 | √ | null |
|
|
Number of columns in Note Field |
|||
| note_rows | INT UNSIGNED | 10 | √ | null |
|
|
Number of rows in Note Field |
|||
| column_name | VARCHAR | 255 | √ | null |
|
|
Name of the column that holds the values for this field. |
|||
| option_group_id | INT UNSIGNED | 10 | √ | null |
|
|
For elements with options, the option group id that is used |
|||
| filter | VARCHAR | 255 | √ | null |
|
|
Stores Contact Get API params contact reference custom fields. May be used for other filters in the future. |
|||
| in_selector | TINYINT | 3 | √ | 0 |
|
|
Should the multi-record custom field values be displayed in tab table listing |
|||
| label_en_US | VARCHAR | 255 | √ | null |
|
|
||||
| help_pre_en_US | TEXT | 65535 | √ | null |
|
|
||||
| help_post_en_US | TEXT | 65535 | √ | null |
|
|
||||
| label_fr_CA | VARCHAR | 255 | √ | null |
|
|
||||
| help_pre_fr_CA | TEXT | 65535 | √ | null |
|
|
||||
| help_post_fr_CA | TEXT | 65535 | √ | null |
|
|
Indexes
| Constraint Name | Type | Sort | Column(s) |
|---|---|---|---|
| PRIMARY | Primary key | Asc | id |
| FK_civicrm_custom_field_custom_group_id | Performance | Asc | custom_group_id |
| UI_label_custom_group_id_en_US | Must be unique | Asc/Asc | label_en_US + custom_group_id |
| UI_label_custom_group_id_fr_CA | Must be unique | Asc/Asc | label_fr_CA + custom_group_id |
| UI_name_custom_group_id | Must be unique | Asc/Asc | name + custom_group_id |
Relationships
Close relationships within degrees of separation
