Skip to main content

ExternalDatabaseConnectionRequestDto

The connection parameters of an external database to test.

NameTypeDescriptionNotes
databaseTypeStringThe engine of the external database: mysql, or sqlite on a Standalone installation.[optional] [example: mysql] [nullable]
databaseTypeEnumExternalDatabaseTypeThe engine named by databaseType, as the server reads it. A value sent here is ignored.[optional] [enum: 0, 1]
dbHostStringThe host name or the IP address of the database server.[optional] [example: localhost] [nullable]
dbPortInteger (int32)The port the database server listens on.[optional] [example: 3306]
dbNameStringThe name of the database to connect to.[optional] [example: docspace] [nullable]
dbUserStringThe user name to connect with.[optional] [example: root] [nullable]
dbPasswordStringThe password to connect with.[optional] [example: my-secret-password] [nullable]
dbSslBooleanWhether the connection is secured with SSL.[optional] [example: false]
sqliteFilePathStringThe path to the database file, used by the SQLite engine only.[optional] [example: /var/lib/docspace/external.db] [nullable]