# README
MySQL Datastore
Minimum required version can be found here defined as MinimumSupportedMySQLVersion in 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.
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
AllowedMigrations configures a set of additional migrations that will pass the health check (head migration is always allowed).
ConnMaxIdleTime is the duration after which an idle connection will be automatically closed.
ConnMaxLifetime is the duration since creation after which a connection will be automatically closed.
CredentialsProviderName is the name of the CredentialsProvider implementation to use for dynamically retrieving the datastore credentials at runtime
Empty by default.
DebugAnalyzeBeforeStatistics signals to the Statistics method that it should run Analyze Table on the relationships table before returning statistics.
FilterMaximumIDCount is the maximum number of IDs that can be used to filter IDs in queries.
GCEnabled indicates whether garbage collection is enabled.
GCInterval is the interval at which garbage collection will occur.
GCMaxOperationTime is the maximum operation time of a garbage collection pass before it times out.
GCWindow is the maximum age of a passed revision that will be considered valid.
MaxOpenConns is the maximum size of the connection pool.
MaxRetries is the maximum number of times a retriable transaction will be client-side retried.
MaxRevisionStalenessPercent is the amount of time, expressed as a percentage of the revision quantization window, that a previously computed rounded revision can still be advertised after the next rounded revision would otherwise be ready.
NewMySQLDatastore creates a new mysql.Datastore value configured with the MySQL instance specified in through the URI parameter.
NewQueryBuilder returns a new QueryBuilder instance.
No description provided by the author
OverrideLockWaitTimeout sets the lock wait timeout on each new connection established with the databases.
RevisionQuantization is the time bucket size to which advertised revisions will be rounded.
TablePrefix allows defining a MySQL table name prefix.
WatchBufferLength is the number of entries that can be stored in the watch buffer while awaiting read by the client.
WatchBufferWriteTimeout is the maximum timeout for writing to the watch buffer, after which the caller to the watch will be disconnected.
WithColumnOptimization configures the column optimization strategy for the MySQL datastore.
WithEnablePrometheusStats marks whether Prometheus metrics provided by Go's database/sql package are enabled.
WithExpirationDisabled disables the expiration of relationships in the MySQL datastore.
# Constants
No description provided by the author
# Variables
No description provided by the author
# Structs
Datastore is a MySQL-based implementation of the datastore.Datastore interface.
QueryBuilder captures all parameterizable queries used by the MySQL datastore implementation.
# Type aliases
Option provides the facility to configure how clients within the MySQL datastore interact with the running MySQL database.