Spice with Dotnet SDK
Works with v1.0+
Use the Spice Dotnet SDK (opens in a new tab) to query Spice from C#.
What This Sample Includes
Program.cs: Query a local Spice runtime, including a parameterized query.Cloud.cs: Query Spice.ai Cloud with inline replacement values.
Prerequisites
Local Quick Start
git clone https://github.com/spiceai/cookbook.git
cd cookbook/client-sdk/spice-dotnet-sdk-sample
git clone https://github.com/spiceai/cookbook.git
cd cookbook/client-sdk/spice-dotnet-sdk-sample
Start Spice runtime in one terminal:
Sample runtime logs:
2025-08-28T21:08:10.674387Z INFO spiced: Starting runtime v1.7.0-unstable-build.246c46c4d-dev+models
2025-08-28T21:08:10.675513Z INFO runtime::init::caching: Initialized sql results cache; max size: 128.00 MiB, item ttl: 1s, hashing algorithm: XXH3, encoding: none
2025-08-28T21:08:10.675671Z INFO runtime::init::caching: Initialized search results cache; max size: 128.00 MiB, item ttl: 1s, engine: Moka
2025-08-28T21:08:11.148956Z INFO runtime::flight: Spice Runtime Flight listening on 127.0.0.1:50051
2025-08-28T21:08:11.151175Z INFO runtime::init::dataset: Dataset taxi_trips initializing...
2025-08-28T21:08:11.162604Z INFO runtime::http: Spice Runtime HTTP listening on 127.0.0.1:8090
2025-08-28T21:08:12.336410Z INFO runtime::init::dataset: Dataset taxi_trips registered (s3://spiceai-demo-datasets/taxi_trips/2024/), acceleration (arrow), results cache enabled.
2025-08-28T21:08:12.338066Z INFO runtime_table::accelerated::refresh_task: Loading data for dataset taxi_trips
2025-08-28T21:08:20.383434Z INFO runtime_table::accelerated::refresh_task: Loaded 2,964,624 rows (399.38 MiB) for dataset taxi_trips in 8s 45ms.
2025-08-28T21:08:20.455383Z INFO runtime: All components are loaded. Spice runtime is ready!
2025-08-28T21:08:10.674387Z INFO spiced: Starting runtime v1.7.0-unstable-build.246c46c4d-dev+models
2025-08-28T21:08:10.675513Z INFO runtime::init::caching: Initialized sql results cache; max size: 128.00 MiB, item ttl: 1s, hashing algorithm: XXH3, encoding: none
2025-08-28T21:08:10.675671Z INFO runtime::init::caching: Initialized search results cache; max size: 128.00 MiB, item ttl: 1s, engine: Moka
2025-08-28T21:08:11.148956Z INFO runtime::flight: Spice Runtime Flight listening on 127.0.0.1:50051
2025-08-28T21:08:11.151175Z INFO runtime::init::dataset: Dataset taxi_trips initializing...
2025-08-28T21:08:11.162604Z INFO runtime::http: Spice Runtime HTTP listening on 127.0.0.1:8090
2025-08-28T21:08:12.336410Z INFO runtime::init::dataset: Dataset taxi_trips registered (s3://spiceai-demo-datasets/taxi_trips/2024/), acceleration (arrow), results cache enabled.
2025-08-28T21:08:12.338066Z INFO runtime_table::accelerated::refresh_task: Loading data for dataset taxi_trips
2025-08-28T21:08:20.383434Z INFO runtime_table::accelerated::refresh_task: Loaded 2,964,624 rows (399.38 MiB) for dataset taxi_trips in 8s 45ms.
2025-08-28T21:08:20.455383Z INFO runtime: All components are loaded. Spice runtime is ready!
Run the sample in another terminal:
Sample output:
=== Using Query ===
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:22:13, fare_amount: 7.20
VendorID: 1, tpep_pickup_datetime: 2024-01-09 23:40:08, fare_amount: 18.40
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:01:47, fare_amount: 15.60
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:26:58, fare_amount: 10.00
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:32:38, fare_amount: 70.00
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:01:50, fare_amount: 14.20
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:44:50, fare_amount: 7.20
VendorID: 1, tpep_pickup_datetime: 2024-01-09 23:32:11, fare_amount: 16.30
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:47:12, fare_amount: 10.70
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:35:00, fare_amount: 14.20
=== Using Query with Parameters ===
VendorID: 2, tpep_pickup_datetime: 2024-01-31 09:54:36, fare_amount: 7.20
VendorID: 2, tpep_pickup_datetime: 2024-01-31 09:04:39, fare_amount: 44.30
VendorID: 2, tpep_pickup_datetime: 2024-01-31 09:12:53, fare_amount: 7.90
VendorID: 2, tpep_pickup_datetime: 2024-01-31 09:24:15, fare_amount: 27.50
VendorID: 2, tpep_pickup_datetime: 2024-01-31 09:42:13, fare_amount: 7.90
=== Using Query ===
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:22:13, fare_amount: 7.20
VendorID: 1, tpep_pickup_datetime: 2024-01-09 23:40:08, fare_amount: 18.40
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:01:47, fare_amount: 15.60
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:26:58, fare_amount: 10.00
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:32:38, fare_amount: 70.00
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:01:50, fare_amount: 14.20
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:44:50, fare_amount: 7.20
VendorID: 1, tpep_pickup_datetime: 2024-01-09 23:32:11, fare_amount: 16.30
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:47:12, fare_amount: 10.70
VendorID: 2, tpep_pickup_datetime: 2024-01-09 23:35:00, fare_amount: 14.20
=== Using Query with Parameters ===
VendorID: 2, tpep_pickup_datetime: 2024-01-31 09:54:36, fare_amount: 7.20
VendorID: 2, tpep_pickup_datetime: 2024-01-31 09:04:39, fare_amount: 44.30
VendorID: 2, tpep_pickup_datetime: 2024-01-31 09:12:53, fare_amount: 7.90
VendorID: 2, tpep_pickup_datetime: 2024-01-31 09:24:15, fare_amount: 27.50
VendorID: 2, tpep_pickup_datetime: 2024-01-31 09:42:13, fare_amount: 7.90
Spice.ai Cloud Configuration
Set your API key for the commands in this README:
export SPICE_API_KEY="your_api_key"
export SPICE_API_KEY="your_api_key"
The cloud snippet keeps an inline API key placeholder by design. Replace the API key placeholder in Cloud.cs with ${SPICE_API_KEY}.
Links
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)
