-
Notifications
You must be signed in to change notification settings - Fork 7
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
Implement docstring, missing methods, basic streaming #56
Conversation
immudb/client.py
Outdated
key (bytes): Key to retrieve | ||
offset (int): Offset of history | ||
limit (int): Limit of history entries | ||
sortorder (bool): Sort order of history |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add information what True and False mean here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've resolved this with a documentation change, but I also opened a PR against this branch with a change to the method that resolves the confusion: #59
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I commented in #59
We shouldn't introduce new parameter, but just rename first one if we really want to do it. Or just write it in the documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most of the outstanding discussion points have been resolved by my recent commits, but I have a few open points marked in this review that need clarification.
Args: | ||
cleanupPercentage (float): Indicates the percentage of the | ||
storage space that will be scanned for unreference data. Although | ||
this operation blocks transaction processing, choosing a small | ||
value (e.g. ``0.1``) may not significantly hinder normal operations, | ||
and will reduce used storage space. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a percentage from 0 to 1, correct? If so, then it should be phrased this way instead:
Args: | |
cleanupPercentage (float): Indicates the percentage of the | |
storage space that will be scanned for unreference data. Although | |
this operation blocks transaction processing, choosing a small | |
value (e.g. ``0.1``) may not significantly hinder normal operations, | |
and will reduce used storage space. | |
Args: | |
cleanupPercentage (float): Fractional decimal indicating the percentage of the | |
storage space that will be scanned for unreferenced data. Although | |
this operation blocks transaction processing, choosing a small | |
value (e.g. ``0.1``) may not significantly hinder normal operations, | |
and will reduce used storage space. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nope, this is between 0 and 100, the 0.1 value is really 0.1% (which is a sane value in this case)
immudb/client.py
Outdated
key (bytes): Key to retrieve | ||
offset (int): Offset of history | ||
limit (int): Limit of history entries | ||
sortorder (bool): Sort order of history |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've resolved this with a documentation change, but I also opened a PR against this branch with a change to the method that resolves the confusion: #59
Args: | ||
user (str): username | ||
newPassword (str): new password | ||
oldPassword (str): old password |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is it that's only necessary for the sysadmin user?
Args: | ||
user (str): username | ||
newPassword (str): new password | ||
oldPassword (str): old password |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This are restrictions implied by the immudb itself.
SysAdmin can change his own password only by giving old and new password.
SysAdmin user can change password of any other user without old password.
Admin users can change password for user only created by that admin without old password.
…-py into feature/fullapisupport
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
All methods implemented