GH-46575: [C++][FlightRPC] ODBC Diagnostics Report#47763

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

Merged
kou merged 3 commits into from
Oct 29, 2025
Merged

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report #47763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ae2993
Extract SQLGetDiagField and SQLGetDiagRec implementation
alinaliBQ Oct 7, 2025
34281ec
Use `ARROW_UNUSED` for ignored results
alinaliBQ Oct 22, 2025
4a0fb9d
Add `[[nodiscard]]` for ODBC APIs
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
357 changes: 353 additions & 4 deletions cpp/src/arrow/flight/sql/odbc/odbc_api.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,20 @@ SQLRETURN SQLFreeStmt(SQLHSTMT handle, SQLUSMALLINT option) {
return SQL_INVALID_HANDLE;
}

inline bool IsValidStringFieldArgs(SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
SQLSMALLINT* string_length_ptr, bool is_unicode) {
const SQLSMALLINT char_size = is_unicode ? GetSqlWCharSize() : sizeof(char);
const bool has_valid_buffer =
buffer_length == SQL_NTS || (buffer_length >= 0 && buffer_length % char_size == 0);

// regardless of capacity return false if invalid
if (diag_info_ptr && !has_valid_buffer) {
return false;
}

return has_valid_buffer || string_length_ptr;
}

SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
SQLSMALLINT rec_number, SQLSMALLINT diag_identifier,
SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
Expand All@@ -76,8 +90,258 @@ SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
<< ", diag_info_ptr: " << diag_info_ptr
<< ", buffer_length: " << buffer_length << ", string_length_ptr: "
<< static_cast<const void*>(string_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagField
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagField
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

if (!diag_info_ptr && !string_length_ptr) {
return SQL_ERROR;
}

// If buffer length derived from null terminated string
if (diag_info_ptr && buffer_length == SQL_NTS) {
const wchar_t* str = reinterpret_cast<wchar_t*>(diag_info_ptr);
buffer_length = wcslen(str) * GetSqlWCharSize();
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
ODBCEnvironment* environment = reinterpret_cast<ODBCEnvironment*>(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_ERROR;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Retrieve and return if header level diagnostics
switch (diag_identifier) {
case SQL_DIAG_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
static_cast<SQLINTEGER>(diagnostics->GetRecordCount());
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Driver manager implements SQL_DIAG_RETURNCODE
case SQL_DIAG_RETURNCODE: {
return SQL_SUCCESS;
}

case SQL_DIAG_CURSOR_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}

// Not supported
case SQL_DIAG_DYNAMIC_FUNCTION:
case SQL_DIAG_DYNAMIC_FUNCTION_CODE: {
if (handle_type == SQL_HANDLE_STMT) {
return SQL_SUCCESS;
}

return SQL_ERROR;
}

case SQL_DIAG_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT is supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}
}

// If not a diagnostic header field then the record number must be 1 or greater
if (rec_number < 1) {
return SQL_ERROR;
}

// Retrieve record level diagnostics from specified 1 based record
const uint32_t record_index = static_cast<uint32_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

// Retrieve record field data
switch (diag_identifier) {
case SQL_DIAG_MESSAGE_TEXT: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& message = diagnostics->GetMessageText(record_index);
return GetStringAttribute(is_unicode, message, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

case SQL_DIAG_NATIVE: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
diagnostics->GetNativeError(record_index);
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

case SQL_DIAG_SERVER_NAME: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
switch (handle_type) {
case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
ODBCConnection* connection = &descriptor->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
ODBCConnection* connection = &statement->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

default:
return SQL_ERROR;
}
}

return SQL_ERROR;
}

case SQL_DIAG_SQLSTATE: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& state = diagnostics->GetSQLState(record_index);
return GetStringAttribute(is_unicode, state, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_COLUMN_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) = SQL_NO_COLUMN_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Return empty string dummy variable for unimplemented fields
case SQL_DIAG_CLASS_ORIGIN:
case SQL_DIAG_CONNECTION_NAME:
case SQL_DIAG_SUBCLASS_ORIGIN: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
return GetStringAttribute(is_unicode, "", true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_ROW_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLLEN*>(diag_info_ptr) = SQL_NO_ROW_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

default: {
return SQL_ERROR;
}
}

return SQL_ERROR;
}

SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT rec_number,
Expand All@@ -91,8 +355,93 @@ SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT r
<< ", message_text: " << static_cast<const void*>(message_text)
<< ", buffer_length: " << buffer_length
<< ", text_length_ptr: " << static_cast<const void*>(text_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagRec
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagRec
using arrow::flight::sql::odbc::Diagnostics;
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

// Record number must be greater or equal to 1
if (rec_number < 1 || buffer_length < 0) {
return SQL_ERROR;
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
auto* environment = ODBCEnvironment::Of(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
auto* connection = ODBCConnection::Of(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
auto* descriptor = ODBCDescriptor::Of(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
auto* statement = ODBCStatement::Of(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_INVALID_HANDLE;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Convert from ODBC 1 based record number to internal diagnostics 0 indexed storage
const size_t record_index = static_cast<size_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

if (sql_state) {
// The length of the sql state is always 5 characters plus null
SQLSMALLINT size = 6;
const std::string& state = diagnostics->GetSQLState(record_index);

// Microsoft documentation does not mention
// any SQLGetDiagRec return value that is associated with `sql_state` buffer, so
// the return value for writing `sql_state` buffer is ignored by the driver.
ARROW_UNUSED(GetStringAttribute(is_unicode, state, false, sql_state, size, &size,
*diagnostics));
}

if (native_error_ptr) {
*native_error_ptr = diagnostics->GetNativeError(record_index);
}

if (message_text || text_length_ptr) {
const std::string& message = diagnostics->GetMessageText(record_index);

// According to Microsoft documentation,
// SQL_SUCCESS_WITH_INFO should be returned if `*message_text` buffer was too
// small to hold the requested diagnostic message.
return GetStringAttribute(is_unicode, message, false, message_text, buffer_length,
text_length_ptr, *diagnostics);
}

return SQL_SUCCESS;
}

SQLRETURN SQLGetEnvAttr(SQLHENV env, SQLINTEGER attr, SQLPOINTER value_ptr,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report#47763

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

Merged
kou merged 3 commits into from
Oct 29, 2025
Merged

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report #47763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ae2993
Extract SQLGetDiagField and SQLGetDiagRec implementation
alinaliBQ Oct 7, 2025
34281ec
Use `ARROW_UNUSED` for ignored results
alinaliBQ Oct 22, 2025
4a0fb9d
Add `[[nodiscard]]` for ODBC APIs
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
357 changes: 353 additions & 4 deletions cpp/src/arrow/flight/sql/odbc/odbc_api.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,20 @@ SQLRETURN SQLFreeStmt(SQLHSTMT handle, SQLUSMALLINT option) {
return SQL_INVALID_HANDLE;
}

inline bool IsValidStringFieldArgs(SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
SQLSMALLINT* string_length_ptr, bool is_unicode) {
const SQLSMALLINT char_size = is_unicode ? GetSqlWCharSize() : sizeof(char);
const bool has_valid_buffer =
buffer_length == SQL_NTS || (buffer_length >= 0 && buffer_length % char_size == 0);

// regardless of capacity return false if invalid
if (diag_info_ptr && !has_valid_buffer) {
return false;
}

return has_valid_buffer || string_length_ptr;
}

SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
SQLSMALLINT rec_number, SQLSMALLINT diag_identifier,
SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
Expand All@@ -76,8 +90,258 @@ SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
<< ", diag_info_ptr: " << diag_info_ptr
<< ", buffer_length: " << buffer_length << ", string_length_ptr: "
<< static_cast<const void*>(string_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagField
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagField
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

if (!diag_info_ptr && !string_length_ptr) {
return SQL_ERROR;
}

// If buffer length derived from null terminated string
if (diag_info_ptr && buffer_length == SQL_NTS) {
const wchar_t* str = reinterpret_cast<wchar_t*>(diag_info_ptr);
buffer_length = wcslen(str) * GetSqlWCharSize();
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
ODBCEnvironment* environment = reinterpret_cast<ODBCEnvironment*>(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_ERROR;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Retrieve and return if header level diagnostics
switch (diag_identifier) {
case SQL_DIAG_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
static_cast<SQLINTEGER>(diagnostics->GetRecordCount());
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Driver manager implements SQL_DIAG_RETURNCODE
case SQL_DIAG_RETURNCODE: {
return SQL_SUCCESS;
}

case SQL_DIAG_CURSOR_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}

// Not supported
case SQL_DIAG_DYNAMIC_FUNCTION:
case SQL_DIAG_DYNAMIC_FUNCTION_CODE: {
if (handle_type == SQL_HANDLE_STMT) {
return SQL_SUCCESS;
}

return SQL_ERROR;
}

case SQL_DIAG_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT is supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}
}

// If not a diagnostic header field then the record number must be 1 or greater
if (rec_number < 1) {
return SQL_ERROR;
}

// Retrieve record level diagnostics from specified 1 based record
const uint32_t record_index = static_cast<uint32_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

// Retrieve record field data
switch (diag_identifier) {
case SQL_DIAG_MESSAGE_TEXT: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& message = diagnostics->GetMessageText(record_index);
return GetStringAttribute(is_unicode, message, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

case SQL_DIAG_NATIVE: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
diagnostics->GetNativeError(record_index);
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

case SQL_DIAG_SERVER_NAME: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
switch (handle_type) {
case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
ODBCConnection* connection = &descriptor->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
ODBCConnection* connection = &statement->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

default:
return SQL_ERROR;
}
}

return SQL_ERROR;
}

case SQL_DIAG_SQLSTATE: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& state = diagnostics->GetSQLState(record_index);
return GetStringAttribute(is_unicode, state, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_COLUMN_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) = SQL_NO_COLUMN_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Return empty string dummy variable for unimplemented fields
case SQL_DIAG_CLASS_ORIGIN:
case SQL_DIAG_CONNECTION_NAME:
case SQL_DIAG_SUBCLASS_ORIGIN: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
return GetStringAttribute(is_unicode, "", true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_ROW_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLLEN*>(diag_info_ptr) = SQL_NO_ROW_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

default: {
return SQL_ERROR;
}
}

return SQL_ERROR;
}

SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT rec_number,
Expand All@@ -91,8 +355,93 @@ SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT r
<< ", message_text: " << static_cast<const void*>(message_text)
<< ", buffer_length: " << buffer_length
<< ", text_length_ptr: " << static_cast<const void*>(text_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagRec
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagRec
using arrow::flight::sql::odbc::Diagnostics;
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

// Record number must be greater or equal to 1
if (rec_number < 1 || buffer_length < 0) {
return SQL_ERROR;
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
auto* environment = ODBCEnvironment::Of(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
auto* connection = ODBCConnection::Of(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
auto* descriptor = ODBCDescriptor::Of(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
auto* statement = ODBCStatement::Of(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_INVALID_HANDLE;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Convert from ODBC 1 based record number to internal diagnostics 0 indexed storage
const size_t record_index = static_cast<size_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

if (sql_state) {
// The length of the sql state is always 5 characters plus null
SQLSMALLINT size = 6;
const std::string& state = diagnostics->GetSQLState(record_index);

// Microsoft documentation does not mention
// any SQLGetDiagRec return value that is associated with `sql_state` buffer, so
// the return value for writing `sql_state` buffer is ignored by the driver.
ARROW_UNUSED(GetStringAttribute(is_unicode, state, false, sql_state, size, &size,
*diagnostics));
}

if (native_error_ptr) {
*native_error_ptr = diagnostics->GetNativeError(record_index);
}

if (message_text || text_length_ptr) {
const std::string& message = diagnostics->GetMessageText(record_index);

// According to Microsoft documentation,
// SQL_SUCCESS_WITH_INFO should be returned if `*message_text` buffer was too
// small to hold the requested diagnostic message.
return GetStringAttribute(is_unicode, message, false, message_text, buffer_length,
text_length_ptr, *diagnostics);
}

return SQL_SUCCESS;
}

SQLRETURN SQLGetEnvAttr(SQLHENV env, SQLINTEGER attr, SQLPOINTER value_ptr,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report#47763

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

Merged
kou merged 3 commits into from
Oct 29, 2025
Merged

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report #47763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ae2993
Extract SQLGetDiagField and SQLGetDiagRec implementation
alinaliBQ Oct 7, 2025
34281ec
Use `ARROW_UNUSED` for ignored results
alinaliBQ Oct 22, 2025
4a0fb9d
Add `[[nodiscard]]` for ODBC APIs
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
357 changes: 353 additions & 4 deletions cpp/src/arrow/flight/sql/odbc/odbc_api.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,20 @@ SQLRETURN SQLFreeStmt(SQLHSTMT handle, SQLUSMALLINT option) {
return SQL_INVALID_HANDLE;
}

inline bool IsValidStringFieldArgs(SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
SQLSMALLINT* string_length_ptr, bool is_unicode) {
const SQLSMALLINT char_size = is_unicode ? GetSqlWCharSize() : sizeof(char);
const bool has_valid_buffer =
buffer_length == SQL_NTS || (buffer_length >= 0 && buffer_length % char_size == 0);

// regardless of capacity return false if invalid
if (diag_info_ptr && !has_valid_buffer) {
return false;
}

return has_valid_buffer || string_length_ptr;
}

SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
SQLSMALLINT rec_number, SQLSMALLINT diag_identifier,
SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
Expand All@@ -76,8 +90,258 @@ SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
<< ", diag_info_ptr: " << diag_info_ptr
<< ", buffer_length: " << buffer_length << ", string_length_ptr: "
<< static_cast<const void*>(string_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagField
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagField
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

if (!diag_info_ptr && !string_length_ptr) {
return SQL_ERROR;
}

// If buffer length derived from null terminated string
if (diag_info_ptr && buffer_length == SQL_NTS) {
const wchar_t* str = reinterpret_cast<wchar_t*>(diag_info_ptr);
buffer_length = wcslen(str) * GetSqlWCharSize();
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
ODBCEnvironment* environment = reinterpret_cast<ODBCEnvironment*>(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_ERROR;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Retrieve and return if header level diagnostics
switch (diag_identifier) {
case SQL_DIAG_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
static_cast<SQLINTEGER>(diagnostics->GetRecordCount());
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Driver manager implements SQL_DIAG_RETURNCODE
case SQL_DIAG_RETURNCODE: {
return SQL_SUCCESS;
}

case SQL_DIAG_CURSOR_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}

// Not supported
case SQL_DIAG_DYNAMIC_FUNCTION:
case SQL_DIAG_DYNAMIC_FUNCTION_CODE: {
if (handle_type == SQL_HANDLE_STMT) {
return SQL_SUCCESS;
}

return SQL_ERROR;
}

case SQL_DIAG_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT is supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}
}

// If not a diagnostic header field then the record number must be 1 or greater
if (rec_number < 1) {
return SQL_ERROR;
}

// Retrieve record level diagnostics from specified 1 based record
const uint32_t record_index = static_cast<uint32_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

// Retrieve record field data
switch (diag_identifier) {
case SQL_DIAG_MESSAGE_TEXT: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& message = diagnostics->GetMessageText(record_index);
return GetStringAttribute(is_unicode, message, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

case SQL_DIAG_NATIVE: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
diagnostics->GetNativeError(record_index);
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

case SQL_DIAG_SERVER_NAME: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
switch (handle_type) {
case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
ODBCConnection* connection = &descriptor->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
ODBCConnection* connection = &statement->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

default:
return SQL_ERROR;
}
}

return SQL_ERROR;
}

case SQL_DIAG_SQLSTATE: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& state = diagnostics->GetSQLState(record_index);
return GetStringAttribute(is_unicode, state, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_COLUMN_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) = SQL_NO_COLUMN_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Return empty string dummy variable for unimplemented fields
case SQL_DIAG_CLASS_ORIGIN:
case SQL_DIAG_CONNECTION_NAME:
case SQL_DIAG_SUBCLASS_ORIGIN: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
return GetStringAttribute(is_unicode, "", true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_ROW_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLLEN*>(diag_info_ptr) = SQL_NO_ROW_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

default: {
return SQL_ERROR;
}
}

return SQL_ERROR;
}

SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT rec_number,
Expand All@@ -91,8 +355,93 @@ SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT r
<< ", message_text: " << static_cast<const void*>(message_text)
<< ", buffer_length: " << buffer_length
<< ", text_length_ptr: " << static_cast<const void*>(text_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagRec
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagRec
using arrow::flight::sql::odbc::Diagnostics;
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

// Record number must be greater or equal to 1
if (rec_number < 1 || buffer_length < 0) {
return SQL_ERROR;
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
auto* environment = ODBCEnvironment::Of(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
auto* connection = ODBCConnection::Of(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
auto* descriptor = ODBCDescriptor::Of(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
auto* statement = ODBCStatement::Of(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_INVALID_HANDLE;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Convert from ODBC 1 based record number to internal diagnostics 0 indexed storage
const size_t record_index = static_cast<size_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

if (sql_state) {
// The length of the sql state is always 5 characters plus null
SQLSMALLINT size = 6;
const std::string& state = diagnostics->GetSQLState(record_index);

// Microsoft documentation does not mention
// any SQLGetDiagRec return value that is associated with `sql_state` buffer, so
// the return value for writing `sql_state` buffer is ignored by the driver.
ARROW_UNUSED(GetStringAttribute(is_unicode, state, false, sql_state, size, &size,
*diagnostics));
}

if (native_error_ptr) {
*native_error_ptr = diagnostics->GetNativeError(record_index);
}

if (message_text || text_length_ptr) {
const std::string& message = diagnostics->GetMessageText(record_index);

// According to Microsoft documentation,
// SQL_SUCCESS_WITH_INFO should be returned if `*message_text` buffer was too
// small to hold the requested diagnostic message.
return GetStringAttribute(is_unicode, message, false, message_text, buffer_length,
text_length_ptr, *diagnostics);
}

return SQL_SUCCESS;
}

SQLRETURN SQLGetEnvAttr(SQLHENV env, SQLINTEGER attr, SQLPOINTER value_ptr,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report#47763

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

Merged
kou merged 3 commits into from
Oct 29, 2025
Merged

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report #47763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ae2993
Extract SQLGetDiagField and SQLGetDiagRec implementation
alinaliBQ Oct 7, 2025
34281ec
Use `ARROW_UNUSED` for ignored results
alinaliBQ Oct 22, 2025
4a0fb9d
Add `[[nodiscard]]` for ODBC APIs
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
357 changes: 353 additions & 4 deletions cpp/src/arrow/flight/sql/odbc/odbc_api.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,20 @@ SQLRETURN SQLFreeStmt(SQLHSTMT handle, SQLUSMALLINT option) {
return SQL_INVALID_HANDLE;
}

inline bool IsValidStringFieldArgs(SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
SQLSMALLINT* string_length_ptr, bool is_unicode) {
const SQLSMALLINT char_size = is_unicode ? GetSqlWCharSize() : sizeof(char);
const bool has_valid_buffer =
buffer_length == SQL_NTS || (buffer_length >= 0 && buffer_length % char_size == 0);

// regardless of capacity return false if invalid
if (diag_info_ptr && !has_valid_buffer) {
return false;
}

return has_valid_buffer || string_length_ptr;
}

SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
SQLSMALLINT rec_number, SQLSMALLINT diag_identifier,
SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
Expand All@@ -76,8 +90,258 @@ SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
<< ", diag_info_ptr: " << diag_info_ptr
<< ", buffer_length: " << buffer_length << ", string_length_ptr: "
<< static_cast<const void*>(string_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagField
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagField
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

if (!diag_info_ptr && !string_length_ptr) {
return SQL_ERROR;
}

// If buffer length derived from null terminated string
if (diag_info_ptr && buffer_length == SQL_NTS) {
const wchar_t* str = reinterpret_cast<wchar_t*>(diag_info_ptr);
buffer_length = wcslen(str) * GetSqlWCharSize();
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
ODBCEnvironment* environment = reinterpret_cast<ODBCEnvironment*>(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_ERROR;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Retrieve and return if header level diagnostics
switch (diag_identifier) {
case SQL_DIAG_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
static_cast<SQLINTEGER>(diagnostics->GetRecordCount());
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Driver manager implements SQL_DIAG_RETURNCODE
case SQL_DIAG_RETURNCODE: {
return SQL_SUCCESS;
}

case SQL_DIAG_CURSOR_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}

// Not supported
case SQL_DIAG_DYNAMIC_FUNCTION:
case SQL_DIAG_DYNAMIC_FUNCTION_CODE: {
if (handle_type == SQL_HANDLE_STMT) {
return SQL_SUCCESS;
}

return SQL_ERROR;
}

case SQL_DIAG_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT is supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}
}

// If not a diagnostic header field then the record number must be 1 or greater
if (rec_number < 1) {
return SQL_ERROR;
}

// Retrieve record level diagnostics from specified 1 based record
const uint32_t record_index = static_cast<uint32_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

// Retrieve record field data
switch (diag_identifier) {
case SQL_DIAG_MESSAGE_TEXT: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& message = diagnostics->GetMessageText(record_index);
return GetStringAttribute(is_unicode, message, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

case SQL_DIAG_NATIVE: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
diagnostics->GetNativeError(record_index);
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

case SQL_DIAG_SERVER_NAME: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
switch (handle_type) {
case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
ODBCConnection* connection = &descriptor->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
ODBCConnection* connection = &statement->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

default:
return SQL_ERROR;
}
}

return SQL_ERROR;
}

case SQL_DIAG_SQLSTATE: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& state = diagnostics->GetSQLState(record_index);
return GetStringAttribute(is_unicode, state, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_COLUMN_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) = SQL_NO_COLUMN_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Return empty string dummy variable for unimplemented fields
case SQL_DIAG_CLASS_ORIGIN:
case SQL_DIAG_CONNECTION_NAME:
case SQL_DIAG_SUBCLASS_ORIGIN: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
return GetStringAttribute(is_unicode, "", true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_ROW_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLLEN*>(diag_info_ptr) = SQL_NO_ROW_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

default: {
return SQL_ERROR;
}
}

return SQL_ERROR;
}

SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT rec_number,
Expand All@@ -91,8 +355,93 @@ SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT r
<< ", message_text: " << static_cast<const void*>(message_text)
<< ", buffer_length: " << buffer_length
<< ", text_length_ptr: " << static_cast<const void*>(text_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagRec
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagRec
using arrow::flight::sql::odbc::Diagnostics;
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

// Record number must be greater or equal to 1
if (rec_number < 1 || buffer_length < 0) {
return SQL_ERROR;
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
auto* environment = ODBCEnvironment::Of(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
auto* connection = ODBCConnection::Of(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
auto* descriptor = ODBCDescriptor::Of(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
auto* statement = ODBCStatement::Of(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_INVALID_HANDLE;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Convert from ODBC 1 based record number to internal diagnostics 0 indexed storage
const size_t record_index = static_cast<size_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

if (sql_state) {
// The length of the sql state is always 5 characters plus null
SQLSMALLINT size = 6;
const std::string& state = diagnostics->GetSQLState(record_index);

// Microsoft documentation does not mention
// any SQLGetDiagRec return value that is associated with `sql_state` buffer, so
// the return value for writing `sql_state` buffer is ignored by the driver.
ARROW_UNUSED(GetStringAttribute(is_unicode, state, false, sql_state, size, &size,
*diagnostics));
}

if (native_error_ptr) {
*native_error_ptr = diagnostics->GetNativeError(record_index);
}

if (message_text || text_length_ptr) {
const std::string& message = diagnostics->GetMessageText(record_index);

// According to Microsoft documentation,
// SQL_SUCCESS_WITH_INFO should be returned if `*message_text` buffer was too
// small to hold the requested diagnostic message.
return GetStringAttribute(is_unicode, message, false, message_text, buffer_length,
text_length_ptr, *diagnostics);
}

return SQL_SUCCESS;
}

SQLRETURN SQLGetEnvAttr(SQLHENV env, SQLINTEGER attr, SQLPOINTER value_ptr,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report#47763

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

Merged
kou merged 3 commits into from
Oct 29, 2025
Merged

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report #47763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ae2993
Extract SQLGetDiagField and SQLGetDiagRec implementation
alinaliBQ Oct 7, 2025
34281ec
Use `ARROW_UNUSED` for ignored results
alinaliBQ Oct 22, 2025
4a0fb9d
Add `[[nodiscard]]` for ODBC APIs
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
357 changes: 353 additions & 4 deletions cpp/src/arrow/flight/sql/odbc/odbc_api.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,20 @@ SQLRETURN SQLFreeStmt(SQLHSTMT handle, SQLUSMALLINT option) {
return SQL_INVALID_HANDLE;
}

inline bool IsValidStringFieldArgs(SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
SQLSMALLINT* string_length_ptr, bool is_unicode) {
const SQLSMALLINT char_size = is_unicode ? GetSqlWCharSize() : sizeof(char);
const bool has_valid_buffer =
buffer_length == SQL_NTS || (buffer_length >= 0 && buffer_length % char_size == 0);

// regardless of capacity return false if invalid
if (diag_info_ptr && !has_valid_buffer) {
return false;
}

return has_valid_buffer || string_length_ptr;
}

SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
SQLSMALLINT rec_number, SQLSMALLINT diag_identifier,
SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
Expand All@@ -76,8 +90,258 @@ SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
<< ", diag_info_ptr: " << diag_info_ptr
<< ", buffer_length: " << buffer_length << ", string_length_ptr: "
<< static_cast<const void*>(string_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagField
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagField
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

if (!diag_info_ptr && !string_length_ptr) {
return SQL_ERROR;
}

// If buffer length derived from null terminated string
if (diag_info_ptr && buffer_length == SQL_NTS) {
const wchar_t* str = reinterpret_cast<wchar_t*>(diag_info_ptr);
buffer_length = wcslen(str) * GetSqlWCharSize();
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
ODBCEnvironment* environment = reinterpret_cast<ODBCEnvironment*>(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_ERROR;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Retrieve and return if header level diagnostics
switch (diag_identifier) {
case SQL_DIAG_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
static_cast<SQLINTEGER>(diagnostics->GetRecordCount());
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Driver manager implements SQL_DIAG_RETURNCODE
case SQL_DIAG_RETURNCODE: {
return SQL_SUCCESS;
}

case SQL_DIAG_CURSOR_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}

// Not supported
case SQL_DIAG_DYNAMIC_FUNCTION:
case SQL_DIAG_DYNAMIC_FUNCTION_CODE: {
if (handle_type == SQL_HANDLE_STMT) {
return SQL_SUCCESS;
}

return SQL_ERROR;
}

case SQL_DIAG_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT is supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}
}

// If not a diagnostic header field then the record number must be 1 or greater
if (rec_number < 1) {
return SQL_ERROR;
}

// Retrieve record level diagnostics from specified 1 based record
const uint32_t record_index = static_cast<uint32_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

// Retrieve record field data
switch (diag_identifier) {
case SQL_DIAG_MESSAGE_TEXT: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& message = diagnostics->GetMessageText(record_index);
return GetStringAttribute(is_unicode, message, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

case SQL_DIAG_NATIVE: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
diagnostics->GetNativeError(record_index);
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

case SQL_DIAG_SERVER_NAME: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
switch (handle_type) {
case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
ODBCConnection* connection = &descriptor->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
ODBCConnection* connection = &statement->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

default:
return SQL_ERROR;
}
}

return SQL_ERROR;
}

case SQL_DIAG_SQLSTATE: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& state = diagnostics->GetSQLState(record_index);
return GetStringAttribute(is_unicode, state, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_COLUMN_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) = SQL_NO_COLUMN_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Return empty string dummy variable for unimplemented fields
case SQL_DIAG_CLASS_ORIGIN:
case SQL_DIAG_CONNECTION_NAME:
case SQL_DIAG_SUBCLASS_ORIGIN: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
return GetStringAttribute(is_unicode, "", true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_ROW_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLLEN*>(diag_info_ptr) = SQL_NO_ROW_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

default: {
return SQL_ERROR;
}
}

return SQL_ERROR;
}

SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT rec_number,
Expand All@@ -91,8 +355,93 @@ SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT r
<< ", message_text: " << static_cast<const void*>(message_text)
<< ", buffer_length: " << buffer_length
<< ", text_length_ptr: " << static_cast<const void*>(text_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagRec
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagRec
using arrow::flight::sql::odbc::Diagnostics;
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

// Record number must be greater or equal to 1
if (rec_number < 1 || buffer_length < 0) {
return SQL_ERROR;
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
auto* environment = ODBCEnvironment::Of(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
auto* connection = ODBCConnection::Of(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
auto* descriptor = ODBCDescriptor::Of(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
auto* statement = ODBCStatement::Of(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_INVALID_HANDLE;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Convert from ODBC 1 based record number to internal diagnostics 0 indexed storage
const size_t record_index = static_cast<size_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

if (sql_state) {
// The length of the sql state is always 5 characters plus null
SQLSMALLINT size = 6;
const std::string& state = diagnostics->GetSQLState(record_index);

// Microsoft documentation does not mention
// any SQLGetDiagRec return value that is associated with `sql_state` buffer, so
// the return value for writing `sql_state` buffer is ignored by the driver.
ARROW_UNUSED(GetStringAttribute(is_unicode, state, false, sql_state, size, &size,
*diagnostics));
}

if (native_error_ptr) {
*native_error_ptr = diagnostics->GetNativeError(record_index);
}

if (message_text || text_length_ptr) {
const std::string& message = diagnostics->GetMessageText(record_index);

// According to Microsoft documentation,
// SQL_SUCCESS_WITH_INFO should be returned if `*message_text` buffer was too
// small to hold the requested diagnostic message.
return GetStringAttribute(is_unicode, message, false, message_text, buffer_length,
text_length_ptr, *diagnostics);
}

return SQL_SUCCESS;
}

SQLRETURN SQLGetEnvAttr(SQLHENV env, SQLINTEGER attr, SQLPOINTER value_ptr,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report#47763

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

Merged
kou merged 3 commits into from
Oct 29, 2025
Merged

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report #47763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ae2993
Extract SQLGetDiagField and SQLGetDiagRec implementation
alinaliBQ Oct 7, 2025
34281ec
Use `ARROW_UNUSED` for ignored results
alinaliBQ Oct 22, 2025
4a0fb9d
Add `[[nodiscard]]` for ODBC APIs
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
357 changes: 353 additions & 4 deletions cpp/src/arrow/flight/sql/odbc/odbc_api.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,20 @@ SQLRETURN SQLFreeStmt(SQLHSTMT handle, SQLUSMALLINT option) {
return SQL_INVALID_HANDLE;
}

inline bool IsValidStringFieldArgs(SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
SQLSMALLINT* string_length_ptr, bool is_unicode) {
const SQLSMALLINT char_size = is_unicode ? GetSqlWCharSize() : sizeof(char);
const bool has_valid_buffer =
buffer_length == SQL_NTS || (buffer_length >= 0 && buffer_length % char_size == 0);

// regardless of capacity return false if invalid
if (diag_info_ptr && !has_valid_buffer) {
return false;
}

return has_valid_buffer || string_length_ptr;
}

SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
SQLSMALLINT rec_number, SQLSMALLINT diag_identifier,
SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
Expand All@@ -76,8 +90,258 @@ SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
<< ", diag_info_ptr: " << diag_info_ptr
<< ", buffer_length: " << buffer_length << ", string_length_ptr: "
<< static_cast<const void*>(string_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagField
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagField
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

if (!diag_info_ptr && !string_length_ptr) {
return SQL_ERROR;
}

// If buffer length derived from null terminated string
if (diag_info_ptr && buffer_length == SQL_NTS) {
const wchar_t* str = reinterpret_cast<wchar_t*>(diag_info_ptr);
buffer_length = wcslen(str) * GetSqlWCharSize();
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
ODBCEnvironment* environment = reinterpret_cast<ODBCEnvironment*>(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_ERROR;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Retrieve and return if header level diagnostics
switch (diag_identifier) {
case SQL_DIAG_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
static_cast<SQLINTEGER>(diagnostics->GetRecordCount());
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Driver manager implements SQL_DIAG_RETURNCODE
case SQL_DIAG_RETURNCODE: {
return SQL_SUCCESS;
}

case SQL_DIAG_CURSOR_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}

// Not supported
case SQL_DIAG_DYNAMIC_FUNCTION:
case SQL_DIAG_DYNAMIC_FUNCTION_CODE: {
if (handle_type == SQL_HANDLE_STMT) {
return SQL_SUCCESS;
}

return SQL_ERROR;
}

case SQL_DIAG_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT is supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}
}

// If not a diagnostic header field then the record number must be 1 or greater
if (rec_number < 1) {
return SQL_ERROR;
}

// Retrieve record level diagnostics from specified 1 based record
const uint32_t record_index = static_cast<uint32_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

// Retrieve record field data
switch (diag_identifier) {
case SQL_DIAG_MESSAGE_TEXT: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& message = diagnostics->GetMessageText(record_index);
return GetStringAttribute(is_unicode, message, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

case SQL_DIAG_NATIVE: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
diagnostics->GetNativeError(record_index);
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

case SQL_DIAG_SERVER_NAME: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
switch (handle_type) {
case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
ODBCConnection* connection = &descriptor->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
ODBCConnection* connection = &statement->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

default:
return SQL_ERROR;
}
}

return SQL_ERROR;
}

case SQL_DIAG_SQLSTATE: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& state = diagnostics->GetSQLState(record_index);
return GetStringAttribute(is_unicode, state, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_COLUMN_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) = SQL_NO_COLUMN_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Return empty string dummy variable for unimplemented fields
case SQL_DIAG_CLASS_ORIGIN:
case SQL_DIAG_CONNECTION_NAME:
case SQL_DIAG_SUBCLASS_ORIGIN: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
return GetStringAttribute(is_unicode, "", true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_ROW_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLLEN*>(diag_info_ptr) = SQL_NO_ROW_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

default: {
return SQL_ERROR;
}
}

return SQL_ERROR;
}

SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT rec_number,
Expand All@@ -91,8 +355,93 @@ SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT r
<< ", message_text: " << static_cast<const void*>(message_text)
<< ", buffer_length: " << buffer_length
<< ", text_length_ptr: " << static_cast<const void*>(text_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagRec
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagRec
using arrow::flight::sql::odbc::Diagnostics;
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

// Record number must be greater or equal to 1
if (rec_number < 1 || buffer_length < 0) {
return SQL_ERROR;
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
auto* environment = ODBCEnvironment::Of(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
auto* connection = ODBCConnection::Of(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
auto* descriptor = ODBCDescriptor::Of(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
auto* statement = ODBCStatement::Of(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_INVALID_HANDLE;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Convert from ODBC 1 based record number to internal diagnostics 0 indexed storage
const size_t record_index = static_cast<size_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

if (sql_state) {
// The length of the sql state is always 5 characters plus null
SQLSMALLINT size = 6;
const std::string& state = diagnostics->GetSQLState(record_index);

// Microsoft documentation does not mention
// any SQLGetDiagRec return value that is associated with `sql_state` buffer, so
// the return value for writing `sql_state` buffer is ignored by the driver.
ARROW_UNUSED(GetStringAttribute(is_unicode, state, false, sql_state, size, &size,
*diagnostics));
}

if (native_error_ptr) {
*native_error_ptr = diagnostics->GetNativeError(record_index);
}

if (message_text || text_length_ptr) {
const std::string& message = diagnostics->GetMessageText(record_index);

// According to Microsoft documentation,
// SQL_SUCCESS_WITH_INFO should be returned if `*message_text` buffer was too
// small to hold the requested diagnostic message.
return GetStringAttribute(is_unicode, message, false, message_text, buffer_length,
text_length_ptr, *diagnostics);
}

return SQL_SUCCESS;
}

SQLRETURN SQLGetEnvAttr(SQLHENV env, SQLINTEGER attr, SQLPOINTER value_ptr,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report#47763

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

Merged
kou merged 3 commits into from
Oct 29, 2025
Merged

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report #47763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ae2993
Extract SQLGetDiagField and SQLGetDiagRec implementation
alinaliBQ Oct 7, 2025
34281ec
Use `ARROW_UNUSED` for ignored results
alinaliBQ Oct 22, 2025
4a0fb9d
Add `[[nodiscard]]` for ODBC APIs
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
357 changes: 353 additions & 4 deletions cpp/src/arrow/flight/sql/odbc/odbc_api.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,20 @@ SQLRETURN SQLFreeStmt(SQLHSTMT handle, SQLUSMALLINT option) {
return SQL_INVALID_HANDLE;
}

inline bool IsValidStringFieldArgs(SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
SQLSMALLINT* string_length_ptr, bool is_unicode) {
const SQLSMALLINT char_size = is_unicode ? GetSqlWCharSize() : sizeof(char);
const bool has_valid_buffer =
buffer_length == SQL_NTS || (buffer_length >= 0 && buffer_length % char_size == 0);

// regardless of capacity return false if invalid
if (diag_info_ptr && !has_valid_buffer) {
return false;
}

return has_valid_buffer || string_length_ptr;
}

SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
SQLSMALLINT rec_number, SQLSMALLINT diag_identifier,
SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
Expand All@@ -76,8 +90,258 @@ SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
<< ", diag_info_ptr: " << diag_info_ptr
<< ", buffer_length: " << buffer_length << ", string_length_ptr: "
<< static_cast<const void*>(string_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagField
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagField
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

if (!diag_info_ptr && !string_length_ptr) {
return SQL_ERROR;
}

// If buffer length derived from null terminated string
if (diag_info_ptr && buffer_length == SQL_NTS) {
const wchar_t* str = reinterpret_cast<wchar_t*>(diag_info_ptr);
buffer_length = wcslen(str) * GetSqlWCharSize();
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
ODBCEnvironment* environment = reinterpret_cast<ODBCEnvironment*>(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_ERROR;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Retrieve and return if header level diagnostics
switch (diag_identifier) {
case SQL_DIAG_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
static_cast<SQLINTEGER>(diagnostics->GetRecordCount());
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Driver manager implements SQL_DIAG_RETURNCODE
case SQL_DIAG_RETURNCODE: {
return SQL_SUCCESS;
}

case SQL_DIAG_CURSOR_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}

// Not supported
case SQL_DIAG_DYNAMIC_FUNCTION:
case SQL_DIAG_DYNAMIC_FUNCTION_CODE: {
if (handle_type == SQL_HANDLE_STMT) {
return SQL_SUCCESS;
}

return SQL_ERROR;
}

case SQL_DIAG_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT is supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}
}

// If not a diagnostic header field then the record number must be 1 or greater
if (rec_number < 1) {
return SQL_ERROR;
}

// Retrieve record level diagnostics from specified 1 based record
const uint32_t record_index = static_cast<uint32_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

// Retrieve record field data
switch (diag_identifier) {
case SQL_DIAG_MESSAGE_TEXT: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& message = diagnostics->GetMessageText(record_index);
return GetStringAttribute(is_unicode, message, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

case SQL_DIAG_NATIVE: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
diagnostics->GetNativeError(record_index);
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

case SQL_DIAG_SERVER_NAME: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
switch (handle_type) {
case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
ODBCConnection* connection = &descriptor->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
ODBCConnection* connection = &statement->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

default:
return SQL_ERROR;
}
}

return SQL_ERROR;
}

case SQL_DIAG_SQLSTATE: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& state = diagnostics->GetSQLState(record_index);
return GetStringAttribute(is_unicode, state, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_COLUMN_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) = SQL_NO_COLUMN_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Return empty string dummy variable for unimplemented fields
case SQL_DIAG_CLASS_ORIGIN:
case SQL_DIAG_CONNECTION_NAME:
case SQL_DIAG_SUBCLASS_ORIGIN: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
return GetStringAttribute(is_unicode, "", true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_ROW_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLLEN*>(diag_info_ptr) = SQL_NO_ROW_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

default: {
return SQL_ERROR;
}
}

return SQL_ERROR;
}

SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT rec_number,
Expand All@@ -91,8 +355,93 @@ SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT r
<< ", message_text: " << static_cast<const void*>(message_text)
<< ", buffer_length: " << buffer_length
<< ", text_length_ptr: " << static_cast<const void*>(text_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagRec
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagRec
using arrow::flight::sql::odbc::Diagnostics;
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

// Record number must be greater or equal to 1
if (rec_number < 1 || buffer_length < 0) {
return SQL_ERROR;
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
auto* environment = ODBCEnvironment::Of(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
auto* connection = ODBCConnection::Of(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
auto* descriptor = ODBCDescriptor::Of(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
auto* statement = ODBCStatement::Of(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_INVALID_HANDLE;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Convert from ODBC 1 based record number to internal diagnostics 0 indexed storage
const size_t record_index = static_cast<size_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

if (sql_state) {
// The length of the sql state is always 5 characters plus null
SQLSMALLINT size = 6;
const std::string& state = diagnostics->GetSQLState(record_index);

// Microsoft documentation does not mention
// any SQLGetDiagRec return value that is associated with `sql_state` buffer, so
// the return value for writing `sql_state` buffer is ignored by the driver.
ARROW_UNUSED(GetStringAttribute(is_unicode, state, false, sql_state, size, &size,
*diagnostics));
}

if (native_error_ptr) {
*native_error_ptr = diagnostics->GetNativeError(record_index);
}

if (message_text || text_length_ptr) {
const std::string& message = diagnostics->GetMessageText(record_index);

// According to Microsoft documentation,
// SQL_SUCCESS_WITH_INFO should be returned if `*message_text` buffer was too
// small to hold the requested diagnostic message.
return GetStringAttribute(is_unicode, message, false, message_text, buffer_length,
text_length_ptr, *diagnostics);
}

return SQL_SUCCESS;
}

SQLRETURN SQLGetEnvAttr(SQLHENV env, SQLINTEGER attr, SQLPOINTER value_ptr,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report#47763

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

Merged
kou merged 3 commits into from
Oct 29, 2025
Merged

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report #47763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ae2993
Extract SQLGetDiagField and SQLGetDiagRec implementation
alinaliBQ Oct 7, 2025
34281ec
Use `ARROW_UNUSED` for ignored results
alinaliBQ Oct 22, 2025
4a0fb9d
Add `[[nodiscard]]` for ODBC APIs
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
357 changes: 353 additions & 4 deletions cpp/src/arrow/flight/sql/odbc/odbc_api.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,20 @@ SQLRETURN SQLFreeStmt(SQLHSTMT handle, SQLUSMALLINT option) {
return SQL_INVALID_HANDLE;
}

inline bool IsValidStringFieldArgs(SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
SQLSMALLINT* string_length_ptr, bool is_unicode) {
const SQLSMALLINT char_size = is_unicode ? GetSqlWCharSize() : sizeof(char);
const bool has_valid_buffer =
buffer_length == SQL_NTS || (buffer_length >= 0 && buffer_length % char_size == 0);

// regardless of capacity return false if invalid
if (diag_info_ptr && !has_valid_buffer) {
return false;
}

return has_valid_buffer || string_length_ptr;
}

SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
SQLSMALLINT rec_number, SQLSMALLINT diag_identifier,
SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
Expand All@@ -76,8 +90,258 @@ SQLRETURN SQLGetDiagField(SQLSMALLINT handle_type, SQLHANDLE handle,
<< ", diag_info_ptr: " << diag_info_ptr
<< ", buffer_length: " << buffer_length << ", string_length_ptr: "
<< static_cast<const void*>(string_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagField
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagField
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

if (!diag_info_ptr && !string_length_ptr) {
return SQL_ERROR;
}

// If buffer length derived from null terminated string
if (diag_info_ptr && buffer_length == SQL_NTS) {
const wchar_t* str = reinterpret_cast<wchar_t*>(diag_info_ptr);
buffer_length = wcslen(str) * GetSqlWCharSize();
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
ODBCEnvironment* environment = reinterpret_cast<ODBCEnvironment*>(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_ERROR;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Retrieve and return if header level diagnostics
switch (diag_identifier) {
case SQL_DIAG_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
static_cast<SQLINTEGER>(diagnostics->GetRecordCount());
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Driver manager implements SQL_DIAG_RETURNCODE
case SQL_DIAG_RETURNCODE: {
return SQL_SUCCESS;
}

case SQL_DIAG_CURSOR_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}

// Not supported
case SQL_DIAG_DYNAMIC_FUNCTION:
case SQL_DIAG_DYNAMIC_FUNCTION_CODE: {
if (handle_type == SQL_HANDLE_STMT) {
return SQL_SUCCESS;
}

return SQL_ERROR;
}

case SQL_DIAG_ROW_COUNT: {
if (handle_type == SQL_HANDLE_STMT) {
if (diag_info_ptr) {
// Will always be 0 if only SELECT is supported
*static_cast<SQLLEN*>(diag_info_ptr) = 0;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

return SQL_ERROR;
}
}

// If not a diagnostic header field then the record number must be 1 or greater
if (rec_number < 1) {
return SQL_ERROR;
}

// Retrieve record level diagnostics from specified 1 based record
const uint32_t record_index = static_cast<uint32_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

// Retrieve record field data
switch (diag_identifier) {
case SQL_DIAG_MESSAGE_TEXT: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& message = diagnostics->GetMessageText(record_index);
return GetStringAttribute(is_unicode, message, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

case SQL_DIAG_NATIVE: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) =
diagnostics->GetNativeError(record_index);
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

case SQL_DIAG_SERVER_NAME: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
switch (handle_type) {
case SQL_HANDLE_DBC: {
ODBCConnection* connection = reinterpret_cast<ODBCConnection*>(handle);
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

case SQL_HANDLE_DESC: {
ODBCDescriptor* descriptor = reinterpret_cast<ODBCDescriptor*>(handle);
ODBCConnection* connection = &descriptor->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
break;
}

case SQL_HANDLE_STMT: {
ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(handle);
ODBCConnection* connection = &statement->GetConnection();
std::string dsn = connection->GetDSN();
return GetStringAttribute(is_unicode, dsn, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

default:
return SQL_ERROR;
}
}

return SQL_ERROR;
}

case SQL_DIAG_SQLSTATE: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
const std::string& state = diagnostics->GetSQLState(record_index);
return GetStringAttribute(is_unicode, state, true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_COLUMN_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLINTEGER*>(diag_info_ptr) = SQL_NO_COLUMN_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLINTEGER);
}

return SQL_SUCCESS;
}

// Return empty string dummy variable for unimplemented fields
case SQL_DIAG_CLASS_ORIGIN:
case SQL_DIAG_CONNECTION_NAME:
case SQL_DIAG_SUBCLASS_ORIGIN: {
if (IsValidStringFieldArgs(diag_info_ptr, buffer_length, string_length_ptr,
is_unicode)) {
return GetStringAttribute(is_unicode, "", true, diag_info_ptr, buffer_length,
string_length_ptr, *diagnostics);
}

return SQL_ERROR;
}

// Return valid dummy variable for unimplemented field
case SQL_DIAG_ROW_NUMBER: {
if (diag_info_ptr) {
*static_cast<SQLLEN*>(diag_info_ptr) = SQL_NO_ROW_NUMBER;
}

if (string_length_ptr) {
*string_length_ptr = sizeof(SQLLEN);
}

return SQL_SUCCESS;
}

default: {
return SQL_ERROR;
}
}

return SQL_ERROR;
}

SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT rec_number,
Expand All@@ -91,8 +355,93 @@ SQLRETURN SQLGetDiagRec(SQLSMALLINT handle_type, SQLHANDLE handle, SQLSMALLINT r
<< ", message_text: " << static_cast<const void*>(message_text)
<< ", buffer_length: " << buffer_length
<< ", text_length_ptr: " << static_cast<const void*>(text_length_ptr);
// GH-46575 TODO: Implement SQLGetDiagRec
return SQL_INVALID_HANDLE;
// GH-46575 TODO: Add tests for SQLGetDiagRec
using arrow::flight::sql::odbc::Diagnostics;
using ODBC::GetStringAttribute;
using ODBC::ODBCConnection;
using ODBC::ODBCDescriptor;
using ODBC::ODBCEnvironment;
using ODBC::ODBCStatement;

if (!handle) {
return SQL_INVALID_HANDLE;
}

// Record number must be greater or equal to 1
if (rec_number < 1 || buffer_length < 0) {
return SQL_ERROR;
}

// Set character type to be Unicode by default
const bool is_unicode = true;
Diagnostics* diagnostics = nullptr;

switch (handle_type) {
case SQL_HANDLE_ENV: {
auto* environment = ODBCEnvironment::Of(handle);
diagnostics = &environment->GetDiagnostics();
break;
}

case SQL_HANDLE_DBC: {
auto* connection = ODBCConnection::Of(handle);
diagnostics = &connection->GetDiagnostics();
break;
}

case SQL_HANDLE_DESC: {
auto* descriptor = ODBCDescriptor::Of(handle);
diagnostics = &descriptor->GetDiagnostics();
break;
}

case SQL_HANDLE_STMT: {
auto* statement = ODBCStatement::Of(handle);
diagnostics = &statement->GetDiagnostics();
break;
}

default:
return SQL_INVALID_HANDLE;
}

if (!diagnostics) {
return SQL_ERROR;
}

// Convert from ODBC 1 based record number to internal diagnostics 0 indexed storage
const size_t record_index = static_cast<size_t>(rec_number - 1);
if (!diagnostics->HasRecord(record_index)) {
return SQL_NO_DATA;
}

if (sql_state) {
// The length of the sql state is always 5 characters plus null
SQLSMALLINT size = 6;
const std::string& state = diagnostics->GetSQLState(record_index);

// Microsoft documentation does not mention
// any SQLGetDiagRec return value that is associated with `sql_state` buffer, so
// the return value for writing `sql_state` buffer is ignored by the driver.
ARROW_UNUSED(GetStringAttribute(is_unicode, state, false, sql_state, size, &size,
*diagnostics));
}

if (native_error_ptr) {
*native_error_ptr = diagnostics->GetNativeError(record_index);
}

if (message_text || text_length_ptr) {
const std::string& message = diagnostics->GetMessageText(record_index);

// According to Microsoft documentation,
// SQL_SUCCESS_WITH_INFO should be returned if `*message_text` buffer was too
// small to hold the requested diagnostic message.
return GetStringAttribute(is_unicode, message, false, message_text, buffer_length,
text_length_ptr, *diagnostics);
}

return SQL_SUCCESS;
}

SQLRETURN SQLGetEnvAttr(SQLHENV env, SQLINTEGER attr, SQLPOINTER value_ptr,
Expand Down
Loading
Loading