Add preview tag to Fusion SQL schedule jobs command

Author: kesmit13

singlestoredb/fusion/handler.py

@@ -5,6 +5,7 @@
 import re
 import sys
 import textwrap
+import warnings
 from collections.abc import Iterable
 from typing import Any
 from typing import Callable
@@ -21,6 +22,7 @@
 
 from . import result
 from ..connection import Connection
+from ..warnings import PreviewFeatureWarning
 
 CORE_GRAMMAR = r'''
     ws = ~r"(\s+|(\s*/\*.*\*/\s*)+)"
@@ -580,6 +582,7 @@ class SQLHandler(NodeVisitor):
     _grammar: str = CORE_GRAMMAR
     _is_compiled: bool = False
     _enabled: bool = True
+    _preview: bool = False
 
     def __init__(self, connection: Connection):
         self.connection = connection
@@ -654,6 +657,13 @@ def execute(self, sql: str) -> result.FusionSQLResult:
         DummySQLResult
 
         """
+        if type(self)._preview:
+            warnings.warn(
+                'This is a preview Fusion SQL command. '
+                'The options and syntax may change in the future.',
+                PreviewFeatureWarning, stacklevel=2,
+            )
+
         type(self).compile()
         self._handled = set()
         try:

singlestoredb/fusion/handlers/job.py

@@ -122,6 +122,8 @@ class ScheduleJobHandler(SQLHandler):
         ;
     """
 
+    _preview = True
+
     def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
         res = FusionSQLResult()
         res.add_field('JobID', result.STRING)

singlestoredb/management/workspace.py

@@ -226,8 +226,8 @@ def upload_folder(
         include_root : bool, optional
             Should the local root folder itself be uploaded as the top folder?
         ignore : Path or str or List[Path] or List[str], optional
-            Glob patterns of files to ignore, for example, '**/*.pyc` will
-            ignore all '*.pyc' files in the directory tree
+            Glob patterns of files to ignore, for example, ``**/*.pyc`` will
+            ignore all ``*.pyc`` files in the directory tree
 
         """
         if not os.path.isdir(local_path):

singlestoredb/warnings.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+
+class PreviewFeatureWarning(UserWarning):
+    """Warning for experimental preview features."""
+    pass