[Chore] Change VARBINARY columns to VARCHAR (#78)

Author: tchapi

.env

@@ -24,8 +24,7 @@ APP_SECRET=630dc0d699fd37e720aff268f75583ed
 # Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
 # For an SQLite database, use: "sqlite:///%kernel.project_dir%/var/data.db"
 # For a PostgreSQL database, use: "postgresql://db_user:db_password@127.0.0.1:5432/db_name?serverVersion=11"
-# IMPORTANT: You MUST also configure your db driver and server_version in config/packages/doctrine.yaml
-DATABASE_URL=mysql://davis:davis@127.0.0.1:3306/davis
+DATABASE_URL="mysql://davis:davis@127.0.0.1:3306/davis?serverVersion=mariadb-10.6.10&charset=utf8mb4"
 ###< doctrine/doctrine-bundle ###
 
 ###> symfony/mailer ###

README.md

@@ -36,17 +36,17 @@ Created and maintained (with the help of the community) by [@tchapi](https://git
 composer install
 ```
 
-2. At least put the correct credentials to your database in your `.env.local` file so you can easily create your database.
+2. At least put the correct credentials to your database in your `.env.local` file so you can easily create the necessary tables.
 
-3. Create the database:
+3. Run the migrations to create all the necessary tables:
 
 ```
-bin/console doctrine:schema:create
+bin/console doctrine:migrations:migrate
 ```
 
-**Davis** can be used with a pre-existing MySQL database (_for instance, one previously managed by Baïkal_). The only missing table would be the `migrations` table, that you can recreate automatically when running the migrations.
+**Davis** can also be used with a pre-existing MySQL database (_for instance, one previously managed by Baïkal_). See the paragraph "Migrating from Baikal" for more info.
 
-> The migrations are not _exactly_ equivalent to those of Baïkal, and allow for a bit more room in columns.
+> The tables are not _exactly_ equivalent to those of Baïkal, and allow for a bit more room in columns for instance (among other things)
 
 ## Configuration
 
@@ -57,7 +57,7 @@ Create your own `.env.local` file to change the necessary variables, if you plan
 a. The database url (_you should already have it configured since you created the database previously_)
 
 ```
-DATABASE_URL=mysql://db_user:db_pass@host:3306/db_name
+DATABASE_URL=mysql://db_user:db_pass@host:3306/db_name?serverVersion=mariadb-10.6.10&charset=utf8mb4
 ```
 
 b. The admin password for the backend
@@ -123,21 +123,35 @@ LDAP_AUTH_USER_AUTOCREATE=true # false by default
 >    LDAP_MAIL_ATTRIBUTE="zimbraMailDeliveryAddress"
 >    ```
 
-## Migrating from Baïkal ?
+## Migrating from Baïkal?
 
 If you're migrating from Baïkal, then you will likely want to do the following :
 
 1. Get a backup of your data (without the `CREATE`  statements, but with complete `INSERT`  statements):
 
-    `mysqldump -u root -p --no-create-info --complete-insert baikal > baikal_to_davis.sql # baikal is the actual name of your database`
+```
+mysqldump -u root -p --no-create-info --complete-insert baikal > baikal_to_davis.sql # baikal is the actual name of your database
+```
+
 
-2. Create a new database for Davis (let's name it `davis`) and create the schema :
+2. Create a new database for Davis (let's name it `davis`) and create the base schema:
+
+```
+bin/console doctrine:migrations:migrate 'DoctrineMigrations\Version20191030113307' --no-interaction
+```
 
-    `bin/console doctrine:schema:create`
 
 3. Reimport the data back:
 
-    `mysql -uroot -p davis < baikal_to_davis.sql`
+```
+mysql -uroot -p davis < baikal_to_davis.sql
+```
+
+4. Run the necessary remaining migrations:
+
+```
+bin/console doctrine:migrations:migrate
+```
 
 # Access / Webserver
 
@@ -196,7 +210,7 @@ The main endpoint for CalDAV, WebDAV or CardDAV is at `/dav`.
         # Env vars (if you did not use .env.local)
         SetEnv APP_ENV prod
         SetEnv APP_SECRET <app-secret-id>
-        SetEnv DATABASE_URL "mysql://db_user:db_pass@host:3306/db_name"
+        SetEnv DATABASE_URL "mysql://db_user:db_pass@host:3306/db_name?serverVersion=mariadb-10.6.10&charset=utf8mb4"
         # ... etc
     </VirtualHost>
 
@@ -221,7 +235,7 @@ The main endpoint for CalDAV, WebDAV or CardDAV is at `/dav`.
 
             # Env vars (if you did not use .env.local)            fastcgi_param APP_ENV prod;
             fastcgi_param APP_SECRET <app-secret-id>;
-            fastcgi_param DATABASE_URL "mysql://db_user:db_pass@host:3306/db_name";
+            fastcgi_param DATABASE_URL "mysql://db_user:db_pass@host:3306/db_name?serverVersion=mariadb-10.6.10&charset=utf8mb4";
             # ... etc ...
 
             fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
@@ -275,9 +289,22 @@ You can start the containers with :
 
     cd docker && docker-compose up -d
 
-**⚠ Do not forget to create the database the first time you run the container** :
+**⚠ Do not forget to run all the migrations the first time you run the container** :
+
+    docker exec -it davis sh -c "APP_ENV=prod bin/console doctrine:migrations:migrate --no-interaction"
+
+### Updating
+
+If you update the code, you need to make sure the database structure is in sync.
+
+**Before v3.0.0**, you need to force the update:
+
+    docker exec -it davis sh -c "APP_ENV=prod bin/console doctrine:schema:update --force --no-interaction"
+
+**For v3.0.0 and after**, you can just migrate again (_provided you correctly followed the migration notes in the v3.0.0 release_):
+
+    docker exec -it davis sh -c "APP_ENV=prod bin/console doctrine:migrations:migrate --no-interaction"
 
-    docker exec -it davis sh -c "APP_ENV=prod bin/console doctrine:schema:create --no-interaction"
 
 Then, head up to `http://<YOUR_DOCKER_IP>:9000` to see the status display :