Skip to content

Commit

Permalink
Readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
fosskers committed Mar 3, 2020
1 parent abb4910 commit f091b35
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.org
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#+TITLE: Chainweb Data
#+AUTHOR: Colin

[[https://github.com/fosskers/aura/workflows/Build/badge.svg]]
[[https://github.com/kadena-io/chainweb-data/workflows/Build/badge.svg]]

* Table of Contents :TOC_4_gh:noexport:
- [[#overview][Overview]]
Expand All @@ -12,10 +12,10 @@
- [[#via-a-postgres-connection-string][via a Postgres Connection String]]
- [[#connecting-to-a-node][Connecting to a Node]]
- [[#commands][Commands]]
- [[#listen][~listen~]]
- [[#backfill][~backfill~]]
- [[#gaps][~gaps~]]
- [[#single][~single~]]
- [[#listen][listen]]
- [[#backfill][backfill]]
- [[#gaps][gaps]]
- [[#single][single]]

* Overview

Expand Down Expand Up @@ -72,7 +72,7 @@ chainweb-data <command> --url=foo.chainweb.com ...

** Commands

*** ~listen~
*** listen

~listen~ fetches live data from a ~chainweb-node~ whose ~headerStream~
configuration value is ~true~.
Expand All @@ -86,7 +86,7 @@ configuration value is ~true~.
As a new block comes in, its chain number is printed as a single digit.
~listen~ will continue until you stop it.

*** ~backfill~
*** backfill

~backfill~ rapidly fills the database downward from the lowest block height it
can find for each chain.
Expand All @@ -104,7 +104,7 @@ chain first via ~listen~ before doing ~backfill~!

~backfill~ will stop when it reaches height 0.

*** ~gaps~
*** gaps

~gaps~ fills in missing blocks that may have been missed during ~listen~ or
~backfill~. Such gaps will naturally occur if you turn ~listen~ off or use
Expand All @@ -118,12 +118,12 @@ chain first via ~listen~ before doing ~backfill~!
[INFO] Filled in 2113 missing blocks.
#+end_example

*** ~single~
*** single

~single~ allows you to sync a block at any location in the blockchain.

#+begin_example
> chainweb-data single --chain=0 --height=200000 --url=foo.chainweb.com --dbuser=colin --dbname=chainweb-data
> chainweb-data single --chain=0 --height=200 --url=foo.chainweb.com --dbuser=joe --dbname=chainweb-data
DB Tables Initialized
[INFO] Filled in 1 blocks.
#+end_example
Expand Down

0 comments on commit f091b35

Please sign in to comment.