Documentation
¶
Overview ¶
Package sqlite provides an interface for writing to a SQLite database.
Index ¶
- func RegisterDatabaseClient(i do.Injector)
- type Client
- func (q *Client) Close() error
- func (q *Client) CurrentTime() time.Time
- func (*Client) Dialect() dialect.Dialect
- func (q *Client) IsReady(ctx context.Context) bool
- func (q *Client) ReadDB() *sql.DB
- func (q *Client) Reader() database.SQLQueryExecutor
- func (q *Client) RollbackTransaction(ctx context.Context, tx database.SQLQueryExecutorAndTransactionManager)
- func (q *Client) WithTransaction(ctx context.Context, fn func(tx database.Tx) error) error
- func (q *Client) WithTransactionOptions(ctx context.Context, fn func(tx database.Tx) error, opts ...database.TxOption) error
- func (q *Client) WriteDB() *sql.DB
- func (q *Client) Writer() database.SQLQueryExecutor
- type Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterDatabaseClient ¶
RegisterDatabaseClient registers a database.Client with the injector. Prerequisite: database.ClientConfig must be registered (e.g. via databasecfg.RegisterClientConfig).
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the primary database querying client.
func NewDatabaseClient ¶
func NewDatabaseClient(ctx context.Context, cfg database.ClientConfig, opts ...Option) (*Client, error)
NewDatabaseClient provides a new DataManager client. If a metrics provider is supplied via WithMetricsProvider, the DB driver will use it so SQL latency and other db.sql.* metrics are emitted (e.g. db_sql_latency_milliseconds_bucket in Prometheus).
func (*Client) CurrentTime ¶
CurrentTime reads the clock this client was built with.
func (*Client) Dialect ¶
Dialect reports the SQL dialect this client speaks, which is always dialect.SQLite.
func (*Client) Reader ¶
func (q *Client) Reader() database.SQLQueryExecutor
Reader returns a non-transactional executor for the read database.
func (*Client) RollbackTransaction ¶
func (q *Client) RollbackTransaction(ctx context.Context, tx database.SQLQueryExecutorAndTransactionManager)
RollbackTransaction rolls tx back, recording a failure on a span rather than returning it.
func (*Client) WithTransaction ¶
WithTransaction runs fn inside a transaction on the write database, committing on a nil return and rolling back on error or panic. See database.RunInTransaction.
func (*Client) WithTransactionOptions ¶ added in v2.9.0
func (q *Client) WithTransactionOptions(ctx context.Context, fn func(tx database.Tx) error, opts ...database.TxOption) error
WithTransactionOptions is WithTransaction configured by opts, which satisfies database.TxOptionsAccess. Callers reach it through database.WithTransaction.
SQLite has one writer, so there is no conflict for database.RetryOnConflict to retry: it is accepted and runs fn once.
func (*Client) WriteDB ¶
WriteDB provides the database object. It satisfies database.RawAccess; prefer Writer and WithTransaction on the Client interface.
func (*Client) Writer ¶
func (q *Client) Writer() database.SQLQueryExecutor
Writer returns a non-transactional executor for the write database.
type Option ¶
type Option func(*options)
Option configures the database client this package constructs. The zero configuration works: an absent logger logs nowhere, an absent tracer provider traces nowhere, and an absent metrics provider emits no metrics.
func WithMetricsProvider ¶
WithMetricsProvider attaches a metrics provider; the DB driver uses it to emit SQL latency and other db.sql.* metrics.
func WithTracerProvider ¶
WithTracerProvider attaches a tracer provider, enabling spans on every database operation.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package tableaccess is the SQLite database.Manager, and every one of its operations refuses.
|
Package tableaccess is the SQLite database.Manager, and every one of its operations refuses. |