stellar-etl: implement export_ledgers command #67
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
debnil
approved these changes
Jul 29, 2020
| logger.Fatal("could not create output file: ", err) | ||
| } | ||
|
|
||
| outFile, err := os.OpenFile(absolutePath, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644) |
There was a problem hiding this comment.
I'd add a TODO to check the permissions on this file. Seems like a possible bug surface in the larger architecture.
cmd/export_ledgers_test.go
Outdated
| } | ||
|
|
||
| func getLastSeqNum() uint32 { | ||
| backend, _ := ledgerbackend.NewHistoryArchiveBackendFromURL("http://history.stellar.org/prd/core-live/core_live_001") |
There was a problem hiding this comment.
It's worth defining another function to define/initialize this backend. I suspect you'll be doing it a good amount across tests, it's an easy way to save some complexity. I'd also define the history archive URL as a variable.
| type cliTest struct { | ||
| name string | ||
| args []string | ||
| golden string |
There was a problem hiding this comment.
Great use of golden files :)
cmd/export_ledgers.go
Outdated
| outFile.WriteString("\n") | ||
| } | ||
|
|
||
| /* |
There was a problem hiding this comment.
I think you can delete these planning comments -- looks all implemented :)
| ledgersCmd.Flags().Uint32P("limit", "l", 60, "Maximum number of ledgers to export") | ||
| ledgersCmd.Flags().StringP("output-file", "o", "exported_ledgers.txt", "Filename of the output file") | ||
| ledgersCmd.MarkFlagRequired("end-ledger") | ||
| /* |
There was a problem hiding this comment.
The commented flags should be modified to account for what you've developed :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
PR Structure
otherwise).
services/friendbot, orallordocif the changes are broad or impact manypackages.
Thoroughness
.mdfiles, etc... affected by this change). Take a look in the
docsfolder for a given service,like this one.
What
This PR implements the export_ledgers command. It allows users to connect to the history archives, retrieve ledger information in a desired range, and export the JSON encodings to an output file.
Why
This command is part of the larger CLI tool. It will allow for updating the BigQuery table history_ledgers more efficiently.
Known limitations
The start-time and end-time flags are not implemented. The ingestion system uses sequence numbers instead of times. If it is expanded to use times, then we can add the flags. The serialize-method flag also is not implemented, since at the moment we only have json encodings for the structs.