db

type Aircraft struct {
	ID        uint64    `db:"id"`
	Icao      string    `db:"icao"`
	CreatedAt time.Time `db:"created_at"`
	UpdatedAt time.Time `db:"updated_at"`
}

type Database interface {
	// Transaction takes a function to execute inside a transaction context.
	// If the function returns an error, the transaction is rolled back.
	Transaction(f func(tx *sqlx.Tx) error) error

	// CreateProject creates a Project record.
	CreateProject(projectName string, now time.Time) (sql.Result, error)
	// GetProject searches for a Project by its name. If the project exists
	// it will be returned. Otherwise an error will be returned.
	GetProject(projectName string) (*Project, error)

	// CreateSession creates a new Session for a particular project.
	CreateSession(project *Project, identifier string, withSquawks bool, withTxTypes bool, withCallSigns bool) (sql.Result, error)
	// GetSessionByIdentifier searches for a Session belonging to the provided project.
	// If the Session exists it will be returned. Otherwise an error is returned.
	GetSessionByIdentifier(project *Project, identifier string) (*Session, error)
	// CloseSession marks the Session as closed. The sql.Result is returned
	// if the query was successful, otherwise an error is returned.
	CloseSession(session *Session, closedAt time.Time) (sql.Result, error)

	// GetAircraftByIcao searches for an Aircraft using it's hex ICAO. If the
	// Aircraft exists it will be returned. Otherwise an error is returned.
	GetAircraftByIcao(icao string) (*Aircraft, error)
	// GetAircraftById searches for an Aircraft using it's ID. If the
	// Aircraft exists it will be returned. Otherwise an error is returned.
	GetAircraftByID(id uint64) (*Aircraft, error)
	// CreateAircraft creates an Aircraft for the specified icao.
	CreateAircraft(icao string, firstSeenTime time.Time) (sql.Result, error)

	// CreateSighting creates a sighting for ac on the provided Session. A sql.Result
	// is returned if the query was successful. Otherwise an error is returned.
	CreateSighting(session *Session, ac *Aircraft, firstSeenTime time.Time) (sql.Result, error)
	// CreateSightingTx creates a sighting for ac on the provided Session, executing
	// the query with the provided transaction. A sql.Result is returned if the query
	// was successful. Otherwise an error is returned.
	CreateSightingTx(tx *sqlx.Tx, session *Session, ac *Aircraft, firstSeenTime time.Time) (sql.Result, error)
	// GetSightingById searches for a Sighting with the provided ID. The Sighting is returned
	// if one was found. Otherwise an error is returned.
	GetSightingByID(sightingID uint64) (*Sighting, error)
	// GetSightingById searches for a Sighting with the provided ID, executing the query
	// with the provided transaction. The Sighting is returned if one was found. Otherwise
	// an error is returned.
	GetSightingByIDTx(tx *sqlx.Tx, sightingID uint64) (*Sighting, error)
	// GetLastSighting searches for a Sighting for ac in the provided Session. The Sighting
	// is returned if one was found. Otherwise an error is returned.
	GetLastSighting(session *Session, ac *Aircraft) (*Sighting, error)
	// GetLastSightingTx searches for a Sighting for ac in the provided Session, executing
	// the query with the provided transaction. The Sighting is returned if one was found.
	// Otherwise an error is returned.
	GetLastSightingTx(tx *sqlx.Tx, session *Session, ac *Aircraft) (*Sighting, error)
	// ReopenSighting updates the provided Sighting to mark it as open. A sql.Result
	// is returned if the query was successful. Otherwise an error is returned.
	ReopenSighting(sighting *Sighting) (sql.Result, error)
	// ReopenSightingTx updates the provided Sighting to mark it as open, executing
	// the query with the provided transaction. A sql.Result is returned if the query
	// was successful. Otherwise an error is returned.
	ReopenSightingTx(tx *sqlx.Tx, sighting *Sighting) (sql.Result, error)
	// CloseSightingBatch takes a list of sightings and marks them as closed in a batch.
	// If successful, nil is returned. Otherwise an error is returned.
	CloseSightingBatch(sightings []*Sighting, closedAt time.Time) error
	// UpdateSightingCallsignTx updates the Sighting.Callsign to the provided callsign.
	// A sql.Result is returned if the query is successful. Otherwise an error is returned.
	UpdateSightingCallsignTx(tx *sqlx.Tx, sighting *Sighting, callsign string) (sql.Result, error)
	// UpdateSightingSquawkTx updates the Sighting.Squawk to the provided squawk.
	// A sql.Result is returned if the query is successful. Otherwise an error is returned.
	UpdateSightingSquawkTx(tx *sqlx.Tx, sighting *Sighting, squawk string) (sql.Result, error)

	// CreateNewSightingCallSignTx inserts a new SightingCallSign for a sighting, executing
	// the query on the provided tx. A sql.Result is returned if the query was successful.
	// Otherwise an error is returned.
	CreateNewSightingCallSignTx(tx *sqlx.Tx, sighting *Sighting, callsign string, observedAt time.Time) (sql.Result, error)
	// CreateNewSightingSquawkTx inserts a new SightingSquaqk for a sighting, executing
	// the query on the provided tx. A sql.Result is returned if the query was successful.
	// Otherwise an error is returned.
	CreateNewSightingSquawkTx(tx *sqlx.Tx, sighting *Sighting, squawk string, observedAt time.Time) (sql.Result, error)

	// CreateSightingLocation inserts a new SightingCallSign for a sighting. A sql.Result is
	// returned if the query was successful. Otherwise an error is returned.
	CreateSightingLocation(sightingID uint64, t time.Time, altitude int64, lat float64, long float64) (sql.Result, error)
	// CreateSightingLocationTx inserts a new SightingLocation for a sighting, executing
	// the query on the provided tx. A sql.Result is returned if the query was successful.
	// Otherwise an error is returned.
	CreateSightingLocationTx(tx *sqlx.Tx, sightingID uint64, t time.Time, altitude int64, lat float64, long float64) (sql.Result, error)
	// LoadLocationHistory searches for SightingLocation records for the provided Sighting.
	// lastID should initially be zero, and in subsequent calls the ID of the last processed
	// row should be used instead. At most batchSize results will be returned. If the query
	// succeeds, the rows are returned (and must be closed by the caller). If unsuccessful
	// an error is returned.
	LoadLocationHistory(sighting *Sighting, lastID int64, batchSize int64) (*sqlx.Rows, error)
	// WalkLocationHistoryBatch searches for SightingLocation records by loading at most
	// batchSize results at a time, invoking f with each batch of results. An error is returned
	// if we were unsuccessful.
	WalkLocationHistoryBatch(sighting *Sighting, batchSize int64, f func([]SightingLocation)) error
	// GetFullLocationHistory queries for all SightingLocation records. Internally, use batchSize
	// to limit the number of rows returned by each query. If successful, the full location history
	// is returned. Otherwise, an error will be returned.
	GetFullLocationHistory(sighting *Sighting, batchSize int64) ([]SightingLocation, error)

	// GetSightingKml queries for a SightingKml record for the provided Sighting. The SightingKml
	// is returned if found, otherwise an error is returned.
	GetSightingKml(sighting *Sighting) (*SightingKml, error)
	// UpdateSightingKml commits an updated KML field to the database. A sql.Result is returned
	// if the query was successful, otherwise an error is returned.
	UpdateSightingKml(sightingKml *SightingKml) (sql.Result, error)
	// CreateSightingKmlContent creates a SightingKml record for the provided Sighting. A sql.Result is
	// returned if the query was successful, otherwise an error is returned.
	CreateSightingKmlContent(sighting *Sighting, kmlData []byte) (sql.Result, error)

	// CreateEmailJobTx inserts a new Email record, executing the query on the provided tx. A
	// sql.Result is returned if the query was successful, otherwise an error is returned.
	CreateEmailJobTx(tx *sqlx.Tx, createdAt time.Time, content []byte) (sql.Result, error)
	// GetPendingEmailJobs searches for non-failed emails with a retryTime less than or equal to
	// currentTime. A list of Email records is returned if successful, otherwise an error is
	// returned.
	GetPendingEmailJobs(currentTime time.Time) ([]Email, error)
	// DeleteCompletedEmailTx deletes the specified job, executing the query on the provided tx.
	// A sql.Result is returned if the query was successful, otherwise an error is returned.
	DeleteCompletedEmailTx(tx *sqlx.Tx, job Email) (sql.Result, error)
	// MarkEmailFailedTx sets job's status to failed, executing the query on the provided tx.
	// A sql.Result is returned if the query was successful, otherwise an error is returned.
	MarkEmailFailedTx(tx *sqlx.Tx, job *Email) (sql.Result, error)
	// RetryEmailAfterTx updates the job records retryAfter to the provided retryAfter value.
	// A sql.Result is returned if the query was successful, otherwise an error is returned.
	RetryEmailAfterTx(tx *sqlx.Tx, job *Email, retryAfter time.Time) (sql.Result, error)
}

type DatabaseImpl struct {
	// contains filtered or unexported fields
}

type Email struct {
	ID         uint64     `db:"id"`
	Status     int32      `db:"status"`
	Retries    int32      `db:"retries"`
	RetryAfter *time.Time `db:"retry_after"`
	CreatedAt  time.Time  `db:"created_at"`
	UpdatedAt  time.Time  `db:"updated_at"`
	Job        []byte
}

type Project struct {
	ID         uint64    `db:"id"`
	Identifier string    `db:"identifier"`
	Label      *string   `db:"label"`
	CreatedAt  time.Time `db:"created_at"`
	UpdatedAt  time.Time `db:"updated_at"`
	// todo: why is project here? should it be deleted?
	DeletedAt *time.Time `db:"deleted_at"`
}

type SchemaMigrations struct {
	Version uint64 `db:"version"`
	Dirty   bool   `db:"dirty"`
}

type Session struct {
	ID                    uint64     `db:"id"`
	Identifier            string     `db:"identifier"`
	ProjectID             uint64     `db:"project_id"`
	ClosedAt              *time.Time `db:"closed_at"`
	CreatedAt             time.Time  `db:"created_at"`
	UpdatedAt             time.Time  `db:"updated_at"`
	DeletedAt             *time.Time `db:"deleted_at"`
	WithSquawks           bool       `db:"with_squawks"`
	WithTransmissionTypes bool       `db:"with_transmission_types"`
	WithCallSigns         bool       `db:"with_callsigns"`
}

type Sighting struct {
	ID         uint64  `db:"id"`
	ProjectID  uint64  `db:"project_id"`
	SessionID  uint64  `db:"session_id"`
	AircraftID uint64  `db:"aircraft_id"`
	CallSign   *string `db:"callsign"`

	CreatedAt time.Time  `db:"created_at"`
	UpdatedAt time.Time  `db:"updated_at"`
	ClosedAt  *time.Time `db:"closed_at"`

	TransmissionTypes uint8   `db:"transmission_types"`
	Squawk            *string `db:"squawk"`
}

type SightingCallSign struct {
	ID         uint64    `db:"id"`
	SightingID uint64    `db:"sighting_id"`
	CallSign   string    `db:"callsign"`
	ObservedAt time.Time `db:"observed_at"`
}

type SightingKml struct {
	ID          uint64 `db:"id"`
	SightingID  uint64 `db:"sighting_id"`
	ContentType int32  `db:"content_type"`
	Kml         []byte `db:"kml"`
}

type SightingLocation struct {
	ID         uint64    `db:"id"`
	SightingID uint64    `db:"sighting_id"`
	TimeStamp  time.Time `db:"timestamp"`
	Altitude   int64     `db:"altitude"`
	Latitude   float64   `db:"latitude"`
	Longitude  float64   `db:"longitude"`
}

type SightingSquawk struct {
	ID         uint64    `db:"id"`
	SightingID uint64    `db:"sighting_id"`
	Squawk     string    `db:"squawk"`
	ObservedAt time.Time `db:"observed_at"`
}

type TxExecer struct {
	// contains filtered or unexported fields
}