mssql-extension/description.yml at main · hugr-lab/mssql-extension · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
extension:
  name: mssql
  description: "Connect DuckDB to Microsoft SQL Server via native TDS (including TLS)."
  version: "0.1.18"
  language: "C++"
  build: "cmake"
  licence: "MIT"
  maintainers:
    - "VGSML"
  excluded_platforms:
    - "osx_amd64"
    - "windows_arm64"
    - "wasm_mvp"
    - "wasm_eh"
    - "wasm_threads"
  test_config: '{"test_env_variables": {"SKIP_TESTS": "1"}}'

repo:
  github: "hugr-lab/mssql-extension"
  ref: "v0.1.18"
  ref_next: 65fc3592940086ddb078b2efc3396f04b50605b4

docs:
  hello_world: |
    INSTALL mssql FROM community;
    LOAD mssql;
    ATTACH 'mssql://sa:YourStrong!Passw0rd@localhost:1433?database=master&use_encrypt=true' AS ms;
    SELECT * FROM ms.dbo.table LIMIT 5;

  extended_description: |
    The mssql extension provides a DuckDB connector for Microsoft SQL Server using the native TDS protocol.

    The extension is experimental and may not cover all edge cases. Please report any issues on the [GitHub repository](https://github.com/hugr-lab/mssql-extension).

    Features:
    - Native TDS protocol (no ODBC/JDBC required)
    - Azure Entra ID authentication (Service Principal, CLI, Device Code, Environment Variables)
    - Azure SQL Database and Microsoft Fabric support
    - Lazy metadata loading for fast connections
    - Schema, table, and view catalog integration
    - Projection and filter pushdown
    - TLS/SSL encrypted connections (encrypt parameter)
    - INSERT support with RETURNING clause
    - UPDATE and DELETE support (requires primary key)
    - Connection pooling with configurable limits
    - DuckDB secret management for credentials
    - ANSI-compliant connections for DDL commands
    - COPY TO for bulk data transfer via BCP protocol
    - CREATE TABLE AS SELECT (CTAS) support