social_auth.install in Social Auth 3.x

Install, update and uninstall functions for Social Auth.

File

social_auth.install

<?php

/**
 * @file
 * Install, update and uninstall functions for Social Auth.
 */
use Drupal\Core\Database\Database;

/**
 * Add 'social_auth' table when the module is updated from 1.x to 2.x.
 *
 * Nothing changes if version 2.x is in use.
 */
function social_auth_update_8201() {
  $schema = Database::getConnection()
    ->schema();
  if (!$schema
    ->tableExists('social_auth')) {
    $spec = [
      'description' => 'The base table for social_auth entities.',
      'fields' => [
        'id' => [
          'type' => 'serial',
          'length' => 10,
          'not null' => TRUE,
          'unsigned' => TRUE,
        ],
        'uuid' => [
          'type' => 'varchar_ascii',
          'length' => 128,
          'not null' => FALSE,
        ],
        'user_id' => [
          'description' => 'The ID of the target entity.',
          'type' => 'int',
          'length' => 10,
          'not null' => TRUE,
          'unsigned' => TRUE,
        ],
        'plugin_id' => [
          'type' => 'varchar',
          'length' => 255,
          'not null' => TRUE,
        ],
        'provider_user_id' => [
          'type' => 'varchar',
          'length' => 255,
          'not null' => TRUE,
        ],
        'created' => [
          'type' => 'int',
          'length' => 11,
          'not null' => TRUE,
        ],
        'changed' => [
          'type' => 'int',
          'length' => 11,
          'not null' => TRUE,
        ],
        'token' => [
          'type' => 'text',
          'not null' => TRUE,
          'size' => 'big',
        ],
        'additional_data' => [
          'type' => 'text',
          'not null' => TRUE,
          'size' => 'big',
        ],
      ],
      'primary key' => [
        'id',
      ],
      'unique keys' => [
        'social_auth_field__uuid__value' => [
          'uuid',
        ],
      ],
      'indexes' => [
        'social_auth_field__user_id__target_id' => [
          'user_id',
        ],
      ],
    ];
    $schema
      ->createTable('social_auth', $spec);
  }
}

/**
 * Update fields' properties.
 *
 * The updating fields are uuid, created, changed, token, and additional_data.
 */
function social_auth_update_8202() {
  $schema = Database::getConnection()
    ->schema();
  $specs = [
    'uuid' => [
      'type' => 'varchar_ascii',
      'length' => 128,
      'not null' => TRUE,
    ],
    'created' => [
      'type' => 'int',
      'length' => 11,
      'not null' => FALSE,
    ],
    'changed' => [
      'type' => 'int',
      'length' => 11,
      'not null' => FALSE,
    ],
    'token' => [
      'type' => 'text',
      'not null' => FALSE,
      'size' => 'big',
    ],
    'additional_data' => [
      'type' => 'text',
      'not null' => FALSE,
      'size' => 'big',
    ],
  ];
  foreach ($specs as $field => $spec) {
    $schema
      ->changeField('social_auth', $field, $field, $spec);
  }
}

Functions

Name	Description
social_auth_update_8201	Add 'social_auth' table when the module is updated from 1.x to 2.x.
social_auth_update_8202	Update fields' properties.