Skip to content
views.install 5.28 KiB
Newer Older
 * @file views.install
 * Contains install and update functions for Views.
Earl Miles's avatar
Earl Miles committed

function views_install() {
  drupal_set_message('Installing views');
  drupal_install_schema('views');
  db_query("UPDATE {system} SET weight = 10 WHERE name = 'views'");
function views_uninstall() {
  drupal_uninstall_schema('views');

/**
 * Implementation of hook_schema
 */
function views_schema() {
  $schema['views_view'] = array(
    'description' => t('Stores the general data for a view.'),
    'fields' => array(
      'vid' => array(
Earl Miles's avatar
Earl Miles committed
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => t('The view ID of the field, defined by the database.'),
        'no export' => TRUE,
      ),
      'name' => array(
Earl Miles's avatar
Earl Miles committed
        'type' => 'varchar',
        'length' => '32',
Earl Miles's avatar
Earl Miles committed
        'not null' => TRUE,
        'description' => t('The unique name of the view. This is the primary field views are loaded from, and is used so that views may be internal and not necessarily in the database. May only be alphanumeric characters plus underscores.'),
      ),
      'description' => array(
Earl Miles's avatar
Earl Miles committed
        'type' => 'varchar',
        'length' => '255',
        'default' => '',
        'description' => t('A description of the view for the admin interface.'),
      ),
Earl Miles's avatar
Earl Miles committed
      'tag' => array(
        'type' => 'varchar',
        'length' => '255',
        'default' => '',
        'description' => t('A tag used to group/sort views in the admin interface'),
      ),
Earl Miles's avatar
Earl Miles committed
        'type' => 'blob',
        'description' => t('A chunk of PHP code that can be used to provide modifications to the view prior to building.'),
      ),
      'base_table' => array(
Earl Miles's avatar
Earl Miles committed
        'type' => 'varchar',
        'length' => '32',
Earl Miles's avatar
Earl Miles committed
        'not null' => TRUE,
        'description' => t('What table this view is based on, such as node, user, comment, or term.'),
      ),
      'is_cacheable' => array(
Earl Miles's avatar
Earl Miles committed
        'type' => 'int',
        'default' => 0,
        'size' => 'tiny',
        'description' => t('A boolean to indicate whether or not this view may have its query cached.'),
      ),
    ),
    'primary key' => array('vid'),
    'unique key' => array('name' => array('name')),
  );

  $schema['views_display'] = array(
    'description' => t('Stores information about each display attached to a view.'),
    'fields' => array(
      'vid' => array(
Earl Miles's avatar
Earl Miles committed
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'description' => t('The view this display is attached to.'),
        'no export' => TRUE,
      ),
Earl Miles's avatar
Earl Miles committed
      'id' => array(
Earl Miles's avatar
Earl Miles committed
        'type' => 'varchar',
        'length' => '64',
Earl Miles's avatar
Earl Miles committed
        'not null' => TRUE,
Earl Miles's avatar
Earl Miles committed
        'description' => t('An identifier for this display; usually generated from the display_plugin, so should be something like page or page_1 or block_2, etc.'),
Earl Miles's avatar
Earl Miles committed
      'display_title' => array(
Earl Miles's avatar
Earl Miles committed
        'type' => 'varchar',
        'length' => '64',
Earl Miles's avatar
Earl Miles committed
        'not null' => TRUE,
Earl Miles's avatar
Earl Miles committed
        'description' => t('The title of the display, viewable by the administrator.'),
      ),
      'display_plugin' => array(
        'type' => 'varchar',
        'length' => '64',
        'default' => '',
        'not null' => TRUE,
        'description' => t('The type of the display. Usually page, block or embed, but is pluggable so may be other things.'),
Earl Miles's avatar
Earl Miles committed
        'type' => 'int',
        'default' => 0,
        'description' => t('The order in which this display is loaded.'),
      ),
      'display_options' => array(
Earl Miles's avatar
Earl Miles committed
        'type' => 'blob',
        'description' => t('A serialized array of options for this display; it contains options that are generally only pertinent to that display plugin type.'),
        'serialize' => TRUE,
        'serialized default' => 'a:0:{}',
      ),
    ),
    'indexes' => array('vid' => array('vid', 'position')),
  );

  $schema['cache_views'] = drupal_get_schema_unprocessed('system', 'cache');
Earl Miles's avatar
Earl Miles committed
  $schema['views_object_cache'] = array(
    'description' => t('A special cache used to store objects that are being edited; it serves to save state in an ordinarily stateless environment.'),
    'fields' => array(
      'sid' => array(
        'type' => 'varchar',
        'length' => '64',
        'description' => t('The session ID this cache object belongs to.'),
      ),
      'name' => array(
        'type' => 'varchar',
        'length' => '32',
        'description' => t('The name of the view this cache is attached to.'),
      ),
      'obj' => array(
        'type' => 'varchar',
        'length' => '32',
        'description' => t('The name of the object this cache is attached to; this essentially represents the owner so that several sub-systems can use this cache.'),
      ),
      'updated' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'description' => t('The time this cache was created or updated.'),
      ),
      'data' => array(
        'type' => 'blob',
        'description' => t('Serialized data being stored.'),
        'serialize' => TRUE,
      ),
    ),
    'indexes' => array(
      'sid_obj_name' => array('sid', 'obj', 'name'),
      'updated' => array('updated'),
    ),
  );