thefrozenfire/dataobjectcruft

A tool for finding and removing tables, fields and indexes which are no longer needed in a SilverStripe database

SilverStripe DataObject Cruft

This module provides a tool in DatabaseAdmin for analyzing and removing parts of the database schema which are left-over from earlier development or removed modules (a.k.a. cruft)., _(*1)

Requirements

• SilverStripe 3.0+

Installation

This module can be installed using composer, by adding the package thefrozenfire/dataobjectcruft, or by cloning this repository to the folder dataobjectcruft. It is recommended that you not install this package in your production environment, as its security impact has not been evaluated., _(*2)

Usage

Once installed, run /dev/build to ensure that the necessary extensions are loaded. Simply visit /dev/scrub to view tables, fields, and indexes which have been identified as not being part of the SilverStripe-generated schema., _(*3)

Before proceeding with any use of this tool, you are urged to ensure that you have recent backups which you can restore from, in case something goes wrong., _(*4)

Not all items listed in this interface are guaranteed to be safely removeable. There are certain situations involving an overloaded DataObject::requireTable, or a DataExtension::augmentDatabase, which can result in additional schema data being generated. Please inspect each schema item that is listed, and only select those items which you are sure are not necessary., _(*5)

Once you have selected each item which you wish to removed, click the "Delete Cruft" button. This will remove all selected schema data., _(*6)