Práticas recomendadas para migração de banco de dados no aplicativo para Sqlite

Estou usando o sqlite para o meu iphone e prevejo que o esquema do banco de dados pode mudar com o tempo. Quais são as pegadinhas, convenções de nomenclatura e coisas a serem observadas para sempre fazer uma migração bem-sucedida?

Por exemplo, pensei em acrescentar uma versão ao nome do banco de dados (por exemplo, Database_v1).

Eu mantenho um aplicativo que precisa atualizar periodicamente um banco de dados sqlite e migrar bancos de dados antigos para o novo esquema e aqui está o que eu faço:

Para rastrear a versão do banco de dados, eu uso a variável integrada de versão do usuário que o sqlite fornece (o sqlite não faz nada com essa variável, você pode usá-la como quiser). Ele começa em 0 e você pode obter / definir essa variável com as seguintes instruções sqlite:

> PRAGMA user_version;  
> PRAGMA user_version = 1;

Quando o aplicativo é iniciado, verifico a versão do usuário atual, aplico as alterações necessárias para atualizar o esquema e, em seguida, atualizo a versão do usuário. Eu envolvo as atualizações em uma transação para que, se algo der errado, as alterações não sejam confirmadas.

Para fazer alterações no esquema, o sqlite suporta a sintaxe "ALTER TABLE" para certas operações (renomear a tabela ou adicionar uma coluna). Esta é uma maneira fácil de atualizar as tabelas existentes no local. Consulte a documentação aqui: http://www.sqlite.org/lang_altertable.html . Para excluir colunas ou outras alterações que não são suportadas pela sintaxe "ALTER TABLE", eu crio uma nova tabela, migro a data para ela, elimino a tabela antiga e renomeio a nova tabela com o nome original.

A resposta de Just Curious é perfeita (você entendeu!) E é o que usamos para rastrear a versão do esquema de banco de dados que está atualmente no aplicativo.

Para executar as migrações que precisam ocorrer para obter user_version correspondente à versão de esquema esperada do aplicativo, usamos uma instrução switch. Aqui está um exemplo recortado de como isso se parece em nosso aplicativo Strip :

- (void) migrateToSchemaFromVersion:(NSInteger)fromVersion toVersion:(NSInteger)toVersion { 
    // allow migrations to fall thru switch cases to do a complete run
    // start with current version + 1
    [self beginTransaction];
    switch (fromVersion + 1) {
        case 3:
            // change pin type to mode 'pin' for keyboard handling changes
            // removing types from previous schema
            sqlite3_exec(db, "DELETE FROM types;", NULL, NULL, NULL);
            NSLog(@"installing current types");
            [self loadInitialData];
        case 4:
            //adds support for recent view tracking
            sqlite3_exec(db, "ALTER TABLE entries ADD COLUMN touched_at TEXT;", NULL, NULL, NULL);
        case 5:
            {
                sqlite3_exec(db, "ALTER TABLE categories ADD COLUMN image TEXT;", NULL, NULL, NULL);
                sqlite3_exec(db, "ALTER TABLE categories ADD COLUMN entry_count INTEGER;", NULL, NULL, NULL);
                sqlite3_exec(db, "CREATE INDEX IF NOT EXISTS categories_id_idx ON categories(id);", NULL, NULL, NULL);
                sqlite3_exec(db, "CREATE INDEX IF NOT EXISTS categories_name_id ON categories(name);", NULL, NULL, NULL);
                sqlite3_exec(db, "CREATE INDEX IF NOT EXISTS entries_id_idx ON entries(id);", NULL, NULL, NULL);

               // etc...
            }
    }

    [self setSchemaVersion];
    [self endTransaction];
}

Deixe-me compartilhar alguns códigos de migração com FMDB e MBProgressHUD.

Veja como você lê e escreve o número da versão do esquema (presumivelmente, faz parte de uma classe de modelo, no meu caso é uma classe singleton chamada Database):

- (int)databaseSchemaVersion {
    FMResultSet *resultSet = [[self database] executeQuery:@"PRAGMA user_version"];
    int version = 0;
    if ([resultSet next]) {
        version = [resultSet intForColumnIndex:0];
    }
    return version;
}

- (void)setDatabaseSchemaVersion:(int)version {
    // FMDB cannot execute this query because FMDB tries to use prepared statements
    sqlite3_exec([self database].sqliteHandle, [[NSString stringWithFormat:@"PRAGMA user_version = %d", DatabaseSchemaVersionLatest] UTF8String], NULL, NULL, NULL);
}

Este é o [self database]método que abre lentamente o banco de dados:

- (FMDatabase *)database {
    if (!_databaseOpen) {
        _databaseOpen = YES;

        NSString *documentsDir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
        NSString *databaseName = [NSString stringWithFormat:@"userdata.sqlite"];

        _database = [[FMDatabase alloc] initWithPath:[documentsDir stringByAppendingPathComponent:databaseName]];
        _database.logsErrors = YES;

        if (![_database openWithFlags:SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE | SQLITE_OPEN_FILEPROTECTION_COMPLETE]) {
            _database = nil;
        } else {
            NSLog(@"Database schema version is %d", [self databaseSchemaVersion]);
        }
    }
    return _database;
}

E aqui estão os métodos de migração chamados a partir do controlador de visualização:

- (BOOL)databaseNeedsMigration {
    return [self databaseSchemaVersion] < databaseSchemaVersionLatest;
}

- (void)migrateDatabase {
    int version = [self databaseSchemaVersion];
    if (version >= databaseSchemaVersionLatest)
        return;

    NSLog(@"Migrating database schema from version %d to version %d", version, databaseSchemaVersionLatest);

    // ...the actual migration code...
    if (version < 1) {
        [[self database] executeUpdate:@"CREATE TABLE foo (...)"];
    }

    [self setDatabaseSchemaVersion:DatabaseSchemaVersionLatest];
    NSLog(@"Database schema version after migration is %d", [self databaseSchemaVersion]);
}

E aqui está o código do controlador de visualização raiz que invoca a migração, usando MBProgressHUD para exibir um painel de progresso:

- (void)viewDidAppear {
    [super viewDidAppear];
    if ([[Database sharedDatabase] userDatabaseNeedsMigration]) {
        MBProgressHUD *hud = [[MBProgressHUD alloc] initWithView:self.view.window];
        [self.view.window addSubview:hud];
        hud.removeFromSuperViewOnHide = YES;
        hud.graceTime = 0.2;
        hud.minShowTime = 0.5;
        hud.labelText = @"Upgrading data";
        hud.taskInProgress = YES;
        [[UIApplication sharedApplication] beginIgnoringInteractionEvents];

        [hud showAnimated:YES whileExecutingBlock:^{
            [[Database sharedDatabase] migrateUserDatabase];
        } onQueue:dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_BACKGROUND, 0) completionBlock:^{
            [[UIApplication sharedApplication] endIgnoringInteractionEvents];
        }];
    }
}

A melhor solução da IMO é construir uma estrutura de atualização do SQLite. Eu tive o mesmo problema (no mundo C #) e construí meu próprio framework. Você pode ler sobre isso aqui . Ele funciona perfeitamente e faz com que minhas atualizações (antes terríveis) funcionem com o mínimo de esforço da minha parte.

Embora a biblioteca seja implementada em C #, as idéias apresentadas devem funcionar bem no seu caso também.

1. Crie uma /migrationspasta com a lista de migrações baseadas em SQL, onde cada migração se parece com isto:

/migrations/001-categories.sql

-- Up
CREATE TABLE Category (id INTEGER PRIMARY KEY, name TEXT);
INSERT INTO Category (id, name) VALUES (1, 'Test');

-- Down
DROP TABLE User;

/migrations/002-posts.sql

-- Up
CREATE TABLE Post (id INTEGER PRIMARY KEY, categoryId INTEGER, text TEXT);

-- Down
DROP TABLE Post;

2. Crie uma tabela de banco de dados contendo a lista de migrações aplicadas, por exemplo:

CREATE TABLE Migration (name TEXT);

3. Atualize a lógica de bootstrap do aplicativo para que antes de iniciar, pegue a lista de migrações da /migrationspasta e execute as migrações que ainda não foram aplicadas.

Aqui está um exemplo implementado com JavaScript: Cliente SQLite para aplicativos Node.js

Algumas dicas...

1) Eu recomendo colocar todo o código para migrar seu banco de dados em um NSOperation e executá-lo em segundo plano. Você pode mostrar um UIAlertView personalizado com um botão giratório enquanto o banco de dados está sendo migrado.

2) Certifique-se de copiar seu banco de dados do pacote para os documentos do aplicativo e usá-lo desse local, caso contrário, você apenas substituirá todo o banco de dados a cada atualização do aplicativo e, em seguida, migrará o novo banco de dados vazio.

3) FMDB é ótimo, mas seu método executeQuery não pode fazer consultas PRAGMA por algum motivo. Você precisará escrever seu próprio método que usa sqlite3 diretamente se quiser verificar a versão do esquema usando PRAGMA user_version.

4) Esta estrutura de código irá garantir que suas atualizações sejam executadas em ordem, e que todas as atualizações sejam executadas, não importa quanto tempo o usuário fica entre as atualizações do aplicativo. Ele poderia ser refatorado posteriormente, mas esta é uma maneira muito simples de olhar para ele. Esse método pode ser executado com segurança toda vez que seu singleton de dados é instanciado e custa apenas uma pequena consulta db que só acontece uma vez por sessão se você configurar seu singleton de dados corretamente.

- (void)upgradeDatabaseIfNeeded {
    if ([self databaseSchemaVersion] < 3)
    {
        if ([self databaseSchemaVersion] < 2)
        {
            if ([self databaseSchemaVersion] < 1)
            {
                // run statements to upgrade from 0 to 1
            }
            // run statements to upgrade from 1 to 2
        }
        // run statements to upgrade from 2 to 3

        // and so on...

        // set this to the latest version number
        [self setDatabaseSchemaVersion:3];
    }
}

Se você alterar o esquema do banco de dados e todo o código que o está usando em um lockstep, como é provável que seja o caso em aplicativos integrados e localizados por telefone, o problema está realmente bem sob controle (nada comparável ao pesadelo que é a migração do esquema em um banco de dados corporativo que pode servir centenas de aplicativos - nem todos sob o controle do DBA ;-).

Para .net, você pode usar lib:

EntityFrameworkCore.Sqlite.Migrations

É simples, portanto, para qualquer outra plataforma, você pode implementar facilmente o mesmo comportamento do lib.