Merge pull request #218 from teoincontatto/release-1.0.0

Release 1.0.0
torodb · Oct 24, 2018 · bd8fb8b · bd8fb8b
2 parents 38e0fdf + 27a8581
commit bd8fb8b
Show file tree

Hide file tree

Showing 15 changed files with 135 additions and 198 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,10 @@ development environment, take a look to our
 
 ## Release History
 
+* 1.0.0
+    * Released on October 24th 2018
+* 1.0.0-beta3
+    * Released on June 30th 2017
 * 1.0.0-beta2
     * Released on April 06th 2017
 * 1.0.0-beta1

diff --git a/RELEASE.md b/RELEASE.md
@@ -1,3 +1,13 @@
+## Release Notes for Stampede 1.0.0
+
+### Changes
+
+* Support MySQL as backend
+
+### Bugs Fixed
+
+* Many many bugfixes (see logs for [MongoWP](https://github.com/torodb/mongowp/commits/0.50.2), [ToroDB Engine](https://github.com/torodb/engine/commits/v0.50.3) and [ToroDB Stampede](https://github.com/torodb/stampede/commits/v1.0.0)
+
 ## Release Notes for Stampede 1.0.0-beta3
 
 ### Changes

diff --git a/documentation/docs/about.md b/documentation/docs/about.md
@@ -14,7 +14,7 @@ During replication ToroDB Stempede transforms MongoDB's JSON documents into a [r
 
 ### SQL Target
 
-Currently, ToroDB Stampede only supports the free open-source database [PostgreSQL](https://www.postgresql.org/) as target.
+Currently, ToroDB Stampede only supports the free open-source databases [PostgreSQL](https://www.postgresql.org/) and [MySQL](https://www.mysql.com/) (and compatible databases) as targets.
 
 ### MongoDB
 
@@ -47,6 +47,8 @@ The main benefit of ToroDB Stampede is to flatten nested documents into tables.
 
 [TODO]: <> (Which PostreSQL version is required?)
 
+[TODO]: <> (Which MySQL version is required?)
+
 [TODO]: <> (not supported types, we need a list)
 
 [Versions]: <> (this section doesn't make any sense currently)

diff --git a/documentation/docs/appendix.md b/documentation/docs/appendix.md
diff --git a/documentation/docs/configuration/mysql-connectivity.md b/documentation/docs/configuration/mysql-connectivity.md
@@ -0,0 +1,36 @@
+<h1>Configuring the MySQL Connection</h1>
+
+ToroDB Stampede uses the following defaults to connect to MySQL:
+
+```json
+backend:
+  mysql:
+    host: localhost
+    port: 5432
+    database: torod
+    user: torodb
+    toropassFile: "~/.toropass"
+    applicationName: "toro"
+    ssl: false
+```
+The [Options Reference](options-reference.md#mysql-configuration) explains these settings in detail.
+
+## Password Configuration
+
+There are two ways to provide the MySQL password:
+
+* Use the `--ask-for-password` option to enter the password manually at startup
+* Use a `toropassFile` as as described in [Creating a `.toropass` file](/installation/prerequisites/#creating-a-toropass-file)
+
+## Backend Connection Pooling
+
+ToroDB Stampede uses a connection pool for the backend connections. Its size and timeout (if no connection is available) can be adjusted. The default configuration is as follows:
+
+```json
+backend:
+  pool:
+    connectionPoolTimeout: 10000
+    connectionPoolSize: 30
+```
+
+The [Options Reference](options-reference.md#torodb-stampede-pool-configuration) explains these settings in detail.