{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "architecture": {
    "summary": "A wire-protocol decoder that writes Apache Arrow column buffers as it reads the socket.",
    "dataPath": [
      "Database wire protocol",
      "Arpeio driver (native protocol decoder)",
      "Arrow column buffers",
      "Your dataframe"
    ],
    "comparison": {
      "odbcJdbcStack": {
        "steps": [
          "Database wire protocol",
          "Vendor client library (OCI, libpq, MSODBCSQL, Netezza ODBC, Teradata TTU)",
          "ODBC / JDBC row API",
          "Row objects, one per record",
          "Column-wise conversion to Arrow",
          "Your dataframe"
        ],
        "cost": "Five hops, two full copies of the data and a client library to deploy on every machine."
      },
      "arpeioStack": {
        "steps": [
          "Database wire protocol",
          "Arpeio driver (native protocol decoder)",
          "Arrow column buffers",
          "Your dataframe"
        ],
        "cost": "The driver writes Arrow buffers as it decodes the wire. Nothing to convert afterwards."
      },
      "note": "Because the result is already Arrow, pandas, Polars, DuckDB and Spark consume it with zero copy."
    },
    "runtimeDependencies": "None beyond the operating system's C library: the released binaries are self-contained, with OpenSSL linked in. Exceptions by design: SQL Server Kerberos logons on Linux load the system MIT Kerberos libraries, and Teradata's legacy port 1025 logs on through the customer's TTU CLIv2.",
    "wireProtocols": {
      "arpemssql": "MS-TDS 7.4, or TDS 8.0 strict encryption",
      "arpepgsql": "PostgreSQL Frontend/Backend (FEBE) v3",
      "arpeoracle": "TNS (Oracle Net) + TTC (Two-Task Common)",
      "arpenz": "Netezza HSV2 handshake + DBOS binary result stream",
      "arpeteradata": "Teradata TD2 logon and request protocol over TLS, or the legacy port 1025 through TTU CLIv2",
      "arpedb2": "DRDA (in development)"
    },
    "standard": {
      "name": "ADBC (Arrow Database Connectivity)",
      "specification": "https://arrow.apache.org/adbc/",
      "apiShape": "Columnar - a query returns Arrow RecordBatches rather than rows"
    }
  },
  "installation": {
    "model": "One-line installer that downloads the driver, installs it per-user by default and registers an ADBC manifest so clients can find it by name.",
    "commands": {
      "linuxMacOS": "curl -fsSL https://raw.githubusercontent.com/arpe-io/adbc-drivers/main/install.sh | sh -s -- arpemssql --license /path/to/your.lic",
      "windowsPowerShell": "& ([scriptblock]::Create((irm https://raw.githubusercontent.com/arpe-io/adbc-drivers/main/install.ps1))) arpemssql -License C:\\path\\to\\your.lic",
      "swapNote": "Replace arpemssql with arpepgsql, arpeoracle, arpenz or arpeteradata as needed.",
      "systemWide": "Use --system (with sudo or an elevated shell) for a machine-wide installation."
    },
    "maintenance": {
      "list": "curl -fsSL https://raw.githubusercontent.com/arpe-io/adbc-drivers/main/install.sh | sh -s -- --list",
      "installed": "curl -fsSL https://raw.githubusercontent.com/arpe-io/adbc-drivers/main/install.sh | sh -s -- --installed",
      "uninstall": "curl -fsSL https://raw.githubusercontent.com/arpe-io/adbc-drivers/main/install.sh | sh -s -- --uninstall arpemssql"
    },
    "paths": [
      { "os": "Linux", "driverFiles": "~/.local/lib/arpeio-adbc/", "manifestSearchPath": "~/.config/adbc/drivers" },
      { "os": "macOS", "driverFiles": "~/.local/lib/arpeio-adbc/", "manifestSearchPath": "~/Library/Application Support/ADBC/Drivers" },
      { "os": "Windows", "driverFiles": "%LOCALAPPDATA%\\arpeio-adbc\\", "manifestSearchPath": "%LOCALAPPDATA%\\ADBC\\Drivers" }
    ],
    "loadByName": "Because the installer registers an ADBC manifest, clients find the driver from its name alone - no path, no LD_LIBRARY_PATH."
  },
  "connectionUris": {
    "arpemssql": "sqlserver://dbuser:<password>@host:1433/?database=appdb&encrypt=true",
    "arpepgsql": "postgresql://dbuser:<password>@host:5432/appdb?sslmode=require",
    "arpeoracle": "oracle://dbuser:<password>@dbhost:1521/appdb?ssl_mode=verify-full",
    "arpedb2": "db2://dbuser:<password>@host:50000/appdb",
    "arpenz": "netezza://dbuser:<password>@host:5480/appdb?sslmode=verify-full",
    "arpeteradata": "teradata://dbuser:<password>@host/appdb?sslmode=verify-full",
    "schemes": {
      "arpemssql": ["sqlserver://", "mssql://", "arpemssql://"],
      "arpepgsql": ["postgresql://", "postgres://", "arpepgsql://"],
      "arpeoracle": ["oracle://", "arpeoracle://"],
      "arpenz": ["netezza://", "postgresql://", "postgres://", "arpenz://"],
      "arpeteradata": ["teradata://", "arpeteradata://", "teradatasql://"]
    },
    "threeWaysToConnect": "Every driver accepts discrete adbc.<loadname>.* options, an ADO.NET connection string (adbc.<loadname>.connection_string), or a URI (the standard uri option). Structured options always win. The URI scheme only selects the URL grammar; it never picks the driver.",
    "note": "Full option reference per driver lives in the documentation under drivers/<driver>/connection/. Teradata: the URI port is the legacy port (default 1025); the TLS port is the https_port query key (default 443). Netezza default port is 5480."
  },
  "adbcOptions": {
    "uri": "Connection URI, passed as the standard ADBC uri option",
    "licence": [
      "arpeio.adbc.license - inline licence text",
      "arpeio.adbc.license_file - path to a licence file",
      "arpeio.adbc.license.status - read-only (GetOption): state, result code, tier and expiry"
    ],
    "environmentVariables": [
      "ARPEIO_ADBC_LICENCE",
      "ARPEIO_ADBC_LICENCE_FILE"
    ]
  },
  "clientExamples": {
    "python": "import adbc_driver_manager.dbapi as dbapi\n\nwith dbapi.connect(driver=\"arpemssql\",\n                   db_kwargs={\"uri\": \"sqlserver://dbuser:<password>@host:1433/?database=appdb&encrypt=true\"}) as conn:\n    cur = conn.cursor()\n    cur.execute(\"SELECT * FROM dbo.orders\")\n    table = cur.fetch_arrow_table()   # ready as Arrow",
    "c": "#include <arrow-adbc/adbc.h>\n// (error checks elided for brevity)\n\nAdbcError e = {}; AdbcDatabase db = {}; AdbcConnection conn = {}; AdbcStatement st = {};\n\nAdbcDatabaseNew(&db, &e);\nAdbcDatabaseSetOption(&db, \"driver\", \"arpemssql\", &e);\nAdbcDatabaseSetOption(&db, \"uri\", \"sqlserver://dbuser:<password>@host:1433/?database=appdb&encrypt=true\", &e);\nAdbcDatabaseInit(&db, &e);\n\nAdbcConnectionNew(&conn, &e); AdbcConnectionInit(&conn, &db, &e);\nAdbcStatementNew(&conn, &st, &e);\nAdbcStatementSetSqlQuery(&st, \"SELECT * FROM dbo.orders\", &e);\n\nArrowArrayStream stream = {}; int64_t n = -1;\nAdbcStatementExecuteQuery(&st, &stream, &n, &e);   // consume `stream`",
    "csharp": "using Apache.Arrow.Adbc;\nusing Apache.Arrow.Adbc.DriverManager;\n\nusing var driver = AdbcDriverManager.FindLoadDriver(\"arpemssql\", loadOptions: AdbcLoadFlags.Default);\nusing var database = driver.Open(new Dictionary<string, string> {\n    [\"uri\"] = \"sqlserver://dbuser:<password>@host:1433/?database=appdb&encrypt=true\" });\n\nusing var connection = database.Connect(null);\nusing var statement = connection.CreateStatement();\nstatement.SqlQuery = \"SELECT * FROM dbo.orders\";\nusing var stream = statement.ExecuteQuery().Stream!;   // IArrowArrayStream",
    "go": "var drv drivermgr.Driver\n\ndb, _ := drv.NewDatabase(map[string]string{\n    \"driver\":           \"arpemssql\",\n    adbc.OptionKeyURI:  \"sqlserver://dbuser:<password>@host:1433/?database=appdb&encrypt=true\",\n})\n\nconn, _ := db.Open(ctx)\nstmt, _ := conn.NewStatement()\n_ = stmt.SetSqlQuery(\"SELECT * FROM dbo.orders\")\n\nreader, _, _ := stmt.ExecuteQuery(ctx)   // array.RecordReader\ndefer reader.Release()",
    "java": "Map<String, Object> params = new HashMap<>();\nJniDriver.PARAM_DRIVER.set(params, \"arpemssql\");\nAdbcDriver.PARAM_URI.set(params, \"sqlserver://dbuser:<password>@host:1433/?database=appdb&encrypt=true\");\n\ntry (BufferAllocator a = new RootAllocator();\n     AdbcDatabase db = new JniDriver(a).open(params);\n     AdbcConnection conn = db.connect();\n     AdbcStatement st = conn.createStatement()) {\n    st.setSqlQuery(\"SELECT * FROM dbo.orders\");\n    try (AdbcStatement.QueryResult r = st.executeQuery()) {\n        ArrowReader reader = r.getReader();\n    }\n}",
    "r": "library(adbcdrivermanager)\n\ndb <- adbc_database_init(adbc_driver(\"arpemssql\"),\n                         uri = \"sqlserver://dbuser:<password>@host:1433/?database=appdb&encrypt=true\")\ncon <- adbc_connection_init(db)\n\ntable <- read_adbc(con, \"SELECT * FROM dbo.orders\") |> arrow::as_arrow_table()",
    "rust": "use adbc_core::{Connection, Database, Driver, Statement, LOAD_FLAG_DEFAULT};\nuse adbc_core::options::{AdbcVersion, OptionDatabase, OptionValue};\nuse adbc_driver_manager::ManagedDriver;\n\nlet mut driver = ManagedDriver::load_from_name(\"arpemssql\", None, AdbcVersion::default(), LOAD_FLAG_DEFAULT, None)?;\nlet mut db = driver.new_database_with_opts([(OptionDatabase::Uri,\n    OptionValue::String(\"sqlserver://dbuser:<password>@host:1433/?database=appdb&encrypt=true\".into()))])?;\n\nlet mut conn = db.new_connection()?;\nlet mut stmt = conn.new_statement()?;\nstmt.set_sql_query(\"SELECT * FROM dbo.orders\")?;\nlet reader = stmt.execute()?;   // impl RecordBatchReader"
  },
  "documentationPages": {
    "baseUrl": "https://adbc-drivers-docs.arpe.io/drivers/",
    "perDriver": [
      "connection/ - connection and URI options",
      "authentication/ - authentication mechanisms",
      "data-types/ - type mappings",
      "compatibility/ - supported versions and services",
      "examples/ - client examples",
      "licensing/ - licence configuration",
      "troubleshooting/ - troubleshooting guide",
      "whats-new/ - release notes"
    ]
  },
  "aiIntegrations": {
    "agentSkill": {
      "name": "arpeio-adbc-drivers",
      "description": "An agent skill that teaches an AI assistant to install, configure and troubleshoot the five drivers: installer, licence, URIs and connection strings, authentication, TLS, Arrow type mappings and bulk ingest, from Python, C, C#, Go, Java, R or Rust.",
      "repository": "https://github.com/arpe-io/arpeio-skills",
      "source": "https://github.com/arpe-io/arpeio-skills/tree/main/plugins/arpeio-adbc-drivers",
      "installClaudeCode": "/plugin install arpeio-adbc-drivers --marketplace arpe-io/arpeio-skills",
      "installOtherAgents": "Copy plugins/arpeio-adbc-drivers/skills/arpeio-adbc-drivers into the agent's skills directory.",
      "documentation": "https://adbc-drivers-docs.arpe.io/ai/agent-skills"
    },
    "mcpServer": {
      "name": "arpeio-mcp",
      "minimumVersion": "0.3.8",
      "description": "The Arpe.io MCP server covers the ADBC drivers alongside the Arpe.io data tools (FastBCP, FastTransfer, LakeXpress, MigratorXpress). All read-only, with no database connectivity needed.",
      "driverTools": [
        "adbc_info - the five drivers with current versions; for one driver, its load name, connection URI, authentication, install command, docs links and FastBCP connection type",
        "documentation search over https://adbc-drivers-docs.arpe.io",
        "arpe_release_notes - driver release notes"
      ],
      "hostedUrl": "https://arpe-io-arpeio-mcp.hf.space/sse",
      "installLocal": "pip install arpeio-mcp",
      "installClaudeCode": "claude mcp add --transport sse arpeio https://arpe-io-arpeio-mcp.hf.space/sse",
      "repository": "https://github.com/arpe-io/arpeio-mcp",
      "documentation": "https://adbc-drivers-docs.arpe.io/ai/mcp-server"
    },
    "fastbcp": {
      "description": "FastBCP reads through these drivers with its ADBC connection types.",
      "connectionTypes": ["adbc_mssql", "adbc_pgsql", "adbc_oracle", "adbc_netezza", "adbc_teradata"]
    }
  },
  "metadata": {
    "lastUpdated": "2026-10-22",
    "dataFormat": "JSON",
    "purpose": "AI Agent Knowledge Base",
    "audience": "LLMs and AI Agents",
    "schemaVersion": "1.0.0"
  }
}
