Skip to content

Commit bbfe878

Browse files
authored
Updated intro message (#75)
* Updated intro message * Updated readme
1 parent 70e9461 commit bbfe878

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ Operations are applied concurrently across multiple tables
2121
* [GDPR right of erasure: delete user data from all tables at once](docs/GDPR_RoE.md)
2222
* [Search in any column](docs/Search.md)
2323
* **Semantic classification**
24-
* [Semantic classification of columns by semantic type](docs/Semantic_classification.md): email, phone number, IP address, etc.
25-
* [Select data based on semantic types](docs/Select_by_class.md)
26-
* [Delete data based on semantic types](docs/Delete_by_class.md)
24+
* [Semantic classification of columns by semantic class](docs/Semantic_classification.md): email, phone number, IP address, etc.
25+
* [Select data based on semantic classes](docs/Select_by_class.md)
26+
* [Delete data based on semantic classes](docs/Delete_by_class.md)
2727
* **Custom**
2828
* [Arbitrary SQL template execution across multiple tables](docs/Arbitrary_multi-table_SQL.md)
2929

discoverx/dx.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,18 @@ def intro(self):
6161
<h1>Hi there, I'm DiscoverX.</h1>
6262
6363
<p>
64-
I'm here to help you discover data in your lakehouse.<br />
65-
You can scan your lakehouse by using
64+
I'm here to help you paralelize multi-table operations across your lakehouse.<br />
65+
You can start by defining the set of tables to run operations on (use "*" as a wildcard)<br />
66+
</p>
67+
<pre><code>dx.from_tables("*.*.*")</code></pre>
68+
<p>
69+
Then you can apply the following operations
70+
<ul>
71+
<li><code>.apply_sql(...)</code> - Runs a SQL template on each table</li>
72+
<li><code>.scan(...)</code> - Scan your lakehouse for columns matching the given rules</li>
73+
<li><code>.search(...)</code> - Search your lakehouse for columns matching the given search term</li>
74+
</ul>
6675
</p>
67-
<pre><code>dx.scan(from_tables="*.*.*")</code></pre>
6876
<p>
6977
For more detailed instructions, check out the <a href="https://github.com/databrickslabs/discoverx">readme</a> or use
7078
</p>

0 commit comments

Comments
 (0)