-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathpipelines.go
More file actions
454 lines (381 loc) · 13.9 KB
/
Copy pathpipelines.go
File metadata and controls
454 lines (381 loc) · 13.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
package pipeline
import (
"errors"
"fmt"
"log/slog"
"os"
"path/filepath"
"slices"
"strings"
"github.com/rasnes/tiingo-duckdb-framework/EtL/config"
"github.com/rasnes/tiingo-duckdb-framework/EtL/constants"
"github.com/rasnes/tiingo-duckdb-framework/EtL/extract"
"github.com/rasnes/tiingo-duckdb-framework/EtL/load"
"github.com/rasnes/tiingo-duckdb-framework/EtL/utils"
"github.com/sourcegraph/conc/iter"
)
type Pipeline struct {
DuckDB *load.DuckDB
TiingoClient *extract.TiingoClient
Logger *slog.Logger
sqlDir string
timeProvider utils.TimeProvider
InTest bool
}
func NewPipeline(config *config.Config, logger *slog.Logger, timeProvider utils.TimeProvider) (*Pipeline, error) {
db, err := load.NewDuckDB(config, logger)
if err != nil {
return nil, fmt.Errorf("error creating DB database: %v", err)
}
httpClient, err := extract.NewTiingoClient(config, logger)
if err != nil {
return nil, fmt.Errorf("error creating Tiingo HTTP client: %v", err)
}
// Determine SQL directory based on working directory
sqlDir := "sql"
if _, err := os.Stat(sqlDir); os.IsNotExist(err) {
// If sql/ doesn't exist in current directory, try parent
sqlDir = filepath.Join("..", "sql")
if _, err := os.Stat(sqlDir); os.IsNotExist(err) {
return nil, fmt.Errorf("cannot find SQL directory in either current or parent directory")
}
}
return &Pipeline{
DuckDB: db,
TiingoClient: httpClient,
Logger: logger,
sqlDir: sqlDir,
timeProvider: timeProvider,
}, nil
}
func (p *Pipeline) Close() {
p.DuckDB.Close()
}
func (p *Pipeline) DailyEndOfDay() (int, error) {
err := p.supportedTickers()
if err != nil {
return 0, fmt.Errorf("error getting supported tickers: %v", err)
}
lastTradingDay, err := p.TiingoClient.GetLastTradingDay()
if err != nil {
return 0, fmt.Errorf("error getting ticker data from last trading day: %v", err)
}
if err := p.DuckDB.LoadCSV(lastTradingDay, "last_trading_day", false); err != nil {
return 0, fmt.Errorf("error loading last_trading_day into DB: %v", err)
}
if err := p.DuckDB.RunQueryFile(p.getSQLPath("insert__daily_adjusted.sql")); err != nil {
return 0, fmt.Errorf("error inserting last trading day into daily_adjusted: %v", err)
}
res, err := p.DuckDB.GetQueryResultsFromFile(p.getSQLPath("query__selected_backfill.sql"))
if err != nil {
return 0, fmt.Errorf("error getting backfill results: %v", err)
}
tickers, ok := res["ticker"]
if !ok {
return 0, errors.New("ticker key not found in selected_backfill.sql results")
}
if len(tickers) == 0 {
return 0, nil
}
nTickers, err := p.BackfillEndOfDay(tickers)
if err != nil {
return nTickers, fmt.Errorf("error backfilling tickers: %v", err)
}
return len(tickers), nil
}
func (p *Pipeline) selectedFundamentals(filter string) ([]string, error) {
query := "select distinct ticker from fundamentals.selected_fundamentals"
query += " " + filter
if !p.InTest && os.Getenv("APP_ENV") != "prod" {
query += " using sample 20"
}
query += " order by ticker;"
fmt.Println("query for fundamentals to fetch:", query)
res, err := p.DuckDB.GetQueryResults(query)
if err != nil {
return nil, fmt.Errorf("error getting fundamentals.selected_fundamentals results: %w", err)
}
fmt.Println("query results:", res)
tickers, ok := res["ticker"]
if !ok {
return nil, fmt.Errorf("ticker key not found in fundamentals.selected_fundamentals results")
}
if len(tickers) == 0 {
return nil, fmt.Errorf("no tickers found in fundamentals.selected_fundamentals results")
}
return tickers, nil
}
type csvPerTicker func(ticker string) (csv []byte, err error)
func fetchCSVs(tickers []string, fetch csvPerTicker) ([]byte, []string, error) {
// Like some HTTP error codes should be ignored (I might not have access).
// BUT: it seems the API sends 400 Bad Request with body: None if no access,
// which is the same as if the request were incorrect. Not optimal.
// UPDATE: with 20+ years of historical data avaiable, one gets 200 OK with body: None
// if data does not exists.
// Remaining question: what is the HTTP code on 3 year subscription and requesting >3 years?
// If it is still 200 but with body: None, I should probably just default to query data from 1995-01-01.
mapper := iter.Mapper[string, []byte]{
MaxGoroutines: 20,
}
// Map over tickers concurrently, fetching CSV data for each
csvs, err := mapper.MapErr(tickers, func(ticker *string) ([]byte, error) {
body, err := fetch(*ticker)
if err != nil {
return nil, fmt.Errorf("error fetching data for ticker %s: %w", *ticker, err)
}
// Handle empty responses by returning nil
if string(body) == "None" {
return nil, nil
}
csv, err := load.AddTickerColumn(body, *ticker)
if err != nil {
return nil, fmt.Errorf("error adding ticker column to CSV for ticker %s: %w", *ticker, err)
}
return csv, nil
})
// Track empty responses
emptyResponses := make([]string, 0)
validCSVs := make([][]byte, 0)
// Process results, separating valid CSVs and empty responses
for i, csv := range csvs {
if csv == nil {
emptyResponses = append(emptyResponses, tickers[i])
} else {
validCSVs = append(validCSVs, csv)
}
}
// If we got an error during fetching, return it
if err != nil {
return nil, emptyResponses, err
}
// Concatenate valid CSVs
if len(validCSVs) == 0 {
return nil, emptyResponses, nil
}
finalCsv, err := load.ConcatCSVs(validCSVs)
if err != nil {
return nil, emptyResponses, fmt.Errorf("error concatenating CSVs: %w", err)
}
return finalCsv, emptyResponses, nil
}
// fetchFundamentalsData handles fetching and loading fundamentals data (daily or statements)
// for the specified tickers into DuckDB. If no tickers provided, uses selectedFundamentals().
// If batchSize > 0, processes tickers in batches to manage memory usage.
// Skips any tickers specified in skipTickers.
func (p *Pipeline) fetchFundamentalsData(
tickers []string,
half bool,
fetchFn csvPerTicker,
tableName string,
batchSize int,
skipTickers []string,
skipExisting bool,
filter string,
) (int, error) {
// Get tickers if none provided
var err error
if len(tickers) == 0 {
if filter != "" {
// Look up tickers with filter on the data
tickers, err = p.selectedFundamentals(filter)
if err != nil {
return 0, fmt.Errorf("error getting selected fundamentals with filter: %w", err)
}
} else {
// Look up all tickers in selected_fundamentals
tickers, err = p.selectedFundamentals("")
if err != nil {
return 0, fmt.Errorf("error getting selected fundamentals without filter: %w", err)
}
}
}
// Make sure we have the latest supported tickers
err = p.supportedTickers()
if err != nil {
return 0, fmt.Errorf("error getting supported tickers: %v", err)
}
// Make sure we have the latest fundamentals metadata
_, err = p.UpdateMetadata()
if err != nil {
return 0, fmt.Errorf("error updating metadata: %v", err)
}
// Handle half processing if requested
if half {
tickers = utils.HalfOfSlice(
tickers,
p.timeProvider.Now().Hour()%2 == 0,
)
}
if skipExisting {
// Filter out tickers that already exist in the database
existingTickers, err := p.DuckDB.GetQueryResults("select distinct ticker from " + tableName)
if err != nil {
return 0, fmt.Errorf("error getting existing tickers: %w", err)
}
skipTickers = append(skipTickers, existingTickers["ticker"]...)
}
// Filter out skipped tickers before any processing
if len(skipTickers) > 0 {
tickers = filterOutSkippedTickers(tickers, skipTickers)
}
// Convert all tickers to uppercase for consistency
upperCaseTickers := make([]string, len(tickers))
for i, ticker := range tickers {
upperCaseTickers[i] = strings.ToUpper(ticker)
}
// Parse table name for logging
dataType := strings.TrimPrefix(tableName, "fundamentals.")
dataType = strings.ReplaceAll(dataType, "_", " ")
totalEmptyResponses := make([]string, 0)
totalProcessed := 0
// Process all tickers at once if batchSize is 0
if batchSize == 0 {
finalCsv, emptyResponses, err := fetchCSVs(upperCaseTickers, fetchFn)
if err != nil {
return 0, fmt.Errorf("error fetching %s data: %w", dataType, err)
}
if len(finalCsv) > 0 {
if err := p.DuckDB.LoadCSV(finalCsv, tableName, true); err != nil {
return 0, fmt.Errorf("error loading %s data to DB: %w", dataType, err)
}
}
totalEmptyResponses = emptyResponses
totalProcessed = len(upperCaseTickers) - len(emptyResponses)
} else {
// Process tickers in batches
for i := 0; i < len(upperCaseTickers); i += batchSize {
end := i + batchSize
if end > len(upperCaseTickers) {
end = len(upperCaseTickers)
}
batch := upperCaseTickers[i:end]
finalCsv, emptyResponses, err := fetchCSVs(batch, fetchFn)
if err != nil {
return totalProcessed, fmt.Errorf("error fetching %s data for batch %d-%d: %w", dataType, i, end-1, err)
}
if len(finalCsv) > 0 {
finalCsvDeduped, err := load.RemoveDuplicateRows(finalCsv)
if err != nil {
return totalProcessed, fmt.Errorf("error removing duplicates from %s data for batch %d-%d: %w", dataType, i, end-1, err)
}
if err := p.DuckDB.LoadCSV(finalCsvDeduped, tableName, true); err != nil {
return totalProcessed, fmt.Errorf("error loading %s data to DB for batch %d-%d: %w", dataType, i, end-1, err)
}
}
totalEmptyResponses = append(totalEmptyResponses, emptyResponses...)
batchProcessed := len(batch) - len(emptyResponses)
totalProcessed += batchProcessed
p.Logger.Info(fmt.Sprintf("Successfully processed batch of %s data", dataType),
"batch", fmt.Sprintf("%d-%d", i, end-1),
"processed", batchProcessed,
"empty_responses", len(emptyResponses))
}
}
p.Logger.Info(fmt.Sprintf("Total number of empty responses: %d", len(totalEmptyResponses)))
return totalProcessed, nil
}
// filterOutSkippedTickers removes any tickers that should be skipped from the input slice
// The comparison is case insensitive
func filterOutSkippedTickers(tickers []string, skipTickers []string) []string {
// Convert skip tickers to uppercase for case-insensitive comparison
upperSkipTickers := make([]string, len(skipTickers))
for i, t := range skipTickers {
upperSkipTickers[i] = strings.ToUpper(t)
}
return slices.DeleteFunc(tickers, func(ticker string) bool {
return slices.Contains(upperSkipTickers, strings.ToUpper(ticker))
})
}
func (p *Pipeline) DailyFundamentals(tickers []string, half bool, batchSize int, skipTickers []string, skipExisting bool, lookback int) (int, error) {
var filter string
if lookback > 0 {
// TODO: add tests for this functionality
filter = fmt.Sprintf("where dailyLastUpdated >= current_date - interval '%d days'", lookback)
}
return p.fetchFundamentalsData(tickers, half, p.TiingoClient.GetDailyFundamentals, "fundamentals.daily", batchSize, skipTickers, skipExisting, filter)
}
func (p *Pipeline) Statements(tickers []string, half bool, batchSize int, skipTickers []string, skipExisting bool, lookback int) (int, error) {
var filter string
if lookback > 0 {
// TODO: add tests for this functionality
filter = fmt.Sprintf("where statementLastUpdated >= current_date - interval '%d days'", lookback)
}
return p.fetchFundamentalsData(tickers, half, p.TiingoClient.GetStatements, "fundamentals.statements", batchSize, skipTickers, skipExisting, filter)
}
func (p *Pipeline) UpdateMetadata() (int, error) {
err := p.supportedTickers()
if err != nil {
return 0, fmt.Errorf("error getting supported tickers: %v", err)
}
// Get fundamentals metadata for all tickers from Tiingo API
metadata, err := p.TiingoClient.GetMeta("")
if err != nil {
return 0, fmt.Errorf("error fetching metadata from Tiingo: %w", err)
}
insertMetaFile := p.getSQLPath("insert__fundamentals_meta.sql")
templateContent, err := os.ReadFile(insertMetaFile)
if err != nil {
return 0, fmt.Errorf("error reading %s file: %w", insertMetaFile, err)
}
sqlParams := map[string]any{
"CsvFile": constants.TmpCSVFile,
}
// Load metadata into DuckDB
res, err := p.DuckDB.LoadCSVWithQuery(metadata, string(templateContent), sqlParams)
if err != nil {
return 0, fmt.Errorf("error loading metadata into DB: %w", err)
}
rowsAffected, err := res.RowsAffected()
if err != nil {
return 0, fmt.Errorf("error getting rows affected: %w", err)
}
return int(rowsAffected), nil
}
func (p *Pipeline) BackfillEndOfDay(tickers []string) (int, error) {
var errorList []error
for i, ticker := range tickers {
history, err := p.TiingoClient.GetHistory(ticker)
if err != nil {
errorList = append(errorList, fmt.Errorf("error fetching history for ticker %s: %w", ticker, err))
continue
}
historyWithTicker, err := load.AddTickerColumn(history, ticker)
if err != nil {
errorList = append(errorList, fmt.Errorf("error adding ticker column to history for ticker %s: %w", ticker, err))
continue
}
if err := p.DuckDB.LoadCSV(historyWithTicker, "daily_adjusted", true); err != nil {
errorList = append(errorList, fmt.Errorf("error loading history to DB for ticker %s: %w", ticker, err))
continue
}
if i > 0 && i%20 == 0 {
if len(errorList) > 0 {
p.Logger.Info(fmt.Sprintf("Successfully backfilled %d tickers; failed on %d tickers", i-len(errorList), len(errorList)))
} else {
p.Logger.Info(fmt.Sprintf("Successfully backfilled %d tickers", i))
}
}
}
if len(errorList) > 0 {
return len(tickers) - len(errorList), errors.Join(errorList...)
}
return len(tickers), nil
}
// Add this helper method
func (p *Pipeline) getSQLPath(filename string) string {
return filepath.Join(p.sqlDir, filename)
}
func (p *Pipeline) supportedTickers() error {
zipSupportedTickers, err := p.TiingoClient.GetSupportedTickers()
if err != nil {
return fmt.Errorf("error getting supported_tickers.zip: %v", err)
}
csvSupportedTickers, err := extract.UnzipSingleCSV(zipSupportedTickers)
if err != nil {
return fmt.Errorf("error unzipping supported_tickers.zip: %v", err)
}
if err := p.DuckDB.LoadCSV(csvSupportedTickers, "supported_tickers", false); err != nil {
return fmt.Errorf("error loading supported_tickers.csv into DB: %v", err)
}
return nil
}