Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs for the dump command #472

Merged
merged 2 commits into from
Jul 22, 2016
Merged

docs for the dump command #472

merged 2 commits into from
Jul 22, 2016

Conversation

jseldess
Copy link
Contributor

@jseldess jseldess commented Jul 21, 2016

@maddyblue
Copy link
Contributor

Everything here LGTM. However I think we should include a paragraph that some operational notes and consistency guarantees of dump. Here's the bullet points:

  • Data will be dumped as it appeared at the time the dump command started. Data changed or added after the dump command started but before it completed will not appear in the output. If a dump takes longer to complete than the configured GC threshold, the dump may fail.
  • Data changes can safely be made while running a dump.
  • Schema changes can safely be made while running a dump.
  • Reads can be done normally during a dump.

Review status: 0 of 3 files reviewed at latest revision, 1 unresolved discussion.


back-up-and-restore-data.md, line 11 [r1] (raw file):

{{site.data.alerts.callout_info}}Currently, only the <code>root</code> user can run the <code>cockroach dump</code> command.{{site.data.alerts.end}}

<div id="toc"></div>

Why do we need this div if toc is false?


Comments from Reviewable

@jseldess
Copy link
Contributor Author

Done. PTAL, Matt.


Review status: 0 of 3 files reviewed at latest revision, 1 unresolved discussion.


back-up-and-restore-data.md, line 11 [r1] (raw file):

Previously, mjibson (Matt Jibson) wrote…

Why do we need this div if toc is false?

See second bullet here: https://github.com/cockroachdb/docs/blob/gh-pages/CONTRIBUTING.md#toc-placement

Comments from Reviewable

@maddyblue
Copy link
Contributor

Review status: 0 of 3 files reviewed at latest revision, 1 unresolved discussion.


back-up-and-restore-data.md, line 13 [r2] (raw file):

- The table data is dumped as it appears at the time that the command is started. Any changes after the command starts will not be included in the dump.
- If the dump takes longer than the `ttlseconds` [replication zone](configure-replication-zones.html) setting for the table (24 hours by default), the dump may fail. 
- Reads and schema changes can happen while a dump is in progress.

I would add "writes" here just to be explicit: "Reads, writes, and schema changes ..."


Comments from Reviewable

@jseldess
Copy link
Contributor Author

Review status: 0 of 3 files reviewed at latest revision, 1 unresolved discussion.


back-up-and-restore-data.md, line 13 [r2] (raw file):

Previously, mjibson (Matt Jibson) wrote…

I would add "writes" here just to be explicit: "Reads, writes, and schema changes ..."

Done.

Comments from Reviewable

@jseldess jseldess merged commit 5b3d832 into gh-pages Jul 22, 2016
@jseldess jseldess deleted the dump branch July 22, 2016 00:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants