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