arrow-tiberius 0.1.0

Apache Arrow and SQL Server bridge through Tiberius
Documentation 
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

# Integration Tests

Default validation does not require SQL Server:

```bash
cargo fmt --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test
```

SQL Server integration tests are opt-in through the xtask runner:

```bash
cargo xtask sqlserver-test
```

This is the normal way to run integration tests. The xtask runner starts a local SQL Server container, waits for readiness, creates the test database, sets compatibility level 100, runs the feature-gated integration tests, and removes the container when the command exits.

Plain `cargo test` must remain independent of SQL Server.

## Container Runtime

The runner supports Docker-compatible runtimes such as Docker and Podman. Runtime selection uses:

1. `--container-runtime`
2. `ARROW_TIBERIUS_CONTAINER_RUNTIME`
3. `docker` on `PATH`
4. `podman` on `PATH`

Examples:

```bash
cargo xtask sqlserver-test --container-runtime podman
ARROW_TIBERIUS_CONTAINER_RUNTIME=podman cargo xtask sqlserver-test
```

Shell aliases such as `alias docker=podman` are not used by the Rust process. Use the flag or environment variable when you need a specific runtime.

## Defaults

The default image is:

```text
mcr.microsoft.com/mssql/server:2017-latest
```

The default database is:

```text
arrow_tiberius_integration
```

SQL Server is configured with:

```sql
ALTER DATABASE [arrow_tiberius_integration] SET COMPATIBILITY_LEVEL = 100;
```

This gives local coverage for the SQL Server 2016 compatibility-level-100 target behavior using a SQL Server 2017 Linux container.

## Existing SQL Server

To use an existing SQL Server instead of a local container:

```bash
cargo xtask sqlserver-test \
  --connection-string 'server=tcp:127.0.0.1,1433;user id=sa;password=...;TrustServerCertificate=true' \
  --database arrow_tiberius_integration
```

The xtask runner passes these environment variables to the feature-gated integration tests:

```text
ARROW_TIBERIUS_TEST_MSSQL_URL
ARROW_TIBERIUS_TEST_MSSQL_DATABASE
```

The lower-level command is only for CI/debugging when SQL Server is already configured and those environment variables are set:

```bash
cargo test --features integration-tests
```

Prefer `cargo xtask sqlserver-test` for local development.

## CI

GitHub Actions runs the same xtask entrypoint in `.github/workflows/ci.yml`.
The fast Rust job runs formatting, clippy, and normal workspace tests first.
The SQL Server job then runs:

```bash
cargo xtask sqlserver-test
```

The CI SQL Server job assumes a Linux runner with Docker available and network
access to pull `mcr.microsoft.com/mssql/server:2017-latest`. Container startup,
readiness, database creation, compatibility-level setup, test execution, and
cleanup remain owned by the xtask harness.

## Debugging

Keep the container after a failed run:

```bash
cargo xtask sqlserver-test --keep-container
```

Change the SQL Server image:

```bash
cargo xtask sqlserver-test --image mcr.microsoft.com/mssql/server:2017-latest
```