1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
// file : migrate/migrate.cli
// license : MIT; see accompanying LICENSE file
include <vector>;
include <string>;
include <cstdint>; // uint16_t
"\section=1"
"\name=brep-migrate"
"\summary=create/drop/migrate brep databases"
{
"<options> <schema>",
"\h|SYNOPSIS|
\c{\b{brep-migrate --help}\n
\b{brep-migrate --version}\n
\b{brep-migrate} [<options>] <schema>}
\h|DESCRIPTION|
In its default mode \cb{brep-migrate} creates the database schema if it
doesn't already exist. Otherwise, it migrates the existing schema and data
to the current version, if needed. The valid schema names are \cb{package}
and \cb{build}.
If the \cb{--recreate} option is specified, then \cb{brep-migrate} instead
recreates the database schema. That is, it drops all the existing tables
(and their data) and then creates them from scratch.
If the \cb{--drop} option is specified, then \cb{brep-migrate} drops all the
existing tables (and their data).
The \cb{--recreate} and \cb{--drop} options are mutually exclusive. When
specified, they will cause \cb{brep-migrate} to fail if the database schema
requires migration. In this case you can either migrate the database first
or drop the entire database using, for example, \cb{psql(1)}."
}
class options
{
"\h|OPTIONS|"
bool --recreate
{
"Recreate the database schema (all the existing data will be lost)."
}
bool --drop
{
"Drop the database schema (all the existing data will be lost)."
}
std::string --db-user|-u
{
"<user>",
"Database user name. If not specified, then operating system (login)
name is used."
}
std::string --db-password
{
"<pass>",
"Database password. If not specified, then login without password is
expected to work."
}
std::string --db-name|-n
{
"<name>",
"Database name. If not specified, then it is implicitly derived by
prefixing the schema name with \cb{brep_}."
}
std::string --db-host|-h
{
"<host>",
"Database host name, address, or socket. If not specified, then connect
to \cb{localhost} using the operating system-default mechanism
(Unix-domain socket, etc)."
}
std::uint16_t --db-port|-p = 0
{
"<port>",
"Database port number. If not specified, the default port is used."
}
std::string --pager // String to allow empty value.
{
"<path>",
"The pager program to be used to show long text. Commonly used pager
programs are \cb{less} and \cb{more}. You can also specify additional
options that should be passed to the pager program with
\cb{--pager-option}. If an empty string is specified as the pager
program, then no pager will be used. If the pager program is not
explicitly specified, then \cb{brep-migrate} will try to use \cb{less}.
If it is not available, then no pager will be used."
}
std::vector<std::string> --pager-option
{
"<opt>",
"Additional option to be passed to the pager program. See \cb{--pager}
for more information on the pager program. Repeat this option to
specify multiple pager options."
}
bool --help {"Print usage information and exit."}
bool --version {"Print version and exit."}
};
"\h|EXIT STATUS|
\dl|
\li|\cb{0}
Success.|
\li|\cb{1}
Fatal error.|
\li|\cb{2}
An instance of \cb{brep-migrate} or some other \cb{brep} utility is already
running. Try again.|
\li|\cb{3}
Recoverable database error. Try again.||
"
|
