Skip to content

Commit 711bce4

Browse files
Merge pull request #449 from authzed/docs-spicedb-update
Auto-generated PR: Update spicedb docs
2 parents 259e8aa + f09c359 commit 711bce4

File tree

1 file changed

+35
-12
lines changed

1 file changed

+35
-12
lines changed

app/spicedb/concepts/commands/page.mdx

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,13 @@ A database that stores and computes permissions
2727

2828
### Children commands
2929

30-
- [spicedb datastore](#reference-spicedb-datastore) - datastore operations
31-
- [spicedb lsp](#reference-spicedb-lsp) - serve language server protocol
32-
- [spicedb man](#reference-spicedb-man) - Generate man page
33-
- [spicedb serve](#reference-spicedb-serve) - serve the permissions database
34-
- [spicedb serve-testing](#reference-spicedb-serve-testing) - test server with an in-memory datastore
35-
- [spicedb version](#reference-spicedb-version) - displays the version of SpiceDB
30+
- [spicedb datastore](#reference-spicedb-datastore) - datastore operations
31+
- [spicedb lsp](#reference-spicedb-lsp) - serve language server protocol
32+
- [spicedb man](#reference-spicedb-man) - Generate man page
33+
- [spicedb serve](#reference-spicedb-serve) - serve the permissions database
34+
- [spicedb serve-testing](#reference-spicedb-serve-testing) - test server with an in-memory datastore
35+
- [spicedb version](#reference-spicedb-version) - displays the version of SpiceDB
36+
3637

3738
## Reference: `spicedb datastore`
3839

@@ -48,10 +49,11 @@ Operations against the configured datastore
4849

4950
### Children commands
5051

51-
- [spicedb datastore gc](#reference-spicedb-datastore-gc) - executes garbage collection
52-
- [spicedb datastore head](#reference-spicedb-datastore-head) - compute the head (latest) database migration revision available
53-
- [spicedb datastore migrate](#reference-spicedb-datastore-migrate) - execute datastore schema migrations
54-
- [spicedb datastore repair](#reference-spicedb-datastore-repair) - executes datastore repair
52+
- [spicedb datastore gc](#reference-spicedb-datastore-gc) - executes garbage collection
53+
- [spicedb datastore head](#reference-spicedb-datastore-head) - compute the head (latest) database migration revision available
54+
- [spicedb datastore migrate](#reference-spicedb-datastore-migrate) - execute datastore schema migrations
55+
- [spicedb datastore repair](#reference-spicedb-datastore-repair) - executes datastore repair
56+
5557

5658
## Reference: `spicedb datastore gc`
5759

@@ -146,6 +148,8 @@ spicedb datastore gc [flags]
146148
--skip-release-check if true, skips checking for new SpiceDB releases
147149
```
148150

151+
152+
149153
## Reference: `spicedb datastore head`
150154

151155
compute the head (latest) database migration revision available
@@ -177,6 +181,8 @@ spicedb datastore head [flags]
177181
--skip-release-check if true, skips checking for new SpiceDB releases
178182
```
179183

184+
185+
180186
## Reference: `spicedb datastore migrate`
181187

182188
Executes datastore schema migrations for the datastore.
@@ -216,6 +222,8 @@ spicedb datastore migrate [revision] [flags]
216222
--skip-release-check if true, skips checking for new SpiceDB releases
217223
```
218224

225+
226+
219227
## Reference: `spicedb datastore repair`
220228

221229
Executes a repair operation for the datastore
@@ -309,6 +317,8 @@ spicedb datastore repair [flags]
309317
--skip-release-check if true, skips checking for new SpiceDB releases
310318
```
311319

320+
321+
312322
## Reference: `spicedb lsp`
313323

314324
serve language server protocol
@@ -332,17 +342,20 @@ spicedb lsp [flags]
332342
--skip-release-check if true, skips checking for new SpiceDB releases
333343
```
334344

345+
346+
335347
## Reference: `spicedb man`
336348

337349
Generate a man page for SpiceDB.
338-
The output can be redirected to a file and installed to the system:
350+
The output can be redirected to a file and installed to the system:
339351

340352
```
341353
spicedb man > spicedb.1
342354
sudo mv spicedb.1 /usr/share/man/man1/
343355
sudo mandb # Update man page database
344356
```
345357

358+
346359
```
347360
spicedb man
348361
```
@@ -355,6 +368,8 @@ spicedb man
355368
--skip-release-check if true, skips checking for new SpiceDB releases
356369
```
357370

371+
372+
358373
## Reference: `spicedb serve`
359374

360375
start a SpiceDB server
@@ -473,6 +488,7 @@ spicedb serve [flags]
473488
--dispatch-upstream-ca-path string local path to the TLS CA used when connecting to the dispatch cluster
474489
--dispatch-upstream-timeout duration maximum duration of a dispatch call an upstream cluster before it times out (default 1m0s)
475490
--enable-experimental-watchable-schema-cache enables the experimental schema cache, which uses the Watch API to keep the schema up to date
491+
--enable-memory-protection-middleware enables middleware that does a best effort at preventing OOM (Out of Memory) if the server's memory usage is too high by returning ResourceExhausted on incoming requests (default true)
476492
--enable-performance-insight-metrics enables performance insight metrics, which are used to track the latency of API calls by shape
477493
--enable-revision-heartbeat enables support for revision heartbeat, used to create a synthetic revision on an interval defined by the quantization window (Postgres driver only) (default true)
478494
--experimental-dispatch-secondary-maximum-primary-hedging-delays stringToString maximum number of hedging delays to use for each request type to delay the primary request. default is 5ms (default [])
@@ -487,7 +503,7 @@ spicedb serve [flags]
487503
--grpc-max-workers uint32 set the number of workers for this server (0 value means 1 worker per request)
488504
--grpc-network string network type to serve gRPC ("tcp", "tcp4", "tcp6", "unix", "unixpacket") (default "tcp")
489505
--grpc-preshared-key strings (required) preshared key(s) that must be provided by clients to authenticate requests
490-
--grpc-shutdown-grace-period duration amount of time after receiving sigint to continue serving
506+
--grpc-shutdown-grace-period duration time limit given to the server to shutdown gracefully after it receives SIGINT or SIGTERM. A value of zero means no limit
491507
--grpc-tls-cert-path string local path to the TLS certificate used to serve gRPC
492508
--grpc-tls-key-path string local path to the TLS key used to serve gRPC
493509
--http-addr string address to listen on to serve proxy (default ":8443")
@@ -542,6 +558,8 @@ spicedb serve [flags]
542558
--skip-release-check if true, skips checking for new SpiceDB releases
543559
```
544560

561+
562+
545563
## Reference: `spicedb serve-testing`
546564

547565
An in-memory spicedb server which serves completely isolated datastores per client-supplied auth token used.
@@ -603,6 +621,8 @@ spicedb serve-testing [flags]
603621
--skip-release-check if true, skips checking for new SpiceDB releases
604622
```
605623

624+
625+
606626
## Reference: `spicedb version`
607627

608628
displays the version of SpiceDB
@@ -624,3 +644,6 @@ spicedb version [flags]
624644
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
625645
--skip-release-check if true, skips checking for new SpiceDB releases
626646
```
647+
648+
649+

0 commit comments

Comments
 (0)