Merge pull request #70 from datastax/feature/#69-rename-size-param

Update the size parameter to be dimension
datastax · Oct 30, 2023 · 5bf400f · 5bf400f
2 parents b5f7747 + 0e3399a
commit 5bf400f
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -74,9 +74,9 @@ api_endpoint = f"https://{database_id}-{database_region}.{database_base_url}"
 astra_db = AstraDB(token=token, api_endpoint=api_endpoint)
 
 # Possible Operations
-astra_db.create_collection(collection_name="collection_test_delete", size=5)
+astra_db.create_collection(collection_name="collection_test_delete", dimension=5)
 astra_db.delete_collection(collection_name="collection_test_delete")
-astra_db.create_collection(collection_name="collection_test", size=5)
+astra_db.create_collection(collection_name="collection_test", dimension=5)
 
 # Collections
 astra_db_collection = AstraDBCollection(

diff --git a/astrapy/db.py b/astrapy/db.py
@@ -347,9 +347,11 @@ def get_collections(self):
 
         return response
 
-    def create_collection(self, size=None, options={}, function="", collection_name=""):
-        if size and not options:
-            options = {"vector": {"size": size}}
+    def create_collection(
+        self, dimension=None, options={}, function="", collection_name=""
+    ):
+        if dimension and not options:
+            options = {"vector": {"dimension": dimension}}
             if function:
                 options["vector"]["function"] = function
         if options:

diff --git a/scripts/astrapy_latest_interface.py b/scripts/astrapy_latest_interface.py
@@ -43,9 +43,9 @@
 astra_db = AstraDB(token=token, api_endpoint=api_endpoint)
 
 # Possible Operations
-astra_db.create_collection(collection_name="collection_test_delete", size=5)
+astra_db.create_collection(collection_name="collection_test_delete", dimension=5)
 astra_db.delete_collection(collection_name="collection_test_delete")
-astra_db.create_collection(collection_name="collection_test", size=5)
+astra_db.create_collection(collection_name="collection_test", dimension=5)
 
 # Collections
 astra_db_collection = AstraDBCollection(

diff --git a/tests/astrapy/test_db.py b/tests/astrapy/test_db.py
@@ -75,7 +75,7 @@ def cliff_data(cliff_uuid):
 
 @pytest.fixture(scope="module")
 def collection(db, cliff_data):
-    db.create_collection(collection_name=TEST_FIXTURE_COLLECTION_NAME, size=5)
+    db.create_collection(collection_name=TEST_FIXTURE_COLLECTION_NAME, dimension=5)
 
     collection = db.collection(collection_name=TEST_FIXTURE_COLLECTION_NAME)
     collection.insert_one(document=cliff_data)
@@ -87,7 +87,7 @@ def collection(db, cliff_data):
 
 @pytest.mark.describe("should create a vector collection")
 def test_create_collection(db):
-    res = db.create_collection(collection_name=TEST_COLLECTION_NAME, size=5)
+    res = db.create_collection(collection_name=TEST_COLLECTION_NAME, dimension=5)
     print("CREATE", res)
     assert res is not None
 

diff --git a/tests/astrapy/test_pagination.py b/tests/astrapy/test_pagination.py
@@ -67,7 +67,7 @@ def test_collection():
         api_endpoint=f"https://{ASTRA_DB_ID}-{ASTRA_DB_REGION}.{ASTRA_DB_BASE_URL}",
         namespace=ASTRA_DB_KEYSPACE,
     )
-    res = astra_db.create_collection(collection_name=TEST_COLLECTION_NAME, size=2)
+    res = astra_db.create_collection(collection_name=TEST_COLLECTION_NAME, dimension=2)
     astra_db_collection = AstraDBCollection(
         collection_name=TEST_COLLECTION_NAME,
         token=ASTRA_DB_APPLICATION_TOKEN,