Updated changelog and documentation to indicate how to generate into …

…a db
HicServices · Mar 30, 2022 · af7c4f5 · af7c4f5
1 parent f9e7ab1
commit af7c4f5
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added support for creating to database
+
 ### Dependencies
 
 - Bump CsvHelper from 24.0.1 to 27.2.1

diff --git a/README.md b/README.md
@@ -62,6 +62,23 @@ First build BadMedicine.csproj
 dotnet publish BadMedicine.csproj -r win-x64 --self-contained
 cd .\bin\Debug\netcoreapp2.2\win-x64\
 ```
+## Direct to Database
+
+You can generate data directly into a relational database (instead of onto disk).
+
+To turn this mode on rename the file `BadMedicine.template.yaml` to `BadMedicine.yaml` and provide the connection strings to your database e.g.:
+
+```yaml
+Database:
+  # Set to true to drop and recreate tables described in the Template
+  DropTables: false
+  # The connection string to your database
+  ConnectionString: server=(localdb)\MSSQLLocalDB;Integrated Security=true;
+  # Your DBMS provider ('MySql', 'PostgreSql','Oracle' or 'MicrosoftSQLServer')
+  DatabaseType: MicrosoftSQLServer
+  # Database to create/use on the server
+  DatabaseName: BadMedicineTestData
+```
 
 ## Library Usage