Update cli

Author: BenConstable9

text_2_sql/data_dictionary/README.md

@@ -122,6 +122,13 @@ You can pass the following command line arguements:
 
 - `-- output_directory` or `-o`: Optional directory that the script will write the output files to.
 - `-- single_file` or `-s`: Optional flag that writes all schemas to a single file.
+- `-- generate_definitions` or `-gen`: Optional flag that uses OpenAI to generate descriptions.
+
+If you need control over the following, run the file directly:
+
+- `entities`: A list of entities to extract. Defaults to None.
+- `excluded_entities`: A list of entities to exclude.
+- `excluded_schemas`: A list of schemas to exclude.
 
 > [!IMPORTANT]
 >

text_2_sql/text_2_sql_core/src/text_2_sql_core/data_dictionary/cli.py

@@ -37,6 +37,14 @@ def create(
             help="Optional flag that writes all schemas to a single file.",
         ),
     ] = False,
+    generate_definitions: Annotated[
+        bool,
+        typer.Option(
+            "--generate_definitions",
+            "-gen",
+            help="Optional flag that will use OpenAI to generate descriptions.",
+        ),
+    ] = False,
 ) -> None:
     """Execute a Text2SQL Data Dictionary Creator YAML file.
 
@@ -50,30 +58,36 @@ def create(
 
     """
 
+    kwargs = {
+        "output_directory": output_directory,
+        "single_file": single_file,
+        "generate_definitions": generate_definitions,
+    }
+
     try:
         if engine == DatabaseEngine.DATABRICKS:
             from text_2_sql_core.data_dictionary.databricks_data_dictionary_creator import (
                 DatabricksDataDictionaryCreator,
             )
 
             data_dictionary_creator = DatabricksDataDictionaryCreator(
-                single_file=single_file, output_directory=output_directory
+                **kwargs,
             )
         elif engine == DatabaseEngine.SNOWFLAKE:
             from text_2_sql_core.data_dictionary.snowflake_data_dictionary_creator import (
                 SnowflakeDataDictionaryCreator,
             )
 
             data_dictionary_creator = SnowflakeDataDictionaryCreator(
-                single_file=single_file, output_directory=output_directory
+                **kwargs,
             )
         elif engine == DatabaseEngine.TSQL:
             from text_2_sql_core.data_dictionary.tsql_data_dictionary_creator import (
                 TSQLDataDictionaryCreator,
             )
 
             data_dictionary_creator = TSQLDataDictionaryCreator(
-                single_file=single_file, output_directory=output_directory
+                **kwargs,
             )
     except ImportError:
         detailed_error = f"""Failed to import {
@@ -82,10 +96,10 @@ def create(
         rich_print(detailed_error)
 
         raise typer.Exit(code=1)
+
     try:
         asyncio.run(data_dictionary_creator.create_data_dictionary())
     except Exception as e:
-        raise e
         logging.error(e)
         rich_print("Text2SQL Data Dictionary Creator Failed ❌")
 

text_2_sql/text_2_sql_core/src/text_2_sql_core/data_dictionary/data_dictionary_creator.py

@@ -237,7 +237,7 @@ def __init__(
         excluded_entities: list[str] = None,
         excluded_schemas: list[str] = None,
         single_file: bool = False,
-        generate_definitions: bool = True,
+        generate_definitions: bool = False,
         output_directory: str = None,
     ):
         """A method to initialize the DataDictionaryCreator class.
@@ -250,6 +250,11 @@ def __init__(
             generate_definitions (bool, optional): A flag to indicate if definitions should be generated. Defaults to True.
         """
 
+        if entities is not None and excluded_entities is not None:
+            raise ValueError(
+                "Cannot pass both entities and excluded_entities. Please pass only one."
+            )
+
         if excluded_entities is None:
             excluded_entities = []