version up to 1.5.0

README.md

@@ -11,7 +11,7 @@ Works and tested on Ubuntu, macOS, Windows 10, can use python 3.8+ (including py
  * only one small dependency (websocket-client), no need to pull a lot of libraries to your project
  * fully documented
  * well tested (on the latest Ubuntu, macOS and Windows 10)
- * fully compatible with the latest version of SurrealDB (1.4.2), including [live queries](https://surrealdb.com/products/lq) and [change feeds](https://surrealdb.com/products/cf)
+ * fully compatible with the latest version of SurrealDB (1.5.0), including [live queries](https://surrealdb.com/products/lq) and [change feeds](https://surrealdb.com/products/cf)
  * debug mode to see all that goes in and out if you need
  * iterator to handle big select queries
  * QL-builder to explore, generate and use SurrealDB queries (explain, transaction etc.)

src/surrealist/ql/statements/rebuild_index.py

@@ -1,8 +1,8 @@
 from typing import List
 
-from .statement import Statement
-from surrealist.utils import OK
 from surrealist.connections import Connection
+from surrealist.utils import OK
+from .statement import Statement
 
 
 class RebuildIndex(Statement):
@@ -13,6 +13,7 @@ class RebuildIndex(Statement):
 
     Examples: https://github.com/kotolex/surrealist/blob/master/examples/surreal_ql/database.py
     """
+
     def __init__(self, connection: Connection, index_name: str, table_name: str, if_exists: bool = False):
         super().__init__(connection)
         self._name = index_name

src/surrealist/ql/statements/show.py

@@ -34,10 +34,20 @@ def validate(self) -> List[str]:
         return [OK] if not result else result
 
     def limit(self, limit: int) -> "Show":
+        """
+        Limits number of results to show (LIMIT statement)
+        :param limit: number of results
+        :return: Show object
+        """
         self._limit = limit
         return self
 
     def since(self, timestamp: str) -> "Show":
+        """
+        Init timestamp since is to show updates
+        :param timestamp: surreal timestamp
+        :return: Show object
+        """
         self._since = timestamp
         return self
 

src/surrealist/ql/statements/utils.py

@@ -3,6 +3,14 @@
 
 
 def combine(result: Optional[str], kwargs: Dict) -> str:
+    """
+    Combine optional raw string representation with optional keyword-arguments. Used in relate/create/update statements
+    for set methods
+
+    :param result: raw string representation for query
+    :param kwargs: optional parameters
+    :return: string combined
+    """
     first = result if result else ''
     second = ", ".join(f"{k} = {json.dumps(v)}" for k, v in kwargs.items()) if kwargs else ''
     args = ', '.join(element for element in (first, second) if element)