.\" Generated by kramdown-man 0.1.8
.\" https://github.com/postmodern/kramdown-man#readme
.TH ronin-db-add 1 "2023-02-01" Ronin DB "User Manuals"
.LP
.SH SYNOPSIS
.LP
.HP
\fBronin-db add\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP \[lB]\fIURI\fP\[rB]
.LP
.SH DESCRIPTION
.LP
.PP
Adds a pre\-existing database to the \fB~/.config/ronin-db/database.yml\fR
configuration file\.
.LP
.SH ARGUMENTS
.LP
.TP
\fINAME\fP
The name of the database to add\.
.LP
.TP
\fIURI\fP
The optional URI to the database to add\.
.LP
.SH OPTIONS
.LP
.TP
\fB-A\fR, \fB--adapter\fR \fBsqlite3|mysql2|postgres|...\fR
The adapter of the database to add\.
.LP
.TP
\fB--sqlite3\fR \fIFILE\fP
Alias for \fB--adapter sqlite3 --database\fR \fIFILE\fP\.
.LP
.TP
\fB--mysql2\fR
Alias for \fB--adapter mysql2\fR\.
.LP
.TP
\fB--postgresql\fR
Alias for \fB--adapter postgresql\fR\.
.LP
.TP
\fB-H\fR, \fB--host\fR \fIHOST\fP
The host of the database to add\.
.LP
.TP
\fB-p\fR, \fB--port\fR \fIPORT\fP
The port of the database to add\.
.LP
.TP
\fB-u\fR, \fB--username\fR \fIUSER\fP
The username to authenticate with for the database\.
.LP
.TP
\fB-P\fR, \fB--password\fR \fIPASSWORD\fP
The password to authenticate with for the database\.
.LP
.TP
\fB--read-password\fR
Reads the database password from STDIN\.
.LP
.TP
\fB-D\fR, \fB--database\fR \fINAME\fP\[or]\fIPATH\fP
The database name to connect to\. If \fB--adapter sqlite3\fR is given then a path
may be given instead\.
.LP
.TP
\fB-h\fR, \fB--help\fR
Print help information\.
.LP
.SH EXAMPLES
.LP
.PP
Add a sqlite3 database file:
.LP
.nf
    \[Do] ronin\-db add other\[ru]db \-\-sqlite3 path\[sl]to\[sl]db\.sqlite3
.fi
.LP
.PP
Add a PostgeSQL database:
.LP
.nf
    \[Do] ronin\-db add other\[ru]db \-\-postgres \-\-host example\.com \-\-port 5432 \-\-username ronin \-\-password s3r3t \-\-database ronin\[ru]db
.fi
.LP
.PP
Add a MySQL database:
.LP
.nf
    \[Do] ronin\-db add other\[ru]db \-\-mysql2 \-\-host example\.com \-\-port 3306 \-\-username ronin \-\-password s3r3t \-\-database ronin\[ru]db
.fi
.LP
.SH ENVIRONMENT
.LP
.TP
\fIHOME\fP
Alternate location for the user\[cq]s home directory\.
.LP
.TP
\fIXDG\[ru]CONFIG\[ru]HOME\fP
Alternate location for the \fB~/.config\fR directory\.
.LP
.TP
\fIXDG\[ru]DATA\[ru]HOME\fP
Alternate location for the \fB~/.local/share\fR directory\.
.LP
.SH FILES
.LP
.TP
\fB~/.local/share/ronin-db/database.sqlite3\fR
The default sqlite3 database file\.
.LP
.TP
\fB~/.config/ronin-db/database.yml\fR
Optional database configuration\.
.LP
.SH AUTHOR
.LP
.PP
Postmodern 
.MT postmodern\.mod3\[at]gmail\.com
.ME
.LP
.SH SEE ALSO
.LP
.PP
ronin\-db(1) ronin\-db\-list(1) ronin\-db\-edit(1) ronin\-db\-remove(1)