Skip to content

Commit bed14da

Browse files
authored
Readme update (#69)
* Fixed version on example notebook * Enriched docs * Updated docs * Updated readme * Updated according to comments * Updated readme * Fixed docs for to_union_dataframe
1 parent e015848 commit bed14da

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ The available `dx` functions are
5858
* `from_tables("<catalog>.<schema>.<table>")` selects tables based on the specified pattern (use `*` as a wildcard). Returns a `DataExplorer` object with methods
5959
* `having_columns` restricts the selection to tables that have the specified columns
6060
* `with_concurrency` defines how many queries are executed concurrently (10 by defailt)
61-
* `apply_sql` applies a SQL template to all tables and returns a [DataExplorerActions](#dataexploreractions-object) object. See in-depth documentation [here](docs/Arbitrary_multi-table_SQL.md).
62-
* `unpivot_string_columns` returns a melted (unpivoted) dataframe with all string columns from the selected tables and returns a [DataExplorerActions](#dataexploreractions-object) object
61+
* `apply_sql` applies a SQL template to all tables. After this command you can apply an [action](#from_tables-actions). See in-depth documentation [here](docs/Arbitrary_multi-table_SQL.md).
62+
* `unpivot_string_columns` returns a melted (unpivoted) dataframe with all string columns from the selected tables. After this command you can apply an [action](#from_tables-actions)
6363
* `intro` gives an introduction to the library
6464
* `scan` scans the lakehouse with regex expressions defined by the rules and to power the semantic classification. [Documentation](docs/Semantic_classification.md)
6565
* `display_rules` shows the rules available for semantic classification
@@ -68,14 +68,13 @@ The available `dx` functions are
6868
* `delete_by_class` deletes from the lakehouse by semantic class. [Documentation](docs/Delete_by_class.md)
6969

7070

71-
### DataExplorerActions Object
71+
### from_tables Actions
7272

73-
The functions available from the `DataExplorerActions` Object are:
73+
After a `apply_sql` or `unpivot_string_columns` command, you can apply the following actions:
7474

7575
* `explain` explains the queries that would be executed
7676
* `execute` executes the queries and shows the result in a unioned dataframe
77-
* `to_union_df` unions all the dataframes that result from the queries
78-
77+
* `to_union_dataframe` unions all the dataframes that result from the queries
7978

8079

8180
## Requirements

0 commit comments

Comments
 (0)