You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/components/data-connectors/mongodb.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,9 +80,9 @@ The MongoDB data connector can be configured by providing the following `params`
80
80
| `mongodb_connection_string` | The connection string to use to connect to the MongoDB server. This can be used instead of providing individual connection parameters. |
81
81
| `mongodb_user` | The MongoDB username. |
82
82
| `mongodb_pass` | The password to connect with. |
83
-
| `mongodb_host` | The hostname of the MongoDB server. |
84
-
| `mongodb_port` | The port of the MongoDB server. |
85
-
| `mongodb_db` | The name of the database to connect to. |
83
+
| `mongodb_host` | The hostname of the MongoDB server. Defaults to `localhost`. |
84
+
| `mongodb_port` | The port of the MongoDB server. Defaults to `27017`. |
85
+
| `mongodb_db` | The name of the database to connect to. Defaults to `default`. |
86
86
| `mongodb_sslmode` | Optional. Specifies the SSL/TLS behavior for the connection, supported values:<br /> <ul><li>`required`: (default) This mode requires an SSL connection. If a secure connection cannot be established, server will not connect.</li><li>`preferred`: This mode will try to establish a secure SSL connection if possible, but will connect insecurely if the server does not support SSL.</li><li>`disabled`: This mode will not attempt to use an SSL connection, even if the server supports it.</li></ul> |
87
87
| `mongodb_sslrootcert` | Optional parameter specifying the path to a custom PEM certificate that the connector will trust. |
88
88
| `mongodb_time_zone` | Optional. Specifies connection time zone. Default is `UTC`. Accepts: <br /><ul><li>Fixed offsets (e.g., `+02:00`).</li><li>IANA time zone names (e.g., `America/Los_Angeles`)</li></ul> |
Copy file name to clipboardExpand all lines: website/docs/features/data-acceleration/snapshots.md
+12-1Lines changed: 12 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ Every accelerated dataset must write to its own file (for example, `/nvme/my_dat
51
51
52
52
## Configure snapshot storage
53
53
54
-
Snapshots are controlled with a top-level `snapshots` block in the Spicepod. The location must point to a folder on S3 or the local filesystem. When the location is an S3 bucket, the configuration accepts any S3 dataset parameters under `params`.
54
+
Snapshots are controlled with a top-level `snapshots` block in the Spicepod. The location can point to S3, Azure ADLS Gen2, Google Cloud Storage, or the local filesystem.
55
55
56
56
```yaml
57
57
snapshots:
@@ -62,6 +62,17 @@ snapshots:
62
62
s3_auth: iam_role # Defaults to iam_role for snapshots
| Local filesystem | Absolute or relative path | N/A |
73
+
74
+
When the location is an S3 bucket, the configuration accepts any [S3 dataset parameters](../../components/data-connectors/s3) under `params`. Azure and GCS locations also accept their respective connector parameters under `params` for explicit credential overrides. When no explicit credentials are supplied, Spice reads standard environment variables for each cloud provider.
75
+
65
76
### Failure behavior
66
77
67
78
`bootstrap_on_failure_behavior`controls what Spice does when it cannot load the most recent snapshot.
Copy file name to clipboardExpand all lines: website/docs/features/observability/index.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -239,6 +239,10 @@ runtime:
239
239
240
240
When `metrics` is empty or omitted, all available metrics are exported.
241
241
242
+
:::caution Filtering happens after `metric_prefix` is applied
243
+
The whitelist is matched against the **final** metric name, after `runtime.telemetry.metric_prefix` has been prepended. If you set `metric_prefix: 'spiceai.'`, the entries under `metrics:` must include the prefix (e.g. `spiceai.query_duration_ms`), otherwise nothing will match and no metrics will be exported.
244
+
:::
245
+
242
246
For full configuration details, see the [runtime.telemetry reference](../reference/spicepod/runtime#runtimetelemetry).
Copy file name to clipboardExpand all lines: website/docs/features/search/vector-search.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -157,6 +157,8 @@ FROM vector_search('sales', 'cutting edge AI', 1500)
157
157
ORDER BY score DESC;
158
158
```
159
159
160
+
`WHERE` predicates on base table columns are pushed down as pre-filters — only matching rows are scored and ranked. See [Search in SQL](../../reference/sql/search#vector-search-vector_search) for details.
161
+
160
162
:::warning[Limitations]
161
163
162
164
-`vector_search` UDTF does not yet support chunked embedding columns. Chunking support is on the roadmap.
Copy file name to clipboardExpand all lines: website/docs/monitoring/datadog/index.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,6 +75,10 @@ runtime:
75
75
76
76
The runtime metric `query_duration_ms` is then exported as `spiceai.query_duration_ms`.
77
77
78
+
:::caution Combining `metric_prefix` with metric filtering
79
+
If you also set [`runtime.telemetry.otel_exporter.metrics`](/docs/next/reference/spicepod/runtime#runtimetelemetryotel_exporter) to whitelist specific metrics, the entries must include the prefix. The filter runs after the prefix is applied, so e.g. `query_duration_ms` will not match when `metric_prefix: 'spiceai.'` is set — use `spiceai.query_duration_ms` instead.
80
+
:::
81
+
78
82
### Add Custom Tags via Resource Attributes
79
83
80
84
Attach custom key/value pairs to every metric using [`runtime.telemetry.properties`](/docs/next/reference/spicepod/runtime#runtimetelemetryproperties). Spice sends these as OpenTelemetry resource attributes:
Copy file name to clipboardExpand all lines: website/docs/reference/spicepod/index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -135,7 +135,7 @@ Enable or disable snapshot management globally. Defaults to `true`.
135
135
136
136
### `snapshots.location`
137
137
138
-
The folder where snapshots are stored. Supports S3 bucket URIs (`s3://bucket/prefix/`) and absolute or relative filesystem paths. The path must resolve to a single folder; Spice creates per-dataset folders underneath using Hive-style partitions (`month=YYYY-MM/day=YYYY-MM-DD/dataset=<name>`).
138
+
The folder where snapshots are stored. Supports S3 bucket URIs (`s3://bucket/prefix/`), Azure ADLS Gen2 URIs (`abfss://container@account.dfs.core.windows.net/path/`), Google Cloud Storage URIs (`gs://bucket/prefix/`), and absolute or relative filesystem paths. The path must resolve to a single folder; Spice creates per-dataset folders underneath using Hive-style partitions (`month=YYYY-MM/day=YYYY-MM-DD/dataset=<name>`).
139
139
140
140
### `snapshots.bootstrap_on_failure_behavior`
141
141
@@ -147,7 +147,7 @@ Controls what happens when Spice cannot load the most recent snapshot on startup
147
147
148
148
### `snapshots.params`
149
149
150
-
Optional key-value map passed to the snapshot storage layer. When `location` points to S3, the configuration accepts any of the [S3 dataset parameters](../components/data-connectors/s3). Snapshots default to `s3_auth: iam_role`, which differs from the S3 dataset default of `public`.
150
+
Optional key-value map passed to the snapshot storage layer. When `location` points to S3, the configuration accepts any of the [S3 dataset parameters](../components/data-connectors/s3). Snapshots default to `s3_auth: iam_role`, which differs from the S3 dataset default of `public`. Azure ADLS and GCS locations also accept their respective connector parameters for explicit credential overrides; when no overrides are supplied, Spice reads standard environment variables for each cloud provider.
Copy file name to clipboardExpand all lines: website/docs/reference/spicepod/runtime.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -435,6 +435,10 @@ runtime:
435
435
- dataset_load_state
436
436
```
437
437
438
+
:::caution Filtering happens after `metric_prefix` is applied
439
+
The whitelist is matched against the **final** metric name, after [`runtime.telemetry.metric_prefix`](#runtimetelemetrymetric_prefix) has been prepended. If you set `metric_prefix: 'spiceai.'`, the entries under `metrics:` must include the prefix (e.g. `spiceai.query_duration_ms`), otherwise nothing will match and no metrics will be exported.
440
+
:::
441
+
438
442
**Authenticated exporters:**
439
443
440
444
For collectors that require authentication, set the `headers` map. Load credentials from a [secret store](../../components/secret-stores) via `${secrets:...}` rather than committing them to source.
Copy file name to clipboardExpand all lines: website/docs/reference/sql/json.md
+118Lines changed: 118 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -477,6 +477,124 @@ SELECT
477
477
FROM products;
478
478
```
479
479
480
+
## JSON Table Functions (UDTFs)
481
+
482
+
Spice includes table-valued functions for decomposing JSON structures into relational rows. Each function is available as both a UDTF (in the `FROM` clause with literal input) and a scalar UDF returning a list of structs (for per-row use with `UNNEST`).
483
+
484
+
### `flatten_json`
485
+
486
+
Walks an arbitrary JSON value and emits one row per reachable leaf.
487
+
488
+
```sql
489
+
flatten_json(input Utf8 [, options...]) -> TABLE(
490
+
path Utf8,
491
+
parent_path Utf8,
492
+
key Utf8,
493
+
value Utf8,
494
+
type Utf8 -- "object"|"array"|"string"|"number"|"integer"|"boolean"|"null"
495
+
)
496
+
```
497
+
498
+
**Options (named arguments):**
499
+
500
+
| Option | Type | Default | Description |
501
+
| --- | --- | --- | --- |
502
+
|`max_depth`| UInt |`64`| Maximum recursion depth. |
Handles `properties` recursion, `items.properties` (arrays of objects), `additionalProperties` maps, `allOf`/`oneOf`/`anyOf` merging, and local `$ref` pointers with cycle detection.
548
+
549
+
**Options (named arguments):**
550
+
551
+
| Option | Type | Default | Description |
552
+
| --- | --- | --- | --- |
553
+
|`max_depth`| UInt |`32`| Maximum recursion depth. |
0 commit comments