Skip to content

GH-50852: [C++][FlightRPC][ODBC] Decode wide connection/descriptor string attributes with the wide decoder #50853

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
vikrantpuppala wants to merge 1 commit into
base: main
Choose a base branch
from
+77 −3
Open

GH-50852: [C++][FlightRPC][ODBC] Decode wide connection/descriptor string attributes with the wide decoder #50853

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
1 change: 1 addition & 0 deletions cpp/src/arrow/flight/sql/odbc/odbc_impl/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ add_arrow_test(odbc_spi_impl_test
json_converter_test.cc
record_batch_transformer_test.cc
util_test.cc
odbc_descriptor_test.cc
EXTRA_LINK_LIBS
arrow_odbc_spi_impl
${ODBC_SPI_IMPL_TEST_LINK_LIBS})
4 changes: 2 additions & 2 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 @@ -465,9 +465,9 @@ void ODBCConnection::SetConnectAttr(SQLINTEGER attribute, SQLPOINTER value,
case SQL_ATTR_CURRENT_CATALOG: {
std::string catalog;
if (is_unicode) {
SetAttributeUTF8(value, string_length, catalog);
} else {
SetAttributeSQLWCHAR(value, string_length, catalog);
} else {
SetAttributeUTF8(value, string_length, catalog);
}
if (!spi_connection_->SetAttribute(Connection::CURRENT_CATALOG, catalog)) {
throw DriverException("Option value changed.", "01S02");
Expand Down
2 changes: 1 addition & 1 deletion cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_descriptor.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ void ODBCDescriptor::SetField(SQLSMALLINT record_number, SQLSMALLINT field_ident
has_bindings_changed_ = true;
break;
case SQL_DESC_NAME:
SetAttributeUTF8(value, buffer_length, record.name);
SetAttributeSQLWCHAR(value, buffer_length, record.name);

@vikrantpuppala vikrantpuppala Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good catch — added ODBCDescriptorTest.SetGetNameWideRoundTrips in odbc_descriptor_test.cc, a direct SetField/GetField round-trip on SQL_DESC_NAME with a multi-character wide name. It passes with the fix and fails without it (the byte-wise decode corrupts the stored UTF-16, which the wide getter then rejects). A black-box test isn't possible here since there's no SQLSetDescField entry point wired up, so the unit test on ODBCDescriptor covers it directly.

has_bindings_changed_ = true;
break;
case SQL_DESC_OCTET_LENGTH:
Expand Down
54 changes: 54 additions & 0 deletions cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_descriptor_test.cc
View file
Open in desktop

@lidavidm lidavidm Aug 20, 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.

Can we consolidate into an existing file?

@vikrantpuppala vikrantpuppala Aug 24, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The tricky part is SQL_DESC_NAME can't be exercised through a public entry point. I had tried a black-box test via SQLGetStmtAttr(SQL_ATTR_APP_ROW_DESC) + SQLSetDescField(ard, 1, SQL_DESC_NAME, …), but that path returns SQL_ERROR (the field isn't settable on the ARD through the DM), so the only way to reach ODBCDescriptor::SetField(SQL_DESC_NAME) is a direct unit test on ODBCDescriptor.

There's no existing descriptor unit test in odbc_impl/ to merge into, and the unit tests there follow a 1:1 source↔test naming convention (util.cc↔util_test.cc, json_converter.cc↔json_converter_test.cc, etc.), so odbc_descriptor_test.cc fit that pattern. Happy to fold it elsewhere if you'd prefer though, e.g. into util_test.cc.

Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include "arrow/flight/sql/odbc/odbc_impl/odbc_descriptor.h"

#include "arrow/flight/sql/odbc/odbc_impl/diagnostics.h"
#include "arrow/flight/sql/odbc/odbc_impl/encoding.h"
#include "arrow/flight/sql/odbc/odbc_impl/encoding_utils.h"

#include <sql.h>
#include <sqlext.h>

#include "gtest/gtest.h"

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

using ODBC::ODBCDescriptor;

TEST(ODBCDescriptorTest, SetGetNameWideRoundTrips) {
arrow::flight::sql::odbc::Diagnostics diagnostics("vendor", "component",
OdbcVersion::V_3);
ODBCDescriptor desc(diagnostics, nullptr, nullptr, /*is_app_descriptor=*/true,
/*is_writable=*/true, /*is_2x_connection=*/false);

SQLSMALLINT count = 1;
desc.SetHeaderField(SQL_DESC_COUNT, reinterpret_cast<SQLPOINTER>(&count), 0);

std::vector<uint8_t> wide;
Utf8ToWcs("my_column", &wide);
desc.SetField(1, SQL_DESC_NAME, wide.data(), static_cast<SQLINTEGER>(wide.size()));

SQLWCHAR out[256];
SQLINTEGER out_len = 0;
desc.GetField(1, SQL_DESC_NAME, out, sizeof(out), &out_len);
std::string name =
ODBC::SqlWcharToString(out, static_cast<SQLSMALLINT>(out_len / GetSqlWCharSize()));
EXPECT_EQ("my_column", name);
}

} // namespace arrow::flight::sql::odbc
19 changes: 19 additions & 0 deletions cpp/src/arrow/flight/sql/odbc/tests/connection_attr_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,4 +410,23 @@ TYPED_TEST(ConnectionAttributeTest, TestSQLSetConnectAttrPacketSizeValid) {
#endif
}

// A multi-character catalog set through the wide entry point must round-trip
// intact.
TYPED_TEST(ConnectionAttributeTest, TestSQLSetGetConnectAttrCurrentCatalogWide) {
ASSIGN_SQLWCHAR_ARR_AND_LEN(catalog, L"my_catalog");

ASSERT_EQ(SQL_SUCCESS, SQLSetConnectAttr(this->conn, SQL_ATTR_CURRENT_CATALOG, catalog,
catalog_len * GetSqlWCharSize()));

SQLWCHAR out_str[kOdbcBufferSize];
SQLINTEGER out_str_len;
ASSERT_EQ(SQL_SUCCESS, SQLGetConnectAttr(this->conn, SQL_ATTR_CURRENT_CATALOG, out_str,
kOdbcBufferSize, &out_str_len));
// SQLGetConnectAttr returns the length in bytes; convert to characters.
out_str_len /= GetSqlWCharSize();
std::string out_catalog =
ODBC::SqlWcharToString(out_str, static_cast<SQLSMALLINT>(out_str_len));
EXPECT_EQ("my_catalog", out_catalog);
}

} // namespace arrow::flight::sql::odbc
Loading