adservices/service-core/java/com/android/adservices/data/topics/migration/ITopicsDbMigrator.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.adservices.data.topics.migration;

import android.database.sqlite.SQLiteDatabase;

/**
 * Its implementations will have logic to migration from a version to next version. The logic would
 * essentially have pre data migration, data transfer and post migration (cleanup) steps. Caller
 * should invoke {@link ITopicsDbMigrator#performMigration(SQLiteDatabase, int, int)} API to perform
 * the migration.
 */
public interface ITopicsDbMigrator {
    /**
     * Migrates the database version from current version on device to another version.
     *
     * @param db db to perform migration on
     * @param oldVersion device version of database
     * @param newVersion target version to create the database
     */
    void performMigration(SQLiteDatabase db, int oldVersion, int newVersion);
}