Synor Database PostgreSQL

Synor Database Engine - PostgreSQL

Installation

# using yarn:
yarn add @synor/database-postgresql pg

# using npm:
npm install --save @synor/database-postgresql pg

URI

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

Params:

Name	Description	Default Value
schema	PostgreSQL Schema	public
ssl	SSL configuration	false
synor_migration_record_table	Name for Migration Record Table	synor_migration_record

Examples:

• postgresql://postgres:postgres@127.0.0.1:5432/synor?synor_migration_record_table=migration_record
• postgresql://postgres:postgres@127.0.0.1:5432/synor?schema=synor

// SSL Example

const ssl = {
  ca: '<path-to-file>',
  cert: '<path-to-file>',
  key: '<path-to-file>',
  passphrase: '<string>',
  rejectUnauthorized: '<boolean>',
  secureOptions: '<number>',
}

const uri = `postgresql://postgres:postgres@127.0.0.1:5432/synor?ssl=${encodeURIComponent(
  JSON.stringify(ssl)
)}`

License

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