Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve command-line processing of gaia_db_extract #1048

Merged
merged 8 commits into from
Nov 5, 2021
Merged

Improve command-line processing of gaia_db_extract #1048

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
de2561f
improve command-line processing of gaia_db_extract
waynelwarren Oct 28, 2021
20a2210
addressing PR comments
waynelwarren Nov 2, 2021
12fd078
Merge branch 'master' into wayne/improve-extract-main
waynelwarren Nov 4, 2021
425d30c
changed c_start_string to c_start_after_string
waynelwarren Nov 4, 2021
48d0125
Merge branch 'master' into wayne/improve-extract-main
waynelwarren Nov 4, 2021
8621b90
reworked usage and error messages
waynelwarren Nov 4, 2021
b054a0c
reworking the usage text
waynelwarren Nov 4, 2021
5598c1b
more usage() improvements
waynelwarren Nov 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 81 additions & 64 deletions production/tools/gaia_db_extract/src/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,49 @@ using namespace gaia::common;
using namespace gaia::tools::db_extract;
using namespace std;

constexpr char c_start_string[] = "--start-after";
const int c_start_length = strlen(c_start_string);
constexpr char c_row_limit_string[] = "--row-limit";
const int c_row_limit_length = strlen(c_row_limit_string);
constexpr char c_database_string[] = "--database";
const int c_database_length = strlen(c_database_string);
constexpr char c_table_string[] = "--table";
const int c_table_length = strlen(c_table_string);
constexpr char c_start_string[] = "start-after";
LaurentiuCristofor marked this conversation as resolved.
Show resolved Hide resolved
constexpr char c_row_limit_string[] = "row-limit";
constexpr char c_database_string[] = "database";
constexpr char c_table_string[] = "table";

// Command-line usage.
static void usage()
{
fprintf(stderr, "Usage: gaia_db_extract [--database=<dbname>] [--table=<tableneme>] [--start-after=ID] [--row-limit=N]\n");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: you have defined constants for the arguments (except for row-limit). Why not use them here as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some changes to this. Hope this is what you meant.

fprintf(stderr, " No parameters: dump catalog.\n");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: why not just use std::cerr and the stream operators here? (more modern C++)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did it.

fprintf(stderr, " Else dump rows specified by database/table name, limited by start-after and row-limit.\n");
}

// Break a command-line parameter into its pieces.
static bool parse_arg(int argc, char* argv[], int& arg, string& key, string& value)
{
if (strncmp(argv[arg], "--", 2))
{
fprintf(stderr, "Incorrect command-line parameter: %s\n", argv[arg]);
return false;
}

key = string(argv[arg] + 2);
auto pos = key.find('=');
if (pos != string::npos)
{
// It's one argv with an equals sign.
value = key.substr(pos + 1);
key = key.substr(0, pos);
}
else
{
// It's two argv's, and the value is the next one.
if (++arg >= argc)
{
fprintf(stderr, "Missing a parameter value\n");
return false;
}
value = string(argv[arg]);
}

return true;
}

int main(int argc, char* argv[])
{
Expand All @@ -33,78 +68,57 @@ int main(int argc, char* argv[])

// Usage:
// gaia_db_extract --database=<dbmame> --table=<tablename> --start-after=ID --row-limit=N
// when no database/table specified, dump catalog
// When no database/table specified, dump catalog.
bool failed_command_line = false;
string key;
string value;
for (auto i = 1; i < argc; i++)
{
string arg(argv[i]);

if (!arg.compare(0, c_start_length, c_start_string))
if (!parse_arg(argc, argv, i, key, value))
{
if (arg.length() == c_start_length)
{
start_after = atoi(argv[++i]);
}
else
{
// Allow for equals sign form (--start-after=12). One arg rather than two.
start_after = atoi(arg.substr(c_start_length + 1).c_str());
}
if (start_after < 1)
{
fprintf(stderr, "Illegal value for start_after. It must be 1 or greater\n");
cout << "{}" << endl;
exit(1);
}
failed_command_line = true;
LaurentiuCristofor marked this conversation as resolved.
Show resolved Hide resolved
}
else if (!arg.compare(0, c_row_limit_length, c_row_limit_string))
else
{
if (arg.length() == c_row_limit_length)
if (!key.compare(c_start_string))
{
row_limit = atoi(argv[++i]);
start_after = atoi(value.c_str());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I think you can use std::stoi and just use the string value without needing to convert it to a C string via c_str().

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this too.

if (start_after < 1)
{
fprintf(stderr, "Illegal value for start_after. It must be 1 or greater\n");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: you could use your constant here. If you use the stream operators << then this is something like:

std::cerr << "Illegal value for " << c_start_after << "...";

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, it's now done this way everywhere.

failed_command_line = true;
}
}
else
else if (!key.compare(c_row_limit_string))
{
// Allow for equals sign form (--row-limit=12). One arg rather than two.
row_limit = atoi(arg.substr(c_row_limit_length + 1).c_str());
row_limit = atoi(value.c_str());
if (row_limit < 1)
{
fprintf(stderr, "Illegal value for row_limit. It must be 1 or greater\n");
failed_command_line = true;
}
}
if (row_limit < 1)
else if (!key.compare(c_database_string))
{
fprintf(stderr, "Illegal value for row_limit. It must be 1 or greater\n");
cout << "{}" << endl;
exit(1);
database = value;
}
}
else if (!arg.compare(0, c_database_length, c_database_string))
{
if (arg.length() == c_database_length)
else if (!key.compare(c_table_string))
{
database = string(argv[++i]);
table = value;
}
else
{
// Allow for equals sign form (--row-limit=12). One arg rather than two.
database = arg.substr(c_database_length + 1);
fprintf(stderr, "Invalid command-line option: '%s'\n", key.c_str());
failed_command_line = true;
}
}
else if (!arg.compare(0, c_table_length, c_table_string))
{
if (arg.length() == c_table_length)
{
table = string(argv[++i]);
}
else
{
// Allow for equals sign form (--row-limit=12). One arg rather than two.
table = arg.substr(c_table_length + 1);
}
}
else
{
fprintf(stderr, "Invalid command-row option: '%s'\n", argv[i]);
fprintf(stderr, "Usage: gaia_db_extract [--database=<dbname>] [--table=<tableneme>] [--start-after=ID] [--row-limit=N]\n");
cout << "{}" << endl;
exit(1);
}
}

if (failed_command_line)
{
usage();
cout << "{}" << endl;
exit(EXIT_FAILURE);
}

try
Expand All @@ -113,9 +127,10 @@ int main(int argc, char* argv[])
}
catch (gaia_exception& e)
{
// This is usually because there is no server running.
fprintf(stderr, "Startup failure, exception: '%s'\n", e.what());
cout << "{}" << endl;
exit(1);
exit(EXIT_FAILURE);
}

// Return an empty JSON document on failure.
Expand All @@ -141,4 +156,6 @@ int main(int argc, char* argv[])
gaia::db::end_session();

cout << extracted_data << endl;

exit(EXIT_SUCCESS);
}