connector

type Connector interface {
	// Sync is a request for a sync with Fivetran, the response should contain the (partial) sync
	Sync(ctx context.Context, req *Request) (*Response, error)
}

type Request struct {
	Agent   string  `json:"agent"`
	State   State   `json:"state"`
	Secrets Secrets `json:"secrets"`
}

type Response struct {
	State   State                           `json:"state"`
	Insert  ResponseInserts                 `json:"insert"`
	Delete  ResponseDeletes                 `json:"delete"`
	Schema  map[string]*ResponseTableSchema `json:"schema"`
	HasMore bool                            `json:"hasMore"`
}

type ResponseDeletes map[string][]any

type ResponseInserts map[string][]any

type ResponseTableSchema struct {
	PrimaryKey []string `json:"primary_key"`
}

type Secrets map[string]string

type State map[string]string

type Table struct {
	// Name the name of the table
	Name string

	// State opaque string to represent the current 'state' of the sync, usually a database cursor
	State string

	// PrimaryKey the list of primary keys used for updates and deletes
	PrimaryKey []string

	// InsertRows additional rows to insert or update
	InsertRows []any

	// DeleteRows rows to mark deleted, providing just the id column suffices
	DeleteRows []any

	// HasMore whether the connector could provide more data or all is synced
	HasMore bool
}

type TableConnector interface {
	// Name the name of the table
	Name() string

	// Sync synchronizes a table, starting from a previous state and returning the new data
	// as well as an updated state
	Sync(ctx context.Context, state string, secrets map[string]string) (*Table, error)
}