Rename getIndexes() to listIndexes() to be consistent with the other

SODA implementations.

Author: anthony-tuininga

doc/src/api_manual/soda.rst

@@ -217,14 +217,6 @@ SodaCollection Methods
  index has been created with the 'dataguide' option enabled. If there are
  no documents in the collection, None is returned.
 
-
-.. method:: SodaCollection.getIndexes()
-
- Returns a list of specifications for the indexes found on the collection.
-
- .. versionadded:: 1.4.0
-
-
 .. method:: SodaCollection.insertMany(docs)
 
  Inserts a list of documents into the collection at one time. Each of the
@@ -294,6 +286,11 @@ SodaCollection Methods
 
  Use of the ``hint`` parameter requires Oracle Client 21.3 or higher (or Oracle Client 19 from 19.11).
 
+.. method:: SodaCollection.listIndexes()
+
+ Returns a list of specifications for the indexes found on the collection.
+
+ .. versionadded:: 1.4.0
 
 .. method:: SodaCollection.save(doc)
 

src/oracledb/impl/thick/odpi.pxd

@@ -1041,9 +1041,6 @@ cdef extern from "impl/thick/odpi/embed/dpi.c":
  const dpiSodaOperOptions *options, uint32_t flags,
  uint64_t *count) nogil
 
- int dpiSodaColl_getIndexes(dpiSodaColl *coll, uint32_t flags,
- dpiStringList *lst) nogil
-
  int dpiSodaColl_getMetadata(dpiSodaColl *coll, const char **value,
  uint32_t *valueLength) nogil
 
@@ -1058,6 +1055,9 @@ cdef extern from "impl/thick/odpi/embed/dpi.c":
  dpiSodaOperOptions *options, uint32_t flags,
  dpiSodaDoc **insertedDoc) nogil
 
+ int dpiSodaColl_listIndexes(dpiSodaColl *coll, uint32_t flags,
+ dpiStringList *lst) nogil
+
  int dpiSodaColl_release(dpiSodaColl *coll) nogil
 
  int dpiSodaColl_remove(dpiSodaColl *coll,

src/oracledb/impl/thick/soda.pyx

@@ -272,21 +272,6 @@ cdef class ThickSodaCollImpl(BaseSodaCollImpl):
  if doc_impl._handle != NULL:
  return doc_impl
 
- def get_indexes(self):
- """
- Internal method for getting the list of indexes on a collection.
- """
- cdef:
- dpiStringList indexes
- uint32_t flags
- int status
- self._db_impl._get_flags(&flags)
- with nogil:
- status = dpiSodaColl_getIndexes(self._handle, flags, &indexes)
- if status < 0:
- _raise_from_odpi()
- return _string_list_to_python(&indexes)
-
  def get_metadata(self):
  """
  Internal method for getting the metadata for a collection.
@@ -389,6 +374,21 @@ cdef class ThickSodaCollImpl(BaseSodaCollImpl):
  if return_doc:
  return output_doc_impl
 
+ def list_indexes(self):
+ """
+ Internal method for getting the list of indexes on a collection.
+ """
+ cdef:
+ dpiStringList indexes
+ uint32_t flags
+ int status
+ self._db_impl._get_flags(&flags)
+ with nogil:
+ status = dpiSodaColl_listIndexes(self._handle, flags, &indexes)
+ if status < 0:
+ _raise_from_odpi()
+ return _string_list_to_python(&indexes)
+
  def remove(self, object op):
  """
  Internal method for removing all of the documents matching the

src/oracledb/soda.py

@@ -214,12 +214,6 @@ def getDataGuide(self) -> "SodaDocument":
  if doc_impl is not None:
  return SodaDocument._from_impl(doc_impl)
 
- def getIndexes(self) -> list:
- """
- Return a list of indexes associated with the collection.
- """
- return [json.loads(s) for s in self._impl.get_indexes()]
-
  def insertMany(self, docs: list) -> None:
  """
  Inserts a list of documents into the collection at one time. Each of
@@ -281,6 +275,12 @@ def insertOneAndGet(self, doc: Any, hint: str=None) -> "SodaDocument":
  return_doc=True)
  return SodaDocument._from_impl(return_doc_impl)
 
+ def listIndexes(self) -> list:
+ """
+ Return a list of indexes associated with the collection.
+ """
+ return [json.loads(s) for s in self._impl.list_indexes()]
+
  @property
  def metadata(self) -> dict:
  """

tests/test_3400_soda_collection.py

@@ -632,9 +632,9 @@ def test_3428_fetch_array_size(self):
  def test_3429_getting_indexes(self):
  "3429 - test getting indexes on a collection"
  soda_db = self.get_soda_database()
- coll = soda_db.createCollection("TestSodaGetIndexes")
+ coll = soda_db.createCollection("TestSodaListIndexes")
  coll.drop()
- coll = soda_db.createCollection("TestSodaGetIndexes")
+ coll = soda_db.createCollection("TestSodaListIndexes")
  index_1 = {
  'name': 'ix_3428-1',
  'fields': [
@@ -655,10 +655,10 @@ def test_3429_getting_indexes(self):
  }
  ]
  }
- self.assertEqual(coll.getIndexes(), [])
+ self.assertEqual(coll.listIndexes(), [])
  coll.createIndex(index_1)
  coll.createIndex(index_2)
- indexes = coll.getIndexes()
+ indexes = coll.listIndexes()
  indexes.sort(key=lambda x: x["name"])
  self.assertEqual(indexes[0]["fields"][0]["path"], "address.city")
  self.assertEqual(indexes[1]["fields"][0]["path"], "address.postal_code")