Skip to content

Commit a0a7f89

Browse files
committed
docs improve
1 parent 6612ff0 commit a0a7f89

3 files changed

Lines changed: 15 additions & 11 deletions

File tree

website/docs/components/data-accelerators/cayenne/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Use [S3 Express One Zone](#aws-s3-express-one-zone-storage) when persistence of
4848

4949
## Advanced Internals
5050

51+
5152
### Sequence-based Upserts and Deletes
5253
Cayenne uses Iceberg-style sequence numbers to enable upsert and delete semantics. Each row is tagged with a sequence number, allowing efficient handling of row-level changes without rewriting entire files. Deletes are tracked as tombstones, and upserts are resolved at query time.
5354

website/docs/reference/spicepod/runtime.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,15 @@ The TLS section specifies the configuration for enabling Transport Layer Securit
215215

216216
In addition to configuring TLS via the manifest, TLS can also be configured via `spiced` command line arguments using the `--tls-enabled true` flag along with `--tls-certificate`/`--tls-certificate-file` and `--tls-key`/`--tls-key-file`.
217217

218+
### Certificate Hot-Reload
219+
220+
Spice can hot-reload TLS certificates and client CA files for runtime endpoints. Update the certificate, key, or CA file on disk, then send `SIGHUP` to the Spice process to reload without restart. Only file-based certificates/keys/CA are hot-reloaded (not inline PEM). Existing connections are not interrupted; only new connections use the updated files. If reload fails, the previous certificate remains active and a warning is logged.
221+
222+
**Steps:**
223+
1. Replace the certificate/key/CA file on disk.
224+
2. Send `SIGHUP` to the Spice process (e.g., `kill -SIGHUP <pid>`).
225+
3. Check logs for reload confirmation or errors.
226+
218227
### `runtime.tls.enabled`
219228

220229
Enables or disables TLS for the runtime endpoints.
@@ -233,10 +242,9 @@ The TLS certificate to use for securing the runtime endpoints. The certificate c
233242
```yaml
234243
runtime:
235244
tls:
236-
...
237245
certificate: |
238246
-----BEGIN CERTIFICATE-----
239-
...
247+
(certificate contents)
240248
-----END CERTIFICATE-----
241249
```
242250

@@ -254,7 +262,6 @@ The path to the TLS PEM-encoded certificate file. Only one of `certificate` or `
254262
```yaml
255263
runtime:
256264
tls:
257-
...
258265
certificate_file: /path/to/cert.pem
259266
```
260267

@@ -265,10 +272,9 @@ The TLS key to use for securing the runtime endpoints. The key can also come fro
265272
```yaml
266273
runtime:
267274
tls:
268-
...
269275
key: |
270276
-----BEGIN PRIVATE KEY-----
271-
...
277+
(private key contents)
272278
-----END PRIVATE KEY-----
273279
```
274280

@@ -286,7 +292,6 @@ The path to the TLS PEM-encoded key file. Only one of `key` or `key_file` must b
286292
```yaml
287293
runtime:
288294
tls:
289-
...
290295
key_file: /path/to/key.pem
291296
```
292297

@@ -323,7 +328,6 @@ Path to a PEM-encoded CA bundle used to verify client certificates. The file is
323328
```yaml
324329
runtime:
325330
tls:
326-
...
327331
client_auth_ca_file: /path/to/client-ca.pem
328332
```
329333

@@ -334,10 +338,9 @@ Inline PEM (or `${ secrets:... }`) form of the client CA bundle. Mutually exclus
334338
```yaml
335339
runtime:
336340
tls:
337-
...
338341
client_auth_ca: |
339342
-----BEGIN CERTIFICATE-----
340-
...
343+
(CA certificate contents)
341344
-----END CERTIFICATE-----
342345
```
343346

website/docs/reference/sql/dml.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ sidebar_position: 30
77

88
Data Manipulation Language (DML) statements are used to insert, update, and delete data in tables. Spice supports DML operations on [write-capable data connectors](../../tags/write) configured with `access: read_write`.
99

10-
:::warning[Supported Operations]
11-
Spice supports `INSERT` for write-capable connectors and `MERGE INTO` for [Spice Cayenne](../../components/data-accelerators/cayenne) catalog tables. `UPDATE` and `DELETE` statements are not yet supported as standalone operations. For data modifications, use `MERGE INTO` or the source database directly.
10+
:::info[Supported Operations]
11+
Spice supports `INSERT`, `UPDATE`, and `DELETE` for write-capable connectors that support these operations. As of v2.0.0-rc.5, the [Snowflake](../../components/data-connectors/snowflake) connector supports all three DML operations when `access: read_write` is set. For Cayenne, use `MERGE INTO` for updates and deletes.
1212
:::
1313

1414
:::info

0 commit comments

Comments
 (0)