Spice.ai OSS Documentation

https://github.com/spiceai/docs
Admin
Spice.ai is an open-source AI infrastructure platform that provides data access and orchestration...
Tokens:553,307
Snippets:8,268
Trust Score:9.8
License:Apache-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/install.md

Install the core runtime that only includes data components.

```shell
spice install
```

--------------------------------

### Interactive SQL Session Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/sql.md

Example of starting the REPL and executing a show tables command.

```shell
$ spice sql
Welcome to the Spice.ai SQL REPL! Type 'help' for help.

show tables;  -- list available tables
sql> show tables
+---------------+--------------------+---------------+------------+
| table_catalog | table_schema       | table_name    | table_type |
+---------------+--------------------+---------------+------------+
| datafusion    | public             | tmp_view_test | VIEW       |
| datafusion    | information_schema | tables        | VIEW       |
| datafusion    | information_schema | views         | VIEW       |
| datafusion    | information_schema | columns       | VIEW       |
| datafusion    | information_schema | df_settings   | VIEW       |
+---------------+--------------------+---------------+------------+
```

--------------------------------

### Additional Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/install.md

Install the runtime with CUDA GPU acceleration.

```shell
spice install cuda
```

--------------------------------

### Install Go SDK

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/sdks/golang/index.md

Use the go get command to install the latest version of the Spice Go SDK.

```shell
go get github.com/spiceai/gospice/v8@latest
```

--------------------------------

### Quickstart PostgreSQL configuration

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/postgres/index.md

Example configuration for connecting to a local PostgreSQL database with acceleration enabled.

```yaml
version: v1
kind: Spicepod
name: pg_demo

datasets:
  - from: postgres:public.customers
    name: customers
    params:
      pg_host: localhost
      pg_port: "5432"
      pg_db: mydb
      pg_user: spice_reader
      pg_pass: ${secrets:PG_PASSWORD}
    acceleration:
      enabled: true
```

--------------------------------

### Quickstart Helm Deployment

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/kubernetes/helm/index.md

Initial commands to add the Spice.ai repository and perform a fresh install or upgrade.

```bash
helm repo add spiceai https://helm.spiceai.org
helm repo update
helm upgrade --install spiceai spiceai/spiceai
```

--------------------------------

### Example of spice connect

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/connect.md

An example of connecting to the spiceai/quickstart pod.

```shell
spice connect spiceai/quickstart
```

--------------------------------

### Run Spice Runtime

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/getting-started/index.mdx

Command to start the runtime and example output logs.

```bash
spice run
```

```text
Spice.ai runtime starting...
2024-08-05T13:02:40.247484Z  INFO runtime::flight: Spice Runtime Flight listening on 127.0.0.1:50051
2024-08-05T13:02:40.247949Z  INFO runtime: Initialized results cache; max size: 128.00 MiB, item ttl: 1s
2024-08-05T13:02:40.248611Z  INFO runtime::http: Spice Runtime HTTP listening on 127.0.0.1:8090
```

--------------------------------

### Interactive Chat Session Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/chat.md

Example of starting a chat session when one model is ready.

```shell
> spice chat
Using model: openai
chat> hello
Hello! How can I assist you today?

Time: 0.57s (first token 0.53s). Tokens: 18. Prompt: 8. Completion: 10 (325.04/s).
```

--------------------------------

### Execute regexp_count example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/scalar_functions.md

Example demonstrating counting matches with a start position and case-insensitive flag.

```sql
> select regexp_count('abcAbAbc', 'abc', 2, 'i');
+---------------------------------------------------------------+
| regexp_count(Utf8("abcAbAbc"),Utf8("abc"),Int64(2),Utf8("i")) |
+---------------------------------------------------------------+
| 1                                                             |
+---------------------------------------------------------------+
```

--------------------------------

### REPL Mode with Model Flag

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/chat.md

Example of starting a REPL session with a specific model.

```shell
# REPL
spice chat --model openai
chat> hello
Hello! How can I assist you today?

Time: 0.61s (first token 0.58s). Tokens: 18. Prompt: 8. Completion: 10 (285.90/s).
```

--------------------------------

### regexp_like Examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/scalar_functions.md

Examples demonstrating case-sensitive and case-insensitive pattern matching.

```sql
> select regexp_like('Köln', '[a-zA-Z]ö[a-zA-Z]{2}');
+--------------------------------------------------------+
| regexp_like(Utf8("Köln"),Utf8("[a-zA-Z]ö[a-zA-Z]{2}")) |
+--------------------------------------------------------+
| true                                                   |
+--------------------------------------------------------+
> SELECT regexp_like('aBc', '(b|d)', 'i');
+--------------------------------------------------+
| regexp_like(Utf8("aBc"),Utf8("(b|d)"),Utf8("i")) |
+--------------------------------------------------+
| true                                             |
+--------------------------------------------------+
```

--------------------------------

### Execute regexp_replace examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/scalar_functions.md

Examples demonstrating global replacement and case-insensitive replacement.

```sql
> select regexp_replace('foobarbaz', 'b(..)', 'X\1Y', 'g');
+------------------------------------------------------------------------+
| regexp_replace(Utf8("foobarbaz"),Utf8("b(..)"),Utf8("X\1Y"),Utf8("g")) |
+------------------------------------------------------------------------+
| fooXarYXazY                                                            |
+------------------------------------------------------------------------+
SELECT regexp_replace('aBc', '(b|d)', 'Ab\1a', 'i');
+-------------------------------------------------------------------+
| regexp_replace(Utf8("aBc"),Utf8("(b|d)"),Utf8("Ab\1a"),Utf8("i")) |
+-------------------------------------------------------------------+
| aAbBac                                                            |
+-------------------------------------------------------------------+
```

--------------------------------

### Complete example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/features/data-acceleration/snapshots.md

This example shows how to configure snapshots for both batch and stream datasets.

```yaml
snapshots:
  enabled: true
  location: s3://some_bucket/some_folder/
  bootstrap_on_failure_behavior: warn
  params:
    s3_auth: iam_role

datasets:
  # Batch dataset with refresh-triggered snapshots
  - from: s3://some_bucket/batch_table/
    name: batch_table
    params:
      file_format: parquet
      s3_auth: iam_role
    acceleration:
      enabled: true
      engine: duckdb
      mode: file
      snapshots: enabled
      snapshots_trigger: refresh_complete
      snapshots_compaction: enabled
      params:
        duckdb_file: /nvme/batch_table.db

  # Stream dataset with time-interval snapshots
  - from: debezium:cdc_source
    name: stream_table
    acceleration:
      enabled: true
      engine: duckdb
      mode: file
      refresh_mode: changes
      snapshots: enabled
      snapshots_trigger: time_interval
      snapshots_trigger_threshold: 5m
      params:
        duckdb_file: /nvme/stream_table.db
```

--------------------------------

### Authentication Examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/login.md

Examples of logging in with default browser flow or using an explicit API key.

```shell
spice login
```

```shell
spice login --key <API_KEY>
```

--------------------------------

### Install Spice CLI on Windows

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/index.md

Use this command in PowerShell to download and execute the installation script.

```bash
curl -L "https://install.spiceai.org/Install.ps1" -o Install.ps1 && PowerShell -ExecutionPolicy Bypass -File ./Install.ps1
```

--------------------------------

### Install Spice.ai SDK

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/sdks/javascript/index.md

Install the package using your preferred package manager.

```shell
npm i @spiceai/spice
```

```shell
yarn add @spiceai/spice
```

```shell
pnpm add @spiceai/spice
```

--------------------------------

### Interact with Spice Chat

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/getting-started/index.mdx

Command to start the chat REPL and an example interaction.

```bash
spice chat
```

```text
Using model: openai_model
chat> How many taxi trips were taken?
A total of 2,964,624 trips were taken according to the dataset.
```

--------------------------------

### Example Spicepod manifest

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/getting-started/spicepods.md

A comprehensive example showing dataset, model, and secret configurations.

```yaml
version: v1
kind: Spicepod
name: my_spicepod

datasets:
  - from: spice.ai/spiceai/quickstart/datasets/taxi_trips
    name: taxi_trips
    acceleration:
      enabled: true

models:
  - from: openai:gpt-4o-mini
    name: openai_model
    params:
      openai_api_key: ${ env:OPENAI_API_KEY }
      tools: auto

secrets:
  - from: env
    name: env
```

--------------------------------

### Install and Configure Trino

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/adbc.md

Install the Trino driver and configure a basic connection.

```shell
dbc install trino
```

```yaml
datasets:
  - from: adbc:my_table
    name: my_table
    params:
      adbc_driver: trino
      adbc_uri: "trino://trino.example.com:8080/hive/default?SSL=false"
```

--------------------------------

### Runtime configuration override examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/run.md

Examples showing how --set-runtime flags map to YAML configuration structures.

```yaml
runtime:
  name: value
```

```yaml
runtime:
  task_history:
    captured_output: none
```

```yaml
runtime:
  results_cache:
    enabled: false
```

```yaml
runtime:
  tls:
    enabled: true
    certificate_file: /path/to/cert.pem
    key_file: /path/to/key.pem
```

--------------------------------

### Install kind and create a local cluster

Source: https://github.com/spiceai/docs/blob/trunk/website/releases/v0.10.1-alpha.md

Optional step to start a local kind cluster for Kubernetes Helm deployment.

```bash
go install sigs.k8s.io/kind@v0.22.0
kind create cluster
```

--------------------------------

### Spicepod Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/features/data-acceleration/snapshots.md

Example configuration for enabling and configuring acceleration snapshots in a Spicepod.

```yaml
snapshots:
  enabled: true
  location: s3://some_bucket/some_folder/
  bootstrap_on_failure_behavior: warn
  params:
    s3_auth: iam_role

datasets:
  - name: some_table
    acceleration:
      engine: duckdb
      mode: file
      snapshots: enabled
      snapshots_trigger: refresh_complete
      params:
        duckdb_file: /nvme/some_table.db
```

--------------------------------

### Install and Configure BigQuery

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/adbc.md

Install the BigQuery driver and configure a dataset using Application Default Credentials.

```shell
# Install the driver
dbc install bigquery

# Authenticate with Google Cloud
gcloud auth application-default login
```

```yaml
datasets:
  - from: adbc:my_table
    name: my_table
    params:
      adbc_driver: bigquery
      adbc_uri: "bigquery:///my-gcp-project?DatasetId=my_dataset"
```

--------------------------------

### Install Python SDK

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/sdks/python/index.md

Install the specific version of the Spice Python SDK from GitHub.

```shell
pip install git+https://github.com/spiceai/spicepy@v3.1.0
```

--------------------------------

### Install prerequisites on Ubuntu/Debian

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/distributions.md

Install the necessary clang and lld packages required for building on Linux arm64.

```bash
sudo apt-get install -y clang lld
```

--------------------------------

### regexp_match Examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/scalar_functions.md

Examples demonstrating string extraction using regular expressions.

```sql
> select regexp_match('Köln', '[a-zA-Z]ö[a-zA-Z]{2}');
+---------------------------------------------------------+
| regexp_match(Utf8("Köln"),Utf8("[a-zA-Z]ö[a-zA-Z]{2}")) |
+---------------------------------------------------------+
| [Köln]                                                  |
+---------------------------------------------------------+
SELECT regexp_match('aBc', '(b|d)', 'i');
+---------------------------------------------------+
| regexp_match(Utf8("aBc"),Utf8("(b|d)"),Utf8("i")) |
+---------------------------------------------------+
| [B]                                               |
+---------------------------------------------------+
```

--------------------------------

### Install or Run Spice CLI

Source: https://github.com/spiceai/docs/blob/trunk/website/releases/v1.0-stable.md

Command to install or run the Spice CLI, with an option to force CPU installation.

```bash
spice install
spice run
spice install ai --cpu
```

--------------------------------

### Install Spice.ai via Helm

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/azure/index.md

Adds the Spice.ai Helm repository and installs the chart using the provided values file.

```bash
helm repo add spiceai https://helm.spiceai.org
helm repo update

helm upgrade --install spiceai spiceai/spiceai \
  --namespace spiceai --create-namespace \
  --version 1.11.5 \
  -f values.yaml
```

--------------------------------

### Link and run a Spice instance

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/cloud/cloud-connect/development.md

Initialize a directory as a Spice instance, link it to a project, and start the runtime in the foreground.

```shell
mkdir -p ~/work/retail-analytics
cd ~/work/retail-analytics
spice cloud link acme/retail-analytics
spice run
```

--------------------------------

### Install libnfs dependency

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/nfs.md

Install the required libnfs library on the host system.

```bash
sudo apt-get install libnfs-dev
```

```bash
brew install libnfs
```

--------------------------------

### Auto-detect shell and install completions

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/completions.md

Example of auto-detecting the user's shell and installing completions.

```shell
spice completions
```

--------------------------------

### Example Kubernetes readiness probe

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/api/HTTP/ready.api.mdx

This is an example of how to configure a Kubernetes readiness probe for the /v1/ready endpoint.

```yaml
readinessProbe:
 httpGet:
   path: /v1/ready
   port: 8090
```

--------------------------------

### Spice CLI Install Specific Version

Source: https://github.com/spiceai/docs/blob/trunk/website/releases/v1.9.0-rc.4.md

Examples of using the 'spice install' command to install specific versions of the Spice runtime and CLI, including with the AI flavor.

```console
# Install a specific version
spice install v1.8.3

# Install a specific version with AI flavor
spice install v1.8.3 ai

# Install latest version (existing behavior)
spice install
spice install ai
```

--------------------------------

### Project directory structure

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/add.md

Example of the directory structure after adding a Spicepod.

```text
├── spicepods/
│   ├── spiceai/
│       ├── quickstart/
│           ├── spicepod.yaml
├── spicepod.yaml
└── ...
```

--------------------------------

### Execute regexp_instr example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/scalar_functions.md

Example demonstrating finding the position of a regex match.

```sql
> SELECT regexp_instr('ABCDEF', 'C(.)(..)');
+---------------------------------------------------------------+
| regexp_instr(Utf8("ABCDEF"),Utf8("C(.)(..)"))                 |
+---------------------------------------------------------------+
| 3                                                             |
+---------------------------------------------------------------+
```

--------------------------------

### Model Selection Prompt Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/chat.md

Example of the model selection prompt when multiple models are available.

```shell
> spice chat
Use the arrow keys to navigate: ↓ ↑ → ←
? Select model:
  ▸ openai
    llama
Using model: openai
chat> hello
Hello! How can I assist you today?

Time: 0.55s (first token 0.43s). Tokens: 18. Prompt: 8. Completion: 10 (80.09/s).
```

--------------------------------

### Initialize Spice Project

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/getting-started/index.mdx

Commands to create a new Spice application and navigate to its directory.

```bash
spice init spice_qs
```

```bash
cd spice_qs
```

--------------------------------

### Install Spice CLI

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/getting-started/index.mdx

Commands to install the Spice CLI on various operating systems.

```bash
curl https://install.spiceai.org | /bin/bash
```

```bash
brew install spiceai/spiceai/spice
```

```powershell
iex ((New-Object System.Net.WebClient).DownloadString("https://install.spiceai.org/Install.ps1"))
```

--------------------------------

### Install Model2Vec Library

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/embeddings/model2vec.md

Install the necessary Python package to begin the distillation process.

```bash
pip install model2vec
```

--------------------------------

### Get Recommendation for a Specific Time API Request

Source: https://github.com/spiceai/docs/blob/trunk/website/releases/v0.4-alpha.md

Example of how to make a GET request to the /recommendation API to fetch recommendations for a specific time.

```http
GET http://localhost:8000/api/v0.1/pods/{pod}/recommendation?time={unix_timestamp}
```

```http
GET http://localhost:8000/api/v0.1/pods/trader/recommendation?time=1605729600
```

--------------------------------

### Runtime Startup Diagnostic Logs

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/spicepod/runtime.md

Example of the primary diagnostic logs emitted at startup, showing CPU budget derivation and thread pool sizing.

```text
CPU budget: 8 cores (source: the declared CPU request (x2); host reports 64, declared CPU request 4 cores, cgroup share unset, cgroup limit unset) → 8 main worker threads, 7 per dedicated runtime pool, 8 target partitions
CPU budget derived sizing: main_runtime_worker_threads=8, dedicated_runtime_worker_threads=7, target_partitions=8, max_concurrent_queries=32, ...
```

--------------------------------

### Verify Spice CLI Installation

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/index.md

Run this command to confirm the CLI is installed and check the current version.

```console
CLI version:     1.x.x
Runtime version: (not installed)
```

--------------------------------

### Initialize SpiceClient and Execute Query

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/sdks/javascript/index.md

Create a client instance and run a SQL query against the Spice runtime.

```js
import { SpiceClient } from '@spiceai/spice';

const main = async () => {
  const spiceClient = new SpiceClient();

  const table = await spiceClient.sql(
    'SELECT trip_distance, total_amount FROM taxi_trips ORDER BY trip_distance DESC LIMIT 10;'
  );

  console.table(table.toArray());
};

main();
```

--------------------------------

### Install Spice CLI

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/aws/integrations.md

Use this command to download and install the Spice CLI on your AWS environment.

```bash
curl https://install.spiceai.org | /bin/bash
```

--------------------------------

### Truncate Usage Examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/scalar_functions.md

Examples demonstrating numeric floor-bucketing, timestamp truncation, and string prefixing.

```sql
-- Numeric: floor-bucket integers into ranges of 10
SELECT truncate(10, 101) AS truncated_id;  -- returns 100

-- Truncate event timestamps to the start of each hour (3600 seconds)
SELECT truncate(3600, extract(epoch FROM event_time)) AS hour_start
FROM events;

-- String: keep the first 2 characters (e.g., country prefix)
SELECT truncate(2, 'United Kingdom');  -- returns 'Un'
```

--------------------------------

### Start the Spice runtime

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/index.md

Launches the local Spice runtime environment.

```bash
# Start the runtime
spice run
```

--------------------------------

### PostgreSQL Catalog Configuration Example

Source: https://github.com/spiceai/docs/blob/trunk/website/releases/v2.0-rc.2.md

Example YAML configuration for connecting to a PostgreSQL catalog.

```yaml
catalogs:
  - from: pg
    name: pg
    include:
      - 'public.*'
    params:
      pg_host: localhost
      pg_port: 5432
      pg_user: postgres
      pg_pass: ${secrets:POSTGRES_PASSWORD}
      pg_db: my_database
      pg_sslmode: disable
```

--------------------------------

### Spice version output examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/version.md

Sample outputs showing version information and upgrade availability notifications.

```shell
> spice version

CLI version:     v1.0.6
Runtime version: v1.0.6+models

CLI version v1.1.0 is now available!
To upgrade, run "spice upgrade".
```

```shell
> spice version

CLI version:     v1.1.0
Runtime version: v1.1.0+models
```

--------------------------------

### Spice Runtime Log Output

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/api/odbc/index.md

Example log output from the Spice runtime after starting.

```log
2024-10-06T20:06:50.084015Z  INFO runtime::flight: Spice Runtime Flight listening on 0.0.0.0:50051
2024-10-06T20:06:50.086948Z  INFO runtime::http: Spice Runtime HTTP listening on 127.0.0.1:8090
2024-10-06T20:06:50.297512Z  INFO runtime: Initialized results cache; max size: 128.00 MiB, item ttl: 1s
2024-10-06T20:06:50.308775Z  INFO runtime: Tool [search] ready to use
2024-10-06T20:06:50.308803Z  INFO runtime: Tool [table_schema] ready to use
2024-10-06T20:06:50.308814Z  INFO runtime: Tool [sql] ready to use
2024-10-06T20:06:50.308829Z  INFO runtime: Tool [list_datasets] ready to use
2024-10-06T20:06:50.921420Z  INFO runtime: Dataset taxi_trips registered (s3://spiceai-demo-datasets/taxi_trips/2024/), results cache enabled.
```

--------------------------------

### json_length Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/json.md

Demonstrates how to get the length of a JSON object or array.

```sql
> SELECT json_length('{"a": 1, "b": 2, "c": 3}');
+-----------------------------------------------+ 
| json_length(Utf8("{\"a\": 1, \"b\": 2, \"c\": 3}")) |
+-----------------------------------------------+ 
| 3                                             |
+-----------------------------------------------+

> SELECT json_length('[1, 2, 3, 4, 5]');
+--------------------------------------+ 
| json_length(Utf8("[1, 2, 3, 4, 5]")) |
+--------------------------------------+ 
| 5                                    |
+--------------------------------------+
```

--------------------------------

### to_unixtime usage examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/scalar_functions.md

Examples demonstrating conversion of RFC3339 strings and custom formatted strings to unix timestamps.

```sql
> select to_unixtime('2020-09-08T12:00:00+00:00');
+------------------------------------------------+
| to_unixtime(Utf8("2020-09-08T12:00:00+00:00")) |
+------------------------------------------------+
| 1599566400                                     |
+------------------------------------------------+
> select to_unixtime('01-14-2023 01:01:30+05:30', '%q', '%d-%m-%Y %H/%M/%S', '%+', '%m-%d-%Y %H:%M:%S%#z');
+-----------------------------------------------------------------------------------------------------------------------------+
| to_unixtime(Utf8("01-14-2023 01:01:30+05:30"),Utf8("%q"),Utf8("%d-%m-%Y %H/%M/%S"),Utf8("%+"),Utf8("%m-%d-%Y %H:%M:%S%#z")) |
+-----------------------------------------------------------------------------------------------------------------------------+
| 1673638290                                                                                                                  |
+-----------------------------------------------------------------------------------------------------------------------------+
```

--------------------------------

### Initialize a new Spicepod

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/getting-started/spicepods.md

Creates a new directory with a basic spicepod.yaml manifest file.

```bash
spice init my_app
```

--------------------------------

### Interactive REPL

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/query.md

Starts an interactive REPL for submitting queries. The example shows submitting a query, the query status updates, and the final result.

```shell
$ spice query
query> SELECT COUNT(*)
     > FROM large_table
     > WHERE status = 'active';
Submitted query: 01ABC-DEF-456-7890AB (PENDING)
Press Ctrl+C to stop waiting (query continues in background)
⠹ RUNNING (2.3s)...
✓ SUCCEEDED (5.1s)
+----------+
| count(*) |
+----------+
| 42000    |
+----------+

Time: 5.10000000 seconds. 1 rows.
```

--------------------------------

### Acceleration Snapshots Configuration Example

Source: https://github.com/spiceai/docs/blob/trunk/website/releases/v1.11.0-rc.2.md

Example configuration for enabling and customizing acceleration snapshots.

```yaml
datasets:
  - from: s3://my-bucket/data.parquet
    name: my_dataset
    acceleration:
      enabled: true
      engine: cayenne
      mode: file
      snapshots: enabled
      snapshots_trigger: time_interval
      snapshots_trigger_threshold: 1h
      snapshots_creation_policy: on_changed
```

--------------------------------

### Running as a non-root user

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/docker/sandbox.md

Example of how to configure a custom Docker image to run as a non-root user, which is recommended by Spice.

```dockerfile
RUN addgroup -g 1001 -S sandboxgroup && adduser -u 1001 -S -G sandboxgroup sandbox
USER sandbox
```

--------------------------------

### Remote and Cloud Chat Examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/chat.md

Examples for connecting to Spice Cloud or remote instances via HTTP or gRPC.

```shell
# Chat with Spice Cloud
spice chat --cloud --api-key <your-api-key> --model <model>

# Chat with a remote spiced instance over HTTP
spice chat --endpoint http://my-remote-host:8090 --model <model>

# Chat with a remote spiced instance over Arrow Flight SQL (gRPC)
spice chat --endpoint grpc://my-remote-host:50051 --model <model>
```

--------------------------------

### View Example Configuration

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/vectors/duckdb.md

Configuration for a view using DuckDB as the vector engine, demonstrating HNSW vector index setup.

```yaml
views:
  - name: review_title_view
    sql: select review_date, review_id, product_title, review_body from amazon_reviews
    columns:
      - name: product_title
        embeddings:
          - from: local_embedding_model
    acceleration:
      enabled: true
      engine: duckdb
      primary_key: review_id
      mode: memory
    vectors:
      enabled: true
      engine: duckdb
      params:
        duckdb_distance_metric: cosine
```

--------------------------------

### Initialize and configure a new Spice application

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/index.md

Creates a new application directory and adds a dependency.

```bash
# Init new app
spice init spice_app

# Add the Quickstart Spicepod
spice add spiceai/quickstart
```

--------------------------------

### SQL REPL Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/features/query-federation/index.md

Example of using the Spice CLI for interactive SQL queries.

```bash
spice sql
```

```sql
SELECT * FROM my_table LIMIT 10;
```

--------------------------------

### Embedding Models Configuration

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/features/embeddings/index.md

Example configuration for defining embedding models in the spicepod.yaml file. This includes both local and remote embedding model setups.

```yaml
embeddings:
  - name: local_embedding_model
    from: huggingface:huggingface.co/sentence-transformers/all-MiniLM-L6-v2

  - from: openai
    name: remote_service
    params:
      openai_api_key: ${ secrets:SPICE_OPENAI_API_KEY }
```

--------------------------------

### Start the Spice SQL REPL

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/features/query-federation/index.md

Command to start the Spice SQL REPL.

```bash
spice sql
```

--------------------------------

### Create project variants

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/cloud.md

Examples for creating Cloud Connect projects versus Spice-managed projects.

```shell
spice cloud project create <NAME>                              # Cloud Connect project
spice cloud project create <NAME> --kind set --region <REGION> # Spice-managed project
```

--------------------------------

### Kubernetes securityContext for non-root user

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/docker/sandbox.md

Example of a Kubernetes securityContext to ensure the sandbox user has access to necessary files when running as a non-root user.

```yaml
securityContext:
  runAsUser: 1001
  runAsGroup: 1001
  # Tells Kubernetes to set the group of the files in the volume to sandboxgroup, 
  # which allows the sandbox user to access the files.
  fsGroup: 1001
```

--------------------------------

### Custom Dockerfile for v1.3.0

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/docker/sandbox.md

This Dockerfile demonstrates how to build a custom Docker image based on v1.3.0, copying the spiced binary and installing additional dependencies. It also shows how to restore previous behavior by including standard Linux tools like bash.

```dockerfile
FROM debian:bookworm-slim

# Copy the spiced binary from the spiceai/spiceai image into the custom image.
COPY --from=spiceai/spiceai:v1.3.0 /usr/local/bin/spiced /usr/local/bin/spiced

# Install any additional dependencies needed for the image.
RUN apt update && apt install -y --no-install-recommends <your-dependencies>

# Any other customizations needed for the image.

WORKDIR /app

ENTRYPOINT ["/usr/local/bin/spiced"]
```

--------------------------------

### Build and Run Custom Image

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/docker/index.md

Commands to build the custom image and start a container instance.

```bash
docker build -t my-spiceai-app .
docker run --rm -p 8090:8090 -p 50051:50051 my-spiceai-app
```

--------------------------------

### Build

Source: https://github.com/spiceai/docs/blob/trunk/website/README.md

Builds static content for deployment.

```bash
npm run build
```

--------------------------------

### Windows Installation

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/installation.md

Install Spice.ai OSS on Windows using the PowerShell install script.

```powershell
iex ((New-Object System.Net.WebClient).DownloadString("https://install.spiceai.org/Install.ps1"))
```

--------------------------------

### macOS, Linux, and WSL Installation

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/installation.md

Install Spice.ai OSS on macOS, Linux, and WSL using either the install script or Homebrew.

```bash
curl https://install.spiceai.org | /bin/bash
```

```bash
brew install spiceai/spiceai/spice
```

--------------------------------

### Configure Spicepod Dependencies

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/getting-started/index.mdx

Commands and configuration to add the quickstart dependency to the project.

```bash
spice add spiceai/quickstart
```

```yaml
version: v1
kind: Spicepod
name: spice_qs
dependencies:
  - spiceai/quickstart
```

--------------------------------

### Install the `flightsql-dbapi` library in your existing Apache Superset environment

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/clients/superset/index.md

Installing the flightsql-dbapi library using pip for existing Superset installations.

```bash
pip install flightsql-dbapi
```

--------------------------------

### SMB Connection Path Examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/smb.md

Various formats for specifying the SMB server, share, and path in the 'from' parameter.

```yaml
# Connect to a specific file
from: smb://fileserver/data/reports/quarterly.parquet

# Connect to a directory (loads all files)
from: smb://fileserver/data/sales/

# Connect to share root
from: smb://fileserver/data/

# Using IP address
from: smb://192.168.1.100/share/data.parquet
```

--------------------------------

### Example Helm values.yaml Configuration

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/kubernetes/helm/index.md

A comprehensive example of a values.yaml file covering labels, image settings, resources, environment variables, stateful storage, monitoring, and spicepod definitions.

```yaml
additionalLabels:
  environment: production
  app: spice

image:
  repository: spiceai/spiceai
  tag: latest
replicaCount: 1

service:
  type: ClusterIP
  additionalAnnotations:
    service.beta.kubernetes.io/aws-load-balancer-internal: 'true'

resources:
  limits:
    # cpu: 1000m  # Do not set CPU limits - can cause throttling
    memory: 2Gi
  requests:
    cpu: 500m
    memory: 1Gi

additionalEnv:
  - name: SPICED_LOG
    value: 'INFO'
  - name: SPICE_SECRET_SPICEAI_KEY
    valueFrom:
      secretKeyRef:
        name: spice-secrets
        key: spiceai-key

stateful:
  enabled: true
  storageClass: 'standard'
  size: 5Gi
  mountPath: /data

monitoring:
  podMonitor:
    enabled: true
    additionalLabels:
      release: prometheus

spicepod:
  name: app
  version: v1
  kind: Spicepod

  datasets:
    - from: s3://spiceai-demo-datasets/taxi_trips/2024/
      name: taxi_trips
      description: Demo taxi trips in s3
      params:
        file_format: parquet
      acceleration:
        enabled: true
        engine: duckdb
        mode: file
        params:
          duckdb_file: /data/taxi_trips.db
        # Uncomment to refresh the acceleration on a schedule
        # refresh_check_interval: 1h
        # refresh_mode: full
```

--------------------------------

### Basic SQL REPL Usage

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/sql.md

Start the interactive SQL REPL against the local Spice runtime.

```shell
spice sql [flags]
```

--------------------------------

### NOT IN Operator Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/subqueries.md

Example of using the NOT IN operator with a list literal.

```sql
SELECT * FROM x WHERE column_1 NOT IN (1,3);

+----------+----------+
| column_1 | column_2 |
+----------+----------+
| 2        | 4        |
+----------+----------+
```

--------------------------------

### IN Operator Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/subqueries.md

Example of using the IN operator with a list literal.

```sql
SELECT * FROM x WHERE column_1 IN (1,3);

+----------+----------+
| column_1 | column_2 |
+----------+----------+
| 1        | 2        |
+----------+----------+
```

--------------------------------

### Example Explain Plan Output

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/troubleshooting/index.md

The output format for an explain plan query.

```console
+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| plan_type     | plan                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
```

--------------------------------

### Literal string example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/operators.md

Example of a basic string literal.

```sql
SELECT 'foo';
```

--------------------------------

### ORDER BY Clause Examples

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/select.md

Provides examples of ordering results by a single column in ascending or descending order, and by multiple columns.

```sql
SELECT age, person FROM table ORDER BY age;
SELECT age, person FROM table ORDER BY age DESC;
SELECT age, person FROM table ORDER BY age, person DESC;
```

--------------------------------

### median example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/aggregate_functions.md

Example usage of the median function.

```sql
> SELECT median(column_name) FROM table_name;
+----------------------+|
| median(column_name)   |
+----------------------+|
| 45.5                 |
+----------------------+|

```

--------------------------------

### Go SDK Example

Source: https://github.com/spiceai/docs/blob/trunk/website/releases/v1.11.0-rc.1.md

Example of using prepared statements with the gospice SDK in Go, demonstrating parameterized queries with typed parameters.

```go
import "github.com/spiceai/gospice/v8"

client, _ := spice.NewClient()
deferr client.Close()

// Parameterized query with typed parameters
results, _ := client.SqlWithParams(ctx,
    "SELECT * FROM products WHERE price > $1 AND category = $2",
    spice.Float64Param(10.0),
    spice.StringParam("electronics"),
)
```

--------------------------------

### max example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/aggregate_functions.md

Example usage of the max function.

```sql
> SELECT max(column_name) FROM table_name;
+----------------------+|
| max(column_name)      |
+----------------------+|
| 150                  |
+----------------------+|

```

--------------------------------

### bool_or example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/aggregate_functions.md

Example usage of the bool_or function.

```sql
> SELECT bool_or(column_name) FROM table_name;
+----------------------------+
| bool_or(column_name)        |
+----------------------------+
| true                        |
+----------------------------+

```

--------------------------------

### bool_and example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/aggregate_functions.md

Example usage of the bool_and function.

```sql
> SELECT bool_and(column_name) FROM table_name;
+----------------------------+
| bool_and(column_name)       |
+----------------------------+
| true                        |
+----------------------------+

```

--------------------------------

### List models example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/models.md

Standard output showing the ID, owner, and status of loaded models.

```shell
>>> spice models

ID     OWNED_BY STATUS ERROR
modlz  local    Ready
```

--------------------------------

### avg Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/aggregate_functions.md

Example of using the avg function.

```sql
> SELECT avg(column_name) FROM table_name;
+---------------------------+ 
| avg(column_name)           |
+---------------------------+ 
| 42.75                      |
+---------------------------+
```

--------------------------------

### Start the runtime

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/getting-started/spiceai.md

Starts the Spice runtime.

```bash
# Start the runtime
spice run
```

--------------------------------

### Install unixodbc on MacOS

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/odbc.md

Install the unixodbc package on MacOS using Homebrew.

```bash
brew install unixodbc
```

--------------------------------

### Start Monitoring Stack

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/monitoring/grafana/index.md

Command to launch the configured Docker Compose services.

```bash
docker-compose up
```

--------------------------------

### Configure FTP/SFTP connection strings

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/ftp.md

Examples of defining the source path for FTP and SFTP servers, including both specific files and directories.

```yaml
# Connect to a specific file
from: sftp://files.example.com/data/customers.parquet

# Connect to a directory (loads all files)
from: sftp://files.example.com/data/sales/

# FTP connection
from: ftp://ftp.example.com/exports/reports/
```

--------------------------------

### Define dataset name and query

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/databricks/index.md

Example showing how to define a dataset name and perform a SQL query against it.

```yaml
datasets:
  - from: databricks:spiceai.datasets.my_awesome_table
    name: cool_dataset
    params: ...
```

```sql
SELECT COUNT(*) FROM cool_dataset;
```

```shell
+----------+
| count(*) |
+----------+
| 6001215  |
+----------+
```

--------------------------------

### Usage

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/install.md

Install the latest version of the Spice runtime.

```shell
spice install [flavor] [flags]
```

--------------------------------

### Define models in spicepod.yaml

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/models/index.md

Example configuration showing how to define different model sources using provider prefixes.

```yaml
models:
  - from: openai:gpt-4o
    name: openai-model

  - from: hf:meta-llama/Llama-3-8B-Instruct
    name: llama3-hf

  - from: file://absolute/path/to/model.gguf
    name: local-model
```

--------------------------------

### Set environment variables and run Spice

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/postgres/index.md

Commands to set the database password and start the Spice runtime.

```bash
echo "PG_PASSWORD=your_password" > .env
```

```bash
spice run
# In another terminal:
spice sql
sql> SELECT count(*) FROM customers;
```

--------------------------------

### Install Spice Helm Chart

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/kubernetes/helm/index.md

Commands to deploy the Spice.ai chart into a Kubernetes cluster.

```bash
helm install {release-name} {repository-name}/spiceai --namespace {namespace}
```

```bash
helm install spiceai spiceai/spiceai --namespace default
```

```bash
helm upgrade --install spiceai-my-app-1 my-spiceai-repo/spiceai
```

--------------------------------

### bit_count usage example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/scalar_functions.md

Example of counting set bits in the integer 255.

```sql
> select bit_count(255) as popcnt;
+--------+
| popcnt |
+--------+
| 8      |
+--------+
```

--------------------------------

### Spice Runtime Initialization Logs

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/embeddings/model2vec.md

Example output from the Spice runtime showing the initialization of embedding models and datasets.

```shell
2025-08-25T15:59:39.033644Z  INFO runtime::init::embedding: Embedding Model minilm_distilled ready
2025-08-25T15:59:39.969381Z  INFO runtime::init::embedding: Embedding Model all_minilm_l6_v2 ready
2025-08-25T15:59:39.969713Z  INFO runtime::init::dataset: Dataset wiki_a_full initializing...
2025-08-25T15:59:39.969713Z  INFO runtime::init::dataset: Dataset wiki_a_distilled initializing...
2025-08-25T15:59:39.973287Z  INFO runtime::init::dataset: Dataset wiki_a_full registered (file://wiki_a2.parquet), acceleration (arrow), results cache enabled.
2025-08-25T15:59:39.973344Z  INFO runtime::init::dataset: Dataset wiki_a_distilled registered (file://wiki_a2.parquet), acceleration (arrow), results cache enabled.
2025-08-25T15:59:39.973637Z  INFO runtime::accelerated_table::refresh_task: Loading data for dataset wiki_a_distilled
2025-08-25T15:59:39.973714Z  INFO runtime::accelerated_table::refresh_task: Loading data for dataset wiki_a_full
2025-08-25T15:59:50.982854Z  INFO runtime::accelerated_table::refresh_task: Dataset wiki_a_distilled received 40,960 records
2025-08-25T16:00:02.953192Z  INFO runtime::accelerated_table::refresh_task: Dataset wiki_a_distilled received 57,344 records
2025-08-25T16:00:14.429262Z  INFO runtime::accelerated_table::refresh_task: Dataset wiki_a_distilled received 40,960 records
2025-08-25T16:00:26.177483Z  INFO runtime::accelerated_table::refresh_task: Dataset wiki_a_distilled received 49,152 records
2025-08-25T16:00:36.963177Z  INFO runtime::accelerated_table::refresh_task: Dataset wiki_a_distilled received 40,960 records
2025-08-25T16:00:49.157552Z  INFO runtime::accelerated_table::refresh_task: Dataset wiki_a_distilled received 49,152 records
2025-08-25T16:01:09.789714Z  INFO runtime::accelerated_table::refresh_task: Loaded 100 rows (904.41 kiB) for dataset wiki_a_full in 1m 29s 816ms.
```

--------------------------------

### last_value example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/aggregate_functions.md

Example usage of the last_value function with ordering.

```sql
> SELECT last_value(column_name ORDER BY other_column) FROM table_name;
+-----------------------------------------------+|
| last_value(column_name ORDER BY other_column) |
+-----------------------------------------------+|
| last_element                                  |
+-----------------------------------------------+|

```

--------------------------------

### first_value example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/aggregate_functions.md

Example usage of the first_value function with ordering.

```sql
> SELECT first_value(column_name ORDER BY other_column) FROM table_name;
+-----------------------------------------------+|
| first_value(column_name ORDER BY other_column)|
+-----------------------------------------------+|
| first_element                                 |
+-----------------------------------------------+|

```

--------------------------------

### Install Spice.ai Dotnet SDK

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/sdks/dotnet/index.md

Use the dotnet CLI to add the spiceai package to your project.

```shell
dotnet add package spiceai
```

--------------------------------

### array_agg Example 1

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/aggregate_functions.md

Example of using array_agg with ORDER BY.

```sql
> SELECT array_agg(column_name ORDER BY other_column) FROM table_name;
+-----------------------------------------------+ 
| array_agg(column_name ORDER BY other_column)  |
+-----------------------------------------------+ 
| [element1, element2, element3]                |
+-----------------------------------------------+
```

--------------------------------

### Cache-Control Header Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/https/index.md

Example of a Cache-Control header returned by an HTTP(s) endpoint.

```http
Cache-Control: max-age=10, stale-while-revalidate=10
```

--------------------------------

### Connect with Client Certificate

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/api/tls/index.md

Examples of authenticating with a client certificate using cURL or the Spice CLI.

```bash
curl --cacert ca.pem --cert client.crt --key client.key \
  https://localhost:8090/v1/sql -d 'SELECT 1'
```

```bash
spice sql --tls-root-certificate-file ./ca.pem \
  --client-tls-certificate-file ./client.crt \
  --client-tls-key-file ./client.key
```

--------------------------------

### Start the runtime

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/spiced.md

Launches the spiced runtime using the Spicepod configuration found in the current directory.

```shell
spiced
```

--------------------------------

### bitmap_count usage example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/scalar_functions.md

Example of counting set bits in a hexadecimal binary literal.

```sql
> select bitmap_count(x'0F') as popcnt;
+--------+
| popcnt |
+--------+
| 4      |
+--------+
```

--------------------------------

### bit_get usage example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/scalar_functions.md

Example of retrieving the bit at position 2 from the integer 11.

```sql
> select bit_get(11, 2) as bit;
+-----+
| bit |
+-----+
| 0   |
+-----+
```

--------------------------------

### Start Docker Compose Services

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/docker/index.md

Command to initialize the containers defined in the docker-compose.yaml file.

```bash
docker compose up
```

--------------------------------

### Alternative MySQL Dataset Configurations

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/mysql/index.md

Demonstrates equivalent ways to specify the database and table in the 'from' field.

```yaml
datasets:
  - from: mysql:mytable
    name: my_dataset
    params:
      mysql_db: my_database
      ...
```

```yaml
datasets:
  - from: mysql:my_database.mytable
    name: my_dataset
    params: ...
```

--------------------------------

### SQL CASE Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/scalar_functions.md

Example of using a searched CASE expression to categorize scores.

```sql
> SELECT CASE WHEN score >= 90 THEN 'A' WHEN score >= 80 THEN 'B' ELSE 'C' END AS grade
  FROM (VALUES (95), (82), (70)) AS t(score);
+-------+
| grade |
+-------+
| A     |
| B     |
| C     |
+-------+
```

--------------------------------

### FROM Clause Subquery Example

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/subqueries.md

Example of a subquery in the FROM clause to filter data before further processing.

```sql
SELECT
  column_2
FROM
  (
    SELECT
      *
    FROM
      x
    WHERE
      column_1 > 1
  );

+----------+
| column_2 |
+----------+
|        4 |
+----------+
```

--------------------------------

### Create and configure a service account

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/deployment/gcp/index.md

Sets up a dedicated service account with necessary IAM roles for storage and secret access.

```bash
gcloud iam service-accounts create spiceai-runtime --project $PROJECT

gcloud projects add-iam-policy-binding $PROJECT \
  --member "serviceAccount:spiceai-runtime@${PROJECT}.iam.gserviceaccount.com" \
  --role roles/storage.objectViewer

gcloud projects add-iam-policy-binding $PROJECT \
  --member "serviceAccount:spiceai-runtime@${PROJECT}.iam.gserviceaccount.com" \
  --role roles/secretmanager.secretAccessor
```

--------------------------------

### array_agg Example 2

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/reference/sql/aggregate_functions.md

Example of using array_agg with DISTINCT and ORDER BY.

```sql
> SELECT array_agg(DISTINCT column_name ORDER BY column_name) FROM table_name;
+--------------------------------------------------------+ 
| array_agg(DISTINCT column_name ORDER BY column_name)  |
+--------------------------------------------------------+ 
| [element1, element2, element3]                         |
+--------------------------------------------------------+
```

--------------------------------

### Initialize Spice Client

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/sdks/golang/index.md

Initialize the Spice client using default settings or a custom flight address.

```go
spice := gospice.NewSpiceClient()
defer spice.Close()

if err := spice.Init(); err != nil {
    panic(fmt.Errorf("error initializing SpiceClient: %w", err))
}
```

```go
if err := spice.Init(
    gospice.WithFlightAddress("grpc://my_remote_spice_instance:50051"),
); err != nil {
    panic(fmt.Errorf("error initializing SpiceClient: %w", err))
}
```

--------------------------------

### Example with App Name

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/cli/reference/init.md

Example of initializing a Spice app named 'taxi-trips' and the subsequent steps.

```shell
> spice init taxi-trips

Initialized taxi-trips/spicepod.yaml

Next steps:
  cd taxi-trips
  spice dataset configure   # add a dataset interactively
  spice run                 # start the runtime

Docs: https://spiceai.org/docs/
```

--------------------------------

### Create test database

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/components/data-connectors/odbc.md

Commands to generate a sample SQLite database for testing.

```bash
$ sqlite3 test.db
SQLite version 3.43.2 2023-10-10 13:08:14
Enter ".help" for usage hints.
sqlite> create table spice_test (name text not null);
sqlite> insert into spice_test values ("Lala");
sqlite> insert into spice_test values ("Hopper");
sqlite> insert into spice_test values ("Linus");
```

--------------------------------

### Connect to Spice Runtime

Source: https://github.com/spiceai/docs/blob/trunk/website/docs/sdks/rust/index.md

Initialize a client to execute SQL queries against the Spice runtime.

```rust
use spiceai::ClientBuilder;

#[tokio::main]
async fn main() {
    let client = ClientBuilder::new()
        .build()
        .await
        .unwrap();

    let data = client.query(
        "SELECT trip_distance, total_amount FROM taxi_trips ORDER BY trip_distance DESC LIMIT 10"
    ).await;
}
```

```rust
use spiceai::ClientBuilder;

#[tokio::main]
async fn main() {
    let client = ClientBuilder::new()
        .flight_url("http://my_remote_spice_instance:50051")
        .build()
        .await
        .unwrap();

    let data = client.query(
        "SELECT trip_distance, total_amount FROM taxi_trips ORDER BY trip_distance DESC LIMIT 10"
    ).await;
}
```
Tokens:
Raw