diff --git a/text_2_sql/data_dictionary/README.md b/text_2_sql/data_dictionary/README.md index b0dedd2..5f6a287 100644 --- a/text_2_sql/data_dictionary/README.md +++ b/text_2_sql/data_dictionary/README.md @@ -229,8 +229,10 @@ To generate a data dictionary, perform the following steps: 1. Create your `.env` file based on the provided sample `text_2_sql/.env.example`. Place this file in the same place in `text_2_sql/.env`. **Execute the following commands in the `text_2_sql_core` directory:** + 2. Package and install the `text_2_sql_core` library. See [build](https://docs.astral.sh/uv/concepts/projects/build/) if you want to build as a wheel and install on an agent. Or you can run from within a `uv` environment and skip packaging. - Install the optional dependencies if you need a database connector other than TSQL. `uv sync --extra ` + 3. Run `uv run data_dictionary ` - You can pass the following command line arguements: - `-- output_directory` or `-o`: Optional directory that the script will write the output files to. @@ -240,6 +242,7 @@ To generate a data dictionary, perform the following steps: - `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. + 4. Upload these generated data dictionaries files to the relevant containers in your storage account. Wait for them to be automatically indexed with the included skillsets. > [!IMPORTANT]