_The SonarQube DB Copy Tool is available to customers with [SonarSource support](https://www.sonarsource.com/support/)._
-This tool is provided to help you migrate your SonarQube database from one DB vendor to another. If, for instance, you've been using your SonarQube instance with Oracle and you want to migrate to PostgreSQL without loosing your analysis history, the SonarQube DB Copy Tool is what you need.
+We provide this tool to help you migrate your SonarQube database from one database vendor to another. For example, if you've been using your SonarQube instance with Oracle and want to migrate to PostgreSQL without losing your analysis history, the SonarQube DB Copy Tool can help.
-In the following lines we will talk about "source" and "target" SonarQube database instances. The source instance is the database you want to discard and the target is the one you want to move to.
+In the following lines, we mention "source" and "target" SonarQube database instances. The source instance is the database you're moving from, and the target instance is the one you're moving to.
-The procedure is basically as follows:
+Here's an overview of the general procedure:
-* connect to both the source and target databases
-* read the data from the source database table by table
-* save the data into the target database table by table
-* recreate the sequences, index, ... on the target database
+* Connect to both the source and target databases.
+* Read the data from the source database table by table.
+* Save the data into the target database table by table.
+* Recreate the sequences, index, ... on the target database.
## Installation
-The SonarQube DB Copy Tool is provided as a standalone JAR file. **It must not be installed in your source or target SonarQube instances**. Put the JAR wherever your want on your machine, the only prerequisite is that this machine must be authorized to access your source and target SonarQube databases.
+The SonarQube DB Copy Tool is provided as a standalone JAR file. You need to make sure you're meeting the following conditions:
-The version of the JAR to use must be at least **1.3.3.627**
+* The JAR file must not be installed in your source or target SonarQube instances. You can put the JAR file anywhere on your machine as long as your machine is authorized to access your source and target SonarQube databases.
+* You must be using at least version **1.3.3.627** of the JAR file.
-## DB Copy Preparation Phase
-In the preparation phase, you ready the target database by setting up SonarQube schema and populating it with the necessary tables so that you end up with the same database schema in the source and the target.
+## DB Copy preparation phase
+To prepare for the DB Copy Tool, you need to ready the target instance by setting up a SonarQube schema and populating it with the necessary tables so that your source and target instances have the same database schema.
-1. Make sure your target database is up and running
+1. Make sure your target database is up and running.
1. On your target database, create the `sonar` schema.
1. Download and expand a copy of SonarQube that exactly matches the version you're running.
1. Configure your SonarQube copy to connect to the target database. (If you've placed your SonarQube copy on the same server that runs your primary SonarQube instance, you'll also need to configure non-default ports for your copy SonarQube instance.)
1. Once your copy instance is up and running (this indicates that the schema is fully populated), you can stop and delete it.
1. Refresh the Database Statistics on the target database before restarting SonarQube
-At this point, you have in your source and target databases the exact same lists of tables.
+At this point, you have the exact same list of tables in your source and target databases.
-## DB Copy Run Phase
-There are only four steps in this phase:
+## DB Copy run phase
+To run the DB Copy Tool, perform the following steps:
1. **Stop your primary SonarQube instance.**
1. Execute the base command jar with the correct parameters.
`-T`|Comma separated list of tables to migrate|no
## Execution Examples
-First sonar-db-copy verifies if URLs can be reached and the database versions:
-
+First, sonar-db-copy verifies if URLs can be reached and the database versions:
+
+```
+***************** CONFIGURATION VERIFICATIONS ***************
+Database SOURCE has been reached at : jdbc:h2:tcp://localhost:9092/sonar-db-copy
+Database DESTINATION has been reached at : mysql://localhost:13306/sonar?autoReconnect=true
+The version of SonarQube schema migration are the same between source (433) and destination (433).
+```
When the versions are different, the application stops.
-
-Sometime when you have restarted the copy, the destination database version is 0. This is not a problem, the copy will continue.
-
+```
+***************** CONFIGURATION VERIFICATIONS ***************
+Database SOURCE has been reached at : jdbc:h2:tcp://localhost:9092/sonar-db-copy
+Database DESTINATION has been reached at : mysql://localhost:13306/sonar?autoReconnect=true
+Exception in thread "main" Version of the schema migration are not the same between source (433) and destination (494).
+```
+
+Sometimes when you have restarted the copy, the destination database version is 0. This is not a problem, and the copy will continue.
+
+```
+***************** CONFIGURATION VERIFICATIONS ***************
+Database SOURCE has been reached at : jdbc:h2:tcp://localhost:9092/sonar-db-copy
+Database DESTINATION has been reached at : mysql://localhost:13306/sonar?autoReconnect=true
+! WARNING – The versions of SonarQube schema migration source is (433) when destination is (0).
+```
+
+Then it searches tables in the source and destination databases:
+
+```
+*************** SEARCH TABLES ***************
+START GETTING METADATA IN SOURCE...
+ 53 TABLES GETTED.
+START GETTING METADATA IN DESTINATION...
+ 53 TABLES GETTED.
+*************** FOUND TABLES ***************
+
+FOUND TABLE : action_plans
+ SOURCE:
+ COLUMNS : (id,kee,name,description,deadline,user_login,project_id,status,created_at,updated_at)
+ TYPES: : (INTEGER,VARCHAR,VARCHAR,VARCHAR,TIMESTAMP,VARCHAR,INTEGER,VARCHAR,TIMESTAMP,TIMESTAMP)
+ DESTINATION:
+ COLUMNS : (id,create_at,updated_at,name,description,deadline,user_login,project_id,status,kee)
+ TYPES : (BIGINT,TIMESTAMP,TIMESTAMP,VARCHAR,VARCHAR,TIMESTAMP,VARCHAR,INTEGER,VARCHAR,VARCHAR)
+
+FOUND TABLE : active_dashboards
+ SOURCE:
+ COLUMNS : (id,dashboard_id,user_id,order_index)
+ TYPES : (INTEGER,INTEGER,INTEGER,INTEGER)
+ DESTINATION:
+ COLUMNS : (id,dashboard_id,user_id,order_index)
+ TYPES : (INTEGER,INTEGER,INTEGER,INTEGER)
+```
+
+If there are missing tables, you will see this log:
+
+```
+FOUND TABLE : action_plans
+ SOURCE:
+ COLUMNS : (id,person_id,login,create_at,updated_at)
+ TYPES: : (INTEGER,INTEGER,VARCHAR,TIMESTAMP,TIMESTAMP)
+ DESTINATION:
+ ! WARNING - TABLE authors is not present in the DESTINATION database.
+```
-Then it searches tables in source and destination database:
-
+Then, sonar-db-copy truncates tables in the target database and indicates the number of tables purged. Of course, the tables missing can not be purged:
-If there are missing tables, you will read this log:
-
+```
+*************** DELETE TABLES FROM DESTINATION ***************
+START DELETING...
+ ! WARNING - Can't DELETE TABLE :authors because it doesn't exist in the destination database.
+ 52 TABLES DELETED IN DESTINATION.
+```
-Second sonar-db-copy truncates tables in target database and indicates the number of tables purged:
-
+Next, sonar-db-copy reproduces data from source to destination and adjusts the sequence of destination database after the copy:
-Of course, the tables missing can not be purged:
-
+```
+*************** COPY DATA ***************
+action_plans 0 / 0
+action_plans 0 / 0
+active_dashboards 0 / 5
+active_dashboards 5 / 5
+active_rules 0 / 629
+active_rules 629 / 629
+active_rule_changes 0 / 0
+active_rule_changes 0 / 0
+active_rule_notes 0 / 0
+active_rule_notes 0 / 0
+active_rule_parameters 0 / 58
+active_rule_parameters 58 / 58
+```
-Third, sonar-db-copy reproduces data from source to destination and adjusts the sequence of destination database after the copy:
-
+If there are some missing tables, you'll see the following warning:
-If there are some missing tables:
-
+```
+! WARNING - Can't WRITE in TABLE :authors because it doesn't exist in destination database.
+```
If errors appear during the copy, the process does NOT stop but the errors are displayed:
-
-At the end sonar-db-copy reiterates the difference between source and destination database. An error message is displayed if the databases are different.
-
+```
+** ERROR ** IN TABLE: users when read and write at col: 10 and id=1.
+** ERROR ** SORUCE COLUMNS ( name,admin,remarks,id,id,login,name).
+** ERROR ** DESTINATION COLUMNS ( id,login,name,email,crypted_password).
+** ERROR ** LINES NOT COPIED at ROW (0) WITH id = (1).
+** ERROR ** Cannot parse "TIMESTAMP" constant "TRUE" [22007-172]
+```
+
+At the end, sonar-db-copy reiterates the difference between the source and destination databases. An error message is displayed if the databases are different.
+
+```
+INFO *************** CHECK DESCREPANCIES ***************
+WARN TABLE projects has 65 ROWS in SOURCE while 0 ROWS in DESTINATION
+INFO ********************************************
+INFO ** THE COPY HAS FINISHED UNSUCCESSFULLY !!! WATCH OUT THE LOG!!! **
+INFO ********************************************
+```
projects / sonarqube.git / commitdiff