database

type Connection ¶

type Connection interface {

	// Query executes a SQL query against Firebolt and returns the result.
	// The sql parameter can be any valid Firebolt SQL statement, including
	// SELECT, INSERT, UPDATE, DELETE, etc.
	Query(ctx context.Context, sql string, args ...any) ([]map[string]any, error)
}

Connection defines the methods for interacting with Firebolt via SQL.

It provides a standardized interface to execute queries against a Firebolt database instance while abstracting away the underlying implementation details of the connection.

type ConnectionCloser ¶

type ConnectionCloser interface {
	Connection

	// Close terminates the underlying database connection and releases
	// all associated resources.
	Close()
}

ConnectionCloser extends the Connection interface to include a method for closing the connection.

func NewConnection(
	logger *slog.Logger,
	params DSNProvider,
) (ConnectionCloser, func(), error)

type ConnectionParams ¶

type ConnectionParams struct {
	ClientID     string
	ClientSecret string
	AccountName  string
	DatabaseName *string
	EngineName   *string
}

ConnectionParams holds the parameters required to establish a connection to Firebolt. It contains authentication credentials, account information, and optional database and engine specifications.

func (c ConnectionParams) DSN() string

func (c ConnectionParams) DriverName() string

func (c ConnectionParams) Hash() string

func (c ConnectionParams) String() string

type DSNProvider ¶

type DSNProvider interface {

	// DriverName returns the name of the database driver.
	DriverName() string

	// DSN returns the Data Source Name (DSN) for the connection.
	DSN() string
}

DSNProvider defines the interface for providing a Data Source Name (DSN). The only DSNProvider implementation is ConnectionParams, but this interface allows to write mock implementations for testing purposes.

type NewConnectionFunc ¶

type NewConnectionFunc func(*slog.Logger, DSNProvider) (ConnectionCloser, func(), error)

NewConnectionFunc defines a function type for creating new connections.

type Pool ¶

type Pool interface {

	// GetConnection returns a connection for the specified parameters.
	// It first checks if a matching connection exists in the pool.
	// If not found, it creates a new connection, adds it to the pool, and returns it.
	GetConnection(params PoolParams) (Connection, error)

	// Close closes all connections in the pool and releases associated resources.
	Close()
}

Pool implements a thread-safe connection pool for Firebolt database connections.

This MCP server is designed to provide access to multiple Firebolt accounts and databases simultaneously, which the current identity has access to. Since the Firebolt Go SDK creates connections to a single account only, we need to maintain a pool of connections to different accounts.

The implementation creates a pool of connections for different combinations of: - Accounts - Databases - Engines

This approach helps LLMs switch between different databases and engines with fewer mistakes, trading some connection efficiency for improved reliability.

func NewPool(logger *slog.Logger, clientID, clientSecret string) (Pool, func())

func NewPoolWithConnectionFactory(
	logger *slog.Logger,
	clientID, clientSecret string,
	newConnectionFunc NewConnectionFunc,
) (Pool, func())

type PoolParams ¶

type PoolParams struct {
	AccountName  string
	DatabaseName *string
	EngineName   *string
}

PoolParams holds the parameters required to create a connection in the pool. The pool will convert these parameters into a ConnectionParams struct by adding the ClientID and ClientSecret.