#866340 follow-up by mikl: Document how to add support for non-standard SQL types to hook_schema().

1 files changed, 10 insertions, 4 deletions

diff --git a/includes/database/schema.inc b/includes/database/schema.inc
index 36c7964c6..184d895ff 100644
--- a/includes/database/schema.inc
+++ b/includes/database/schema.inc
@@ -40,10 +40,16 @@ require_once dirname(__FILE__) . '/query.inc';
  *       description might contain "Always holds the largest (most
  *       recent) {node_revision}.vid value for this nid."
  *     - 'type': The generic datatype: 'char', 'varchar', 'text', 'blob', 'int',
- *       'float', 'numeric', 'serial', 'date', 'datetime' or 'time'. Most types
- *       types just map to the according database engine specific datatypes. Use
- *       'serial' for auto incrementing fields. This will expand to 'INT
- *       auto_increment' on MySQL.
+ *       'float', 'numeric', or 'serial'. Most types just map to the according
+ *       database engine specific datatypes. Use 'serial' for auto incrementing
+ *       fields. This will expand to 'INT auto_increment' on MySQL.
+ *     - 'mysql_type', 'pgsql_type', 'sqlite_type', etc.: If you need to
+ *       use a record type not included in the officially supported list
+ *       of types above, you can specify a type for each database
+ *       backend. In this case, you can leave out the type parameter,
+ *       but be advised that your schema will fail to load on backends that
+ *       do not have a type specified. A possible solution can be to
+ *       use the "text" type as a fallback.
  *     - 'serialize': A boolean indicating whether the field will be stored as
  *       a serialized string.
  *     - 'size': The data size: 'tiny', 'small', 'medium', 'normal',