[CLIENT-2468] Simplify index creation API#505
Open
juliannguyen4 wants to merge 61 commits intodevfrom
Open
Conversation
4bb0d29 to
b696c61
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## dev #505 +/- ##
==========================================
- Coverage 83.55% 83.53% -0.02%
==========================================
Files 99 99
Lines 14438 14395 -43
==========================================
- Hits 12063 12025 -38
+ Misses 2375 2370 -5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…ex-create-api # Conflicts: # doc/aerospike.rst # doc/client.rst
…rectly to an integer variable
… in tests to prevent warnings
…e func definition docstrings since the declarations already have them
…s, and lists are missing tests
This file contains hidden or 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
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.
To make creating secondary indices with a list of contexts simpler:
client.index_<index_datatype>_create()methods into oneclient.index_single_value_create()method that takes in actxparameter. As a result, these are now deprecated:ctxparameter toclient.index_map_keys_create(),client.index_map_values_create(), andclient.index_list_create(). As a result,client.index_cdt_create()is now deprecated.Implementation details
Extra changes
The following methods are now deprecated:
Preview of updated docs
https://aerospike-python-client--505.org.readthedocs.build/en/505/client.html#index-operations
https://aerospike-python-client--505.org.readthedocs.build/en/505/aerospike.html#index-types
TODO
docstrings are missing return valuesdon't document integer as return value, just assume it returns None since exception will be raised if an error occurstest/miscdon't update because not maintained