tripal/tripal_bulk_loader/tripal_bulk_loader.install

<?php
/**
 * @file
 * @todo Add file header description
 */

/**
 * Implements hook_schema
 *
 * Creates the following tables in the Drupal database:
 *  - tripal_bulk_loader: Stores extra details for bulk loading jobs (nodes)
 *  - tripal_bulk_loader_template: Stores all loading templates
 *  - tripal_bulk_loader_inserted: Keeps track of all records inserted for a given bulk loading job
 */
function tripal_bulk_loader_schema() {
  $schema = array();
  $schema['tripal_bulk_loader'] = array(
    'fields' => array(
      'nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'loader_name' => array(
        'type' => 'varchar',
      ),
      'template_id' => array(
        'type' => 'int',
      ),
      'file' => array(
        'type' => 'varchar',
        'not null' => TRUE
      ),
      'job_id' => array(
        'type' => 'int',
      ),
      'job_status' => array(
        'type' => 'varchar',
      ),
      'file_has_header' => array(
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 0,
      ),
      'keep_track_inserted' => array(
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 1
      ),
    ),
      'primary key' => array('nid'),
      'unique keys' => array(
        'name' => array('loader_name')
    ),
  );
  $schema['tripal_bulk_loader_template'] = array(
      'fields' => array(
         'template_id' => array(
            'type' => 'serial',
            'unsigned' => TRUE,
            'not null' => TRUE,
          ),
          'name' => array(
            'type' => 'varchar',
          ),
          'template_array' => array(
            'type' => 'varchar',
          ),
          'created' => array(
            'description' => 'The Unix timestamp when the template was created.',
            'type' => 'int',
            'not null' => TRUE,
            'default' => 0,
          ),
          'changed' => array(
            'description' => 'The Unix timestamp when the template was most recently saved.',
            'type' => 'int',
            'not null' => TRUE,
            'default' => 0,
          )
    ),
      'primary key' => array('template_id'),
    'unique keys' => array(
        'name' => array('name')
    ),
  );
  $schema['tripal_bulk_loader_inserted'] = array(
    'fields' => array(
      'tripal_bulk_loader_inserted_id' => array(
        'type' => 'serial',
        'not null' => TRUE
      ),
      'nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'table_inserted_into' => array(
        'type' => 'varchar',
        'not null' => TRUE,
      ),
      'table_primary_key' => array(
        'type' => 'varchar',
        'not null' => TRUE,
      ),
      'ids_inserted' => array(
        'type' => 'text',
        'not null' => TRUE
      ),
    ),
    'primary key' => array('tripal_bulk_loader_inserted_id'),
  );
  $schema['tripal_bulk_loader_constants'] = array(
    'fields' => array(
      'constant_id' => array(
        'type' => 'serial',
        'not null' => TRUE
      ),
      'nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'group_id' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0
      ),
      'chado_table' => array(
        'type' => 'varchar',
        'not null' => TRUE,
      ),
      'chado_field' => array(
        'type' => 'varchar',
        'not null' => TRUE,
      ),
      'record_id' => array(
        'type' => 'int',
        'not null' => TRUE
      ),
      'field_id' => array(
        'type' => 'int',
        'not null' => TRUE
      ),
      'value' => array(
        'type' => 'text',
      ),
    ),
    'primary key' => array('constant_id'),
  );

  return $schema;
}

/**
 * Update schema for version 6.x-0.3.1b-1.5
 * - Add the tripal_bulk_loader_constants table
 */
function tripal_bulk_loader_update_6150() {

  // Create tripal_bulk_loader_constants table
  $schema = tripal_bulk_loader_schema();
  db_create_table('tripal_bulk_loader_constants', $schema['tripal_bulk_loader_constants']);

  return 'Added support for loader-specific constants.';

}

/**
 * Update schema for version 6.x-0.3.1b-1.5
 * - Add the tripal_bulk_loader_constants.group_id column
 *   to allow multiple sets of constants per job
 */
function tripal_bulk_loader_update_6151() {

  $schema = tripal_bulk_loader_schema();
  db_add_field(
    'tripal_bulk_loader_constants',
    'group_id',
    array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0
      )
    );

  return 'Added support for multiple sets of loader-specific constants.';
}

function tripal_bulk_loader_update_6152() {

  db_add_field(
    'tripal_bulk_loader',
    'keep_track_inserted',
    array(
      'type' => 'int',
      'size' => 'tiny',
      'not null' => TRUE,
      'default' => 1
    )
  );

  return 'Added ability to rollback loading job based on storing loaded ids.';
}

/**
 * Update to 7.x-2.0
 * -Cast tripal_bulk_loader.template_id to int field
 */
function tripal_bulk_loader_update_7201() {

  db_change_field(
    'tripal_bulk_loader',
    'template_id',
    'template_id',
    array('type' => 'int')
  );


  db_add_field(
    'tripal_bulk_loader_template',
    'created',
    array(
      'description' => 'The Unix timestamp when the template was created.',
      'type' => 'int',
      'not null' => TRUE,
      'default' => 0,
    )
  );

  db_add_field(
    'tripal_bulk_loader_template',
    'changed',
    array(
      'description' => 'The Unix timestamp when the template was most recently saved.',
      'type' => 'int',
      'not null' => TRUE,
      'default' => 0,
    )
  );


  return 'Updated tripal_bulk_loader.template_id from character to integer '
    . 'and added time created/updated track to templates.';

}

/**
 * Implementation of hook_requirements().
 */
function tripal_bulk_loader_requirements($phase) {
  $requirements = array();
  if ($phase == 'install') {
    // make sure chado is installed
    if (!tripal_core_is_chado_installed()) {
      $requirements ['tripal_bulk_loader'] = array(
            'title' => "tripal_bulk_loader",
            'value' => "ERROR: Chado most be installed before this module can be enabled",
            'severity' => REQUIREMENT_ERROR,
      );
    }
  }
  return $requirements;
}