Skip to content

Commit b696c61

Browse files
committed
move deprecated index creation methods to the bottom of section
1 parent b8cd58a commit b696c61

File tree

1 file changed

+48
-49
lines changed

1 file changed

+48
-49
lines changed

doc/client.rst

Lines changed: 48 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -883,34 +883,6 @@ Index Operations
883883
.. class:: Client
884884
:noindex:
885885

886-
.. method:: index_string_create(ns, set, bin, name[, policy: dict])
887-
888-
Create a string index with *index_name* on the *bin* in the specified \
889-
*ns*, *set*.
890-
891-
:param str ns: the namespace in the aerospike cluster.
892-
:param str set: the set name.
893-
:param str bin: the name of bin the secondary index is built on.
894-
:param str name: the name of the index.
895-
:param dict policy: optional :ref:`aerospike_info_policies`.
896-
:raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
897-
898-
.. deprecated:: 14.0.0 :meth:`index_single_value_create` should be used instead.
899-
900-
.. method:: index_integer_create(ns, set, bin, name[, policy])
901-
902-
Create an integer index with *name* on the *bin* in the specified \
903-
*ns*, *set*.
904-
905-
:param str ns: the namespace in the aerospike cluster.
906-
:param str set: the set name.
907-
:param str bin: the name of bin the secondary index is built on.
908-
:param str name: the name of the index.
909-
:param dict policy: optional :ref:`aerospike_info_policies`.
910-
:raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
911-
912-
.. deprecated:: 14.0.0 :meth:`index_single_value_create` should be used instead.
913-
914886
.. method:: index_list_create(ns, set, bin, index_datatype, name[, policy: dict])
915887

916888
Create an index named *name* for numeric, string or GeoJSON values \
@@ -973,55 +945,82 @@ Index Operations
973945
client.index_map_values_create('test', 'demo', 'fav_movies', aerospike.INDEX_NUMERIC, 'demo_fav_movies_views_idx')
974946
client.close()
975947
976-
.. method:: index_geo2dsphere_create(ns, set, bin, name[, policy: dict])
948+
.. method:: index_remove(ns: str, name: str[, policy: dict])
977949

978-
Create a geospatial 2D spherical index with *name* on the *bin* \
979-
in the specified *ns*, *set*.
950+
Remove the index with *name* from the namespace.
980951

981952
:param str ns: the namespace in the aerospike cluster.
982-
:param str set: the set name.
983-
:param str bin: the name of bin the secondary index is built on.
984953
:param str name: the name of the index.
985954
:param dict policy: optional :ref:`aerospike_info_policies`.
986955
:raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
987956

988-
.. seealso:: :class:`aerospike.GeoJSON`, :mod:`aerospike.predicates`
957+
.. method:: get_cdtctx_base64(ctx: list) -> str
989958

990-
.. note:: Requires server version >= 3.7.0
959+
Get the base64 representation of aerospike CDT ctx.
991960

992-
.. code-block:: python
961+
See :ref:`aerospike_operation_helpers.cdt_ctx` for more details on CDT context.
993962

994-
import aerospike
963+
:param list ctx: Aerospike CDT context: generated by aerospike CDT ctx helper :mod:`aerospike_helpers`.
964+
:raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
995965

996-
client = aerospike.client({ 'hosts': [ ('127.0.0.1', 3000)]})
997-
client.index_geo2dsphere_create('test', 'pads', 'loc', 'pads_loc_geo')
998-
client.close()
966+
.. include:: examples/get_cdtctx_base64.py
967+
:code: python
968+
969+
.. versionchanged:: 7.1.1
970+
971+
.. method:: index_string_create(ns, set, bin, name[, policy: dict])
972+
973+
Create a string index with *index_name* on the *bin* in the specified \
974+
*ns*, *set*.
975+
976+
:param str ns: the namespace in the aerospike cluster.
977+
:param str set: the set name.
978+
:param str bin: the name of bin the secondary index is built on.
979+
:param str name: the name of the index.
980+
:param dict policy: optional :ref:`aerospike_info_policies`.
981+
:raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
999982

1000983
.. deprecated:: 14.0.0 :meth:`index_single_value_create` should be used instead.
1001984

1002-
.. method:: index_remove(ns: str, name: str[, policy: dict])
985+
.. method:: index_integer_create(ns, set, bin, name[, policy])
1003986

1004-
Remove the index with *name* from the namespace.
987+
Create an integer index with *name* on the *bin* in the specified \
988+
*ns*, *set*.
1005989

1006990
:param str ns: the namespace in the aerospike cluster.
991+
:param str set: the set name.
992+
:param str bin: the name of bin the secondary index is built on.
1007993
:param str name: the name of the index.
1008994
:param dict policy: optional :ref:`aerospike_info_policies`.
1009995
:raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
1010996

1011-
.. method:: get_cdtctx_base64(ctx: list) -> str
997+
.. deprecated:: 14.0.0 :meth:`index_single_value_create` should be used instead.
1012998

1013-
Get the base64 representation of aerospike CDT ctx.
999+
.. method:: index_geo2dsphere_create(ns, set, bin, name[, policy: dict])
10141000

1015-
See :ref:`aerospike_operation_helpers.cdt_ctx` for more details on CDT context.
1001+
Create a geospatial 2D spherical index with *name* on the *bin* \
1002+
in the specified *ns*, *set*.
10161003

1017-
:param list ctx: Aerospike CDT context: generated by aerospike CDT ctx helper :mod:`aerospike_helpers`.
1004+
:param str ns: the namespace in the aerospike cluster.
1005+
:param str set: the set name.
1006+
:param str bin: the name of bin the secondary index is built on.
1007+
:param str name: the name of the index.
1008+
:param dict policy: optional :ref:`aerospike_info_policies`.
10181009
:raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
10191010

1020-
.. include:: examples/get_cdtctx_base64.py
1021-
:code: python
1011+
.. seealso:: :class:`aerospike.GeoJSON`, :mod:`aerospike.predicates`
10221012

1023-
.. versionchanged:: 7.1.1
1013+
.. note:: Requires server version >= 3.7.0
1014+
1015+
.. code-block:: python
1016+
1017+
import aerospike
1018+
1019+
client = aerospike.client({ 'hosts': [ ('127.0.0.1', 3000)]})
1020+
client.index_geo2dsphere_create('test', 'pads', 'loc', 'pads_loc_geo')
1021+
client.close()
10241022
1023+
.. deprecated:: 14.0.0 :meth:`index_single_value_create` should be used instead.
10251024

10261025
.. index::
10271026
single: Admin Operations

0 commit comments

Comments
 (0)