IF Commons GitHub

sync-medium

verbmutate

Exchange a store that merges with a shared place: publish its new rows as delta files and take the files of the others.

Program anyfs-reader. Origin anyfs.

Governance: the action

What the verb is and may do, as governance says it. Each annotation is expressed by the surfaces or says why it is not.

PropertyValue
kindaction
effectmutate
idempotenttrue
audienceboth
tierwriter
dryRuntrue
checkfalse
reachChannelslocal, mcp
reachReadOnlyfalse
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationnone

Operands

OperandMeaning
STOREThe store that merges.
MEDIUMThe shared place: any store that reads, writes and lists.

Options

OptionMeaningProperties
--replicaThe identity of the store as a replica (32 hexadecimal digits), which the store does not say of itself.type=value, required=false, standard=false, humanOnly=false, valueName=ID
--max-rowsPut at most N rows in one delta file.type=value, required=false, standard=false, humanOnly=false, valueName=N
--trustWhom to take changes from: open (anyone), allowlist (the replicas of --replicas) or signed (the keys of --roster). Where it is left out the mount says, and where the mount says nothing the store keeps the trust it has.type=value, required=false, standard=false, humanOnly=false, valueName=MODE
--rosterThe keys that are known, as a file of a JSON list (or env:NAME, a variable that holds the text): for --trust signed.type=value, required=false, standard=false, humanOnly=false, valueName=FILE
--sign-keyThe keys that sign what is published, each a file (or env:NAME, a variable that holds the key): a delta is signed with the key of the replica that made it. The key is never given on the command line.type=value, required=false, standard=false, humanOnly=false, valueName=FILE[,FILE]
--replicasThe replicas that are taken changes from, by identity (32 hexadecimal digits); with --trust signed it narrows the roster.type=value, required=false, standard=false, humanOnly=false, valueName=ID[,ID]
--jsonWrite one JSON document and nothing else for a person.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--quietShow only how it ended.type=flag, short=q, required=false, standard=true, humanOnly=false, negatable=false, default=false
--verboseShow every step as it happens.type=flag, short=v, required=false, standard=true, humanOnly=false, negatable=false, default=false
--colorUse colour where the terminal shows it (--no-color turns it off).type=flag, required=false, standard=true, humanOnly=false, negatable=true, default=true
--non-interactiveNever ask a question: where one is needed, fail and say so.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--dry-runShow what would change and change nothing.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false

Examples

anyfs sync-medium --dry-run --replica 0123456789abcdef0123456789abcdef fleet-a:/ shared:/  # How many rows are not published yet and which delta files of the others are not taken.
anyfs sync-medium --replica 0123456789abcdef0123456789abcdef fleet-a:/ shared:/  # Publish the new rows as delta files and take the others'.

Physical: what it is drawn as

Not drawn by any surface for this tier.

Not drawn

  • cli: sync-medium is for the tier writer; this caller holds reader
  • mcp: sync-medium is for the tier writer; this caller holds reader
  • rest: sync-medium is for the tier writer; this caller holds reader

Titles, headings, exports, tables, columns and requirements. Esc closes.