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