[Summary view] [Print] [Text view]

   1  $Id: README.txt,v 1.2 2008/05/08 03:25:05 bjaspan Exp $
   2  
   3  Schema module
   4  
   5  PREREQUISITES
   6  
   7  Drupal 6.x
   8  
   9  OVERVIEW
  10  
  11  Introduced in Drupal 6, the Schema API allows modules to declare their
  12  database tables in a structured array (similar to the Form API) and
  13  provides API functions for creating, dropping, and changing tables,
  14  columns, keys, and indexes.
  15  
  16  The Schema module provides additional Schema-related functionality not
  17  provided by the core Schema API that is useful for module
  18  developers. Currently, this includes:
  19  
  20  * Schema documentation: hyperlinked display of the schema's embedded
  21    documentation explaining what each table and field is for. 
  22  * Schema structure generation: the module examines the live database
  23    and creates Schema API data structures for all tables that match the
  24    live database. 
  25  * Schema comparison: the module compares the live database structure
  26    with the schema structure declared by all enabled modules, reporting
  27    on any missing or incorrect tables. 
  28  
  29  Note for MySQL users: The Schema module requires MySQL 5. Prior
  30  versions of MySQL do not support the INFORMATION_SCHEMA database that
  31  the Schema module uses to inspect the database.
  32  
  33  INSTALLATION
  34  
  35  Install and activate Schema like every other Drupal module.
  36  
  37  ADMINISTRATOR USAGE
  38  
  39  Visit Administer >> Site building >> Schema to access Schema's UI
  40  functionality.
  41  
  42  AUTHOR
  43  
  44  Barry Jaspan
  45  firstname at lastname dot org