forked from authzed/spicedb
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request authzed#1738 from josephschorr/datastore-readme
Add missing datastore READMEs
- Loading branch information
Showing
4 changed files
with
24 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# MySQL Datastore | ||
|
||
**Minimum required version** can be found here defined as `MinimumSupportedMySQLVersion` in [version.go](version/version.go) | ||
|
||
This datastore implementation allows you to use a MySQL database as the backing durable storage for SpiceDB. | ||
|
||
## Usage Caveats | ||
|
||
The MySQL datastore only supports a single primary node, and does not support read replicas. It is therefore only recommended for installations that can scale the MySQL instance vertically and cannot be used efficiently in a mulit-region installation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
package version | ||
|
||
// MinimumSupportedMySQLVersion is the minimum version of MySQL supported for this driver. | ||
// | ||
// NOTE: must match a tag on DockerHub for the `mysql` image. | ||
const MinimumSupportedMySQLVersion = "8.0" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Spanner Datastore | ||
|
||
This datastore implementation allows you to use a [Google Cloud Spanner](https://cloud.google.com/spanner) database as the backing durable storage for SpiceDB. | ||
|
||
## Usage Benefits | ||
|
||
The Spanner datastore, like the CockroachDB datastore, can be used in highly scalable and multi-region installations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters