Config Object

Config Object

Key NameTypeDefaultDescription
connOptionsobjectCommon Knex options
    compileSqlOnErrorbooleanfalse
    ...See knex options
manticoresearchobjectCommon manticoresearch options
    maxMatchesnumber1000
    ...See manticoresearch options

Driver Specific Connection

These driver specific connection objects should be used as your Dobo connection object's array written in your {data-dir}/config/dobo.json, NOT in {data-dir}/config/doboKnex.json.

See Dobo's Config Object for more info on this topic.

General

Key NameTypeDefaultDescription
namestringdefaultConnection name
typestringConnection's driver type. See below
connectionobjectConnection details
    hoststring127.0.0.1Hostname/ip to connect to
    portnumberDefaults to DB's default port
    userstringUsername to connect as
    passwordstringUser's password
    databasestringDatabase name
    ...See knex connection config
useNullAsDefaultbooleantrueSee knex options
...See knex options

SQLite3

Key NameTypeDefaultDescription
...See knex options
connectionobjectConnection details
    filenamestringPath to database file
...See knex options

Directory to database file, if not specifed, defaults to {data-dir}/plugins/dobo/db/{filename}

if {filename} is :memory:, it turns on SQLite3 memory database

Directory tokens are supported, it will be replaced by its respected values if any are found:

  • {app-dir}
  • {data-dir}
  • {tmp-dir}

Driver Types

Very similar to client option Knexjs's term, it should be one of:

  • dbknex:better-sqlite3, driver: better-sqlite3
  • dbknex:cockcrouchdb, driver: pg
  • dbknex:mssql, driver: tedious
  • dbknex:mysql, driver: mysql
  • dbknex:mysql2, driver: mysql2
  • dbknex:oracle, driver: oracle
  • dbknex:oracledb, driver: oracledb
  • dbknex:pg-native, driver: pg-native
  • dbknex:postgres, driver: pg
  • dbknex:redshift, driver: pg
  • dbknex:sqlite3, driver: sqlite3
  • dbknex:manticoresearch, driver: mysql