Skip to content

GH-49482: [C++][FlightRPC][ODBC] Fix inconsistent SQLGetInfo values in global connection #50021

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
vanshaj2023 wants to merge 9 commits into
base: main
Choose a base branch
from
+50 −58
Open

GH-49482: [C++][FlightRPC][ODBC] Fix inconsistent SQLGetInfo values in global connection #50021

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4b13ca4
GH-49482: fix inconsistent SQLGetInfo values in global connection
vanshaj2023 May 22, 2026
1864e21
address review: use checked_cast and fix test expectations for DDL info
vanshaj2023 May 25, 2026
7a68a25
address review: qualify checked_cast and use TYPED_TEST for DDL tests
vanshaj2023 May 26, 2026
f312558
GH-49482: remove premature SQL_DROP_SCHEMA/TABLE cache defaults, fix …
vanshaj2023 Aug 4, 2026
de092ed
fix clang-format and correct DropTable/DropSchema remote expectations
vanshaj2023 Aug 6, 2026
cfb3d10
Update cpp/src/arrow/flight/sql/odbc/tests/connection_info_test.cc
vanshaj2023 Aug 6, 2026
cbb6d27
Update cpp/src/arrow/flight/sql/odbc/tests/connection_info_test.cc
vanshaj2023 Aug 6, 2026
870e231
address review: remove duplicate DropSchema remote test, fix comment
vanshaj2023 Aug 6, 2026
9e47bdf
Update cpp/src/arrow/flight/sql/odbc/tests/connection_info_test.cc
vanshaj2023 Aug 7, 2026
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
70 changes: 36 additions & 34 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 @@ -25,6 +25,7 @@
#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/scalar.h"
#include "arrow/type_fwd.h"
#include "arrow/util/checked_cast.h"

#include "arrow/flight/sql/odbc/odbc_impl/flight_sql_stream_chunk_buffer.h"
#include "arrow/flight/sql/odbc/odbc_impl/scalar_function_reporter.h"
Expand Down Expand Up @@ -76,6 +77,9 @@
#define ARROW_CONVERT_VARCHAR 19

namespace arrow::flight::sql::odbc {

using arrow::internal::checked_cast;

namespace {
// Return the corresponding field in SQLGetInfo's SQL_CONVERT_* field
// types for the given Arrow SqlConvert enum value.
Expand Down Expand Up @@ -190,7 +194,7 @@ inline int64_t ScalarToInt64(UnionScalar* scalar) {
}

inline std::string ScalarToBoolString(UnionScalar* scalar) {
return reinterpret_cast<BooleanScalar*>(scalar->child_value().get())->value ? "Y" : "N";
return checked_cast<BooleanScalar*>(scalar->child_value().get())->value ? "Y" : "N";
}

inline void SetDefaultIfMissing(std::unordered_map<uint16_t, Connection::Info>& cache,
Expand Down Expand Up @@ -246,8 +250,6 @@ GetInfoCache::GetInfoCache(FlightClientOptions& client_options,
info_[SQL_DROP_CHARACTER_SET] = static_cast<uint32_t>(0);
info_[SQL_DROP_COLLATION] = static_cast<uint32_t>(0);
info_[SQL_DROP_DOMAIN] = static_cast<uint32_t>(0);
info_[SQL_DROP_SCHEMA] = static_cast<uint32_t>(0);
info_[SQL_DROP_TABLE] = static_cast<uint32_t>(0);
info_[SQL_DROP_TRANSLATION] = static_cast<uint32_t>(0);
info_[SQL_DROP_VIEW] = static_cast<uint32_t>(0);
info_[SQL_MAX_IDENTIFIER_LEN] = static_cast<uint16_t>(65535); // arbitrary
Expand Down Expand Up @@ -395,25 +397,21 @@ bool GetInfoCache::LoadInfoFromServer() {
// Unused by ODBC.
break;
case SqlInfoOptions::SQL_DDL_SCHEMA: {
// GH-49500 TODO: use scalar bool to determine `SQL_CREATE_SCHEMA` and
// `SQL_DROP_SCHEMA` values

// Note: this is a bitmask and we can't describe cascade or restrict
// flags.
info_[SQL_DROP_SCHEMA] = static_cast<uint32_t>(SQL_DS_DROP_SCHEMA);

// Note: this is a bitmask and we can't describe authorization or
// collation
info_[SQL_CREATE_SCHEMA] = static_cast<uint32_t>(SQL_CS_CREATE_SCHEMA);
bool supported =
checked_cast<BooleanScalar*>(scalar->child_value().get())->value;
info_[SQL_DROP_SCHEMA] =
static_cast<uint32_t>(supported ? SQL_DS_DROP_SCHEMA : 0);
info_[SQL_CREATE_SCHEMA] =
Comment on lines +400 to +404
static_cast<uint32_t>(supported ? SQL_CS_CREATE_SCHEMA : 0);
break;
}
case SqlInfoOptions::SQL_DDL_TABLE: {
// GH-49500 TODO: use scalar bool to determine `SQL_CREATE_TABLE` and
// `SQL_DROP_TABLE` values

// This is a bitmask and we cannot describe all clauses.
info_[SQL_CREATE_TABLE] = static_cast<uint32_t>(SQL_CT_CREATE_TABLE);
info_[SQL_DROP_TABLE] = static_cast<uint32_t>(SQL_DT_DROP_TABLE);
bool supported =
checked_cast<BooleanScalar*>(scalar->child_value().get())->value;
info_[SQL_CREATE_TABLE] =
static_cast<uint32_t>(supported ? SQL_CT_CREATE_TABLE : 0);
info_[SQL_DROP_TABLE] =
static_cast<uint32_t>(supported ? SQL_DT_DROP_TABLE : 0);
break;
}
case SqlInfoOptions::SQL_ALL_TABLES_ARE_SELECTABLE: {
Expand All @@ -426,7 +424,7 @@ bool GetInfoCache::LoadInfoFromServer() {
}
case SqlInfoOptions::SQL_NULL_PLUS_NULL_IS_NULL: {
info_[SQL_CONCAT_NULL_BEHAVIOR] = static_cast<uint16_t>(
reinterpret_cast<BooleanScalar*>(scalar->child_value().get())->value
checked_cast<BooleanScalar*>(scalar->child_value().get())->value
? SQL_CB_NULL
: SQL_CB_NON_NULL);
break;
Expand All @@ -436,15 +434,15 @@ bool GetInfoCache::LoadInfoFromServer() {
// SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES since we need both
// properties to determine the value for SQL_CORRELATION_NAME.
supports_correlation_name =
reinterpret_cast<BooleanScalar*>(scalar->child_value().get())->value;
checked_cast<BooleanScalar*>(scalar->child_value().get())->value;
break;
}
case SqlInfoOptions::SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES: {
// Simply cache SQL_SUPPORTS_TABLE_CORRELATION_NAMES and
// SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES since we need both
// properties to determine the value for SQL_CORRELATION_NAME.
requires_different_correlation_name =
reinterpret_cast<BooleanScalar*>(scalar->child_value().get())->value;
checked_cast<BooleanScalar*>(scalar->child_value().get())->value;
break;
}
case SqlInfoOptions::SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY: {
Expand All @@ -454,9 +452,8 @@ bool GetInfoCache::LoadInfoFromServer() {
case SqlInfoOptions::SQL_SUPPORTS_ORDER_BY_UNRELATED: {
// Note: this is the negation of the Flight SQL property.
info_[SQL_ORDER_BY_COLUMNS_IN_SELECT] =
reinterpret_cast<BooleanScalar*>(scalar->child_value().get())->value
? "N"
: "Y";
checked_cast<BooleanScalar*>(scalar->child_value().get())->value ? "N"
: "Y";
break;
}
case SqlInfoOptions::SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE: {
Expand All @@ -465,7 +462,7 @@ bool GetInfoCache::LoadInfoFromServer() {
}
case SqlInfoOptions::SQL_SUPPORTS_NON_NULLABLE_COLUMNS: {
info_[SQL_NON_NULLABLE_COLUMNS] = static_cast<uint16_t>(
reinterpret_cast<BooleanScalar*>(scalar->child_value().get())->value
checked_cast<BooleanScalar*>(scalar->child_value().get())->value
? SQL_NNC_NON_NULL
: SQL_NNC_NULL);
break;
Expand All @@ -475,10 +472,15 @@ bool GetInfoCache::LoadInfoFromServer() {
break;
}
case SqlInfoOptions::SQL_CATALOG_AT_START: {
info_[SQL_CATALOG_LOCATION] = static_cast<uint16_t>(
reinterpret_cast<BooleanScalar*>(scalar->child_value().get())->value
? SQL_CL_START
: SQL_CL_END);
// Only use this as a fallback if ARROW_SQL_CATALOG_TERM has not already
// set SQL_CATALOG_LOCATION (to avoid conflicting writes depending on
// response key ordering).
SetDefaultIfMissing(
info_, SQL_CATALOG_LOCATION,
static_cast<uint16_t>(
checked_cast<BooleanScalar*>(scalar->child_value().get())->value
? SQL_CL_START
: SQL_CL_END));
break;
}
case SqlInfoOptions::SQL_SELECT_FOR_UPDATE_SUPPORTED:
Expand All @@ -494,22 +496,22 @@ bool GetInfoCache::LoadInfoFromServer() {
}
case SqlInfoOptions::SQL_TRANSACTIONS_SUPPORTED: {
transactions_supported =
reinterpret_cast<BooleanScalar*>(scalar->child_value().get())->value;
Comment on lines 496 to -497

@alinaliBQ alinaliBQ May 25, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Please fix the CI build failures from checked_cast in this file:
https://github.com/apache/arrow/actions/runs/26406439067/job/77730895486?pr=50021#step:7:4419

/Users/runner/work/arrow/arrow/cpp/src/arrow/flight/sql/odbc/odbc_impl/get_info_cache.cc:499:19: error: use of undeclared identifier 'checked_cast'; did you mean 'internal::checked_cast'?
  499 |                   checked_cast<BooleanScalar*>(scalar->child_value().get())->value;
      |                   ^~~~~~~~~~~~
      |                   internal::checked_cast
/Users/runner/work/arrow/arrow/cpp/src/arrow/util/checked_cast.h:28:19: note: 'internal::checked_cast' declared here

checked_cast<BooleanScalar*>(scalar->child_value().get())->value;
break;
}
case SqlInfoOptions::SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT: {
transaction_ddl_commit =
reinterpret_cast<BooleanScalar*>(scalar->child_value().get())->value;
checked_cast<BooleanScalar*>(scalar->child_value().get())->value;
break;
}
case SqlInfoOptions::SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED: {
transaction_ddl_ignore =
reinterpret_cast<BooleanScalar*>(scalar->child_value().get())->value;
checked_cast<BooleanScalar*>(scalar->child_value().get())->value;
break;
}
case SqlInfoOptions::SQL_BATCH_UPDATES_SUPPORTED: {
info_[SQL_BATCH_SUPPORT] = static_cast<uint32_t>(
reinterpret_cast<BooleanScalar*>(scalar->child_value().get())->value
checked_cast<BooleanScalar*>(scalar->child_value().get())->value
? SQL_BS_ROW_COUNT_EXPLICIT
: 0);
break;
Expand Down
38 changes: 14 additions & 24 deletions cpp/src/arrow/flight/sql/odbc/tests/connection_info_test.cc
View file
Open in desktop

@lidavidm lidavidm May 25, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It seems there's some failing tests - some more test cases need updating?

@alinaliBQ alinaliBQ May 25, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@vanshaj2023 To ensure maximum coverage, please build and run the ODBC tests locally against a Dremio docker instance with documentation here:

arrow/cpp/src/arrow/flight/sql/odbc/README.md

Lines 88 to 89 in cd1811b

## Steps to Run the ODBC tests
After ODBC has been registered, you can run the ODBC tests. It is recommended to run the ODBC tests locally first.

Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ template <typename T>
class ConnectionInfoTest : public T {};

class ConnectionInfoMockTest : public FlightSQLODBCMockTestBase {};
class ConnectionInfoRemoteTest : public FlightSQLODBCRemoteTestBase {};
using TestTypes = ::testing::Types<ConnectionInfoMockTest, FlightSQLODBCRemoteTestBase>;
TYPED_TEST_SUITE(ConnectionInfoTest, TestTypes);

Expand Down Expand Up @@ -622,18 +623,11 @@ TYPED_TEST(ConnectionInfoTest, TestSQLGetInfoAlterTable) {
EXPECT_EQ(static_cast<SQLUINTEGER>(0), value);
}

TYPED_TEST(ConnectionInfoHandleTest, TestSQLGetInfoCatalogLocation) {
// GH-49482 TODO: resolve inconsitent return value for SQL_CATALOG_LOCATION and change
// test type to `ConnectionInfoTest`
this->ConnectWithString(this->GetConnectionString(), this->conn);

TYPED_TEST(ConnectionInfoTest, TestSQLGetInfoCatalogLocation) {
SQLUSMALLINT value;
GetInfo(this->conn, SQL_CATALOG_LOCATION, &value);

EXPECT_EQ(static_cast<SQLUSMALLINT>(0), value);

EXPECT_EQ(SQL_SUCCESS, SQLDisconnect(this->conn))
<< GetOdbcErrorMessage(SQL_HANDLE_DBC, this->conn);
}

TYPED_TEST(ConnectionInfoTest, TestSQLGetInfoCatalogName) {
Expand Down Expand Up @@ -706,7 +700,8 @@ TEST_F(ConnectionInfoMockTest, TestSQLGetInfoCreateSchema) {
SQLUINTEGER value;
GetInfo(this->conn, SQL_CREATE_SCHEMA, &value);

EXPECT_EQ(static_cast<SQLUINTEGER>(1), value);
// SQLite (the mock backend) does not support schema DDL.
EXPECT_EQ(static_cast<SQLUINTEGER>(0), value);
}

TEST_F(ConnectionInfoMockTest, TestSQLGetInfoCreateTable) {
Expand Down Expand Up @@ -758,32 +753,27 @@ TYPED_TEST(ConnectionInfoTest, TestSQLGetInfoDropDomain) {
EXPECT_EQ(static_cast<SQLUINTEGER>(0), value);
}

TYPED_TEST(ConnectionInfoHandleTest, TestSQLGetInfoDropSchema) {
// GH-49482 TODO: resolve inconsitent return value for SQL_DROP_SCHEMA and change test
// type to `ConnectionInfoTest`
this->ConnectWithString(this->GetConnectionString(), this->conn);

TYPED_TEST(ConnectionInfoTest, TestSQLGetInfoDropSchema) {
SQLUINTEGER value;
GetInfo(this->conn, SQL_DROP_SCHEMA, &value);

// Neither the SQLite mock backend nor the Dremio backend support schema DDL.
EXPECT_EQ(static_cast<SQLUINTEGER>(0), value);

EXPECT_EQ(SQL_SUCCESS, SQLDisconnect(this->conn))
<< GetOdbcErrorMessage(SQL_HANDLE_DBC, this->conn);
}

TYPED_TEST(ConnectionInfoHandleTest, TestSQLGetInfoDropTable) {
// GH-49482 TODO: resolve inconsitent return value for SQL_DROP_TABLE and change test
// type to `ConnectionInfoTest`
this->ConnectWithString(this->GetConnectionString(), this->conn);
TEST_F(ConnectionInfoMockTest, TestSQLGetInfoDropTable) {
SQLUINTEGER value;
GetInfo(this->conn, SQL_DROP_TABLE, &value);

EXPECT_EQ(static_cast<SQLUINTEGER>(SQL_DT_DROP_TABLE), value);
}

TEST_F(ConnectionInfoRemoteTest, TestSQLGetInfoDropTable) {
SQLUINTEGER value;
GetInfo(this->conn, SQL_DROP_TABLE, &value);

// The Dremio backend does not report table DDL support.
EXPECT_EQ(static_cast<SQLUINTEGER>(0), value);

@alinaliBQ alinaliBQ Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Out of scope of this PR but helpful to mention, there is a gap that 2 tests are missing from the original implementation:

  • TEST_F(ConnectionInfoRemoteTest, TestSQLGetInfoCreateTable) for SQL_CREATE_TABLE
  • TEST_F(ConnectionInfoRemoteTest, TestSQLGetInfoCreateSchema) for SQL_CREATE_SCHEMA
    Theoretically these tests should also return 0 to signal table and schema DDL is not supported in Dremio instance. It also explains why we were only seeing inconsistencies in SQL_DROP_TABLE and SQL_DROP_SCHEMA.

@alinaliBQ alinaliBQ Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I raised #50828 for this


EXPECT_EQ(SQL_SUCCESS, SQLDisconnect(this->conn))
<< GetOdbcErrorMessage(SQL_HANDLE_DBC, this->conn);
}

TYPED_TEST(ConnectionInfoTest, TestSQLGetInfoDropTranslation) {
Expand Down
Loading