DbSchema - README

DbSchema is a universal database tool for database query and design. Using DbSchema you can reverse engineer the
database schema from database and manage it using diagrams.
The schema design and diagrams will be saved to the DbSchema project file, making possible to manage the schema
over multiple databases, design the schema offline ( without database connectivity ), compare and migrate the
schema between different versions, etc.
DbSchema include a bunch of tools, available inside layouts.
> Relational Data Editor for exploring data from multiple tables simultaneously, edit data, setup filters.
  The editor is persisted to the project file.
> SQL editor - with autocomplete, script execution.
> Query Builder - with filters, left join or exists queries, group by.
> Data Generator - with configurable patterns, object generators, JSON.
> Data Loader - from csv or text files.
> Data Analytic Sheets - with charts, buttons, tables.
> Interactive layouts - edit the schema directly in diagrams.
> Support for NoSql databases: MongoDb
> Generate interactive image documentation : PDF and HTML5
> Schema Compare and Synchronization, generate schema scripts
> Support for Dark UI


Installing DbSchema
========================
DbSchema can run on Windows, Linux ( all versions ) and Mac OS.
By default all installers contains OpenJDK 11 bundle for 64 bits and OpenJfx libraries.
Java does no longer support 32 bits operating systems, therefore we don't provide any 32 bits installer.

For Windows: please download and run the executable installer.

For Linux and MacOs:
- download the installation kit
- set execution mode to DbSchema script
    chmod +x DbSchema.sh
- start DbSchema
    ./DbSchema.sh

Contents:
=========
C:\ProgramFiles\DbSchema ( on Linux/Mac the software installation location )
  config/             Configuration templates files for different databases.
  drivers/            JDBC drivers, here are stored the drivers automatic delivered with DbSchema.
                      Drivers are also automatic downloaded by DbSchema when connecting the first time to the database.
                      This will be placed in the User Home directory .DbSchema/drivers.
                      From the Connection Dialog / Manage you can also upload driver files into the application, will also be
                      placed in the User Home directory .DbSchema/drivers
  samples/            Sample schemas
  license/            DbSchema license details ( commercial, personal and academic ).
                      We use similar license as other large computer software companies (IntelliJ ).

  lib/                Application Java libraries. Here a list of all dependencies we use and their usage.
                      dependencies {
                          compile "org.openjfx:javafx-base:$fxVersion:$platform" // ALL THIS ARE JAVAFX LIBRARIES, used for graphic interface.
                          compile "org.openjfx:javafx-graphics:$fxVersion:$platform"
                          compile "org.openjfx:javafx-controls:$fxVersion:$platform"
                          compile "org.openjfx:javafx-web:$fxVersion:$platform"
                          compile "org.openjfx:javafx-swing:$fxVersion:$platform"
                          compile "org.openjfx:javafx-media:$fxVersion:$platform"
                          compile "org.controlsfx:controlsfx:9.0.0"  // JavaFx related components : http://fxexperience.com/controlsfx/
                          compile "org.codehaus.groovy:groovy:2.5.4" // Groovy scripting language support, we use this for Templates ( Analytic Application, generate ALTER TABLE statements, SQL Editor )
                          compile "org.codehaus.groovy:groovy-sql:2.5.4"
                          compile "org.codehaus.groovy:groovy-templates:2.5.4"
                          compile "org.codehaus.groovy:groovy-json:2.5.4"
                          compile "org.apache.pdfbox:pdfbox:2.0.13" // Generate PDF documentation https://pdfbox.apache.org/
                          compile "com.github.dhorions:boxable:1.5" // Tables inside PDF
                          compile "com.jcraft:jsch:0.1.54" // Support for SSH database connectivity http://www.jcraft.com/jsch/
                          compile "org.jsoup:jsoup:1.11.3" // HTML parser. Some JavaFx components are build from HTML text ( like warning and error messages, with red or bold text ), we use this here. https://jsoup.org/
                          compile "org.apache.poi:poi:4.0.0" // Two Apache libraries for Excel documents, DbSchema can export raw data to Excel format. https://poi.apache.org/
                          compile "org.apache.poi:poi-ooxml:4.0.0"
                          compile "com.google.code.gson:gson:2.8.5" // We use this for MongoDb manipulate JSON objects. https://github.com/google/gson
                          compile "com.github.albfernandez:juniversalchardet:2.4.0" // Universal Charset Detector, for opening SQL and text files.
                          compile "dev.scheibelhofer:crypto-tools:0.0.5" // PEM certificates conversion, used to load certificates into Java Keystore
                          testCompile 'junit:junit:4.12' // https://github.com/google/gson
                      }


C:\Users\<YourUser>\.DbSchema  ( .DbSchema folder in User Home directory )
  drivers/            Here are the JDBC database drivers downloaded during DbSchema run or manually uploaded.
  config/             All user changes made to DbSchema configuration ( Model / Settings ) are placed here.
                      Delete this folder to restore the software default settings.
  log/                Application logs


DbSchema Connectivity to Internet
=================================
WE STRONGLY ENSURE DATA PRIVACY. WE NEVER SEND OR UPLOAD ANY PRIVATE DATA TO EXTERNAL SERVERS OR EXTERNAL SITES.
DBSCHEMA CAN RUN FINE IN ANY PRIVATE NETWORK, WITHOUT INTERNET CONNECTIVITY, WITH THE RESTRICTIONS BELOW ( software updates and JDBC drivers - you have to provide them manually ).
Somehow there are two reasons why we may connect to internet.

 - Periodically check for new DbSchema releases. We continue to improve our software with support for new databases,
   improve existing support, new features, etc. On startup DbSchema will check if new versions are released,
   download and install them.
 - DbSchema include few of the existing database drivers ( MySql, Postgres, SqlServer ).
   For many other databases the JDBC drivers are downloaded first time you will try to connect to them, from this location
   https://dbschema.com
   You can visit by yourself this location. Please let us know if the drivers we deliver are not the latest or you get any issues.

About JDBC drivers
==========================
  DbSchema connects to database using JDBC drivers. This can be done for reading the schema  information,
  browse the database data or execute SQL queries.
  PLEASE DO NOT DISABLE THE NETWORKING FOR DBSCHEMA. THIS MAY GENERATE ERRORS WHEN TRYING TO CONNECT TO DATABASE.
  Please also check your firewall settings.

  JDBC drivers are software files with the extension .jar. Each database uses its own drivers.
  DbSchema includes few database drivers ( MySql, Postgres, Oracle ). If you use another database or if the
  configured driver is too old, you may need to upload the driver file by yourself in the application.
  From application menu 'Tools' -> 'Driver Manager' choose your database and press 'Load driver file' to upload it.
  More information about where you can find the driver files for each database can be found on
  https://dbschema.com/drivers.html

Uninstalling DbSchema
==========================
  If you installed DbSchema with the help of Installation Wizard, then
  just run the INSTALLATION_HOME/bin/Uninstall.exe file

  To uninstall DbSchema after manual installation, simply delete the
  contents of the DbSchema home installation directory.


Licensing & pricing
==========================
  Licensing and pricing information can be found at https://dbschema.com/purchase.html

Home Page:
==========
  https://dbschema.com

Support
=======
  In the DbSchema application you can find an option 'Technical Support' under the Help menu.
  This is the prefferred method of writing us, since the Java and Windows version as well as the Output logs
  will be sent to us.
  For technical support and assistance, you may find necessary information at the Support page
  (https://dbschema.com/support.html) or contact us at support@dbschema.com.

Bug Reporting & Contact:
==============
  Send emails to support@dbschema.com


=============
You are encouraged to visit our DbSchema web site at https://dbschema.com
or to contact us via e-mail at support@dbschema.com if you have any comments about
this release. In particular, we are very interested in any ease-of-use, user
interface suggestions that you may have. We will be posting regular updates
of our progress to our online forums.
=============
