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
fix: correct MySQL DSN format, CockroachDB port, and URL encoding
- MySQL: Use DSN format (user:pass@tcp(host:port)/db?parseTime=true)
instead of URI format (mysql://...) which is incompatible with driver
- CockroachDB: Use correct default port 26257 instead of 5432
- URL encode credentials for Postgres/CockroachDB to handle special chars
- Update tests to use correct MySQL DSN format
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/spicedb.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,17 +87,21 @@ spicedb datastore gc [flags]
87
87
--datastore-connect-rate duration rate at which new connections are allowed to the datastore (at a rate of 1/duration) (cockroach driver only) (default 100ms)
--datastore-follower-read-delay-duration duration amount of time to subtract from non-sync revision timestamps to ensure they are sufficiently in the past to enable follower reads (cockroach and spanner drivers only) or read replicas (postgres and mysql drivers only) (default 4.8s)
94
95
--datastore-gc-interval duration amount of time between passes of garbage collection (postgres driver only) (default 3m0s)
95
96
--datastore-gc-max-operation-time duration maximum amount of time a garbage collection pass can operate before timing out (postgres driver only) (default 1m0s)
96
97
--datastore-gc-window duration amount of time before revisions are garbage collected (default 24h0m0s)
98
+
--datastore-host string datastore host (used to build connection URI if datastore-conn-uri is not provided)
97
99
--datastore-include-query-parameters-in-traces include query parameters in traces (postgres and CRDB drivers only)
98
100
--datastore-max-tx-retries int number of times a retriable transaction should be retried (default 10)
99
101
--datastore-migration-phase string datastore-specific flag that should be used to signal to a datastore which phase of a multi-step migration it is in
100
102
--datastore-mysql-table-prefix string prefix to add to the name of all SpiceDB database tables
103
+
--datastore-password string datastore password (used to build connection URI if datastore-conn-uri is not provided)
104
+
--datastore-port string datastore port (used to build connection URI if datastore-conn-uri is not provided)
101
105
--datastore-prometheus-metrics set to false to disabled metrics from the datastore (do not use for Spanner; setting to false will disable metrics to the configured metrics store in Spanner) (default true)
102
106
--datastore-read-replica-conn-pool-read-healthcheck-interval duration amount of time between connection health checks in a remote datastore's connection pool (default 30s)
103
107
--datastore-read-replica-conn-pool-read-max-idletime duration maximum amount of time a connection can idle in a remote datastore's connection pool (default 30m0s)
@@ -125,6 +129,7 @@ spicedb datastore gc [flags]
125
129
--datastore-spanner-min-sessions uint minimum number of sessions across all Spanner gRPC connections the client can have at a given time (default 100)
126
130
--datastore-tx-overlap-key string static key to touch when writing to ensure transactions overlap (only used if --datastore-tx-overlap-strategy=static is set; cockroach driver only) (default "key")
127
131
--datastore-tx-overlap-strategy string strategy to generate transaction overlap keys ("request", "prefix", "static", "insecure") (cockroach driver only - see https://spicedb.dev/d/crdb-overlap for details) (default "static")
132
+
--datastore-username string datastore username (used to build connection URI if datastore-conn-uri is not provided)
128
133
--datastore-watch-buffer-length uint16 how large the watch buffer should be before blocking (default 1024)
129
134
--datastore-watch-buffer-write-timeout duration how long the watch buffer should queue before forcefully disconnecting the reader (default 1s)
130
135
--datastore-watch-connect-timeout duration how long the watch connection should wait before timing out (cockroachdb driver only) (default 1s)
--datastore-connect-rate duration rate at which new connections are allowed to the datastore (at a rate of 1/duration) (cockroach driver only) (default 100ms)
--datastore-follower-read-delay-duration duration amount of time to subtract from non-sync revision timestamps to ensure they are sufficiently in the past to enable follower reads (cockroach and spanner drivers only) or read replicas (postgres and mysql drivers only) (default 4.8s)
263
269
--datastore-gc-interval duration amount of time between passes of garbage collection (postgres driver only) (default 3m0s)
264
270
--datastore-gc-max-operation-time duration maximum amount of time a garbage collection pass can operate before timing out (postgres driver only) (default 1m0s)
265
271
--datastore-gc-window duration amount of time before revisions are garbage collected (default 24h0m0s)
272
+
--datastore-host string datastore host (used to build connection URI if datastore-conn-uri is not provided)
266
273
--datastore-include-query-parameters-in-traces include query parameters in traces (postgres and CRDB drivers only)
267
274
--datastore-max-tx-retries int number of times a retriable transaction should be retried (default 10)
268
275
--datastore-migration-phase string datastore-specific flag that should be used to signal to a datastore which phase of a multi-step migration it is in
269
276
--datastore-mysql-table-prefix string prefix to add to the name of all SpiceDB database tables
277
+
--datastore-password string datastore password (used to build connection URI if datastore-conn-uri is not provided)
278
+
--datastore-port string datastore port (used to build connection URI if datastore-conn-uri is not provided)
270
279
--datastore-prometheus-metrics set to false to disabled metrics from the datastore (do not use for Spanner; setting to false will disable metrics to the configured metrics store in Spanner) (default true)
271
280
--datastore-read-replica-conn-pool-read-healthcheck-interval duration amount of time between connection health checks in a remote datastore's connection pool (default 30s)
272
281
--datastore-read-replica-conn-pool-read-max-idletime duration maximum amount of time a connection can idle in a remote datastore's connection pool (default 30m0s)
--datastore-spanner-min-sessions uint minimum number of sessions across all Spanner gRPC connections the client can have at a given time (default 100)
295
304
--datastore-tx-overlap-key string static key to touch when writing to ensure transactions overlap (only used if --datastore-tx-overlap-strategy=static is set; cockroach driver only) (default "key")
296
305
--datastore-tx-overlap-strategy string strategy to generate transaction overlap keys ("request", "prefix", "static", "insecure") (cockroach driver only - see https://spicedb.dev/d/crdb-overlap for details) (default "static")
306
+
--datastore-username string datastore username (used to build connection URI if datastore-conn-uri is not provided)
297
307
--datastore-watch-buffer-length uint16 how large the watch buffer should be before blocking (default 1024)
298
308
--datastore-watch-buffer-write-timeout duration how long the watch buffer should queue before forcefully disconnecting the reader (default 1s)
299
309
--datastore-watch-connect-timeout duration how long the watch connection should wait before timing out (cockroachdb driver only) (default 1s)
@@ -417,17 +427,21 @@ spicedb serve [flags]
417
427
--datastore-connect-rate duration rate at which new connections are allowed to the datastore (at a rate of 1/duration) (cockroach driver only) (default 100ms)
--datastore-follower-read-delay-duration duration amount of time to subtract from non-sync revision timestamps to ensure they are sufficiently in the past to enable follower reads (cockroach and spanner drivers only) or read replicas (postgres and mysql drivers only) (default 4.8s)
424
435
--datastore-gc-interval duration amount of time between passes of garbage collection (postgres driver only) (default 3m0s)
425
436
--datastore-gc-max-operation-time duration maximum amount of time a garbage collection pass can operate before timing out (postgres driver only) (default 1m0s)
426
437
--datastore-gc-window duration amount of time before revisions are garbage collected (default 24h0m0s)
438
+
--datastore-host string datastore host (used to build connection URI if datastore-conn-uri is not provided)
427
439
--datastore-include-query-parameters-in-traces include query parameters in traces (postgres and CRDB drivers only)
428
440
--datastore-max-tx-retries int number of times a retriable transaction should be retried (default 10)
429
441
--datastore-migration-phase string datastore-specific flag that should be used to signal to a datastore which phase of a multi-step migration it is in
430
442
--datastore-mysql-table-prefix string prefix to add to the name of all SpiceDB database tables
443
+
--datastore-password string datastore password (used to build connection URI if datastore-conn-uri is not provided)
444
+
--datastore-port string datastore port (used to build connection URI if datastore-conn-uri is not provided)
431
445
--datastore-prometheus-metrics set to false to disabled metrics from the datastore (do not use for Spanner; setting to false will disable metrics to the configured metrics store in Spanner) (default true)
432
446
--datastore-read-replica-conn-pool-read-healthcheck-interval duration amount of time between connection health checks in a remote datastore's connection pool (default 30s)
433
447
--datastore-read-replica-conn-pool-read-max-idletime duration maximum amount of time a connection can idle in a remote datastore's connection pool (default 30m0s)
@@ -456,6 +470,7 @@ spicedb serve [flags]
456
470
--datastore-spanner-min-sessions uint minimum number of sessions across all Spanner gRPC connections the client can have at a given time (default 100)
457
471
--datastore-tx-overlap-key string static key to touch when writing to ensure transactions overlap (only used if --datastore-tx-overlap-strategy=static is set; cockroach driver only) (default "key")
458
472
--datastore-tx-overlap-strategy string strategy to generate transaction overlap keys ("request", "prefix", "static", "insecure") (cockroach driver only - see https://spicedb.dev/d/crdb-overlap for details) (default "static")
473
+
--datastore-username string datastore username (used to build connection URI if datastore-conn-uri is not provided)
459
474
--datastore-watch-buffer-length uint16 how large the watch buffer should be before blocking (default 1024)
460
475
--datastore-watch-buffer-write-timeout duration how long the watch buffer should queue before forcefully disconnecting the reader (default 1s)
461
476
--datastore-watch-connect-timeout duration how long the watch connection should wait before timing out (cockroachdb driver only) (default 1s)
0 commit comments