Skip to main content

dx-common-go

dx-common-go is the shared Go SDK for Data Exchange services. It provides stable contracts for service bootstrap, configuration, HTTP behavior, errors, identity, paging, SQL, cache, events, health, and gRPC status mapping, plus foundation packages for search, object storage, messaging, observability, security, testing, and integrations.

Which API should I use?

For new service code, start with platform packages:

ConcernPreferred package
Process lifecycleplatform/bootstrap
Typed configurationplatform/config
HTTP routes and handlersplatform/http
Error taxonomyplatform/errors
Identity in contextplatform/security/identity
Paginationplatform/paging
SQL and transactionsplatform/database/sql
Cacheplatform/cache
Events and outboxplatform/events
Healthplatform/observability/health
gRPC status mappingplatform/grpc

Top-level foundation packages remain part of the source tree. Use them where no platform seam exists, or through the explicit adapter package named by the platform API.

Start here

For the complete fleet, trust model, and deployment model, use the Data Exchange platform documentation. For a guided curriculum, use the Go learning path.

Documentation truth

These pages were reviewed against the public Go source and service call sites. There are currently no published repository tags; the docs therefore describe the current source line and do not claim a released semantic version. See Versions and compatibility.