config properties database

Version

v2.3.0

database Type

object (database)

database Properties

Property	Type	Required	Nullable	Defined by
database	string	Optional	cannot be null	Config
dialect	string	Optional	cannot be null	Config
host	string	Optional	cannot be null	Config
password	string	Optional	cannot be null	Config
port	string	Optional	cannot be null	Config
url	string	Optional	cannot be null	Config
user	string	Optional	cannot be null	Config

database

database determines the name of the database schema to use.

database

• is optional

• cannot be null

database Type

string

database Default Value

The default value is:

"hanko"

dialect

dialect is the name of the database system to use.

dialect

• is optional

• cannot be null

dialect Type

string

dialect Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"postgres"
"mysql"
"mariadb"
"cockroach"

dialect Default Value

The default value is:

"postgres"

host

host is the host the database system is running on.

host

• is optional

• cannot be null

host Type

string

host Default Value

The default value is:

"localhost"

password

password is the password for the database user to use for connecting to the database.

password

• is optional

• cannot be null

password Type

string

password Default Value

The default value is:

"hanko"

port

port is the port the database system is running on.

port

• is optional

• cannot be null

port Type

string

port Default Value

The default value is:

"5432"

url

url is a datasource connection string. It can be used instead of the rest of the database configuration options. If this url is set then it is prioritized, i.e. the rest of the options, if set, have no effect.

Schema: dialect://username:password@host:port/database

url

• is optional

• cannot be null

url Type

string

url Examples

postgres://hanko:hanko@localhost:5432/hanko

user

user is the database user to use for connecting to the database.

user

• is optional

• cannot be null

user Type

string

user Default Value

The default value is:

"hanko"