Fieldtype::getDatabaseSchema() method

Get the database schema for this field

  • Should return an array like in the example below, indexed by field name with type details as the value (as it would be in an SQL statement).

  • Indexes are passed through with a keys array. Note that pages_id as a field and primary key may be retrieved by starting with the parent schema return from the built-in getDatabaseSchema() method.

  • At minimum, each Fieldtype must add a data field as well as an index for it.

  • If you want a PHP NULL value to become a NULL in the database, your column definition must specify: DEFAULT NULL.

Example

array(
 'data' => 'mediumtext NOT NULL',
 'keys' => array(
   'primary' => 'PRIMARY KEY (`pages_id`)',
   'FULLTEXT KEY data (data)',
 ),
 'xtra' => array(
   // optional extras, MySQL defaults will be used if omitted
   'append' =>
     'ENGINE={$this->config->dbEngine} ' .
     'DEFAULT CHARSET={$this->config->dbCharset}'

   // true (default) if this schema provides all storage for this fieldtype.
   // false if other storage is involved with this fieldtype, beyond this schema
   // (like repeaters, PageTable, etc.)
   'all' => true,
 )
);

Usage

$array = $fieldtype->getDatabaseSchema(Field $field);

Arguments

NameType(s)Description
fieldField

In case it's needed for the schema, but typically isn't.

Return value

array


Fieldtype methods and properties

API reference based on ProcessWire core version 3.0.234

Latest news

  • ProcessWire Weekly #511
    In the 511th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new third party module called Auto AVIF, and more. Read on!
    Weekly.pw / 25 February 2024
  • Using date range fields in ProcessWire
    This week we'll take a detailed look at the newest addition to the ProFields set of modules: the Date Range Fieldtype and Inputfield.
    Blog / 24 November 2023
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani