function field_sql_storage_update_8000

Renames the 'language' column to 'langcode' in field data tables.

File

drupal/core/modules/field_sql_storage/field_sql_storage.install, line 79

Install, update, and uninstall functions for the Field SQL Storage module.

Code

function field_sql_storage_update_8000(&$sandbox) {

  // Get field definitions from config, and deleted fields from state system.
  $config_names = config_get_storage_names_with_prefix('field.field');
  $deleted_fields = Drupal::state()
    ->get('field.field.deleted') ?: array();

  // Ditch UUID keys, we will iterate through deleted fields using a numeric
  // index.
  $deleted_fields = array_values($deleted_fields);
  if (empty($config_names) && empty($deleted_fields)) {
    return;
  }
  if (!isset($sandbox['index'])) {
    $sandbox['index'] = 0;
    $sandbox['max'] = count($config_names) + count($deleted_fields);
  }

  // Retrieve the next field definition. When the index exceeds the number of
  // 'configuration' fields, use it to iterate on deleted fields.
  if (isset($config_names[$sandbox['index']])) {
    $field_config = config($config_names[$sandbox['index']])
      ->get();
  }
  else {
    $field_config = $deleted_fields[$sandbox['index'] - count($config_names)];
  }
  if ($field_config['storage']['type'] == 'field_sql_storage') {
    $field = new Field($field_config);

    // Prepare updated schema data structures.
    $primary_key_data = array(
      'entity_type',
      'entity_id',
      'deleted',
      'delta',
      'langcode',
    );
    $primary_key_revision = array(
      'entity_type',
      'entity_id',
      'revision_id',
      'deleted',
      'delta',
      'langcode',
    );
    $langcode_index = array(
      'langcode',
    );
    $field_langcode = array(
      'type' => 'varchar',
      'length' => 32,
      'not null' => TRUE,
      'default' => '',
    );
    $table_info = array(
      _field_sql_storage_tablename($field) => $primary_key_data,
      _field_sql_storage_revision_tablename($field) => $primary_key_revision,
    );
    foreach ($table_info as $table => $primary_key) {

      // Do not update tables which already have the langcode column,
      // created during the upgrade before this update function.
      if (db_field_exists($table, 'language')) {
        db_drop_primary_key($table);
        db_drop_index($table, 'language');
        db_change_field($table, 'language', 'langcode', $field_langcode);
        db_add_primary_key($table, $primary_key);
        db_add_index($table, 'langcode', $langcode_index);
      }
    }
  }
  $sandbox['index']++;
  $sandbox['#finished'] = empty($sandbox['max']) ? 1 : $sandbox['index'] / $sandbox['max'];
}