db

type ColumnKey struct {
	Schema string
	Table  string
	Column string
}

type ConnectionConfig struct {
	DataSource        *storepb.DataSource
	ConnectionContext ConnectionContext
	Password          string
}

type ConnectionContext struct {
	EnvironmentID string
	InstanceID    string
	EngineVersion string
	// UseDatabaseOwner is used by Postgres for using role of database owner.
	UseDatabaseOwner bool
	DatabaseName     string
	// It's only set for Redshift datashare database.
	DataShare bool
	// ReadOnly is only supported for Postgres at the moment.
	ReadOnly bool
}

type ConstraintKey struct {
	Schema     string
	Constraint string
}

type Driver interface {
	// General execution
	// A driver might support multiple engines (e.g. MySQL driver can support both MySQL and TiDB),
	// So we pass the dbType to tell the exact engine.
	Open(ctx context.Context, dbType storepb.Engine, config ConnectionConfig) (Driver, error)
	// Remember to call Close to avoid connection leak
	Close(ctx context.Context) error
	Ping(ctx context.Context) error
	GetDB() *sql.DB

	// Sync schema
	// SyncInstance syncs the instance metadata.
	SyncInstance(ctx context.Context) (*InstanceMetadata, error)
	// SyncDBSchema syncs a single database schema. A database the target no
	// longer has must be reported as common.NotFound (not as a plain error), so a
	// caller can mirror the target's inventory instead of guessing from the
	// message; every other failure keeps its own error.
	SyncDBSchema(ctx context.Context) (*storepb.DatabaseSchemaMetadata, error)
}

type IndexKey struct {
	Schema string
	Table  string
	Index  string
}

type InstanceMetadata struct {
	Version string
	// Simplified database metadata.
	Databases []*storepb.DatabaseSchemaMetadata
	Metadata  *storepb.Instance
}

type MigrationStatus string

type ObjectDefinitionReader interface {
	// GetObjectDefinition returns the DDL of the named object. ok is false when
	// this engine has no definition for that object type; the caller then falls
	// back to reconstruction.
	GetObjectDefinition(ctx context.Context, objectType storepb.MetaType, name string) (definition string, ok bool, err error)
}

type SequenceKey struct {
	Schema   string
	Sequence string
}

type TableKey struct {
	Schema string
	Table  string
}

type TableKeyWithColumns struct {
	Schema  string
	Table   string
	Columns []*storepb.ColumnMetadata
}