Updating readme with first-time setup details #7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hasghari
requested changes
Apr 28, 2018
README.md
Outdated
| add_column :my_table, :parentry, :ltree | ||
| add_column :my_table, :parent_id, :integer | ||
|
|
||
| add_column :my_table, :parent_depth, :integer, default: 0 # optional | ||
| add_index :my_table, :parentry |
There was a problem hiding this comment.
the ltree extension works best with a gist index.
README.md
Outdated
| add_column :my_table, :parentry, :ltree | ||
| add_column :my_table, :parent_id, :integer | ||
|
|
||
| add_column :my_table, :parent_depth, :integer, default: 0 # optional |
There was a problem hiding this comment.
parentry_depth is the column that will be used for the depth cache.
README.md
Outdated
| @@ -26,11 +26,23 @@ Or install it yourself as: | |||
|
|
|||
| ## Usage | |||
|
|
|||
| This gem requires 2 columns for each table: `parentry` and `parent_id`. A sample migration would look like: | |||
| This gem requires 2 columns for each table: `parentry` and `parent_id`, and is dependent on the `ltree` postgresql extension. A sample migration would look like: | |||
There was a problem hiding this comment.
ltree is actually not a requirement. You can persist the hierarchy as an array if you can't or don't want to use the ltree module.
class MyTable < ApplicationRecord
include Parentry
parentry strategy: :array
endI really need to spend some time on adding good documentation for this gem.
hasghari
approved these changes
Jun 5, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.