RDBC-644 API Syntax

Simplified 'BulkInsert.store_with_entity' into 'BulkInsert.store'
The original 'store' has been changed to 'store_as' - indicating that it requires providing certain document id

Author: poissoncorp

ravendb/documents/bulk_insert_operation.py

@@ -194,17 +194,17 @@ def _fill_metadata_if_needed(self, entity: object, metadata: MetadataAsDictionar
             if python_type is not None:
                 metadata[constants.Documents.Metadata.RAVEN_PYTHON_TYPE] = python_type
 
-    def store_by_entity(self, entity: object, metadata: Optional[MetadataAsDictionary] = None) -> str:
+    def store(self, entity: object, metadata: Optional[MetadataAsDictionary] = None) -> str:
         key = (
             self._get_id(entity)
             if metadata is None or constants.Documents.Metadata.ID not in metadata
             else metadata[constants.Documents.Metadata.ID]
         )
 
-        self.store(entity, key, metadata or MetadataAsDictionary())
+        self.store_as(entity, key, metadata or MetadataAsDictionary())
         return key
 
-    def store(
+    def store_as(
         self, entity: object, key: str, metadata: Optional[MetadataAsDictionary] = MetadataAsDictionary()
     ) -> None:
         try:

ravendb/tests/jvm_migrated_tests/client_tests/subscriptions_tests/test_basic_subscription.py

@@ -571,9 +571,9 @@ def test_should_pull_documents_after_bulk_insert(self):
         key = self.store.subscriptions.create_for_class(User, SubscriptionCreationOptions())
         with self.store.subscriptions.get_subscription_worker(SubscriptionWorkerOptions(key), User) as subscription:
             with self.store.bulk_insert() as bulk_insert:
-                bulk_insert.store_by_entity(User())
-                bulk_insert.store_by_entity(User())
-                bulk_insert.store_by_entity(User())
+                bulk_insert.store(User())
+                bulk_insert.store(User())
+                bulk_insert.store(User())
 
             users: List[User] = []
             third_user_processed = Event()

ravendb/tests/jvm_migrated_tests/client_tests/test_bulk_inserts.py

@@ -22,10 +22,10 @@ def test_simple_bulk_insert_should_work(self):
         foo_bar4 = FooBar("Mega Jane")
 
         with self.store.bulk_insert() as bulk_insert:
-            bulk_insert.store_by_entity(foo_bar1)
-            bulk_insert.store_by_entity(foo_bar2)
-            bulk_insert.store_by_entity(foo_bar3)
-            bulk_insert.store_by_entity(foo_bar4)
+            bulk_insert.store(foo_bar1)
+            bulk_insert.store(foo_bar2)
+            bulk_insert.store(foo_bar3)
+            bulk_insert.store(foo_bar4)
 
         with self.store.open_session() as session:
             doc1 = session.load("FooBars/1-A", FooBar)
@@ -46,7 +46,7 @@ def test_simple_bulk_insert_should_work(self):
     def test_should_not_accept_ids_ending_with_pipe_line(self):
         with self.store.bulk_insert() as bulk_insert:
             self.assertRaisesWithMessage(
-                bulk_insert.store,
+                bulk_insert.store_as,
                 RuntimeError,
                 "Document ids cannot end with '|', but was called with foobars|",
                 FooBar(),
@@ -60,7 +60,7 @@ def test_can_modify_metadata_with_bulk_insert(self):
             foobar = FooBar("Jon Snow")
             metadata = MetadataAsDictionary()
             metadata[constants.Documents.Metadata.EXPIRES] = expiration_date
-            bulk_insert.store_by_entity(foobar, metadata)
+            bulk_insert.store(foobar, metadata)
 
         with self.store.open_session() as session:
             entity = session.load("FooBars/1-A", FooBar)
@@ -70,7 +70,7 @@ def test_can_modify_metadata_with_bulk_insert(self):
     def test_killed_to_early(self):
         with self.assertRaises(BulkInsertAbortedException):
             with self.store.bulk_insert() as bulk_insert:
-                bulk_insert.store_by_entity(FooBar())
+                bulk_insert.store(FooBar())
                 time.sleep(0.1)  # todo: wait for operation to be created first, then try to kill it
                 bulk_insert.abort()
-                bulk_insert.store_by_entity(FooBar())
+                bulk_insert.store(FooBar())

ravendb/tests/jvm_migrated_tests/issues_tests/test_RDBC_387.py

@@ -0,0 +1,29 @@
+from ravendb.infrastructure.entities import User
+from ravendb.tests.test_base import TestBase
+
+
+class TestRDBC387(TestBase):
+    def setUp(self):
+        super(TestRDBC387, self).setUp()
+
+    def test_should_store_single_id(self):
+        with self.store.open_session() as session:
+            u = User(name="John")
+            session.store(u)
+            session.save_changes()
+            user_id_via_session_id = u.Id
+
+        with self.store.bulk_insert() as bulk_insert:
+            u = User(name="Marcin")
+            bulk_insert.store(u)
+            user_id_via_bulk_insert = u.Id
+
+        with self.store.open_session() as session:
+            session_user = session.load(user_id_via_session_id, dict)
+            bulk_insert_user = session.load(user_id_via_bulk_insert, dict)
+
+            self.assertIsNone(session_user.get("id", None))
+            self.assertIsNone(bulk_insert_user.get("id", None))
+
+            self.assertIsNone(session_user.get("Id", None))
+            self.assertIsNone(bulk_insert_user.get("Id", None))

ravendb/tests/jvm_migrated_tests/issues_tests/test_ravenDB_16301.py

@@ -19,7 +19,7 @@ def test_can_use_conditional_load_lazily(self):
         # Store 100 companies using bulk insert - it won't store identity property on the server
         with self.store.bulk_insert() as bulk_insert:
             for i in range(100):
-                bulk_insert.store_by_entity(Company())
+                bulk_insert.store(Company())
 
         conditional_loads: List[Lazy[ConditionalLoadResult[Company]]] = []