README.md

Synor Database MySQL

Synor Database Engine - MySQL

Installation

# using yarn:
yarn add @synor/database-mysql

# using npm:
npm install --save @synor/database-mysql

URI

Format: mysql://[user[:password]@][hostname][:port]/database[?param=value&...]

Params:

Name	Description	Default Value
ssl	MySQL SSL Options	undefined
synor_migration_record_table	Name for Migration Record Table	synor_migration_record

Examples:

• mysql://root:[email protected]:3306/synor?synor_migration_record_table=migration_record

// SSL Example

const ssl = JSON.stringify({
  ca: '<path-to-file>',
  cert: '<path-to-file>',
  ciphers: '<string>',
  key: '<path-to-file>',
  passphrase: '<string>',
  rejectUnauthorized: '<boolean>'
}) // 'Amazon RDS'

const uri = `mysql://root:[email protected]:3306/synor?ssl=${encodeURIComponent(
  ssl
)}`

License

Licensed under the MIT License. Check the LICENSE file for details.