Convert the schema documentation into a Perl class that contains the same

information but can also return the SQL commands or apply them to a
database.

1 files changed, 0 insertions, 156 deletions

diff --git a/docs/design-schema b/docs/design-schema
deleted file mode 100644
index 8e04f49..0000000
--- a/docs/design-schema
+++ /dev/null
@@ -1,156 +0,0 @@
-                      Database Schema for the Wallet
-
-Introduction
-
-    Here should be a comprehensive list of the tables used by the wallet,
-    the SQL to create those tables, and a specification of what they're
-    for.  It's possible that this file will later be written in some other
-    format to make extraction of the SQL easier.  Please do not copy this
-    data into some other file that could get out of sync with this
-    documentation; instead, if it's necessary to change the format, please
-    move this file elsewhere and keep the documentation with the schema.
-
-Object Metadata
-
-    Each object stored in the wallet is represented by an entry in the
-    objects table:
-
-      create table objects
-         (ob_name               varchar(255) not null,
-          ob_type               varchar(16)
-              not null references types(ty_name),
-          ob_owner              integer default null references acls(ac_id),
-          ob_acl_get            integer default null references acls(ac_id),
-          ob_acl_store          integer default null references acls(ac_id),
-          ob_acl_show           integer default null references acls(ac_id),
-          ob_acl_destroy        integer default null references acls(ac_id),
-          ob_acl_flags          integer default null references acls(ac_id),
-          ob_expires            datetime default null,
-          ob_created_by         varchar(255) not null,
-          ob_created_from       varchar(255) not null,
-          ob_created_on         datetime not null,
-          ob_stored_by          varchar(255) default null,
-          ob_stored_from        varchar(255) default null,
-          ob_stored_on          datetime default null,
-          ob_downloaded_by      varchar(255) default null,
-          ob_downloaded_from    varchar(255) default null,
-          ob_downloaded_on      datetime default null,
-          primary key (ob_name, ob_type),
-          index (ob_owner),
-          index (ob_expires));
-
-    Object names are not globally unique but only unique within their
-    type, so the table has a joint primary key.  I haven't yet decided
-    what indices the table will need.
-
-    Each object has an owner and then up to five more specific ACLs.  The
-    ob_acl_flags ACL controls who can set flags on this object.  Each ACL
-    references entries in the following table:
-
-      create table acls
-         (ac_id                 integer auto_increment primary key,
-          ac_name               varchar(255) not null,
-          unique index (ac_name));
-
-    This just keeps track of unique ACL identifiers.  The data is then
-    stored in:
-
-      create table acl_entries
-         (ae_id                 integer
-              not null references acls(ac_id),
-          ae_scheme             varchar(32)
-              not null references acl_schemes(as_name),
-          ae_identifier         varchar(255)
-              not null);
-
-    Each object may have zero or more flags associated with it.
-
-      create table flags
-         (fl_object             varchar(255)
-              not null references objects(ob_name),
-          fl_type               varchar(16)
-              not null references objects(ob_type),
-          fl_flag               varchar(32)
-              not null references flag_names(fn_name));
-
-    Every change made to any object in the wallet database will be
-    recorded in this table.
-
-      create table object_history
-         (oh_id                 integer auto_increment primary key,
-          oh_object             varchar(255)
-              not null references objects(ob_object),
-          oh_type               varchar(16)
-              not null references objects(ob_type),
-          oh_action
-               enum('create', 'destroy', 'get', 'store', set') not null,
-          oh_field
-              enum('owner', 'acl_get', 'acl_store', 'acl_show',
-                   'acl_destroy', 'acl_flags', 'expires', 'flags',
-                   'type_data'),
-          oh_type_field         varchar(255),
-          oh_from               varchar(255),
-          oh_to                 varchar(255),
-          oh_by                 varchar(255) not null,
-          oh_from               varchar(255) not hull,
-          oh_on                 datetime not null,
-          index (oh_object, oh_type));
-
-    For a change of type create, get, store, or destroy, only the action
-    and the trace records (by, from, and on) are stored.  For changes to
-    columns or to the flags table, oh_field takes what attribute is
-    changed, oh_from takes the previous value converted to a string and
-    oh_to takes the next value similarly converted to a string.  The
-    special field value "type_data" is used when type-specific data is
-    changed, and in that case (and only that case) some type-specific name
-    for the data being changed is stored in oh_type_field.
-
-    Every change made to any ACL in the database will be recorded in this
-    table.
-
-      create table acl_history
-         (ah_id                 integer auto_increment primary key,
-          ah_acl                integer not null,
-          ah_action             enum('create', 'destroy', 'add', 'remove')
-              not null,
-          ah_scheme             varchar(32),
-          ah_identifier         varchar(255),
-          ah_by                 varchar(255) not null,
-          ah_from               varchar(255) not null,
-          ah_on                 datetime not null,
-          index (ah_acl));
-
-    For a change of type create or destroy, only the action and the trace
-    records (by, from, and on) are stored.  For a change to the lines of
-    an ACL, the scheme and identifier of the line that was added or
-    removed is included.  Note that changes to the ACL name are not
-    recorded; ACLs are always tracked by system-generated ID, so name
-    changes are purely cosmetic.
-
-    The following are normalization tables used to constrain the values 
-
-      create table types
-         (ty_name               varchar(16) primary key);
-
-      create table acl_schemes
-         (as_name               varchar(32) primary key);
-
-      create table flag_names
-         (fn_name               varchar(32) primary key);
-
-Storage Backend Data
-
-    To support restricting the allowable enctypes for a given keytab, the
-    keytab backend will use the following table:
-
-      create table keytab_enctypes
-         (ke_principal          varchar(255)
-              not null references objects(ob_name),
-          ke_enctype            varchar(255)
-              not null references enctypes(en_name));
-
-    There is a normalization table to ensure that only supported enctypes
-    are configured:
-
-       create table enctypes
-          (en_name               varchar(255) primary key);