feat(go/adbc): add context.Context support for uniform OpenTelemetry instrumentation by zeroshade · Pull Request #4009 · apache/arrow-adbc

zeroshade · 2026-02-20T19:55:17Z

Summary

Implements context.Context support for all Go ADBC methods to enable uniform OpenTelemetry instrumentation, cancellation, and deadline propagation (addresses #2772).

Add DatabaseContext, ConnectionContext, and StatementContext interfaces that mirror existing interfaces but require context.Context for all methods
Add extension Context interfaces: PostInitOptionsContext, GetSetOptionsContext, ConnectionGetStatisticsContext, StatementExecuteSchemaContext
Implement adapter functions (AsDatabaseContext, AsConnectionContext, AsStatementContext) to wrap non-context implementations for backward compatibility
Add IngestStreamContext helper for context-aware bulk ingestion
Comprehensive test suite (9 tests, all passing)

Changes

New Interfaces (go/adbc/adbc.go):

DatabaseContext - Database with context support for all operations
ConnectionContext - Connection with context support for all operations
StatementContext - Statement with context support for all operations
Extension interfaces with context support

Adapter Implementation (go/adbc/context_adapters.go):

Three adapter types that wrap non-context implementations
Proper nil handling and double-wrap prevention
Context pass-through for methods that already accept context
Clear documentation about context limitations for legacy methods

Tests (go/adbc/context_adapters_test.go):

Comprehensive test coverage for all adapters
Tests for error handling, nil handling, and context pass-through
All tests passing with race detector

Documentation & Examples:

Updated package documentation explaining Context interfaces
Added IngestStreamContext helper function
Example code demonstrating adapter usage

Migration Path

For Applications:

// Wrap existing Database to add context support
db := driver.NewDatabase(opts)
dbCtx := adbc.AsDatabaseContext(db)

ctx := context.Background()
conn, err := dbCtx.Open(ctx)

For Driver Implementers:

Existing drivers work unchanged via adapters
New drivers should implement Context interfaces directly
Gradual migration supported - no breaking changes

Notes

This is the first step toward uniform OpenTelemetry support. Future work includes:

Updating individual drivers to implement Context interfaces natively
Adding context-aware tests to validation suite
Enhanced tracing instrumentation using context propagation

Closes #2772.

- Add DatabaseContext, ConnectionContext, StatementContext interfaces - Add extension Context interfaces (PostInitOptions, GetSetOptions, etc.) - Add context_adapters.go with DatabaseContext adapter implementation - Add context_adapters_test.go with tests for DatabaseContext adapter - Update .gitignore to exclude docs/plans Relates to apache#2772

Implement adapter to wrap existing Connection and Statement implementations as ConnectionContext and StatementContext for backward compatibility. Relates to apache#2772

Ensure adapters handle nil inputs correctly and return nil when given nil inputs. Tests verify that AsDatabaseContext, AsConnectionContext, and AsStatementContext all handle nil correctly. Note: Tests for avoiding double-wrapping are not applicable because Database/DatabaseContext, Connection/ConnectionContext, and Statement/StatementContext have conflicting method signatures (Close() vs Close(ctx)), making it impossible for a type to implement both interfaces simultaneously. Relates to apache#2772

- Update package docs to explain Context interfaces - Add IngestStreamContext helper for context-aware ingestion - Add example code demonstrating Context usage Relates to apache#2772

lidavidm

Overall LGTM but some comments on whether we may want to consolidate some things

lidavidm · 2026-02-25T00:23:26Z

+// Any connection specific options should be set using SetOptions before
+// calling Open.
+type DriverWithContext interface {
+	NewDatabaseWithContext(ctx context.Context, opts map[string]string) (Database, error)


Given we aren't suffixing the other methods, maybe it's ok to break this (experimental) API and call it just NewDatabase now?

Changing this has a knock-on effect of causing us to have to update and cause breaking changes to the bigquery and databricks drivers here which currently implement both NewDatabase and NewDatabaseWithContext. If we change this, we have to update all of those drivers by removing the version without a context. Are we okay with that?

This ends up being a HUGE refactor having to update EVERY go-based driver in here 😦 I think it's not worth doing, at least not as part of this PR

Darn, alright.

…instrumentation (apache#4009) ## Summary Implements context.Context support for all Go ADBC methods to enable uniform OpenTelemetry instrumentation, cancellation, and deadline propagation (addresses apache#2772). - Add `DatabaseContext`, `ConnectionContext`, and `StatementContext` interfaces that mirror existing interfaces but require `context.Context` for all methods - Add extension Context interfaces: `PostInitOptionsContext`, `GetSetOptionsContext`, `ConnectionGetStatisticsContext`, `StatementExecuteSchemaContext` - Implement adapter functions (`AsDatabaseContext`, `AsConnectionContext`, `AsStatementContext`) to wrap non-context implementations for backward compatibility - Add `IngestStreamContext` helper for context-aware bulk ingestion - Comprehensive test suite (9 tests, all passing) ## Changes **New Interfaces** (`go/adbc/adbc.go`): - `DatabaseContext` - Database with context support for all operations - `ConnectionContext` - Connection with context support for all operations - `StatementContext` - Statement with context support for all operations - Extension interfaces with context support **Adapter Implementation** (`go/adbc/context_adapters.go`): - Three adapter types that wrap non-context implementations - Proper nil handling and double-wrap prevention - Context pass-through for methods that already accept context - Clear documentation about context limitations for legacy methods **Tests** (`go/adbc/context_adapters_test.go`): - Comprehensive test coverage for all adapters - Tests for error handling, nil handling, and context pass-through - All tests passing with race detector **Documentation & Examples**: - Updated package documentation explaining Context interfaces - Added `IngestStreamContext` helper function - Example code demonstrating adapter usage ## Migration Path **For Applications:** ```go // Wrap existing Database to add context support db := driver.NewDatabase(opts) dbCtx := adbc.AsDatabaseContext(db) ctx := context.Background() conn, err := dbCtx.Open(ctx) ``` **For Driver Implementers:** - Existing drivers work unchanged via adapters - New drivers should implement Context interfaces directly - Gradual migration supported - no breaking changes ## Notes This is the first step toward uniform OpenTelemetry support. Future work includes: - Updating individual drivers to implement Context interfaces natively - Adding context-aware tests to validation suite - Enhanced tracing instrumentation using context propagation Closes apache#2772.

lidavidm · 2026-04-09T01:34:53Z

+// Any connection specific options should be set using SetOptions before
+// calling Open.
+type DriverWithContext interface {
+	NewDatabaseWithContext(ctx context.Context, opts map[string]string) (Database, error)


I missed this but this needs to return DatabaseWithContext

Ah, that runs back into the huge refactor...I guess I'll work around this in driverbase

zeroshade added 5 commits February 20, 2026 14:26

feat(go/adbc): add ConnectionContext and StatementContext adapters

ab748e0

Implement adapter to wrap existing Connection and Statement implementations as ConnectionContext and StatementContext for backward compatibility. Relates to apache#2772

docs(go/adbc): add Context interface documentation and examples

c749ee5

- Update package docs to explain Context interfaces - Add IngestStreamContext helper for context-aware ingestion - Add example code demonstrating Context usage Relates to apache#2772

pre-commit

ed16c14

lidavidm reviewed Feb 21, 2026

View reviewed changes

Comment thread .gitignore

Comment thread go/adbc/adbc.go Outdated

Comment thread go/adbc/adbc.test Outdated

Comment thread go/adbc/adbc.go

zeroshade added 2 commits February 24, 2026 11:12

update from comments

1dca0d8

fix example identifier

de0b006

lidavidm approved these changes Feb 25, 2026

View reviewed changes

updates from comments

5a884a6

zeroshade requested a review from lidavidm February 25, 2026 16:54

lidavidm approved these changes Feb 26, 2026

View reviewed changes

lidavidm added this to the ADBC Libraries 23 milestone Feb 26, 2026

zeroshade merged commit a8a3454 into apache:main Feb 26, 2026
40 checks passed

lidavidm reviewed Apr 9, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(go/adbc): add context.Context support for uniform OpenTelemetry instrumentation#4009

feat(go/adbc): add context.Context support for uniform OpenTelemetry instrumentation#4009
zeroshade merged 8 commits into
apache:mainfrom
zeroshade:go-contexts

zeroshade commented Feb 20, 2026 •

edited by lidavidm

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lidavidm left a comment

Uh oh!

Uh oh!

Uh oh!

lidavidm Feb 25, 2026

Uh oh!

zeroshade Feb 25, 2026

Uh oh!

zeroshade Feb 25, 2026

Uh oh!

lidavidm Feb 25, 2026

Uh oh!

Uh oh!

Uh oh!

lidavidm Apr 9, 2026

Uh oh!

lidavidm Apr 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

zeroshade commented Feb 20, 2026 • edited by lidavidm Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Migration Path

Notes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lidavidm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lidavidm Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

zeroshade Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

zeroshade Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

lidavidm Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lidavidm Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

lidavidm Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

zeroshade commented Feb 20, 2026 •

edited by lidavidm

Loading