Skip to content

GH-47709 : [C++][FlightRPC] Return ODBC and data source information #47762

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+962 −75
Draft

GH-47709 : [C++][FlightRPC] Return ODBC and data source information #47762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b003b79
Extract SQLGetInfo implementation
alinaliBQ Oct 8, 2025
f7a7386
Remove `using List`
alinaliBQ Oct 22, 2025
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
18 changes: 16 additions & 2 deletions cpp/src/arrow/flight/sql/odbc/odbc_api.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,22 @@ SQLRETURN SQLGetInfo(SQLHDBC conn, SQLUSMALLINT info_type, SQLPOINTER info_value
<< ", info_value_ptr: " << info_value_ptr << ", buf_len: " << buf_len
<< ", string_length_ptr: "
<< static_cast<const void*>(string_length_ptr);
// GH-47709 TODO: Implement SQLGetInfo
return SQL_INVALID_HANDLE;

using ODBC::ODBCConnection;

return ODBCConnection::ExecuteWithDiagnostics(conn, SQL_ERROR, [=]() {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(conn);

// Set character type to be Unicode by default
const bool is_unicode = true;

if (!info_value_ptr && !string_length_ptr) {
return static_cast<SQLRETURN>(SQL_ERROR);
}

return connection->GetInfo(info_type, info_value_ptr, buf_len, string_length_ptr,
is_unicode);
});
}

SQLRETURN SQLGetStmtAttr(SQLHSTMT stmt, SQLINTEGER attribute, SQLPOINTER value_ptr,
Expand Down
24 changes: 19 additions & 5 deletions cpp/src/arrow/flight/sql/odbc/odbc_impl/get_info_cache.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -913,21 +913,21 @@ bool GetInfoCache::LoadInfoFromServer() {
break;
}
case SqlInfoOptions::SQL_SUPPORTED_RESULT_SET_TYPES:
// Ignored. Warpdrive supports forward-only only.
// Ignored. Arrow ODBC supports forward-only only.
break;
case SqlInfoOptions::SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIED:
// Ignored. Warpdrive supports forward-only only.
// Ignored. Arrow ODBC supports forward-only only.
break;
case SqlInfoOptions::SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLY:
// Ignored. Warpdrive supports forward-only only.
// Ignored. Arrow ODBC supports forward-only only.
break;
case SqlInfoOptions::
SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVE:
// Ignored. Warpdrive supports forward-only only.
// Ignored. Arrow ODBC supports forward-only only.
break;
case SqlInfoOptions::
SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVE:
// Ignored. Warpdrive supports forward-only only.
// Ignored. Arrow ODBC supports forward-only only.
break;

// List<string> properties
Expand Down Expand Up @@ -1127,6 +1127,7 @@ void GetInfoCache::LoadDefaultsForMissingEntries() {
SetDefaultIfMissing(info_, SQL_CONVERT_DECIMAL, static_cast<uint32_t>(0));
SetDefaultIfMissing(info_, SQL_CONVERT_DOUBLE, static_cast<uint32_t>(0));
SetDefaultIfMissing(info_, SQL_CONVERT_FLOAT, static_cast<uint32_t>(0));
SetDefaultIfMissing(info_, SQL_CONVERT_FUNCTIONS, static_cast<uint32_t>(0));
SetDefaultIfMissing(info_, SQL_CONVERT_GUID, static_cast<uint32_t>(0));
SetDefaultIfMissing(info_, SQL_CONVERT_INTEGER, static_cast<uint32_t>(0));
SetDefaultIfMissing(info_, SQL_CONVERT_INTERVAL_YEAR_MONTH, static_cast<uint32_t>(0));
Expand Down Expand Up @@ -1205,6 +1206,7 @@ void GetInfoCache::LoadDefaultsForMissingEntries() {
SetDefaultIfMissing(info_, SQL_MAX_COLUMNS_IN_ORDER_BY, static_cast<uint16_t>(0));
SetDefaultIfMissing(info_, SQL_MAX_COLUMNS_IN_SELECT, static_cast<uint16_t>(0));
SetDefaultIfMissing(info_, SQL_MAX_COLUMNS_IN_TABLE, static_cast<uint16_t>(0));
SetDefaultIfMissing(info_, SQL_MAX_CONCURRENT_ACTIVITIES, static_cast<uint16_t>(0));
SetDefaultIfMissing(info_, SQL_MAX_CURSOR_NAME_LEN, static_cast<uint16_t>(0));
SetDefaultIfMissing(info_, SQL_MAX_DRIVER_CONNECTIONS, static_cast<uint16_t>(0));
SetDefaultIfMissing(info_, SQL_MAX_IDENTIFIER_LEN, static_cast<uint16_t>(65535));
Expand All @@ -1224,6 +1226,7 @@ void GetInfoCache::LoadDefaultsForMissingEntries() {
SetDefaultIfMissing(info_, SQL_OJ_CAPABILITIES,
static_cast<uint32_t>(SQL_OJ_LEFT | SQL_OJ_RIGHT | SQL_OJ_FULL));
SetDefaultIfMissing(info_, SQL_ORDER_BY_COLUMNS_IN_SELECT, "Y");
SetDefaultIfMissing(info_, SQL_OUTER_JOINS, "N");
SetDefaultIfMissing(info_, SQL_PROCEDURE_TERM, "");
SetDefaultIfMissing(info_, SQL_PROCEDURES, "N");
SetDefaultIfMissing(info_, SQL_QUOTED_IDENTIFIER_CASE,
Expand All @@ -1232,6 +1235,7 @@ void GetInfoCache::LoadDefaultsForMissingEntries() {
SetDefaultIfMissing(info_, SQL_SCHEMA_USAGE,
static_cast<uint32_t>(SQL_SU_DML_STATEMENTS));
SetDefaultIfMissing(info_, SQL_SEARCH_PATTERN_ESCAPE, "\\");
SetDefaultIfMissing(info_, SQL_SPECIAL_CHARACTERS, "");
SetDefaultIfMissing(
info_, SQL_SERVER_NAME,
"Arrow Flight SQL Server"); // This might actually need to be the hostname.
Expand Down Expand Up @@ -1286,6 +1290,16 @@ void GetInfoCache::LoadDefaultsForMissingEntries() {
SQL_FN_TSI_FRAC_SECOND | SQL_FN_TSI_SECOND | SQL_FN_TSI_MINUTE |
SQL_FN_TSI_HOUR | SQL_FN_TSI_DAY | SQL_FN_TSI_WEEK |
SQL_FN_TSI_MONTH | SQL_FN_TSI_QUARTER | SQL_FN_TSI_YEAR));
SetDefaultIfMissing(
info_, SQL_TIMEDATE_FUNCTIONS,
static_cast<uint32_t>(
SQL_FN_TD_CURRENT_DATE | SQL_FN_TD_CURRENT_TIME | SQL_FN_TD_CURRENT_TIMESTAMP |
SQL_FN_TD_CURDATE | SQL_FN_TD_CURTIME | SQL_FN_TD_DAYNAME |
SQL_FN_TD_DAYOFMONTH | SQL_FN_TD_DAYOFWEEK | SQL_FN_TD_DAYOFYEAR |
SQL_FN_TD_EXTRACT | SQL_FN_TD_HOUR | SQL_FN_TD_MINUTE | SQL_FN_TD_MONTH |
SQL_FN_TD_MONTHNAME | SQL_FN_TD_NOW | SQL_FN_TD_QUARTER | SQL_FN_TD_SECOND |
SQL_FN_TD_TIMESTAMPADD | SQL_FN_TD_TIMESTAMPDIFF | SQL_FN_TD_WEEK |
SQL_FN_TD_YEAR));
SetDefaultIfMissing(info_, SQL_UNION,
static_cast<uint32_t>(SQL_U_UNION | SQL_U_UNION_ALL));
SetDefaultIfMissing(info_, SQL_XOPEN_CLI_YEAR, "1995");
Expand Down
125 changes: 59 additions & 66 deletions cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_connection.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,152 +137,144 @@ void ODBCConnection::Connect(std::string dsn,
attribute_tracking_statement_ = std::make_shared<ODBCStatement>(*this, spi_statement);
}

void ODBCConnection::GetInfo(SQLUSMALLINT info_type, SQLPOINTER value,
SQLSMALLINT buffer_length, SQLSMALLINT* output_length,
bool is_unicode) {
SQLRETURN ODBCConnection::GetInfo(SQLUSMALLINT info_type, SQLPOINTER value,
SQLSMALLINT buffer_length, SQLSMALLINT* output_length,
bool is_unicode) {
switch (info_type) {
case SQL_ACTIVE_ENVIRONMENTS:
GetAttribute(static_cast<SQLUSMALLINT>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
#ifdef SQL_ASYNC_DBC_FUNCTIONS
case SQL_ASYNC_DBC_FUNCTIONS:
GetAttribute(static_cast<SQLUINTEGER>(SQL_ASYNC_DBC_NOT_CAPABLE), value,
buffer_length, output_length);
break;
return SQL_SUCCESS;
#endif
case SQL_ASYNC_MODE:
GetAttribute(static_cast<SQLUINTEGER>(SQL_AM_NONE), value, buffer_length,
output_length);
break;
return SQL_SUCCESS;
#ifdef SQL_ASYNC_NOTIFICATION
case SQL_ASYNC_NOTIFICATION:
GetAttribute(static_cast<SQLUINTEGER>(SQL_ASYNC_NOTIFICATION_NOT_CAPABLE), value,
buffer_length, output_length);
break;
return SQL_SUCCESS;
#endif
case SQL_BATCH_ROW_COUNT:
GetAttribute(static_cast<SQLUINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_BATCH_SUPPORT:
GetAttribute(static_cast<SQLUINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_DATA_SOURCE_NAME:
GetStringAttribute(is_unicode, dsn_, true, value, buffer_length, output_length,
GetDiagnostics());
break;
return GetStringAttribute(is_unicode, dsn_, true, value, buffer_length,
output_length, GetDiagnostics());
case SQL_DRIVER_ODBC_VER:
GetStringAttribute(is_unicode, "03.80", true, value, buffer_length, output_length,
GetDiagnostics());
break;
return GetStringAttribute(is_unicode, "03.80", true, value, buffer_length,
output_length, GetDiagnostics());
case SQL_DYNAMIC_CURSOR_ATTRIBUTES1:
GetAttribute(static_cast<SQLUINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_DYNAMIC_CURSOR_ATTRIBUTES2:
GetAttribute(static_cast<SQLUINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES1:
GetAttribute(static_cast<SQLUINTEGER>(SQL_CA1_NEXT), value, buffer_length,
output_length);
break;
return SQL_SUCCESS;
case SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES2:
GetAttribute(static_cast<SQLUINTEGER>(SQL_CA2_READ_ONLY_CONCURRENCY), value,
buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_FILE_USAGE:
GetAttribute(static_cast<SQLUSMALLINT>(SQL_FILE_NOT_SUPPORTED), value,
buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_KEYSET_CURSOR_ATTRIBUTES1:
GetAttribute(static_cast<SQLUINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_KEYSET_CURSOR_ATTRIBUTES2:
GetAttribute(static_cast<SQLUINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_MAX_ASYNC_CONCURRENT_STATEMENTS:
GetAttribute(static_cast<SQLUINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_ODBC_INTERFACE_CONFORMANCE:
GetAttribute(static_cast<SQLUINTEGER>(SQL_OIC_CORE), value, buffer_length,
output_length);
break;
return SQL_SUCCESS;
// case SQL_ODBC_STANDARD_CLI_CONFORMANCE: - mentioned in SQLGetInfo spec with no
// description and there is no constant for this.
case SQL_PARAM_ARRAY_ROW_COUNTS:
GetAttribute(static_cast<SQLUINTEGER>(SQL_PARC_NO_BATCH), value, buffer_length,
output_length);
break;
return SQL_SUCCESS;
case SQL_PARAM_ARRAY_SELECTS:
GetAttribute(static_cast<SQLUINTEGER>(SQL_PAS_NO_SELECT), value, buffer_length,
output_length);
break;
return SQL_SUCCESS;
case SQL_ROW_UPDATES:
GetStringAttribute(is_unicode, "N", true, value, buffer_length, output_length,
GetDiagnostics());
break;
return GetStringAttribute(is_unicode, "N", true, value, buffer_length,
output_length, GetDiagnostics());
case SQL_SCROLL_OPTIONS:
GetAttribute(static_cast<SQLUINTEGER>(SQL_SO_FORWARD_ONLY), value, buffer_length,
output_length);
break;
return SQL_SUCCESS;
case SQL_STATIC_CURSOR_ATTRIBUTES1:
GetAttribute(static_cast<SQLUINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_STATIC_CURSOR_ATTRIBUTES2:
GetAttribute(static_cast<SQLUINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_BOOKMARK_PERSISTENCE:
GetAttribute(static_cast<SQLUINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_DESCRIBE_PARAMETER:
GetStringAttribute(is_unicode, "N", true, value, buffer_length, output_length,
GetDiagnostics());
break;
return GetStringAttribute(is_unicode, "N", true, value, buffer_length,
output_length, GetDiagnostics());
case SQL_MULT_RESULT_SETS:
GetStringAttribute(is_unicode, "N", true, value, buffer_length, output_length,
GetDiagnostics());
break;
return GetStringAttribute(is_unicode, "N", true, value, buffer_length,
output_length, GetDiagnostics());
case SQL_MULTIPLE_ACTIVE_TXN:
GetStringAttribute(is_unicode, "N", true, value, buffer_length, output_length,
GetDiagnostics());
break;
return GetStringAttribute(is_unicode, "N", true, value, buffer_length,
output_length, GetDiagnostics());
case SQL_NEED_LONG_DATA_LEN:
GetStringAttribute(is_unicode, "N", true, value, buffer_length, output_length,
GetDiagnostics());
break;
return GetStringAttribute(is_unicode, "N", true, value, buffer_length,
output_length, GetDiagnostics());
case SQL_TXN_CAPABLE:
GetAttribute(static_cast<SQLUSMALLINT>(SQL_TC_NONE), value, buffer_length,
output_length);
break;
return SQL_SUCCESS;
case SQL_TXN_ISOLATION_OPTION:
GetAttribute(static_cast<SQLUINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_TABLE_TERM:
GetStringAttribute(is_unicode, "table", true, value, buffer_length, output_length,
GetDiagnostics());
break;
return GetStringAttribute(is_unicode, "table", true, value, buffer_length,
output_length, GetDiagnostics());
// Deprecated ODBC 2.x fields required for backwards compatibility.
case SQL_ODBC_API_CONFORMANCE:
GetAttribute(static_cast<SQLUSMALLINT>(SQL_OAC_LEVEL1), value, buffer_length,
output_length);
break;
return SQL_SUCCESS;
case SQL_FETCH_DIRECTION:
GetAttribute(static_cast<SQLINTEGER>(SQL_FETCH_NEXT), value, buffer_length,
output_length);
break;
return SQL_SUCCESS;
case SQL_LOCK_TYPES:
GetAttribute(static_cast<SQLINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_POS_OPERATIONS:
GetAttribute(static_cast<SQLINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_POSITIONED_STATEMENTS:
GetAttribute(static_cast<SQLINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_SCROLL_CONCURRENCY:
GetAttribute(static_cast<SQLINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;
case SQL_STATIC_SENSITIVITY:
GetAttribute(static_cast<SQLINTEGER>(0), value, buffer_length, output_length);
break;
return SQL_SUCCESS;

// Driver-level string properties.
case SQL_USER_NAME:
Expand Down Expand Up @@ -317,9 +309,8 @@ void ODBCConnection::GetInfo(SQLUSMALLINT info_type, SQLPOINTER value,
case SQL_XOPEN_CLI_YEAR: {
const auto& info = spi_connection_->GetInfo(info_type);
const std::string& info_value = boost::get<std::string>(info);
GetStringAttribute(is_unicode, info_value, true, value, buffer_length,
output_length, GetDiagnostics());
break;
return GetStringAttribute(is_unicode, info_value, true, value, buffer_length,
output_length, GetDiagnostics());
}

// Driver-level 32-bit integer properties.
Expand Down Expand Up @@ -409,7 +400,7 @@ void ODBCConnection::GetInfo(SQLUSMALLINT info_type, SQLPOINTER value,
const auto& info = spi_connection_->GetInfo(info_type);
uint32_t info_value = boost::get<uint32_t>(info);
GetAttribute(info_value, value, buffer_length, output_length);
break;
return SQL_SUCCESS;
}

// Driver-level 16-bit integer properties.
Expand Down Expand Up @@ -444,7 +435,7 @@ void ODBCConnection::GetInfo(SQLUSMALLINT info_type, SQLPOINTER value,
const auto& info = spi_connection_->GetInfo(info_type);
uint16_t info_value = boost::get<uint16_t>(info);
GetAttribute(info_value, value, buffer_length, output_length);
break;
return SQL_SUCCESS;
}

// Special case - SQL_DATABASE_NAME is an alias for SQL_ATTR_CURRENT_CATALOG.
Expand All @@ -454,13 +445,15 @@ void ODBCConnection::GetInfo(SQLUSMALLINT info_type, SQLPOINTER value,
throw DriverException("Optional feature not supported.", "HYC00");
}
const std::string& info_value = boost::get<std::string>(*attr);
GetStringAttribute(is_unicode, info_value, true, value, buffer_length,
output_length, GetDiagnostics());
break;
return GetStringAttribute(is_unicode, info_value, true, value, buffer_length,
output_length, GetDiagnostics());
}
default:
throw DriverException("Unknown SQLGetInfo type: " + std::to_string(info_type));
throw DriverException("Unknown SQLGetInfo type: " + std::to_string(info_type),
"HY096");
}

return SQL_ERROR;
}

void ODBCConnection::SetConnectAttr(SQLINTEGER attribute, SQLPOINTER value,
Expand Down
4 changes: 2 additions & 2 deletions cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_connection.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ class ODBCConnection : public ODBCHandle<ODBCConnection> {
const arrow::flight::sql::odbc::Connection::ConnPropertyMap& properties,
std::vector<std::string_view>& missing_properties);

void GetInfo(SQLUSMALLINT info_type, SQLPOINTER value, SQLSMALLINT buffer_length,
SQLSMALLINT* output_length, bool is_unicode);
SQLRETURN GetInfo(SQLUSMALLINT info_type, SQLPOINTER value, SQLSMALLINT buffer_length,
SQLSMALLINT* output_length, bool is_unicode);
void SetConnectAttr(SQLINTEGER attribute, SQLPOINTER value, SQLINTEGER string_length,
bool isUnicode);
void GetConnectAttr(SQLINTEGER attribute, SQLPOINTER value, SQLINTEGER buffer_length,
Expand Down
1 change: 1 addition & 0 deletions cpp/src/arrow/flight/sql/odbc/tests/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ add_arrow_test(flight_sql_odbc_test
SOURCES
odbc_test_suite.cc
odbc_test_suite.h
connection_info_test.cc
connection_test.cc
# Enable Protobuf cleanup after test execution
# GH-46889: move protobuf_test_util to a more common location
Expand Down
Loading
Loading