Skip to content

Commit 8ce60e9

Browse files
Update README.md (#169)
1 parent ae45e95 commit 8ce60e9

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

text_2_sql/data_dictionary/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,10 @@ To generate a data dictionary, perform the following steps:
229229
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`.
230230

231231
**Execute the following commands in the `text_2_sql_core` directory:**
232+
232233
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.
233234
- Install the optional dependencies if you need a database connector other than TSQL. `uv sync --extra <DATABASE ENGINE>`
235+
234236
3. Run `uv run data_dictionary <DATABASE ENGINE>`
235237
- You can pass the following command line arguements:
236238
- `-- 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:
240242
- `entities`: A list of entities to extract. Defaults to None.
241243
- `excluded_entities`: A list of entities to exclude.
242244
- `excluded_schemas`: A list of schemas to exclude.
245+
243246
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.
244247

245248
> [!IMPORTANT]

0 commit comments

Comments
 (0)