adapters

type DBAdapter interface {
	Open(dbURL string) (*sqlx.DB, error)
	// TODO: incrementally refactor DBAdapter to be responsible for actually _doing_ the queries,
	// TODO: legacy stringly queries:
	// TypeMapping maps generic SQL column types to db adapter dependent column types
	TypeMapping(sqlColumnType types.SQLColumnType) (string, error)
	// ErrorEquals compares generic SQL errors to db adapter dependent errors
	ErrorEquals(err error, sqlErrorType types.SQLErrorType) bool
	// SecureColumnName returns columns with proper delimiters to ensure well formed column names
	SecureName(name string) string
	// CreateTableQuery builds a CREATE TABLE query to create a new table
	CreateTableQuery(tableName string, columns []*types.SQLTableColumn) (string, string)
	// FindTableQuery builds a SELECT query to check if a table exists
	FindTableQuery() string
	// TableDefinitionQuery builds a SELECT query to get a table structure from the Dictionary table
	TableDefinitionQuery() string
	// AlterColumnQuery builds an ALTER COLUMN query to alter a table structure (only adding columns is supported)
	AlterColumnQuery(tableName, columnName string, sqlColumnType types.SQLColumnType, length, order int) (string, string)
	// SelectRowQuery builds a SELECT query to get row values
	SelectRowQuery(tableName, fields, indexValue string) string
	// SelectLogQuery builds a SELECT query to get all tables involved in a given block transaction
	SelectLogQuery() string
	// InsertLogQuery builds an INSERT query to store data in Log table
	InsertLogQuery() string
	// UpsertQuery builds an INSERT... ON CONFLICT (or similar) query to upsert data in event tables based on PK
	UpsertQuery(table *types.SQLTable, row types.EventDataRow) (types.UpsertDeleteQuery, interface{}, error)
	// DeleteQuery builds a DELETE FROM event tables query based on PK
	DeleteQuery(table *types.SQLTable, row types.EventDataRow) (types.UpsertDeleteQuery, error)
	// RestoreDBQuery builds a list of sql clauses needed to restore the db to a point in time
	RestoreDBQuery() string
	// CleanDBQueries returns necessary queries to clean the database
	CleanDBQueries() types.SQLCleanDBQuery
	// DropTableQuery builds a DROP TABLE query to delete a table
	DropTableQuery(tableName string) string
	// Get the schema qualified name of the given table
	SchemaName(tableName string) string
}

type DBNotifyTriggerAdapter interface {
	// Create a SQL function that notifies on channel with the payload of columns - the payload containing the value
	// of each column will be sent once whenever any of the columns changes. Expected to replace existing function.
	CreateNotifyFunctionQuery(function, channel string, columns ...string) string
	// Create a trigger that fires the named function after any operation on a row in table. Expected to replace existing
	// trigger.
	CreateTriggerQuery(triggerName, tableName, functionName string) string
}

type PostgresAdapter struct {
	Schema string
	types.SQLNames
	Log *logging.Logger
}

type SQLiteAdapter struct {
	Log *logging.Logger
}