Merge pull request #1 from ByteStorage/api-dev

add db api

Author: qishenonly

FlyDB/db.py

@@ -1,3 +1,4 @@
+from pprint import pprint
 from typing import Union
 import grpc
 from FlyDB.client_grpc import db_pb2_grpc
@@ -25,7 +26,6 @@ def __init__(self):
         # The stub provides methods to call the gRPC service methods defined in db.proto.
         self.stub = db_pb2_grpc.GStringServiceStub(self.channel)
 
-
     def _validate_input(self, value, value_type, param_name):
         if not isinstance(value, value_type):
             raise TypeError(f"{param_name} must be of type {value_type}")
@@ -35,7 +35,7 @@ def connect_option(self, dir_path: str, data_file_size: int, sync_write: bool):
         Connects to the gRPC server with provided options.
 
         Parameters:
-            dir_path (str): The directory path for the FlyDB2.
+            dir_path (str): The directory path for the FlyDB.
             data_file_size (int): The size of data files.
             sync_write (bool): Indicates whether to use synchronous writes.
 
@@ -60,13 +60,13 @@ def connect_option(self, dir_path: str, data_file_size: int, sync_write: bool):
 
     def set(self, key: str, value: Union[str, int, float, bool, bytes], expire: int):
         """
-        Sets the key-value pair in the FlyDB2.
+        Sets the key-value pair in the FlyDB.
 
         Parameters:
             key (str): The key to be set.
             value (Union[str, int, float, bool, bytes]): The value to be set.
-            expire (int): The expiration time for the key-value pair in nanoseconds.
-                            When expire is 0, it never expires. Expire is in milliseconds.
+            expire (int): The expiration time for the key-value pair in milliseconds.
+                            When expire is 0, it never expires. 
 
         Returns:
             None
@@ -94,9 +94,23 @@ def set(self, key: str, value: Union[str, int, float, bool, bytes], expire: int)
         if response.ok:
             print("Put data success!")
 
+    def _return_type_response(self, response):
+        if response.HasField("StringValue"):
+            return response.StringValue
+        elif response.HasField("Int64Value"):
+            return response.Int64Value
+        elif response.HasField("Float64Value"):
+            return response.Float64Value
+        elif response.HasField("BoolValue"):
+            return response.BoolValue
+        elif response.HasField("BytesValue"):
+            return response.BytesValue
+        else:
+            raise ValueError("Unsupported value type")
+
     def get(self, key):
         """
-        Retrieves the value associated with the given key from the FlyDB2.
+        Retrieves the value associated with the given key from the FlyDB.
 
         Parameters:
             key (str): The key for which the value needs to be retrieved.
@@ -105,37 +119,26 @@ def get(self, key):
             Union[str, int, float, bool, bytes]: The value associated with the given key.
 
         Raises:
-            KeyError: If the key is not found in the FlyDB2.
-            TimeoutError: If the key has expired in the FlyDB2.
+            KeyError: If the key is not found in the FlyDB.
+            TimeoutError: If the key has expired in the FlyDB.
         """
         request = db_pb2.GetRequest()
         request.key = key
         try:
             response = self.stub.Get(request)
             # Determine the type of value and return accordingly
-            if response.HasField("StringValue"):
-                return response.StringValue
-            elif response.HasField("Int64Value"):
-                return response.Int64Value
-            elif response.HasField("Float64Value"):
-                return response.Float64Value
-            elif response.HasField("BoolValue"):
-                return response.BoolValue
-            elif response.HasField("BytesValue"):
-                return response.BytesValue
-            else:
-                raise ValueError("Unsupported value type")
+            return self._return_type_response(response)
         except grpc._channel._InactiveRpcError as e:
             if "KeyNotFoundError" in str(e):
-                raise KeyError("key is not found in the FlyDB2")
+                raise KeyError("key is not found in the FlyDB")
             elif "Wrong value" in str(e):
                 raise TimeoutError("key expired")
             else:
                 raise
 
     def delete(self, key):
         """
-        Deletes the key-value pair from the FlyDB2.
+        Deletes the key-value pair from the FlyDB.
 
         Parameters:
             key (str): The key to be deleted.
@@ -144,7 +147,7 @@ def delete(self, key):
             None
 
         Raises:
-            KeyError: If the key is not found in the FlyDB2.
+            KeyError: If the key is not found in the FlyDB.
         """
         request = db_pb2.DelRequest()
         request.key = key
@@ -154,8 +157,166 @@ def delete(self, key):
                 print("Delete data success!")
         except grpc._channel._InactiveRpcError as e:
             if "KeyNotFoundError" in str(e):
-                raise KeyError("key is not found in the FlyDB2")
+                raise KeyError("key is not found in the FlyDB")
+            else:
+                raise
+
+    def type(self, key):
+        """
+        Returns the type of the value associated with the given key.
+
+        Parameters:
+            key (str): The key for which the value type needs to be retrieved.
+
+        Returns:
+            str: The type of the value associated with the given key.
+
+        Raises:
+            KeyError: If the key is not found in the FlyDB.
+        """
+        request = db_pb2.TypeRequest()
+        request.key = key
+        try:
+            response = self.stub.Type(request)
+            return response.type
+        except grpc._channel._InactiveRpcError as e:
+            if "KeyNotFoundError" in str(e):
+                raise KeyError("key is not found in the FlyDB")
             else:
                 raise
 
+    def len(self, key):
+        """
+        Returns the length of the string value associated with the given key.
 
+        Parameters:
+            key (str): The key for which the string length needs to be retrieved.
+
+        Returns:
+            int: The length of the string value associated with the given key.
+
+        Raises:
+            KeyError: If the key is not found in the FlyDB.
+            TypeError: If the value associated with the given key is not of type string.
+        """
+        request = db_pb2.StrLenRequest()
+        request.key = key
+        try:
+            response = self.stub.StrLen(request)
+            return response.length
+        except grpc._channel._InactiveRpcError as e:
+            if "KeyNotFoundError" in str(e):
+                raise KeyError("key is not found in the FlyDB")
+            elif "Wrong value" in str(e):
+                raise TypeError("value is not of type string")
+            else:
+                raise
+
+    def get_set(self, key, value, expire):
+        """
+        Sets the value associated with the given key and returns the old value.
+
+        Parameters:
+            key (str): The key for which the value needs to be set.
+            value (Union[str, int, float, bool, bytes]): The value to be set.
+            expire (int): The expiration time for the key-value pair in milliseconds.
+                            When expire is 0, it never expires. 
+
+        Returns:
+            Union[str, int, float, bool, bytes]: The old value associated with the given key.
+
+        Raises:
+            TypeError: If the value associated with the given key is not of type string.
+        """
+        request = db_pb2.GetSetRequest()
+        request.key = key
+
+        if isinstance(value, str):
+            request.StringValue = value
+        elif isinstance(value, int):
+            request.Int64Value = value
+        elif isinstance(value, float):
+            request.Float64Value = value
+        elif isinstance(value, bool):
+            request.BoolValue = value
+        elif isinstance(value, bytes):
+            request.BytesValue = value
+        else:
+            raise TypeError("Unsupported type")
+
+        request.expire = expire * 1000000
+        try:
+            response = self.stub.GetSet(request)
+            return self._return_type_response(response)
+        except grpc._channel._InactiveRpcError as e:
+            if "Wrong value" in str(e):
+                raise TypeError("value is not of type string")
+            else:
+                raise
+
+    def exist(self, key):
+        """
+        Checks if the given key exists in the FlyDB.
+
+        Parameters:
+            key (str): The key to be checked.
+
+        Returns:
+            bool: True if the key exists in the FlyDB, False otherwise.
+        """
+        request = db_pb2.ExistsRequest()
+        request.key = key
+        response = self.stub.Exists(request)
+        return response.exists
+
+    def persist(self, key):
+        """
+        Removes the expiration associated with the given key.
+
+        Parameters:
+            key (str): The key for which the expiration needs to be removed.
+
+        Returns:
+            None
+
+        Raises:
+            KeyError: If the key is not found in the FlyDB.
+        """
+        request = db_pb2.PersistRequest()
+        request.key = key
+        try:
+            response = self.stub.Persist(request)
+            if response.ok:
+                print("Persist success!")
+        except grpc._channel._InactiveRpcError as e:
+            if "KeyNotFoundError" in str(e):
+                raise KeyError("key is not found in the FlyDB")
+            else:
+                raise
+
+    def mget(self, keys):
+        """
+        Retrieves the values associated with the given keys from the FlyDB.
+
+        Parameters:
+            keys (list): The list of keys for which the values need to be retrieved.
+
+        Returns:
+            list: The list of values associated with the given keys.
+
+        Raises:
+            KeyError: If any of the keys is not found in the FlyDB.
+        """
+        request = db_pb2.MGetRequest()
+        request.keys.extend(keys)
+        try:
+            response = self.stub.MGet(request)
+            values = []
+            for value in response.values:
+                values.append(value)
+            return values
+        except grpc._channel._InactiveRpcError as e:
+            if "KeyNotFoundError" in str(e):
+                raise KeyError("key is not found in the FlyDB")
+            else:
+                raise

FlyDB/example/simple.py

@@ -1,19 +1,50 @@
+import time
 from pathlib import Path
 from FlyDB import db
 
 # Create a FlyDB2 client
 db_client = db.FlyDB()
 
-# Connect to the FlyDB2
+# Connect to the FlyDB
 path = Path.cwd().joinpath("data")
 db_client.connect_option(str(path), 256*1024*1024, True)
 
 # Set a key-value pair
-db_client.set("key", "value", 0)
+db_client.set("key", "value",0)
 
 # Get the value of a key
 value = db_client.get("key")
 print(value)
 
+# Get the type of a key
+types = db_client.type("key")
+print(types)
+
+# Get the length of a value
+length = db_client.len("key")
+print(length)
+
+# Set the value and return the old value
+new_value = db_client.get_set("key", "value22222", 0)
+print(new_value)
+value = db_client.get("key")
+print(value)
+
+# Exist a key
+ok = db_client.exist("key")
+print(ok)
+
+# Persist expire time
+db_client.set("key1", "value1", 2)
+db_client.persist("key")
+time.sleep(3)
+value = db_client.get("key")
+print(value)
+
+# mgset
+db_client.set("key2", "value2", 0)
+v = db_client.mget(["key", "key2"])
+print(v)
+
 # Delete a key-value pair
 db_client.delete("key")