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

Documentation Update #94

Merged
merged 9 commits into from
Mar 9, 2018
Merged

Documentation Update #94

merged 9 commits into from
Mar 9, 2018

Conversation

julyate
Copy link
Contributor

@julyate julyate commented Mar 9, 2018

No description provided.

@julyate julyate requested a review from rafaeljesus March 9, 2018 08:29
@codecov
Copy link

codecov bot commented Mar 9, 2018

Codecov Report

Merging #94 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #94   +/-   ##
=======================================
  Coverage   32.39%   32.39%           
=======================================
  Files           5        5           
  Lines         213      213           
=======================================
  Hits           69       69           
  Misses        140      140           
  Partials        4        4

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 44a937c...86e8b91. Read the comment docs.

README.md Outdated
@@ -56,7 +107,25 @@ klepto steal \
--read-max-conns=8
```

## Relationships
Behind the scenes Klepto will establishes the connection with the source and target databases with the given parameters passed, and will dump 4 the tables.
Copy link
Contributor Author

@julyate julyate Mar 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rafaeljesus Is this description correct for the example file?

Copy link
Contributor

@rafaeljesus rafaeljesus Mar 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm I just realised that for this particular example we don't need to set

--concurrency
--read-max-conns
--read-max-idle-conns

Given this config only dumps a single table (users). We could move them to the recommend section below I think

README.md Outdated
You can set the following fields in the file:
* Tables
* Matchers
* more?
Copy link
Contributor Author

@julyate julyate Mar 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rafaeljesus What other fields can you set in the toml file, and what do they mean?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Tables represents table definition
  • Filters represents the way you want to filter the results
  • Matchers are variables to replace placeholders in Filter
  • Relationships represents a relationship definition

README.md Outdated
## Relationships
Behind the scenes Klepto will establishes the connection with the source and target databases with the given parameters passed, and will dump 4 the tables.

We recommend to always set the following parameters:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

@rafaeljesus rafaeljesus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🏅

@rafaeljesus
Copy link
Contributor

@julyate thanks a lot

@rafaeljesus rafaeljesus merged commit bbca864 into master Mar 9, 2018
@rafaeljesus rafaeljesus deleted the documentation-updates branch March 9, 2018 11:32
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.

2 participants