Docs: state that a stream created before #515 cannot be read after the next enable

Aperta Adatta ai principianti
  • Qualcosa non va?
#938 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 5 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
85/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
markdown, rust
Ambito
documentation

Direzione di ricerca

Leggi la sezione Streams in docs/manuals/07-upgrade-manual.md e la riga “Stream disable and enable” in docs/differences-from-dynamodb.md. Aggiungi al manuale l’avviso specificato e le istruzioni per svuotare lo stream, poi riassumili e inserisci un collegamento al manuale nella riga delle differenze. Il lavoro è terminato quando entrambi i documenti descrivono lo stream illeggibile dopo la prima attivazione successiva all’aggiornamento e il manuale indica le tre risposte di errore.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

What happens

With #515, each stream carries its label in its shard ids. A stream that an earlier release created has shard ids without a label, and the earlier release stored its label only in the table row. The first UpdateTable that enables the table's stream under #515 writes the new stream's label to the table row. After that, the earlier stream's ARN does not resolve:

  • DescribeStream answers Stream: <arn> not found.
  • ListStreams omits the stream.
  • An iterator that still reads the stream answers Stream does not exist.

A consumer cannot read the records that it did not read before the enable. After a disable alone, the stream stays describable, and, from reading util::shard_in_stream, its shards stay readable under its ARN until the next enable. #515 states this limitation in its Compatibility section and tells the reader to drain such a stream before enabling it again.

What the docs say now

On #515's head (23a02ea5b):

  • docs/differences-from-dynamodb.md, row "Stream disable and enable": a stream created by a release before #515 "loses its ARN once the table is disabled and re-enabled". The row does not say that the stream's records become unreadable. It also says "the table is disabled", where StreamEnabled: false disables only the stream.
  • docs/manuals/07-upgrade-manual.md, section "Streams: disabling closes the shards, enabling creates a new stream": the section does not mention the limitation.

The review of #515 asks for direct wording in the docs and says that a follow-up PR can make the change.

What to change

After #515 merges:

  1. In the upgrade manual's streams section, add a paragraph. It names the streams it applies to: streams created by a release before the one that ships #515. It says that the table's first stream enable after the upgrade makes such a stream unreadable, and it lists the three answers above. It tells the operator to read such a stream to the end of each shard after the disable and before the enable.
  2. In the differences row, replace the "loses its ARN" sentence with a one-sentence summary of the new paragraph. Link the row to the upgrade manual paragraph.

Keeping the earlier stream's ARN resolvable is out of scope. It needs a per-table stream history column and a migration on three backends (#515's Compatibility section).

Lingua principale
Rust
Stelle
517
Fork
60
Merge medio
5g 21h
PR unite (30g)
110

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ExtendDB/extenddb

Tutte le issue di ExtendDB/extenddb

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.