Home /Modules/connector/CONNECTOR-CATALOG.md

CONNECTOR-CATALOG.md

lib/connector/CONNECTOR-CATALOG.md · 42 line(s) · markdown

Connector Catalog

Finite connector registry. "Baseline adapter" means a C/C++ API and build target exist; it does not imply full production readiness or that integration tests have passed. Vendor dependencies must be installed separately. Build commands and security notes are in README.md.

Database connectors

Family / referenceImplementationCurrent capability and limitation
mysqlMySQL-compatible C client APIC ABI, C++17 RAII, connect/ping/execute/errors, prepared-statement parameter/result binding and fetch wrappers using MySQL's MYSQL_BIND API; bound buffers and indicators must remain valid for the required statement lifetime
mariadbShared mysql adapter, MariaDB Connector/C build profileAPI-compatible build profile; validate against target server/client versions
sqliteSQLite C APIC/C++ connection wrapper, prepared statements, text/int64/double/NULL binds, step/finalize
postgreslibpqC/C++ connection wrapper and parameterized PQexecParams; results remain native PGresult objects owned by the caller
odbcODBC 3.x driver managerConnection lifecycle, direct/prepared execution, row fetch and column reads; native SQLBindParameter is available through the exposed statement handle
sqlserverODBC profileUses operator-installed Microsoft ODBC Driver for SQL Server through odbc; same API and capabilities apply
oracleODBC profileUses operator-installed Oracle ODBC driver through odbc; this is not a direct OCI implementation

Non-database data sources

Family / referenceImplementationCurrent capability and limitation
delimitedDependency-free C parser + C++ facadeParses one CSV/TSV record, quoted fields and doubled quotes; caller owns file iteration, encoding, headers, and schema inference
jsonDependency-free structural tokenizer + C++ facadeRecords token offsets/types/parent links and checks structural nesting/string escapes; it is not a semantic JSON DOM or complete standards-compliant validator, and primitive syntax/string decoding are not fully validated
xmllibxml2 validator + C++ facadeWell-formedness validation with network fetching disabled; no XPath/DOM/schema API
restlibcurl C API + C++ facadeGET and JSON POST, timeouts, TLS peer/host verification, redirects disabled; no OAuth/arbitrary-header/retry layer
mqttEclipse Mosquitto C API + C++ client facadeConnect/publish/subscribe/callback dispatch/network loop; TLS/authentication helpers and reconnect policy are not exposed yet

Connector reference registry

connector_registry.h/.c and the C++17 facade provide explicit named references, non-owning native handles, per-reference properties, and deterministic lookup. Duplicate references are rejected. Unnamed lookup succeeds only with exactly one registered connector; zero or multiple candidates are errors. This prevents a configuration such as mysql plus postgres from silently resolving to an arbitrary connection.

Production-readiness checklist

Before marking a family production-ready, add:

  1. Integration tests against configured database/services and verified platform builds.
  2. Fully documented parameter lifetimes, result ownership, transactions, cancellation, and timeout semantics.
  3. TLS/authentication configuration appropriate to each driver and safe secret handling.
  4. Full result/row streaming and capability discovery where relevant.
  5. Verified builds on Linux, macOS, and Windows 10+ with documented dependency versions.

The workflow runs build and smoke-test jobs on Linux and macOS. Windows is not yet covered by that workflow. No live database, REST endpoint, or MQTT broker integration test is represented by the default CI; review the latest workflow result before treating the build as verified.