sqlds

package module

Go to main page

Versions in this module

v4

v4.2.3

Jun 5, 2025

v4.2.2

Apr 23, 2025

v4.2.1

Mar 26, 2025

Changes in this version

type DriverSettings

+ RowLimit int64

type SQLDatasource

+ func (ds *SQLDatasource) SetDefaultRowLimit(limit int64)

v4.2.0

Mar 19, 2025

Changes in this version

type SQLDatasource

+ EnableRowLimit bool

+ func (ds *SQLDatasource) GetRowLimit() int64

v4.1.7

Jan 14, 2025

v4.1.6

Jan 6, 2025

v4.1.5

Dec 13, 2024

Changes in this version

type HealthChecker

+ PostCheckHealth func(ctx context.Context, req *backend.CheckHealthRequest) *backend.CheckHealthResult

+ PreCheckHealth func(ctx context.Context, req *backend.CheckHealthRequest) *backend.CheckHealthResult

type SQLDatasource

+ PostCheckHealth func(ctx context.Context, req *backend.CheckHealthRequest) *backend.CheckHealthResult

+ PreCheckHealth func(ctx context.Context, req *backend.CheckHealthRequest) *backend.CheckHealthResult

type SQLMock

+ ShouldFailToConnect bool

v4.1.4

Nov 8, 2024

Changes in this version

+ var ErrorParsingMacroBrackets = errors.New("failed to parse macro arguments (missing close bracket?)")

v4.1.3

Nov 1, 2024

Changes in this version

type Connector

+ func (c *Connector) Dispose()

v4.1.2

Sep 30, 2024

v4.1.1

Aug 30, 2024

v4.1.0

Jul 26, 2024

Changes in this version

+ type CheckHealthMutator interface

+ MutateCheckHealth func(ctx context.Context, req *backend.CheckHealthRequest) (context.Context, *backend.CheckHealthRequest)

+ type QueryDataMutator interface

+ MutateQueryData func(ctx context.Context, req *backend.QueryDataRequest) (context.Context, *backend.QueryDataRequest)

v4.0.0

Jul 9, 2024

Changes in this version

+ const EndpointHealth

+ const EndpointQuery

+ const FormatOptionLogs

+ const FormatOptionMulti

+ const FormatOptionTable

+ const FormatOptionTimeSeries

+ const FormatOptionTrace

+ const MockDataFolder

+ const SourceDownstream

+ const SourcePlugin

+ const StatusError

+ const StatusOK

+ var DefaultMacros = sqlutil.DefaultMacros

+ var ErrorBadArgumentCount = errors.New("unexpected number of arguments")

+ var ErrorBadDatasource = errors.New("type assertion to datasource failed")

+ var ErrorJSON = errors.New("error unmarshaling query JSON the Query Model")

+ var ErrorMissingDBConnection = PluginError(errors.New("unable to get default db connection"))

+ var ErrorMissingMultipleConnectionsConfig = PluginError(errors.New("received connection arguments but the feature is not enabled"))

+ var ErrorNoResults = errors.New("no results returned from query")

+ var ErrorNotImplemented = errors.New("not implemented")

+ var ErrorQuery = errors.New("error querying the database")

+ var ErrorTimeout = errors.New("query timeout exceeded")

+ var ErrorWrongOptions = errors.New("error reading query options")

+ var HeaderKey = "grafana-http-headers"

+ var MissingDBConnection = ErrorMissingDBConnection

+ var MissingMultipleConnectionsConfig = ErrorMissingMultipleConnectionsConfig

+ func CreateMockData(table string, folder string, csvData string) error

+ func CreateMockTable(table string, folder string) error

+ func DownstreamError(err error, override ...bool) error

+ func ErrorSource(err error) backend.ErrorSource

+ func Interpolate(driver Driver, query *Query) (string, error)

+ func PluginError(err error, override ...bool) error

+ type Completable interface

+ Columns func(ctx context.Context, options Options) ([]string, error)

+ Schemas func(ctx context.Context, options Options) ([]string, error)

+ Tables func(ctx context.Context, options Options) ([]string, error)

+ type Connection interface

+ Close func() error

+ Ping func() error

+ PingContext func(ctx context.Context) error

+ QueryContext func(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)

+ type Connector struct

+ UID string

+ func NewConnector(ctx context.Context, driver Driver, ...) (*Connector, error)

+ func (c *Connector) Connect(ctx context.Context, headers http.Header) (*dbConnection, error)

+ func (c *Connector) GetConnectionFromQuery(ctx context.Context, q *Query) (string, dbConnection, error)

+ func (c *Connector) Reconnect(ctx context.Context, dbConn dbConnection, q *Query, cacheKey string) (*sql.DB, error)

+ type DBQuery struct

+ DB Connection

+ DSName string

+ Settings backend.DataSourceInstanceSettings

+ func NewQuery(db Connection, settings backend.DataSourceInstanceSettings, ...) *DBQuery

+ func (q *DBQuery) Run(ctx context.Context, query *Query, args ...interface{}) (data.Frames, error)

+ type Driver interface

+ Connect func(context.Context, backend.DataSourceInstanceSettings, json.RawMessage) (*sql.DB, error)

+ Converters func() []sqlutil.Converter

+ Macros func() Macros

+ Settings func(context.Context, backend.DataSourceInstanceSettings) DriverSettings

+ type DriverSettings struct

+ Errors bool

+ FillMode *data.FillMissing

+ ForwardHeaders bool

+ Pause int

+ Retries int

+ RetryOn []string

+ Timeout time.Duration

+ type Endpoint string

+ type FormatQueryOption = sqlutil.FormatQueryOption

+ type HealthChecker struct

+ Connector *Connector

+ Metrics Metrics

+ func (hc *HealthChecker) Check(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error)

+ type MacroFunc = sqlutil.MacroFunc

+ type Macros = sqlutil.Macros

+ type Metrics struct

+ DSName string

+ DSType string

+ Endpoint Endpoint

+ func NewMetrics(dsName, dsType string, endpoint Endpoint) Metrics

+ func (m *Metrics) CollectDuration(source Source, status Status, duration float64)

+ func (m *Metrics) WithEndpoint(endpoint Endpoint) Metrics

+ type Options map[string]string

+ func ParseOptions(rawOptions json.RawMessage) (Options, error)

+ type Query = sqlutil.Query

+ func GetQuery(query backend.DataQuery, headers http.Header, setHeaders bool) (*Query, error)

+ type QueryArgSetter interface

+ SetQueryArgs func(ctx context.Context, headers http.Header) []interface{}

+ type QueryMutator interface

+ MutateQuery func(ctx context.Context, req backend.DataQuery) (context.Context, backend.DataQuery)

+ type Response struct

+ func NewResponse(res *backend.QueryDataResponse) *Response

+ func (r *Response) Response() *backend.QueryDataResponse

+ func (r *Response) Set(refID string, res backend.DataResponse)

+ type ResponseMutator interface

+ MutateResponse func(ctx context.Context, res data.Frames) (data.Frames, error)

+ type SQLDatasource struct

+ CustomRoutes map[string]func(http.ResponseWriter, *http.Request)

+ EnableMultipleConnections bool

+ func NewDatasource(c Driver) *SQLDatasource

+ func (ds *SQLDatasource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error)

+ func (ds *SQLDatasource) Dispose()

+ func (ds *SQLDatasource) DriverSettings() DriverSettings

+ func (ds *SQLDatasource) GetDBFromQuery(ctx context.Context, q *Query) (*sql.DB, error)

+ func (ds *SQLDatasource) NewDatasource(ctx context.Context, settings backend.DataSourceInstanceSettings) (instancemgmt.Instance, error)

+ func (ds *SQLDatasource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error)

+ type SQLMock struct

+ func (h *SQLMock) Connect(_ context.Context, _ backend.DataSourceInstanceSettings, msg json.RawMessage) (*sql.DB, error)

+ func (h *SQLMock) Converters() []sqlutil.Converter

+ func (h *SQLMock) Macros() Macros

+ func (h *SQLMock) Settings(_ context.Context, _ backend.DataSourceInstanceSettings) DriverSettings

+ type Source string

+ type Status string

Other modules containing this package

github.com/grafana/sqlds

github.com/grafana/sqlds/v2

github.com/grafana/sqlds/v3

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL