Skip to content

fix(cli): Open a session without a default schema #1825

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

Open
PingLiuPing wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(cli): Open a session without a default schema #1825

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 36 additions & 17 deletions axiom/cli/AxiomSql.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
#include "axiom/cli/Connectors.h"
#include "axiom/cli/Console.h"
#include "axiom/cli/SystemUser.h"
#include "axiom/connectors/ConnectorMetadataRegistry.h"
#include "axiom/connectors/tests/TestTableJson.h"
#include "velox/common/base/Exceptions.h"

Expand All @@ -51,7 +52,7 @@ int main(int argc, char** argv) {
folly::FunctionScheduler progressScheduler;
axiom::sql::SqlQueryRunner runner{
axiom::sql::SystemUser::resolve(), &progressScheduler, FLAGS_v2};
runner.initialize([&]() {
auto initializeConnectors = [&]() {
VELOX_USER_CHECK(
FLAGS_data_path.empty() || FLAGS_etc_dir.empty(),
"--data_path and --etc_dir are mutually exclusive. Use --data_path for "
Expand Down Expand Up @@ -116,29 +117,47 @@ int main(int argc, char** argv) {
connectorId = defaultConnector->connectorId();
}

// Not every catalog has a built-in default schema. Leave the schema empty
// instead of refusing to start: only bare table names need it, and the
// session can set one later with `use <catalog>.<schema>`.
std::string schema = FLAGS_schema;
if (schema.empty()) {
auto defaultSchemaIterator = defaultSchemas.find(connectorId);
VELOX_USER_CHECK(
defaultSchemaIterator != defaultSchemas.end() &&
!defaultSchemaIterator->second.empty(),
"Schema must be specified for connector {}",
connectorId);
schema = defaultSchemaIterator->second;
if (const auto it = defaultSchemas.find(connectorId);
it != defaultSchemas.end()) {
schema = it->second;
}
}

return std::make_pair(connectorId, schema);
});
};

// Register after initialize() so sessionConfig() is available.
connectors.registerSystemConnector(runner.sessionConfig());
connectors.registerFileConnector();

axiom::sql::Console console{runner};
console.initialize();
// Invalid CLI flags throw VeloxUserError; surface them as a clean
// 'Error: ...' line and a non-zero exit.
// Both connector registration and the console throw VeloxUserError on bad
// flags or catalog properties. Keep them inside the handler so either one
// prints an 'Error: ' line and exits non-zero instead of escaping main.
try {
runner.initialize(initializeConnectors);

// Register after initialize() so sessionConfig() is available.
connectors.registerSystemConnector(runner.sessionConfig());
connectors.registerFileConnector();

// --catalog is only checked here because the system and file catalogs are
// registered above, after the connectors the flag usually names.
const auto& catalog = runner.defaultConnectorId();
VELOX_USER_CHECK_NOT_NULL(
facebook::axiom::connector::ConnectorMetadataRegistry::tryGet(catalog),
"Catalog does not exist: {}",
catalog);

if (runner.defaultSchema().empty()) {
std::cerr << "Catalog '" << catalog
<< "' has no default schema. Qualify table names as "
"'<schema>.<table>', or run 'use "
<< catalog << ".<schema>' to set one." << std::endl;
}

axiom::sql::Console console{runner};
console.initialize();
console.run();
} catch (const facebook::velox::VeloxUserError& e) {
std::cerr << "Error: " << e.message() << std::endl;
Expand Down
4 changes: 2 additions & 2 deletions axiom/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ The examples below use `axiom_sql` for brevity. With Buck, replace
|------|---------|-------------|
| `--query` | | SQL text to execute. Supports multiple semicolon-separated statements. If not specified, enters interactive mode. If set to an empty string (`--query ""`), reads semicolon-separated SQL statements from stdin. |
| `--init` | | Path to a SQL file with semicolon-separated statements to execute on startup before entering interactive mode or running `--query`. |
| `--catalog` | | Default catalog (connector). If not specified, defaults to `hive` when `--data_path` is set, `tpch` otherwise. |
| `--schema` | | Default schema. If not specified, defaults to `tiny` for TPC-H and `default` for Hive and Test connectors. |
| `--catalog` | | Default catalog (connector). If not specified, defaults to `hive` when `--data_path` is set, `tpch` otherwise. Startup fails if the catalog is not registered. |
| `--schema` | | Default schema. If not specified, defaults to `tiny` for TPC-H and `default` for Hive and Test connectors. Other catalogs, such as `system`, have no default schema: qualify table names as `<schema>.<table>`, or run `use <catalog>.<schema>`. |
| `--etc_dir` | | Path to a directory of catalog `.properties` files. Mutually exclusive with `--data_path`. External catalogs are not selected automatically; use `--catalog` or fully-qualified names in SQL. |
| `--data_path` | | Hive specific: root path for Hive-style partitioned data. Registers local Hive connector. Mutually exclusive with `--etc_dir`. |
| `--data_format` | `parquet` | Hive specific: data format, `parquet`, `dwrf`, or `text`. |
Expand Down
Loading